ホーム › Security.Cryptography › CertEnumCTLsInStore

CertEnumCTLsInStore

関数

証明書ストア内のCTLを順に列挙する。

DLLCRYPT32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

CTL_CONTEXT* CertEnumCTLsInStore(
    HCERTSTORE hCertStore,
    CTL_CONTEXT* pPrevCtlContext   // optional
);

パラメーター

名前	型	方向	説明
hCertStore	HCERTSTORE	in	証明書ストアのハンドル。
pPrevCtlContext	CTL_CONTEXT*	inoptional	直前に見つかった CTL_CONTEXT 構造体へのポインター。ストア内の最初の CTL を取得するには NULL でなければなりません。後続の CTL は、pPrevCtlContext に前回の呼び出しで返されたポインターを設定することで列挙されます。この関数は、このパラメーターの値が非 NULL の場合、参照される CTL_CONTEXT を解放します。列挙では、 CertDeleteCTLFromStore によって以前に削除された CTL はスキップされます。

戻り値の型: CTL_CONTEXT*

公式ドキュメント

CertEnumCTLsInStore 関数は、証明書ストア内の最初または次の証明書信頼リスト (CTL) コンテキストを取得します。ループ内で使用すると、この関数によって証明書ストア内のすべての CTL コンテキストを順番に取得できます。

戻り値

関数が成功した場合、戻り値は読み取り専用の CTL_CONTEXT へのポインターです。

関数が失敗し、CTL が見つからなかった場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

発生し得るエラーコードの一部を次に示します。

戻りコード	説明
CRYPT_E_NOT_FOUND	ストア内に CTL が存在しないか、関数がストアのリストの末尾に到達しました。
E_INVALIDARG	hCertStore パラメーターのハンドルが、pPrevCtlContext パラメーターが指す CTL コンテキスト内のハンドルと一致しません。

解説(Remarks)

返されたポインターは、後続の呼び出しで pPrevCtlContext として渡されると解放されます。それ以外の場合、ポインターは CertFreeCTLContext を呼び出して明示的に解放する必要があります。NULL でない pPrevCtlContext は、エラーの場合であっても、この関数によって (CertFreeCTLContext の呼び出しを通じて) 常に解放されます。

複製は、 CertDuplicateCTLContext を呼び出すことで作成できます。

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

各言語での呼び出し定義

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

CTL_CONTEXT* CertEnumCTLsInStore(
    HCERTSTORE hCertStore,
    CTL_CONTEXT* pPrevCtlContext   // optional
);

[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CertEnumCTLsInStore(
    IntPtr hCertStore,   // HCERTSTORE
    IntPtr pPrevCtlContext   // CTL_CONTEXT* optional
);

<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertEnumCTLsInStore(
    hCertStore As IntPtr,   ' HCERTSTORE
    pPrevCtlContext As IntPtr   ' CTL_CONTEXT* optional
) As IntPtr
End Function

' hCertStore : HCERTSTORE
' pPrevCtlContext : CTL_CONTEXT* optional
Declare PtrSafe Function CertEnumCTLsInStore Lib "crypt32" ( _
    ByVal hCertStore As LongPtr, _
    ByVal pPrevCtlContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CertEnumCTLsInStore = ctypes.windll.crypt32.CertEnumCTLsInStore
CertEnumCTLsInStore.restype = ctypes.c_void_p
CertEnumCTLsInStore.argtypes = [
    wintypes.HANDLE,  # hCertStore : HCERTSTORE
    ctypes.c_void_p,  # pPrevCtlContext : CTL_CONTEXT* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CRYPT32.dll')
CertEnumCTLsInStore = Fiddle::Function.new(
  lib['CertEnumCTLsInStore'],
  [
    Fiddle::TYPE_VOIDP,  # hCertStore : HCERTSTORE
    Fiddle::TYPE_VOIDP,  # pPrevCtlContext : CTL_CONTEXT* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "crypt32")]
extern "system" {
    fn CertEnumCTLsInStore(
        hCertStore: *mut core::ffi::c_void,  // HCERTSTORE
        pPrevCtlContext: *mut CTL_CONTEXT  // CTL_CONTEXT* optional
    ) -> *mut CTL_CONTEXT;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern IntPtr CertEnumCTLsInStore(IntPtr hCertStore, IntPtr pPrevCtlContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertEnumCTLsInStore' -Namespace Win32 -PassThru
# $api::CertEnumCTLsInStore(hCertStore, pPrevCtlContext)

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

出力引数:

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