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

CryptSetProviderW

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CryptSetProviderW(
    LPCWSTR pszProvName,
    DWORD dwProvType
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

BOOL CryptSetProviderW(
    LPCWSTR pszProvName,
    DWORD dwProvType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CryptSetProviderW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszProvName,   // LPCWSTR
    uint dwProvType   // DWORD
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CryptSetProviderW(
    <MarshalAs(UnmanagedType.LPWStr)> pszProvName As String,   ' LPCWSTR
    dwProvType As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszProvName : LPCWSTR
' dwProvType : DWORD
Declare PtrSafe Function CryptSetProviderW Lib "advapi32" ( _
    ByVal pszProvName As LongPtr, _
    ByVal dwProvType As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CryptSetProviderW = ctypes.windll.advapi32.CryptSetProviderW
CryptSetProviderW.restype = wintypes.BOOL
CryptSetProviderW.argtypes = [
    wintypes.LPCWSTR,  # pszProvName : LPCWSTR
    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')
CryptSetProviderW = Fiddle::Function.new(
  lib['CryptSetProviderW'],
  [
    Fiddle::TYPE_VOIDP,  # pszProvName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwProvType : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn CryptSetProviderW(
        pszProvName: *const u16,  // LPCWSTR
        dwProvType: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CryptSetProviderW([MarshalAs(UnmanagedType.LPWStr)] string pszProvName, uint dwProvType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CryptSetProviderW' -Namespace Win32 -PassThru
# $api::CryptSetProviderW(pszProvName, dwProvType)
#uselib "ADVAPI32.dll"
#func global CryptSetProviderW "CryptSetProviderW" wptr, wptr
; CryptSetProviderW pszProvName, dwProvType   ; 戻り値は stat
; pszProvName : LPCWSTR -> "wptr"
; dwProvType : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderW "CryptSetProviderW" wstr, int
; res = CryptSetProviderW(pszProvName, dwProvType)
; pszProvName : LPCWSTR -> "wstr"
; dwProvType : DWORD -> "int"
; BOOL CryptSetProviderW(LPCWSTR pszProvName, DWORD dwProvType)
#uselib "ADVAPI32.dll"
#cfunc global CryptSetProviderW "CryptSetProviderW" wstr, int
; res = CryptSetProviderW(pszProvName, dwProvType)
; pszProvName : LPCWSTR -> "wstr"
; dwProvType : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCryptSetProviderW = advapi32.NewProc("CryptSetProviderW")
)

// pszProvName (LPCWSTR), dwProvType (DWORD)
r1, _, err := procCryptSetProviderW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszProvName))),
	uintptr(dwProvType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CryptSetProviderW(
  pszProvName: PWideChar;   // LPCWSTR
  dwProvType: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptSetProviderW';
result := DllCall("ADVAPI32\CryptSetProviderW"
    , "WStr", pszProvName   ; LPCWSTR
    , "UInt", dwProvType   ; DWORD
    , "Int")   ; return: BOOL
●CryptSetProviderW(pszProvName, dwProvType) = DLL("ADVAPI32.dll", "bool CryptSetProviderW(char*, dword)")
# 呼び出し: CryptSetProviderW(pszProvName, dwProvType)
# pszProvName : LPCWSTR -> "char*"
# dwProvType : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn CryptSetProviderW(
    pszProvName: [*c]const u16, // LPCWSTR
    dwProvType: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CryptSetProviderW(
    pszProvName: WideCString,  # LPCWSTR
    dwProvType: uint32  # DWORD
): int32 {.importc: "CryptSetProviderW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int CryptSetProviderW(
    const(wchar)* pszProvName,   // LPCWSTR
    uint dwProvType   // DWORD
);
ccall((:CryptSetProviderW, "ADVAPI32.dll"), stdcall, Int32,
      (Cwstring, UInt32),
      pszProvName, dwProvType)
# pszProvName : LPCWSTR -> Cwstring
# dwProvType : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t CryptSetProviderW(
    const uint16_t* pszProvName,
    uint32_t dwProvType);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CryptSetProviderW(pszProvName, dwProvType)
-- pszProvName : LPCWSTR
-- dwProvType : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CryptSetProviderW = lib.func('__stdcall', 'CryptSetProviderW', 'int32_t', ['str16', 'uint32_t']);
// CryptSetProviderW(pszProvName, dwProvType)
// pszProvName : LPCWSTR -> 'str16'
// dwProvType : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  CryptSetProviderW: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.CryptSetProviderW(pszProvName, dwProvType)
// pszProvName : LPCWSTR -> "buffer"
// dwProvType : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CryptSetProviderW(
    const uint16_t* pszProvName,
    uint32_t dwProvType);
C, "ADVAPI32.dll");
// $ffi->CryptSetProviderW(pszProvName, dwProvType);
// pszProvName : LPCWSTR
// 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.UNICODE_OPTIONS);
    boolean CryptSetProviderW(
        WString pszProvName,   // LPCWSTR
        int dwProvType   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun CryptSetProviderW = CryptSetProviderW(
    pszProvName : UInt16*,   # LPCWSTR
    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 CryptSetProviderWNative = Int32 Function(Pointer<Utf16>, Uint32);
typedef CryptSetProviderWDart = int Function(Pointer<Utf16>, int);
final CryptSetProviderW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CryptSetProviderWNative, CryptSetProviderWDart>('CryptSetProviderW');
// pszProvName : LPCWSTR -> Pointer<Utf16>
// dwProvType : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CryptSetProviderW(
  pszProvName: PWideChar;   // LPCWSTR
  dwProvType: DWORD   // DWORD
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CryptSetProviderW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let cryptsetproviderw =
  foreign "CryptSetProviderW"
    ((ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pszProvName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("CryptSetProviderW" crypt-set-provider-w :convention :stdcall) :int32
  (psz-prov-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-prov-type :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CryptSetProviderW = Win32::API::More->new('ADVAPI32',
    'BOOL CryptSetProviderW(LPCWSTR pszProvName, DWORD dwProvType)');
# my $ret = $CryptSetProviderW->Call($pszProvName, $dwProvType);
# pszProvName : LPCWSTR -> LPCWSTR
# dwProvType : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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