ホーム › Security.Cryptography › CertEnumCertificateContextProperties

CertEnumCertificateContextProperties

関数

証明書コンテキストのプロパティを順に列挙する。

DLLCRYPT32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// CRYPT32.dll
#include <windows.h>

DWORD CertEnumCertificateContextProperties(
    const CERT_CONTEXT* pCertContext,
    DWORD dwPropId
);

パラメーター

名前	型	方向	説明
pCertContext	CERT_CONTEXT*	in	列挙対象のプロパティを含む証明書の CERT_CONTEXT 構造体へのポインターです。
dwPropId	DWORD	in	最後に列挙されたプロパティのプロパティ番号です。最初のプロパティを取得するには、dwPropId を 0 にします。後続のプロパティを取得するには、dwPropId に、直前の関数呼び出しで返されたプロパティ番号を設定します。すべてのプロパティを列挙するには、関数が 0 を返すまで関数呼び出しを続けます。アプリケーションは、この関数が返した dwPropId を指定して CertGetCertificateContextProperty を呼び出すことで、そのプロパティのデータを取得できます。

名前

型

方向

説明

pCertContext

CERT_CONTEXT*

列挙対象のプロパティを含む証明書の CERT_CONTEXT 構造体へのポインターです。

dwPropId

DWORD

最後に列挙されたプロパティのプロパティ番号です。最初のプロパティを取得するには、dwPropId を 0 にします。後続のプロパティを取得するには、dwPropId に、直前の関数呼び出しで返されたプロパティ番号を設定します。すべてのプロパティを列挙するには、関数が 0 を返すまで関数呼び出しを続けます。

アプリケーションは、この関数が返した dwPropId を指定して CertGetCertificateContextProperty を呼び出すことで、そのプロパティのデータを取得できます。

戻り値の型: DWORD

公式ドキュメント

CertEnumCertificateContextProperties 関数は、証明書コンテキストに関連付けられた最初または次の拡張プロパティを取得します。

戻り値

戻り値は、証明書コンテキストのプロパティを識別する DWORD 値です。ある呼び出しで返された DWORD 値は、後続の呼び出しで dwPropId として指定できます。列挙すべきプロパティがそれ以上ない場合、または関数が失敗した場合は、0 が返されます。

解説(Remarks)

CERT_KEY_PROV_HANDLE_PROP_ID および CERT_KEY_SPEC_PROP_ID の各プロパティは、CERT_KEY_CONTEXT_PROP_ID プロパティのメンバーとして格納されます。これらは個別には列挙されません。

例

サンプル C プログラム: ストア内の証明書を一覧表示するを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// CRYPT32.dll
#include <windows.h>

DWORD CertEnumCertificateContextProperties(
    const CERT_CONTEXT* pCertContext,
    DWORD dwPropId
);

[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern uint CertEnumCertificateContextProperties(
    IntPtr pCertContext,   // CERT_CONTEXT*
    uint dwPropId   // DWORD
);

<DllImport("CRYPT32.dll", ExactSpelling:=True)>
Public Shared Function CertEnumCertificateContextProperties(
    pCertContext As IntPtr,   ' CERT_CONTEXT*
    dwPropId As UInteger   ' DWORD
) As UInteger
End Function

' pCertContext : CERT_CONTEXT*
' dwPropId : DWORD
Declare PtrSafe Function CertEnumCertificateContextProperties Lib "crypt32" ( _
    ByVal pCertContext As LongPtr, _
    ByVal dwPropId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertEnumCertificateContextProperties = ctypes.windll.crypt32.CertEnumCertificateContextProperties
CertEnumCertificateContextProperties.restype = wintypes.DWORD
CertEnumCertificateContextProperties.argtypes = [
    ctypes.c_void_p,  # pCertContext : CERT_CONTEXT*
    wintypes.DWORD,  # dwPropId : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertEnumCertificateContextProperties = Fiddle::Function.new(
  lib['CertEnumCertificateContextProperties'],
  [
    Fiddle::TYPE_VOIDP,  # pCertContext : CERT_CONTEXT*
    -Fiddle::TYPE_INT,  # dwPropId : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "crypt32")]
extern "system" {
    fn CertEnumCertificateContextProperties(
        pCertContext: *const CERT_CONTEXT,  // CERT_CONTEXT*
        dwPropId: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll")]
public static extern uint CertEnumCertificateContextProperties(IntPtr pCertContext, uint dwPropId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertEnumCertificateContextProperties' -Namespace Win32 -PassThru
# $api::CertEnumCertificateContextProperties(pCertContext, dwPropId)

#uselib "CRYPT32.dll"
#func global CertEnumCertificateContextProperties "CertEnumCertificateContextProperties" sptr, sptr
; CertEnumCertificateContextProperties varptr(pCertContext), dwPropId   ; 戻り値は stat
; pCertContext : CERT_CONTEXT* -> "sptr"
; dwPropId : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CRYPT32.dll"
#cfunc global CertEnumCertificateContextProperties "CertEnumCertificateContextProperties" var, int
; res = CertEnumCertificateContextProperties(pCertContext, dwPropId)
; pCertContext : CERT_CONTEXT* -> "var"
; dwPropId : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll"
#cfunc global CertEnumCertificateContextProperties "CertEnumCertificateContextProperties" sptr, int
; res = CertEnumCertificateContextProperties(varptr(pCertContext), dwPropId)
; pCertContext : CERT_CONTEXT* -> "sptr"
; dwPropId : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。