Méthode IWiaErrorHandler::GetStatusDescription

Retourne une chaîne qui décrit le code status.

Syntaxe

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

Paramètres

punkItem [in]

Type : IUnknown*

Pointeur vers l’IUnknown de l’élément en cours de transfert. Cet objet implémente au minimum IWiaItem2 et IWiaDataTransfer.

hrStatus [in]

Type : HRESULT

HRESULT qui est le code status reçu par BandedDataCallback.

cbResLength [in]

Type : LONG

LONG qui correspond à la taille des données auxquelles fait référence pbData.

pbData [in]

Type : BYTE*

Pointeur vers la mémoire tampon de données reçue par BandedDataCallback.

pbstrDescription [out]

Type : BSTR*

BSTR qui reçoit une description de l’status ou de l’erreur rencontrée pendant le transfert de données. Ce paramètre ne peut pas avoir la valeur NULL. L’appelant doit libérer la chaîne à l’aide de SysFreeString, et l’implémenteur doit allouer la chaîne à l’aide de SysAllocString.

Valeur retournée

Type : HRESULT

Retourne l’une des valeurs suivantes.

Code de retour	Description
S_OK	pbstrDescription contient un pointeur BSTR valide.
S_FALSE	hrStatus est inconnu et aucune description n’est disponible.

 

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
En-tête	Wia.h
IDL	Wia.idl
Bibliothèque	Wiaguid.lib