ICertPolicy::GetDescription メソッド (certpol.h)
GetDescription メソッドは、ポリシー モジュールとその関数の人間が判読できる説明を返します。
構文
HRESULT GetDescription(
[out] BSTR *pstrDescription
);
パラメーター
[out] pstrDescription
ポリシー モジュールを記述する BSTR へのポインター。
戻り値
C++
メソッドが成功した場合、メソッドは S_OKを返します。メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。 一般的なエラー コードの一覧については、「 共通 HRESULT 値」を参照してください。
VB
ポリシー モジュールとその関数を記述する文字列を返します。注釈
カスタム ポリシー モジュールを記述するときは、このメソッドを実装します。
例
#include <windows.h>
#include <Certpol.h>
STDMETHODIMP CCertPolicy::GetDescription(
/* [out, retval] */ BSTR __RPC_FAR *pstrDescription)
{
if (NULL == pstrDescription)
{
// Bad pointer address
return ( E_POINTER );
}
if (NULL != *pstrDescription)
{
SysFreeString(*pstrDescription);
*pstrDescription=NULL;
}
// wszMyModuleDesc defined elsewhere, for example:
// #define wszMyModuleDesc L"My Policy Module"
*pstrDescription = SysAllocString(wszMyModuleDesc);
if (NULL == *pstrDescription)
{
// Not enough memory
return ( E_OUTOFMEMORY );
}
// Success
return( S_OK );
}
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | certpol.h (Certsrv.h を含む) |
Library | Certidl.lib |