Поделиться через


Метод 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
Header certpol.h (включая Certsrv.h)
Библиотека Certidl.lib

См. также раздел

ICertPolicy

ICertPolicy2