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

El método GetDescription devuelve una descripción legible del módulo de salida y su función. Este método se definió por primera vez en la interfaz ICertExit .

Sintaxis

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parámetros

[out] pstrDescription

Puntero al BSTR que describe el módulo de salida.

Valor devuelto

C++

Si el método se realiza correctamente, el método devuelve S_OK.

Si se produce un error en el método, devuelve un valor HRESULT que indica el error. Para obtener una lista de códigos de error comunes, consulte Valores HRESULT comunes.

VB

Devuelve una cadena que describe el módulo de salida y su función.

Comentarios

Al escribir un módulo de salida personalizado, implemente este método.

Ejemplos

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 compatible	No se admite ninguno
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	certexit.h (incluya Certsrv.h)

Consulte también

ICertExit

ICertExit2