Метод IWiaDataTransfer::idtGetData (wia_xp.h)

Метод IWiaDataTransfer::idtGetData извлекает полные файлы с устройства получения образов Windows (WIA).

Синтаксис

HRESULT idtGetData(
  [in, out] LPSTGMEDIUM      pMedium,
  [in]      IWiaDataCallback *pIWiaDataCallback
);

Параметры

[in, out] pMedium

Тип: LPSTGMEDIUM

Указатель на структуру STGMEDIUM .

[in] pIWiaDataCallback

Тип: IWiaDataCallback*

Указатель на интерфейс IWiaDataCallback .

Возвращаемое значение

Тип: HRESULT

Этот метод может возвращать любое из следующих значений:

Возвращаемое значение	Значение
E_INVALIDARG	Один или несколько параметров этого метода содержат недопустимые данные.
E_OUTOFMEMORY	Этот метод не может выделить достаточно памяти для выполнения операции.
E_UNEXPECTED	Произошла неизвестная ошибка.
S_FALSE	Приложение отменило операцию.
S_OK	Образ успешно получен.
STG_E_MEDIUMFULL	Среда хранения, используемая приложением для получения образа, заполнена.
WIA_S_NO_DEVICE_AVAILABLE	К компьютеру пользователя не подключены аппаратные устройства WIA.

 

Этот метод возвращает значение, указанное в коде ошибок, или стандартную ошибку COM, если она завершается сбоем по какой-либо причине, кроме указанной в предыдущей таблице.

Комментарии

В большинстве случаев этот метод работает идентично методу IDataObject::GetData . Основное отличие заключается в том, что IWiaDataTransfer::idtGetData предоставляет дополнительный параметр для указателя на интерфейс IWiaDataCallback . Приложения используют этот необязательный параметр для получения уведомлений о состоянии во время передачи данных. Если уведомления о состоянии не требуются, необходимо задать нулевое значение.

Формат передачи данных определяется значениями свойств WIA_IPA_FORMAT и WIA_IPA_TYMED элемента. Приложение задает эти свойства с помощью вызовов метода IWiaPropertyStorage::WriteMultiple .

В отличие от метода IWiaDataTransfer::idtGetBandedData , IWiaDataTransfer::idtGetData передает полный файл с устройства WIA в приложение, а не только один диапазон данных. Параметр pMedium является указателем на структуру STGMEDIUM , которая содержит сведения о носителе, используемом для передачи данных. Программы используют параметр pIWiaDataCallback , чтобы передать этому методу указатель на интерфейс IWiaDataCallback . Периодически этот метод будет использовать указатель интерфейса для вызова метода BandedDataCallback и предоставления приложению сведений о состоянии выполняющегося переноса данных.

Передайте значение NULL в качестве значения элемента lpszFileName структуры pMedium , чтобы позволить WIA определить имя и расположение нового файла. После возврата элемент lpszFileName структуры pMedium содержит расположение и имя нового файла.

Если значение, возвращаемое этим методом, является значением COM SUCCESS или передача представляет собой многостранийную передачу файлов, а возвращенный код ошибки WIA_ERROR_PAPER_JAM, WIA_ERROR_PAPER_EMPTY или WIA_ERROR_PAPER_PROBLEM, WIA не удаляет файл.

Требования

Минимальная версия клиента	Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	wia_xp.h (включая Wia.h)
Библиотека	Wiaguid.lib
DLL	Wiaservc.dll