ホーム › Security.Cryptography › CertEnumCTLContextProperties

CertEnumCTLContextProperties

関数

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

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

シグネチャ

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

DWORD CertEnumCTLContextProperties(
    CTL_CONTEXT* pCtlContext,
    DWORD dwPropId
);

パラメーター

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

名前

型

方向

説明

pCtlContext

CTL_CONTEXT*

CTL_CONTEXT 構造体へのポインターです。

dwPropId

DWORD

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

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

戻り値の型: DWORD

公式ドキュメント

CertEnumCTLContextProperties 関数は、証明書信頼リスト (CTL) コンテキストに関連付けられた拡張プロパティのうち、最初または次のものを取得します。この関数をループ内で使用すると、CTL コンテキストに関連付けられたすべての拡張プロパティを順番に取得できます。

戻り値

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

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

各言語での呼び出し定義

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

DWORD CertEnumCTLContextProperties(
    CTL_CONTEXT* pCtlContext,
    DWORD dwPropId
);

[DllImport("CRYPT32.dll", ExactSpelling = true)]
static extern uint CertEnumCTLContextProperties(
    IntPtr pCtlContext,   // CTL_CONTEXT*
    uint dwPropId   // DWORD
);

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

' pCtlContext : CTL_CONTEXT*
' dwPropId : DWORD
Declare PtrSafe Function CertEnumCTLContextProperties Lib "crypt32" ( _
    ByVal pCtlContext 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

CertEnumCTLContextProperties = ctypes.windll.crypt32.CertEnumCTLContextProperties
CertEnumCTLContextProperties.restype = wintypes.DWORD
CertEnumCTLContextProperties.argtypes = [
    ctypes.c_void_p,  # pCtlContext : CTL_CONTEXT*
    wintypes.DWORD,  # dwPropId : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertEnumCTLContextProperties = Fiddle::Function.new(
  lib['CertEnumCTLContextProperties'],
  [
    Fiddle::TYPE_VOIDP,  # pCtlContext : CTL_CONTEXT*
    -Fiddle::TYPE_INT,  # dwPropId : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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