ICertConfig::GetField メソッド (certcli.h)

  • [アーティクル]

GetField メソッドは、構成データベースの現在のレコードから特定のフィールドを取得します。 このメソッドは、最初に ICertConfig インターフェイスで定義されました。

構文

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

パラメーター

[in] strFieldName

返すフィールドの名前を指定します。 このパラメーターには、フィールド名に対して次のいずれかの有効な文字列を指定できます (一部の証明機関は、各フィールドのデータを提供しない場合があることに注意してください)。

値 意味
機関
 参照証明機関 (CA) 名。
CommonName
 サーバーの共通名。
構成
 computer\CA 名を参照します。
Country (国)
 国/地域。
説明
 サーバーに関する説明コメント (古い "コメント" を置き換えます)。
ExchangeCertificate
 Exchange 証明書を含むファイルの名前 (Certificate Services 1.0 にのみ適用されます)。
Flags
 CA 情報が見つかった場所を表す文字列。 詳細については、「解説」を参照してください。
局所性
 市区町村。
組織
 組織。
OrgUnit
 組織単位。
SanitizedName
 GetConfig で説明されている規則に従ってサニタイズされる CA 名。
SanitizedShortName
 「GetConfig」で説明されている規則に従ってサニタイズおよび短縮される CA 名。
サーバー
 参照コンピューター名。
ShortName
 SanitizedShortName ですが、 GetConfig で説明されているように、'!xxx' シーケンスを使用して、元のテキストに変換されます。
SignatureCertificate
 CA 証明書 (CA 署名証明書とも呼ばれます) を含むファイルの名前。これは ルート証明書である場合とそうでない場合があります。
State
 州または都道府県。
WebEnrollmentServers
 Active Directory 内の特定の CA 構成の証明書登録 Web サービス URL の配列。

Windows Vista および Windows Storage Server 2003: このフィールドはサポートされていません。

[out, retval] pstrOut

フィールドからデータを受信する BSTR へのポインター。 BSTR の使用が完了したら、SysFreeString 関数を呼び出して pbstrOut を解放します。

戻り値

C++

メソッドが成功した場合、メソッドは S_OKを返します。

メソッドが失敗した場合は、エラーを示す HRESULT 値を返します。 一般的なエラー コードの一覧については、「 共通の HRESULT 値」を参照してください。

VB

戻り値は、フィールドのデータを表す文字列です。

注釈

このメソッドは、指定したフィールドのフィールド データを返します。

strFieldName パラメーターに "Flags" を指定すると、flags フィールドに対して取得されたデータは、C ライブラリ関数_wtoiを使用して整数に変換できる文字列になります。 結果の整数は、フラグがCAIF_DSENTRYおよびCAIF_SHAREDFOLDERENTRYが設定されているかどうかを判断するために調べることができるビットフィールドを表します。 CAIF_DSENTRY (0x00000001) が設定されている場合、CA の情報は Directory Services に含まれていました。 CAIF_SHAREDFOLDERENTRY (0x00000002) が設定されている場合、CA の情報は共有フォルダーに含まれていました。 これらのフラグの一方または両方を設定できます。

例

    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
ヘッダー certcli.h (Certsrv.h を含む)
Library Certidl.lib
[DLL] Certcli.dll

こちらもご覧ください

CCertConfig

ICertConfig