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

O método GetDescription retorna uma descrição legível por humanos do módulo de política e sua função.

Sintaxe

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parâmetros

[out] pstrDescription

Um ponteiro para um BSTR que descreve o módulo de política.

Retornar valor

C++

Se o método for bem-sucedido, o método retornará S_OK.

Se o método falhar, ele retornará um valor HRESULT que indica o erro. Para obter uma lista de códigos de erro comuns, consulte Valores HRESULT comuns.

VB

Retorna uma cadeia de caracteres que descreve o módulo de política e sua função.

Comentários

Ao escrever módulos de política personalizados, implemente esse método.

Exemplos

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Nenhum compatível
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	certpol.h (inclua Certsrv.h)
Biblioteca	Certidl.lib

Confira também

ICertPolicy

ICertPolicy2