Win32 API 日本語リファレンス
ホーム › Security.Cryptography › CryptSetProviderA

CryptSetProviderA

関数
指定プロバイダータイプの既定プロバイダーを設定する(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptSetProviderA(
    LPCSTR pszProvName,
    DWORD dwProvType
);

パラメーター

名前型方向説明
pszProvNameLPCSTRin新しい既定の CSP の名前。指定する CSP はコンピューターにインストールされている必要があります。利用可能な暗号化プロバイダーの一覧については、 Cryptographic Provider Names を参照してください。
dwProvTypeDWORDinpszProvName で指定された CSP のプロバイダーの種類。

戻り値の型: BOOL

公式ドキュメント

現在のユーザーの既定の暗号化サービスプロバイダー (CSP) を指定します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外 (TRUE) になります。

関数が失敗した場合、戻り値は 0 (FALSE) になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。発生し得るエラーコードの一部を次の表に示します。

戻り値 説明
ERROR_INVALID_HANDLE
 いずれかのパラメーターが有効でないハンドルを指定しています。
ERROR_INVALID_PARAMETER
 いずれかのパラメーターに有効でない値が含まれています。多くの場合、これは有効でないポインターです。
ERROR_NOT_ENOUGH_MEMORY
 操作中にオペレーティングシステムのメモリが不足しました。

エラーは、内部で呼び出される RegCreateKeyEx および RegSetValueEx から伝播されることもあります。

解説(Remarks)

一般的なアプリケーションでは、 CryptAcquireContext を呼び出す際に CSP 名を指定しません。ただし、アプリケーションが特定の CSP を選択することも可能です。これにより、ユーザーは適切なセキュリティレベルを持つ CSP を自由に選択できます。

CryptSetProvider を呼び出すと、それ以降に実行されるすべてのアプリケーションが使用する、指定された種類の CSP が決定されます。そのため、この関数はユーザーの同意なしに呼び出してはなりません。

メモ

wincrypt.h ヘッダーは CryptSetProvider を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CryptSetProviderA(
    LPCSTR pszProvName,
    DWORD dwProvType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetProviderA(
    [MarshalAs(UnmanagedType.LPStr)] string pszProvName,   // LPCSTR
    uint dwProvType   // DWORD
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetProviderA(
    <MarshalAs(UnmanagedType.LPStr)> pszProvName As String,   ' LPCSTR
    dwProvType As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszProvName : LPCSTR
' dwProvType : DWORD
Declare PtrSafe Function CryptSetProviderA Lib "advapi32" ( _
    ByVal pszProvName As String, _
    ByVal dwProvType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptSetProviderA = ctypes.windll.advapi32.CryptSetProviderA
CryptSetProviderA.restype = wintypes.BOOL
CryptSetProviderA.argtypes = [
    wintypes.LPCSTR,  # pszProvName : LPCSTR
    wintypes.DWORD,  # dwProvType : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CryptSetProviderA = Fiddle::Function.new(
  lib['CryptSetProviderA'],
  [
    Fiddle::TYPE_VOIDP,  # pszProvName : LPCSTR
    -Fiddle::TYPE_INT,  # dwProvType : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn CryptSetProviderA(
        pszProvName: *const u8,  // LPCSTR
        dwProvType: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CryptSetProviderA([MarshalAs(UnmanagedType.LPStr)] string pszProvName, uint dwProvType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSetProviderA' -Namespace Win32 -PassThru
# $api::CryptSetProviderA(pszProvName, dwProvType)
#uselib "ADVAPI32.dll"
#func global CryptSetProviderA "CryptSetProviderA" sptr, sptr
; CryptSetProviderA pszProvName, dwProvType   ; 戻り値は stat
; pszProvName : LPCSTR -> "sptr"
; dwProvType : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderA "CryptSetProviderA" str, int
; res = CryptSetProviderA(pszProvName, dwProvType)
; pszProvName : LPCSTR -> "str"
; dwProvType : DWORD -> "int"
; BOOL CryptSetProviderA(LPCSTR pszProvName, DWORD dwProvType)
#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderA "CryptSetProviderA" str, int
; res = CryptSetProviderA(pszProvName, dwProvType)
; pszProvName : LPCSTR -> "str"
; dwProvType : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCryptSetProviderA = advapi32.NewProc("CryptSetProviderA")
)

// pszProvName (LPCSTR), dwProvType (DWORD)
r1, _, err := procCryptSetProviderA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszProvName))),
	uintptr(dwProvType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptSetProviderA(
  pszProvName: PAnsiChar;   // LPCSTR
  dwProvType: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptSetProviderA';
result := DllCall("ADVAPI32\CryptSetProviderA"
    , "AStr", pszProvName   ; LPCSTR
    , "UInt", dwProvType   ; DWORD
    , "Int")   ; return: BOOL
●CryptSetProviderA(pszProvName, dwProvType) = DLL("ADVAPI32.dll", "bool CryptSetProviderA(char*, dword)")
# 呼び出し: CryptSetProviderA(pszProvName, dwProvType)
# pszProvName : LPCSTR -> "char*"
# dwProvType : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn CryptSetProviderA(
    pszProvName: [*c]const u8, // LPCSTR
    dwProvType: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CryptSetProviderA(
    pszProvName: cstring,  # LPCSTR
    dwProvType: uint32  # DWORD
): int32 {.importc: "CryptSetProviderA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int CryptSetProviderA(
    const(char)* pszProvName,   // LPCSTR
    uint dwProvType   // DWORD
);
ccall((:CryptSetProviderA, "ADVAPI32.dll"), stdcall, Int32,
      (Cstring, UInt32),
      pszProvName, dwProvType)
# pszProvName : LPCSTR -> Cstring
# dwProvType : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptSetProviderA(
    const char* pszProvName,
    uint32_t dwProvType);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptSetProviderA(pszProvName, dwProvType)
-- pszProvName : LPCSTR
-- dwProvType : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CryptSetProviderA = lib.func('__stdcall', 'CryptSetProviderA', 'int32_t', ['str', 'uint32_t']);
// CryptSetProviderA(pszProvName, dwProvType)
// pszProvName : LPCSTR -> 'str'
// dwProvType : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  CryptSetProviderA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.CryptSetProviderA(pszProvName, dwProvType)
// pszProvName : LPCSTR -> "buffer"
// dwProvType : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptSetProviderA(
    const char* pszProvName,
    uint32_t dwProvType);
C, "ADVAPI32.dll");
// $ffi->CryptSetProviderA(pszProvName, dwProvType);
// pszProvName : LPCSTR
// dwProvType : DWORD
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.ASCII_OPTIONS);
    boolean CryptSetProviderA(
        String pszProvName,   // LPCSTR
        int dwProvType   // DWORD
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun CryptSetProviderA = CryptSetProviderA(
    pszProvName : UInt8*,   # LPCSTR
    dwProvType : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CryptSetProviderANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef CryptSetProviderADart = int Function(Pointer<Utf8>, int);
final CryptSetProviderA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CryptSetProviderANative, CryptSetProviderADart>('CryptSetProviderA');
// pszProvName : LPCSTR -> Pointer<Utf8>
// dwProvType : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptSetProviderA(
  pszProvName: PAnsiChar;   // LPCSTR
  dwProvType: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptSetProviderA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CryptSetProviderA"
  c_CryptSetProviderA :: CString -> Word32 -> IO CInt
-- pszProvName : LPCSTR -> CString
-- dwProvType : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cryptsetprovidera =
  foreign "CryptSetProviderA"
    (string @-> uint32_t @-> returning int32_t)
(* pszProvName : LPCSTR -> string *)
(* dwProvType : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("CryptSetProviderA" crypt-set-provider-a :convention :stdcall) :int32
  (psz-prov-name :string)   ; LPCSTR
  (dw-prov-type :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptSetProviderA = Win32::API::More->new('ADVAPI32',
    'BOOL CryptSetProviderA(LPCSTR pszProvName, DWORD dwProvType)');
# my $ret = $CryptSetProviderA->Call($pszProvName, $dwProvType);
# pszProvName : LPCSTR -> LPCSTR
# dwProvType : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目