Metode ICertExit::GetDescription (certexit.h)

Metode GetDescription mengembalikan deskripsi modul keluar yang dapat dibaca manusia dan fungsinya. Metode ini pertama kali didefinisikan dalam antarmuka ICertExit .

Sintaks

HRESULT GetDescription(
  [out] BSTR *pstrDescription
);

Parameter

[out] pstrDescription

Pointer ke BSTR yang menjelaskan modul keluar.

Nilai kembali

C++

Jika metode berhasil, metode akan mengembalikan S_OK.

Jika metode gagal, metode mengembalikan nilai HRESULT yang menunjukkan kesalahan. Untuk daftar kode kesalahan umum, lihat Nilai HRESULT Umum.

VB

Mengembalikan string yang menjelaskan modul keluar dan fungsinya.

Keterangan

Saat Anda menulis modul keluar kustom, terapkan metode ini.

Contoh

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

Persyaratan

Klien minimum yang didukung	Tidak ada yang didukung
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	certexit.h (termasuk Certsrv.h)

Lihat juga

ICertExit

ICertExit2