Méthode ICertExit::GetDescription (certexit.h)

  • Article

La méthode GetDescription retourne une description lisible du module de sortie et de sa fonction. Cette méthode a d’abord été définie dans l’interface ICertExit .

Syntaxe

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Paramètres

[out] pstrDescription

Pointeur vers le BSTR qui décrit le module de sortie.

Valeur retournée

C++

Si la méthode réussit, la méthode retourne S_OK.

Si la méthode échoue, elle retourne une valeur HRESULT qui indique l’erreur. Pour obtenir la liste des codes d’erreur courants, consultez Valeurs HRESULT courantes.

VB

Retourne une chaîne qui décrit le module de sortie et sa fonction.

Remarques

Lorsque vous écrivez un module de sortie personnalisé, implémentez cette méthode.

Exemples

STDMETHODIMP
CCertExit::GetDescription(
    /* [out, retval] */ BSTR __RPC_FAR *pstrDescription)
{
    if (NULL == pstrDescription)
    {
        // Bad pointer address.
        return (E_POINTER);
    }
    if (NULL != *pstrDescription)
    {
        SysFreeString(*pstrDescription);
        *pstrDescription=NULL;
    }
    // wszMyExitModuleDesc defined elsewhere, for example:
    // #define wszMyExitModuleDesc L"My Exit Module"
    *pstrDescription = SysAllocString(wszMyExitModuleDesc);
    if (NULL == *pstrDescription)
    {
        // Not enough memory
        return ( E_OUTOFMEMORY );
    }
    // Success
    return( S_OK );
}

Configuration requise

   
Client minimal pris en charge Aucun pris en charge
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête certexit.h (include Certsrv.h)

Voir aussi

ICertExit

ICertExit2