Метод ICertConfig::GetField (certcli.h)

Статья
08/22/2023

Метод GetField получает определенное поле из текущей записи базы данных конфигурации. Этот метод был впервые определен в интерфейсе ICertConfig .

Синтаксис

HRESULT GetField(
  [in]          const BSTR strFieldName,
  [out, retval] BSTR       *pstrOut
);

Параметры

[in] strFieldName

Указывает имя возвращаемого поля. Этот параметр может быть одной из следующих допустимых строк для имен полей (обратите внимание, что некоторые центры сертификации могут не предоставлять данные для каждого поля).

Значение	Значение
Центр авторизации	Имя эталонного центра сертификации (ЦС).
CommonName	Общее имя сервера.
Config	Эталонный компьютер\имя ЦС.
Страна	Страна или регион.
Описание	Описательный комментарий о сервере (заменяет устаревшее примечание).
ExchangeCertificate	Имя файла, содержащего сертификат Exchange (применяется только к службам сертификатов версии 1.0).
Flags	Строка, представляющая расположение, в котором были найдены сведения о ЦС. Дополнительные сведения см. в подразделе "Примечания".
Расположение	Город или город.
Организация	Организации.
OrgUnit	Подразделения.
SanitizedName	Имя ЦС, которое очищается в соответствии с правилами, описанными в getConfig.
SanitizedShortName	Имя ЦС, которое очищается и сокращается в соответствии с правилами, описанными в getConfig.
Сервер	Имя эталонного компьютера.
ShortName	SanitizedShortName, но с последовательностями "!xxx", как описано в GetConfig, переведены обратно в исходный текст.
SignatureCertificate	Имя файла, содержащего сертификат ЦС (также известный как сертификат подписи ЦС); это может быть корневой сертификат.
Состояние	Штат или провинция.
WebEnrollmentServers	Массив URL-адресов веб-службы регистрации сертификатов для определенной конфигурации ЦС в Active Directory. Windows Vista и Windows Storage Server 2003: Это поле не поддерживается.

[out, retval] pstrOut

Указатель на BSTR , получающий данные из поля. Завершив использование BSTR, освободите pbstrOut , вызвав функцию SysFreeString .

Возвращаемое значение

C++

Если метод выполнен успешно, метод возвращает S_OK.

Если метод завершается сбоем, он возвращает значение HRESULT , указывающее на ошибку. Список распространенных кодов ошибок см. в разделе Общие значения HRESULT.

VB

Возвращаемое значение — это строка, представляющая данные для поля.

Если указать "Flags" в параметре strFieldName , полученные данные для поля flags — это строка, которую можно преобразовать в целое число с помощью функции C-library _wtoi. Результирующее целое число представляет битовое поле, которое можно изучить, чтобы определить, установлены ли флаги CAIF_DSENTRY и CAIF_SHAREDFOLDERENTRY. Если задано CAIF_DSENTRY (0x00000001), сведения о ЦС содержались в службах каталогов. Если задано CAIF_SHAREDFOLDERENTRY (0x00000002), сведения о ЦС содержались в общей папке. Обратите внимание, что может быть установлен один или оба из этих флагов.

Примеры

    BSTR  bstrFieldName = NULL;
    BSTR  bstrFieldValue = NULL;
    HRESULT    hr;

    // Specify the field to retrieve, for example, "CommonName".
    bstrFieldName = SysAllocString(L"<FIELDNAMEHERE>");
    if (NULL == bstrFieldName)
    {
        printf("Memory allocation failed for bstrFieldName.\n");
        goto error;
    }

    // pConfig is a previously instantiated ICertConfig object.
    hr = pConfig->GetField(bstrFieldName, &bstrFieldValue);
    if (FAILED(hr))
    {
        printf("Failed GetField - [%x]\n", hr);
        goto error;
    }
    else
        printf("GetField value for %ws is: %ws\n", 
            bstrFieldName, bstrFieldValue );

error:

    if (bstrFieldName)
        SysFreeString(bstrFieldName);

    if (bstrFieldValue)
        SysFreeString(bstrFieldValue);

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	certcli.h (включая Certsrv.h)
Библиотека	Certidl.lib
DLL	Certcli.dll

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

CCertConfig

ICertConfig

Share via