ICertExit::GetDescription-Methode (certexit.h)

Die GetDescription-Methode gibt eine lesbare Beschreibung des Exitmoduls und seiner Funktion zurück. Diese Methode wurde zuerst in der ICertExit-Schnittstelle definiert.

Syntax

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parameter

[out] pstrDescription

Ein Zeiger auf den BSTR , der das Exitmodul beschreibt.

Rückgabewert

C++

Wenn die Methode erfolgreich ist, gibt die Methode S_OK zurück.

Wenn die Methode fehlschlägt, gibt sie einen HRESULT-Wert zurück, der den Fehler angibt. Eine Liste allgemeiner Fehlercodes finden Sie unter Allgemeine HRESULT-Werte.

VB

Gibt eine Zeichenfolge zurück, die das Exitmodul und seine Funktion beschreibt.

Hinweise

Wenn Sie ein benutzerdefiniertes Exitmodul schreiben, implementieren Sie diese Methode.

Beispiele

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 );
}

Anforderungen

Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	certexit.h (include Certsrv.h)

Weitere Informationen

ICertExit

ICertExit2