Метод IWiaErrorHandler::GetStatusDescription

Возвращает строку, описывающую код состояния.

Синтаксис

HRESULT GetStatusDescription(
  [in]  IUnknown *punkItem,
  [in]  HRESULT  hrStatus,
  [in]  LONG     cbResLength,
  [in]  BYTE     *pbData,
  [out] BSTR     *pbstrDescription
);

Параметры

punkItem [in]

Тип: IUnknown*

Указатель на IUnknown передаваемого элемента. Этот объект минимально реализует IWiaItem2 и IWiaDataTransfer.

hrStatus [in]

Тип: HRESULT

HRESULT — код состояния, полученный BandedDataCallback.

cbResLength [in]

Тип: LONG

LONG — это размер данных, на которые ссылается pbData.

pbData [in]

Тип: BYTE*

Указатель на буфер данных, полученный BandedDataCallback.

pbstrDescription [out]

Тип: BSTR*

BSTR , получающий описание состояния или ошибки, возникших во время передачи данных. Этот параметр не может иметь значение NULL. Вызывающий объект должен освободить строку с помощью SysFreeString, а разработчик должен выделить строку с помощью SysAllocString.

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

Тип: HRESULT

Возвращает одно из следующих значений.

Код возврата	Описание
S_OK	pbstrDescription содержит допустимый указатель BSTR .
S_FALSE	HrStatus неизвестен, и описание недоступно.

 

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Заголовок	Wia.h
IDL	Wia.idl
Библиотека	Wiaguid.lib