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

Метод 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
Header certexit.h (включая Certsrv.h)

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

ICertExit

ICertExit2