ICertPolicy::GetDescription-Methode (certpol.h)

  • Artikel

Die GetDescription-Methode gibt eine lesbare Beschreibung des Richtlinienmoduls und seiner Funktion zurück.

Syntax

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parameter

[out] pstrDescription

Ein Zeiger auf einen BSTR , der das Richtlinienmodul 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 Richtlinienmodul und seine Funktion beschreibt.

Hinweise

Wenn Sie benutzerdefinierte Richtlinienmodule schreiben, implementieren Sie diese Methode.

Beispiele

#include <windows.h>
#include <Certpol.h>

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

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Nicht unterstützt
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile certpol.h (include Certsrv.h)
Bibliothek Certidl.lib

Weitere Informationen

ICertPolicy

ICertPolicy2