IWiaErrorHandler::GetStatusDescription method

Returns a string that describes the status code.

Syntax


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

Parameters

punkItem [in]

Type: IUnknown*

Pointer to the IUnknown of the item being transferred. This object minimally implements IWiaItem2 and IWiaDataTransfer.

hrStatus [in]

Type: HRESULT

HRESULT that is the status code received by BandedDataCallback.

cbResLength [in]

Type: LONG

LONG that is the size of the data referred to by pbData.

pbData [in]

Type: BYTE*

Pointer to the data buffer as received by BandedDataCallback.

pbstrDescription [out]

Type: BSTR*

BSTR that receives a description of the status or error encountered during the data transfer. This parameter cannot be NULL. The caller must free the string using SysFreeString, and the implementor must allocate the string using SysAllocString.

Return value

Type: HRESULT

Returns one of the following values.

Return codeDescription
S_OK

pbstrDescription contains a valid BSTR pointer.

S_FALSE

hrStatus is unknown and no description is available.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wia.h

IDL

Wia.idl

Library

Wiaguid.lib

 

 

Show: