CertSetCTLContextProperty
関数シグネチャ
// CRYPT32.dll
#include <windows.h>
BOOL CertSetCTLContextProperty(
CTL_CONTEXT* pCtlContext,
DWORD dwPropId,
DWORD dwFlags,
const void* pvData // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| pCtlContext | CTL_CONTEXT* | in | CTL_CONTEXT 構造体へのポインターです。 | ||||||||||||||||||||||||||||||||||||
| dwPropId | DWORD | in | 設定するプロパティを指定します。dwPropId の値によって、pvData パラメーターの型と内容が決まります。現在定義されている識別子と、それに関連する pvData の型は次のとおりです。
通常は、CERT_NEXT_UPDATE_LOCATION_PROP_ID プロパティのみが設定されます。 ユーザーは、CERT_FIRST_USER_PROP_ID から CERT_LAST_USER_PROP_ID までの DWORD 値を使用して、追加の dwPropId 型を定義できます。すべてのユーザー定義 dwPropId 型について、pvData はエンコードされた CRYPT_DATA_BLOB 構造体を指します。 | ||||||||||||||||||||||||||||||||||||
| dwFlags | DWORD | in | CERT_KEY_PROV_HANDLE_PROP_ID または CERT_KEY_CONTEXT_PROP_ID の dwPropId プロパティに対しては、CERT_STORE_NO_CRYPT_RELEASE_FLAG を設定できます。 CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG 値が設定されている場合、プロバイダーへの書き込みエラーはすべて無視され、キャッシュされたコンテキストのプロパティは常に設定されます。 CERT_SET_PROPERTY_INHIBIT_PERSIST_FLAG が設定されている場合、設定されたプロパティは永続化されません。 | ||||||||||||||||||||||||||||||||||||
| pvData | void* | inoptional | dwPropId に渡された値によって決まるデータ型へのポインターです。 注意 任意の dwPropId について、pvData を NULL に設定すると、そのプロパティが削除されます。
|
戻り値の型: BOOL
公式ドキュメント
指定された証明書信頼リスト (CTL) コンテキストの拡張プロパティを設定します。
戻り値
関数が成功した場合、戻り値は TRUE です。
関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラー コードの 1 つは次のとおりです。
| 戻り値コード | 説明 |
|---|---|
| プロパティ識別子が無効です。詳細については、 CertSetCertificateContextProperty を参照してください。 |
解説(Remarks)
プロパティが既に存在する場合、その古い値は置き換えられます。
例
Example C Program: Getting and Setting Certificate Properties を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// CRYPT32.dll
#include <windows.h>
BOOL CertSetCTLContextProperty(
CTL_CONTEXT* pCtlContext,
DWORD dwPropId,
DWORD dwFlags,
const void* pvData // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("CRYPT32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CertSetCTLContextProperty(
IntPtr pCtlContext, // CTL_CONTEXT*
uint dwPropId, // DWORD
uint dwFlags, // DWORD
IntPtr pvData // void* optional
);<DllImport("CRYPT32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CertSetCTLContextProperty(
pCtlContext As IntPtr, ' CTL_CONTEXT*
dwPropId As UInteger, ' DWORD
dwFlags As UInteger, ' DWORD
pvData As IntPtr ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pCtlContext : CTL_CONTEXT*
' dwPropId : DWORD
' dwFlags : DWORD
' pvData : void* optional
Declare PtrSafe Function CertSetCTLContextProperty Lib "crypt32" ( _
ByVal pCtlContext As LongPtr, _
ByVal dwPropId As Long, _
ByVal dwFlags As Long, _
ByVal pvData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CertSetCTLContextProperty = ctypes.windll.crypt32.CertSetCTLContextProperty
CertSetCTLContextProperty.restype = wintypes.BOOL
CertSetCTLContextProperty.argtypes = [
ctypes.c_void_p, # pCtlContext : CTL_CONTEXT*
wintypes.DWORD, # dwPropId : DWORD
wintypes.DWORD, # dwFlags : DWORD
ctypes.POINTER(None), # pvData : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('CRYPT32.dll')
CertSetCTLContextProperty = Fiddle::Function.new(
lib['CertSetCTLContextProperty'],
[
Fiddle::TYPE_VOIDP, # pCtlContext : CTL_CONTEXT*
-Fiddle::TYPE_INT, # dwPropId : DWORD
-Fiddle::TYPE_INT, # dwFlags : DWORD
Fiddle::TYPE_VOIDP, # pvData : void* optional
],
Fiddle::TYPE_INT)#[link(name = "crypt32")]
extern "system" {
fn CertSetCTLContextProperty(
pCtlContext: *mut CTL_CONTEXT, // CTL_CONTEXT*
dwPropId: u32, // DWORD
dwFlags: u32, // DWORD
pvData: *const () // void* optional
) -> 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 CertSetCTLContextProperty(IntPtr pCtlContext, uint dwPropId, uint dwFlags, IntPtr pvData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CRYPT32_CertSetCTLContextProperty' -Namespace Win32 -PassThru
# $api::CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData)#uselib "CRYPT32.dll"
#func global CertSetCTLContextProperty "CertSetCTLContextProperty" sptr, sptr, sptr, sptr
; CertSetCTLContextProperty varptr(pCtlContext), dwPropId, dwFlags, pvData ; 戻り値は stat
; pCtlContext : CTL_CONTEXT* -> "sptr"
; dwPropId : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pvData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "CRYPT32.dll" #cfunc global CertSetCTLContextProperty "CertSetCTLContextProperty" var, int, int, sptr ; res = CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData) ; pCtlContext : CTL_CONTEXT* -> "var" ; dwPropId : DWORD -> "int" ; dwFlags : DWORD -> "int" ; pvData : void* optional -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CRYPT32.dll" #cfunc global CertSetCTLContextProperty "CertSetCTLContextProperty" sptr, int, int, sptr ; res = CertSetCTLContextProperty(varptr(pCtlContext), dwPropId, dwFlags, pvData) ; pCtlContext : CTL_CONTEXT* -> "sptr" ; dwPropId : DWORD -> "int" ; dwFlags : DWORD -> "int" ; pvData : void* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL CertSetCTLContextProperty(CTL_CONTEXT* pCtlContext, DWORD dwPropId, DWORD dwFlags, void* pvData) #uselib "CRYPT32.dll" #cfunc global CertSetCTLContextProperty "CertSetCTLContextProperty" var, int, int, intptr ; res = CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData) ; pCtlContext : CTL_CONTEXT* -> "var" ; dwPropId : DWORD -> "int" ; dwFlags : DWORD -> "int" ; pvData : void* optional -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL CertSetCTLContextProperty(CTL_CONTEXT* pCtlContext, DWORD dwPropId, DWORD dwFlags, void* pvData) #uselib "CRYPT32.dll" #cfunc global CertSetCTLContextProperty "CertSetCTLContextProperty" intptr, int, int, intptr ; res = CertSetCTLContextProperty(varptr(pCtlContext), dwPropId, dwFlags, pvData) ; pCtlContext : CTL_CONTEXT* -> "intptr" ; dwPropId : DWORD -> "int" ; dwFlags : DWORD -> "int" ; pvData : void* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
crypt32 = windows.NewLazySystemDLL("CRYPT32.dll")
procCertSetCTLContextProperty = crypt32.NewProc("CertSetCTLContextProperty")
)
// pCtlContext (CTL_CONTEXT*), dwPropId (DWORD), dwFlags (DWORD), pvData (void* optional)
r1, _, err := procCertSetCTLContextProperty.Call(
uintptr(pCtlContext),
uintptr(dwPropId),
uintptr(dwFlags),
uintptr(pvData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction CertSetCTLContextProperty(
pCtlContext: Pointer; // CTL_CONTEXT*
dwPropId: DWORD; // DWORD
dwFlags: DWORD; // DWORD
pvData: Pointer // void* optional
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CertSetCTLContextProperty';result := DllCall("CRYPT32\CertSetCTLContextProperty"
, "Ptr", pCtlContext ; CTL_CONTEXT*
, "UInt", dwPropId ; DWORD
, "UInt", dwFlags ; DWORD
, "Ptr", pvData ; void* optional
, "Int") ; return: BOOL●CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData) = DLL("CRYPT32.dll", "bool CertSetCTLContextProperty(void*, dword, dword, void*)")
# 呼び出し: CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData)
# pCtlContext : CTL_CONTEXT* -> "void*"
# dwPropId : DWORD -> "dword"
# dwFlags : DWORD -> "dword"
# pvData : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "crypt32" fn CertSetCTLContextProperty(
pCtlContext: [*c]CTL_CONTEXT, // CTL_CONTEXT*
dwPropId: u32, // DWORD
dwFlags: u32, // DWORD
pvData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;proc CertSetCTLContextProperty(
pCtlContext: ptr CTL_CONTEXT, # CTL_CONTEXT*
dwPropId: uint32, # DWORD
dwFlags: uint32, # DWORD
pvData: pointer # void* optional
): int32 {.importc: "CertSetCTLContextProperty", stdcall, dynlib: "CRYPT32.dll".}pragma(lib, "crypt32");
extern(Windows)
int CertSetCTLContextProperty(
CTL_CONTEXT* pCtlContext, // CTL_CONTEXT*
uint dwPropId, // DWORD
uint dwFlags, // DWORD
void* pvData // void* optional
);ccall((:CertSetCTLContextProperty, "CRYPT32.dll"), stdcall, Int32,
(Ptr{CTL_CONTEXT}, UInt32, UInt32, Ptr{Cvoid}),
pCtlContext, dwPropId, dwFlags, pvData)
# pCtlContext : CTL_CONTEXT* -> Ptr{CTL_CONTEXT}
# dwPropId : DWORD -> UInt32
# dwFlags : DWORD -> UInt32
# pvData : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CertSetCTLContextProperty(
void* pCtlContext,
uint32_t dwPropId,
uint32_t dwFlags,
void* pvData);
]]
local crypt32 = ffi.load("crypt32")
-- crypt32.CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData)
-- pCtlContext : CTL_CONTEXT*
-- dwPropId : DWORD
-- dwFlags : DWORD
-- pvData : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('CRYPT32.dll');
const CertSetCTLContextProperty = lib.func('__stdcall', 'CertSetCTLContextProperty', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *']);
// CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData)
// pCtlContext : CTL_CONTEXT* -> 'void *'
// dwPropId : DWORD -> 'uint32_t'
// dwFlags : DWORD -> 'uint32_t'
// pvData : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("CRYPT32.dll", {
CertSetCTLContextProperty: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData)
// pCtlContext : CTL_CONTEXT* -> "pointer"
// dwPropId : DWORD -> "u32"
// dwFlags : DWORD -> "u32"
// pvData : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CertSetCTLContextProperty(
void* pCtlContext,
uint32_t dwPropId,
uint32_t dwFlags,
void* pvData);
C, "CRYPT32.dll");
// $ffi->CertSetCTLContextProperty(pCtlContext, dwPropId, dwFlags, pvData);
// pCtlContext : CTL_CONTEXT*
// dwPropId : DWORD
// dwFlags : DWORD
// pvData : void* optional
// 構造体/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 CertSetCTLContextProperty(
Pointer pCtlContext, // CTL_CONTEXT*
int dwPropId, // DWORD
int dwFlags, // DWORD
Pointer pvData // void* optional
);
}@[Link("crypt32")]
lib LibCRYPT32
fun CertSetCTLContextProperty = CertSetCTLContextProperty(
pCtlContext : CTL_CONTEXT*, # CTL_CONTEXT*
dwPropId : UInt32, # DWORD
dwFlags : UInt32, # DWORD
pvData : Void* # void* optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef CertSetCTLContextPropertyNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef CertSetCTLContextPropertyDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final CertSetCTLContextProperty = DynamicLibrary.open('CRYPT32.dll')
.lookupFunction<CertSetCTLContextPropertyNative, CertSetCTLContextPropertyDart>('CertSetCTLContextProperty');
// pCtlContext : CTL_CONTEXT* -> Pointer<Void>
// dwPropId : DWORD -> Uint32
// dwFlags : DWORD -> Uint32
// pvData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CertSetCTLContextProperty(
pCtlContext: Pointer; // CTL_CONTEXT*
dwPropId: DWORD; // DWORD
dwFlags: DWORD; // DWORD
pvData: Pointer // void* optional
): BOOL; stdcall;
external 'CRYPT32.dll' name 'CertSetCTLContextProperty';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CertSetCTLContextProperty"
c_CertSetCTLContextProperty :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- pCtlContext : CTL_CONTEXT* -> Ptr ()
-- dwPropId : DWORD -> Word32
-- dwFlags : DWORD -> Word32
-- pvData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let certsetctlcontextproperty =
foreign "CertSetCTLContextProperty"
((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* pCtlContext : CTL_CONTEXT* -> (ptr void) *)
(* dwPropId : DWORD -> uint32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* pvData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library crypt32 (t "CRYPT32.dll"))
(cffi:use-foreign-library crypt32)
(cffi:defcfun ("CertSetCTLContextProperty" cert-set-ctlcontext-property :convention :stdcall) :int32
(p-ctl-context :pointer) ; CTL_CONTEXT*
(dw-prop-id :uint32) ; DWORD
(dw-flags :uint32) ; DWORD
(pv-data :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CertSetCTLContextProperty = Win32::API::More->new('CRYPT32',
'BOOL CertSetCTLContextProperty(LPVOID pCtlContext, DWORD dwPropId, DWORD dwFlags, LPVOID pvData)');
# my $ret = $CertSetCTLContextProperty->Call($pCtlContext, $dwPropId, $dwFlags, $pvData);
# pCtlContext : CTL_CONTEXT* -> LPVOID
# dwPropId : DWORD -> DWORD
# dwFlags : DWORD -> DWORD
# pvData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CertGetCTLContextProperty — CTLコンテキストの指定プロパティを取得する。
- f CertSetCertificateContextProperty — 証明書コンテキストの指定プロパティを設定する。
- f CryptEncodeObject — 暗号構造体を指定したエンコード形式に符号化する。