Metodo ICertExit::GetDescription (certexit.h)

  • Articolo

Il metodo GetDescription restituisce una descrizione leggibile del modulo di uscita e della relativa funzione. Questo metodo è stato definito per la prima volta nell'interfaccia ICertExit .

Sintassi

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parametri

[out] pstrDescription

Puntatore a BSTR che descrive il modulo di uscita.

Valore restituito

C++

Se il metodo ha esito positivo, il metodo restituisce S_OK.

Se il metodo ha esito negativo, restituisce un valore HRESULT che indica l'errore. Per un elenco di codici di errore comuni, vedere Valori HRESULT comuni.

VB

Restituisce una stringa che descrive il modulo di uscita e la relativa funzione.

Commenti

Quando si scrive un modulo di uscita personalizzato, implementare questo metodo.

Esempio

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

Requisiti

   
Client minimo supportato Nessuno supportato
Server minimo supportato Windows Server 2003 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione certexit.h (include Certsrv.h)

Vedi anche

ICertExit

ICertExit2