CertGetCTLContextProperty
関数シグネチャ
// CRYPT32.dll
#include <windows.h>
BOOL CertGetCTLContextProperty(
CTL_CONTEXT* pCtlContext,
DWORD dwPropId,
void* pvData, // optional
DWORD* pcbData
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| pCtlContext | CTL_CONTEXT* | in | CTL_CONTEXT 構造体へのポインターです。 | ||||||||||||||||||||||||||||||||||||||
| dwPropId | DWORD | in | 取得するプロパティを識別します。現在定義されている識別子と、pvData で返されるデータ型を次の表に示します。
その他すべてのプロパティ識別子では、pvData は CertSetCertificateContextProperty の pvData パラメーターが指すような CRYPT_DATA_BLOB ではなく、バイト配列を指します。 各プロパティ識別子の詳細については、CertSetCertificateContextProperty の dwPropId パラメーターに関するドキュメントを参照してください。最も関心が高い定義済みプロパティは CERT_SHA1_HASH_PROP_ID と CERT_NEXT_UPDATE_LOCATION_PROP_ID です。 | ||||||||||||||||||||||||||||||||||||||
| pvData | void* | outoptional | dwPropId で決まるデータを受け取るバッファーへのポインターです。返される構造体のメンバーが指す構造体も、ベース構造体に続いて返されます。そのため、pcbData に格納されるサイズは、ベース構造体のサイズを超えることがよくあります。 このパラメーターを NULL にすると、メモリ割り当てを目的として情報のサイズを取得できます。詳細については、 Retrieving Data of Unknown Length を参照してください。 | ||||||||||||||||||||||||||||||||||||||
| pcbData | DWORD* | inout | pvData パラメーターが指すバッファーのサイズ (バイト単位) を指定する DWORD 値へのポインターです。関数が戻るとき、この DWORD 値にはバッファーに格納されるバイト数が入ります。 注意 バッファーに返されたデータを処理する際、アプリケーションは返されたデータの実際のサイズを使用する必要があります。実際のサイズは、入力時に指定したバッファーのサイズよりわずかに小さい場合があります。(入力時には、想定される最大の出力データがバッファーに収まるよう、通常は十分に大きいバッファー サイズを指定します。) 出力時には、このパラメーターが指す変数が、バッファーにコピーされたデータの実際のサイズを反映するように更新されます。
|
戻り値の型: BOOL
公式ドキュメント
証明書信頼リスト (CTL) コンテキストの拡張プロパティを取得します。
戻り値
関数が成功した場合、戻り値は TRUE です。
関数が失敗した場合、戻り値は FALSE です。
呼び出される関数 CryptHashCertificate からのエラーが、この関数に伝播されることがあります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
発生し得るエラー コードの一部を次に示します。
| 戻りコード | 説明 |
|---|---|
| CTL に指定されたプロパティがありません。 | |
| pvData パラメーターで指定されたバッファーが返されるデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATA コードを設定し、必要なバッファー サイズ (バイト単位) を pcbData が指す変数に格納します。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CRYPT32.dll
#include <windows.h>
BOOL CertGetCTLContextProperty(
CTL_CONTEXT* pCtlContext,
DWORD dwPropId,
void* pvData, // optional
DWORD* pcbData
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertGetCTLContextProperty(
IntPtr pCtlContext, // CTL_CONTEXT*
uint dwPropId, // DWORD
IntPtr pvData, // void* optional, out
ref uint pcbData // DWORD* in/out
);<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertGetCTLContextProperty(
pCtlContext As IntPtr, ' CTL_CONTEXT*
dwPropId As UInteger, ' DWORD
pvData As IntPtr, ' void* optional, out
ByRef pcbData As UInteger ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pCtlContext : CTL_CONTEXT*
' dwPropId : DWORD
' pvData : void* optional, out
' pcbData : DWORD* in/out
Declare PtrSafe Function CertGetCTLContextProperty Lib "crypt32" ( _
ByVal pCtlContext As LongPtr, _
ByVal dwPropId As Long, _
ByVal pvData As LongPtr, _
ByRef pcbData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CertGetCTLContextProperty = ctypes.windll.crypt32.CertGetCTLContextProperty
CertGetCTLContextProperty.restype = wintypes.BOOL
CertGetCTLContextProperty.argtypes = [
ctypes.c_void_p, # pCtlContext : CTL_CONTEXT*
wintypes.DWORD, # dwPropId : DWORD
ctypes.POINTER(None), # pvData : void* optional, out
ctypes.POINTER(wintypes.DWORD), # pcbData : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CRYPT32.dll')
CertGetCTLContextProperty = Fiddle::Function.new(
lib['CertGetCTLContextProperty'],
[
Fiddle::TYPE_VOIDP, # pCtlContext : CTL_CONTEXT*
-Fiddle::TYPE_INT, # dwPropId : DWORD
Fiddle::TYPE_VOIDP, # pvData : void* optional, out
Fiddle::TYPE_VOIDP, # pcbData : DWORD* in/out
],
Fiddle::TYPE_INT)#[link(name = "crypt32")]
extern "system" {
fn CertGetCTLContextProperty(
pCtlContext: *mut CTL_CONTEXT, // CTL_CONTEXT*
dwPropId: u32, // DWORD
pvData: *mut (), // void* optional, out
pcbData: *mut u32 // DWORD* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true)]
public static extern bool CertGetCTLContextProperty(IntPtr pCtlContext, uint dwPropId, IntPtr pvData, ref uint pcbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertGetCTLContextProperty' -Namespace Win32 -PassThru
# $api::CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData)#uselib "CRYPT32.dll"
#func global CertGetCTLContextProperty "CertGetCTLContextProperty" sptr, sptr, sptr, sptr
; CertGetCTLContextProperty varptr(pCtlContext), dwPropId, pvData, varptr(pcbData) ; 戻り値は stat
; pCtlContext : CTL_CONTEXT* -> "sptr"
; dwPropId : DWORD -> "sptr"
; pvData : void* optional, out -> "sptr"
; pcbData : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "CRYPT32.dll" #cfunc global CertGetCTLContextProperty "CertGetCTLContextProperty" var, int, sptr, var ; res = CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData) ; pCtlContext : CTL_CONTEXT* -> "var" ; dwPropId : DWORD -> "int" ; pvData : void* optional, out -> "sptr" ; pcbData : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll" #cfunc global CertGetCTLContextProperty "CertGetCTLContextProperty" sptr, int, sptr, sptr ; res = CertGetCTLContextProperty(varptr(pCtlContext), dwPropId, pvData, varptr(pcbData)) ; pCtlContext : CTL_CONTEXT* -> "sptr" ; dwPropId : DWORD -> "int" ; pvData : void* optional, out -> "sptr" ; pcbData : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL CertGetCTLContextProperty(CTL_CONTEXT* pCtlContext, DWORD dwPropId, void* pvData, DWORD* pcbData) #uselib "CRYPT32.dll" #cfunc global CertGetCTLContextProperty "CertGetCTLContextProperty" var, int, intptr, var ; res = CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData) ; pCtlContext : CTL_CONTEXT* -> "var" ; dwPropId : DWORD -> "int" ; pvData : void* optional, out -> "intptr" ; pcbData : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CertGetCTLContextProperty(CTL_CONTEXT* pCtlContext, DWORD dwPropId, void* pvData, DWORD* pcbData) #uselib "CRYPT32.dll" #cfunc global CertGetCTLContextProperty "CertGetCTLContextProperty" intptr, int, intptr, intptr ; res = CertGetCTLContextProperty(varptr(pCtlContext), dwPropId, pvData, varptr(pcbData)) ; pCtlContext : CTL_CONTEXT* -> "intptr" ; dwPropId : DWORD -> "int" ; pvData : void* optional, out -> "intptr" ; pcbData : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
procCertGetCTLContextProperty = crypt32.NewProc("CertGetCTLContextProperty")
)
// pCtlContext (CTL_CONTEXT*), dwPropId (DWORD), pvData (void* optional, out), pcbData (DWORD* in/out)
r1, _, err := procCertGetCTLContextProperty.Call(
uintptr(pCtlContext),
uintptr(dwPropId),
uintptr(pvData),
uintptr(pcbData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CertGetCTLContextProperty(
pCtlContext: Pointer; // CTL_CONTEXT*
dwPropId: DWORD; // DWORD
pvData: Pointer; // void* optional, out
pcbData: Pointer // DWORD* in/out
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CertGetCTLContextProperty';result := DllCall("CRYPT32\CertGetCTLContextProperty"
, "Ptr", pCtlContext ; CTL_CONTEXT*
, "UInt", dwPropId ; DWORD
, "Ptr", pvData ; void* optional, out
, "Ptr", pcbData ; DWORD* in/out
, "Int") ; return: BOOL●CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData) = DLL("CRYPT32.dll", "bool CertGetCTLContextProperty(void*, dword, void*, void*)")
# 呼び出し: CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData)
# pCtlContext : CTL_CONTEXT* -> "void*"
# dwPropId : DWORD -> "dword"
# pvData : void* optional, out -> "void*"
# pcbData : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "crypt32" fn CertGetCTLContextProperty(
pCtlContext: [*c]CTL_CONTEXT, // CTL_CONTEXT*
dwPropId: u32, // DWORD
pvData: ?*anyopaque, // void* optional, out
pcbData: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;proc CertGetCTLContextProperty(
pCtlContext: ptr CTL_CONTEXT, # CTL_CONTEXT*
dwPropId: uint32, # DWORD
pvData: pointer, # void* optional, out
pcbData: ptr uint32 # DWORD* in/out
): int32 {.importc: "CertGetCTLContextProperty", stdcall, dynlib: "CRYPT32.dll".}pragma(lib, "crypt32");
extern(Windows)
int CertGetCTLContextProperty(
CTL_CONTEXT* pCtlContext, // CTL_CONTEXT*
uint dwPropId, // DWORD
void* pvData, // void* optional, out
uint* pcbData // DWORD* in/out
);ccall((:CertGetCTLContextProperty, "CRYPT32.dll"), stdcall, Int32,
(Ptr{CTL_CONTEXT}, UInt32, Ptr{Cvoid}, Ptr{UInt32}),
pCtlContext, dwPropId, pvData, pcbData)
# pCtlContext : CTL_CONTEXT* -> Ptr{CTL_CONTEXT}
# dwPropId : DWORD -> UInt32
# pvData : void* optional, out -> Ptr{Cvoid}
# pcbData : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CertGetCTLContextProperty(
void* pCtlContext,
uint32_t dwPropId,
void* pvData,
uint32_t* pcbData);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData)
-- pCtlContext : CTL_CONTEXT*
-- dwPropId : DWORD
-- pvData : void* optional, out
-- pcbData : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CertGetCTLContextProperty = lib.func('__stdcall', 'CertGetCTLContextProperty', 'int32_t', ['void *', 'uint32_t', 'void *', 'uint32_t *']);
// CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData)
// pCtlContext : CTL_CONTEXT* -> 'void *'
// dwPropId : DWORD -> 'uint32_t'
// pvData : void* optional, out -> 'void *'
// pcbData : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CRYPT32.dll", {
CertGetCTLContextProperty: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData)
// pCtlContext : CTL_CONTEXT* -> "pointer"
// dwPropId : DWORD -> "u32"
// pvData : void* optional, out -> "pointer"
// pcbData : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CertGetCTLContextProperty(
void* pCtlContext,
uint32_t dwPropId,
void* pvData,
uint32_t* pcbData);
C, "CRYPT32.dll");
// $ffi->CertGetCTLContextProperty(pCtlContext, dwPropId, pvData, pcbData);
// pCtlContext : CTL_CONTEXT*
// dwPropId : DWORD
// pvData : void* optional, out
// pcbData : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Crypt32 extends StdCallLibrary {
Crypt32 INSTANCE = Native.load("crypt32", Crypt32.class);
boolean CertGetCTLContextProperty(
Pointer pCtlContext, // CTL_CONTEXT*
int dwPropId, // DWORD
Pointer pvData, // void* optional, out
IntByReference pcbData // DWORD* in/out
);
}@[Link("crypt32")]
lib LibCRYPT32
fun CertGetCTLContextProperty = CertGetCTLContextProperty(
pCtlContext : CTL_CONTEXT*, # CTL_CONTEXT*
dwPropId : UInt32, # DWORD
pvData : Void*, # void* optional, out
pcbData : UInt32* # DWORD* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CertGetCTLContextPropertyNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef CertGetCTLContextPropertyDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final CertGetCTLContextProperty = DynamicLibrary.open('CRYPT32.dll')
.lookupFunction<CertGetCTLContextPropertyNative, CertGetCTLContextPropertyDart>('CertGetCTLContextProperty');
// pCtlContext : CTL_CONTEXT* -> Pointer<Void>
// dwPropId : DWORD -> Uint32
// pvData : void* optional, out -> Pointer<Void>
// pcbData : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CertGetCTLContextProperty(
pCtlContext: Pointer; // CTL_CONTEXT*
dwPropId: DWORD; // DWORD
pvData: Pointer; // void* optional, out
pcbData: Pointer // DWORD* in/out
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CertGetCTLContextProperty';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CertGetCTLContextProperty"
c_CertGetCTLContextProperty :: Ptr () -> Word32 -> Ptr () -> Ptr Word32 -> IO CInt
-- pCtlContext : CTL_CONTEXT* -> Ptr ()
-- dwPropId : DWORD -> Word32
-- pvData : void* optional, out -> Ptr ()
-- pcbData : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let certgetctlcontextproperty =
foreign "CertGetCTLContextProperty"
((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* pCtlContext : CTL_CONTEXT* -> (ptr void) *)
(* dwPropId : DWORD -> uint32_t *)
(* pvData : void* optional, out -> (ptr void) *)
(* pcbData : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)
(cffi:defcfun ("CertGetCTLContextProperty" cert-get-ctlcontext-property :convention :stdcall) :int32
(p-ctl-context :pointer) ; CTL_CONTEXT*
(dw-prop-id :uint32) ; DWORD
(pv-data :pointer) ; void* optional, out
(pcb-data :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CertGetCTLContextProperty = Win32::API::More->new('CRYPT32',
'BOOL CertGetCTLContextProperty(LPVOID pCtlContext, DWORD dwPropId, LPVOID pvData, LPVOID pcbData)');
# my $ret = $CertGetCTLContextProperty->Call($pCtlContext, $dwPropId, $pvData, $pcbData);
# pCtlContext : CTL_CONTEXT* -> LPVOID
# dwPropId : DWORD -> DWORD
# pvData : void* optional, out -> LPVOID
# pcbData : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CertEnumCTLContextProperties — CTLコンテキストのプロパティを順に列挙する。
- f CertGetCertificateContextProperty — 証明書コンテキストの指定プロパティを取得する。
- f CertSetCTLContextProperty — CTLコンテキストの指定プロパティを設定する。
- f CryptHashCertificate — 指定アルゴリズムでエンコード済み証明書のハッシュを計算する。