Método IWiaErrorHandler::GetStatusDescription

Devuelve una cadena que describe el código de estado.

Sintaxis

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

Parámetros

punkItem [in]

Tipo: IUnknown*

Puntero al IUnknown del elemento que se va a transferir. Este objeto implementa mínimamente IWiaItem2 e IWiaDataTransfer.

hrStatus [in]

Tipo: HRESULT

HRESULT que es el código de estado recibido por BandedDataCallback.

cbResLength [in]

Tipo: LONG

LONG que es el tamaño de los datos a los que hace referencia pbData.

pbData [in]

Tipo: BYTE*

Puntero al búfer de datos tal y como recibe BandedDataCallback.

pbstrDescription [out]

Tipo: BSTR*

BSTR que recibe una descripción del estado o error detectado durante la transferencia de datos. Este parámetro no puede ser NULL. El autor de la llamada debe liberar la cadena mediante SysFreeString y el implementador debe asignar la cadena mediante SysAllocString.

Valor devuelto

Tipo: HRESULT

Devuelve uno de los valores siguientes.

Código devuelto	Descripción
S_OK	pbstrDescription contiene un puntero BSTR válido.
S_FALSE	hrStatus es desconocido y no hay ninguna descripción disponible.

 

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Encabezado	Wia.h
IDL	Wia.idl
Biblioteca	Wiaguid.lib