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

O método GetDescription retorna uma descrição legível por humanos do módulo de saída e sua função. Esse método foi definido pela primeira vez na interface ICertExit .

Sintaxe

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parâmetros

[out] pstrDescription

Um ponteiro para o BSTR que descreve o módulo de saída.

Valor retornado

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 saída e sua função.

Comentários

Ao escrever um módulo de saída personalizado, implemente esse método.

Exemplos

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

Requisitos

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	certexit.h (inclua Certsrv.h)

Confira também

ICertExit

ICertExit2