Méthode ICertPolicy ::GetDescription (certpol.h)

La méthode GetDescription retourne une description lisible du module de stratégie et de sa fonction.

Syntaxe

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Paramètres

[out] pstrDescription

Pointeur vers un BSTR qui décrit le module de stratégie.

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 stratégie et sa fonction.

Remarques

Lorsque vous écrivez des modules de stratégie personnalisés, implémentez cette méthode.

Exemples

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

Configuration requise

Condition requise	Valeur
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	certpol.h (inclure Certsrv.h)
Bibliothèque	Certidl.lib

Voir aussi

ICertPolicy

ICertPolicy2