ICertExit::GetDescription メソッド (certexit.h)
GetDescription メソッドは、終了モジュールとその関数の人間が判読できる説明を返します。 このメソッドは、最初に ICertExit インターフェイスで定義されました。
構文
HRESULT GetDescription(
[out] BSTR *pstrDescription
);
パラメーター
[out] pstrDescription
終了モジュールを記述する BSTR へのポインター。
戻り値
C++
メソッドが成功した場合、メソッドは S_OKを返します。メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。 一般的なエラー コードの一覧については、「 共通 HRESULT 値」を参照してください。
VB
終了モジュールとその関数を記述する文字列を返します。解説
カスタム出口モジュールを作成する場合は、このメソッドを実装します。
例
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 );
}
要件
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | certexit.h (Certsrv.h を含む) |