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

SCardSetCardTypeProviderNameW

関数
指定カード種別のプロバイダー名を設定する。
DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardSetCardTypeProviderNameW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    DWORD dwProviderId,
    LPCWSTR szProvider
);

パラメーター

名前方向説明
hContextUINT_PTRinリソースマネージャーコンテキストを識別するハンドルです。リソースマネージャーコンテキストは、事前の SCardEstablishContext の呼び出しで設定できます。SCardSetCardTypeProviderName の呼び出しが特定のコンテキストに向けられていない場合、この値は NULL にできます。
szCardNameLPCWSTRinこのプロバイダー名が関連付けられているカード種別の名前です。
dwProviderIdDWORDin

このカード種別に関連付けられたプロバイダーの識別子です。

意味
SCARD_PROVIDER_PRIMARY
1
この関数は、スマートカードプライマリサービスプロバイダーの名前を GUID 文字列として取得します。
SCARD_PROVIDER_CSP
2
この関数は、暗号化サービスプロバイダー(CSP)の名前を取得します。
SCARD_PROVIDER_KSP
3
この関数は、スマートカードのキーストレージプロバイダー(KSP)の名前を取得します。
SCARD_PROVIDER_CARD_MODULE
0x80000001
この関数は、カードモジュールの名前を取得します。
szProviderLPCWSTRinCSP を表すプロバイダー名を含む文字列です。

戻り値の型: INT

公式ドキュメント

指定したカード名とプロバイダー種別に対応するプロバイダーを含むモジュール(ダイナミックリンクライブラリ)の名前を指定します。(Unicode)

戻り値

この関数は、成功するか失敗するかに応じて異なる値を返します。

戻り値 説明
成功
SCARD_S_SUCCESS。
失敗
エラーコード。詳細については、 Smart Card Return Values を参照してください。

解説(Remarks)

この関数はリダイレクトされませんが、リモートデスクトップセッション内で呼び出してもエラーにはなりません。その場合は、結果がローカルコンピューターではなくリモートコンピューターから得られることを意味するだけです。

この関数はプロバイダー名を設定します。一方、 SCardGetCardTypeProviderName を使用するとプロバイダー名を取得できます。

次の例は、カード種別のプロバイダー名を指定する方法を示しています。

LPTSTR            szNewProvName = _T("My Provider Name");
LPTSTR            szCardName = _T("WindowsCard");
LONG              lReturn = SCARD_S_SUCCESS;

// Set the card type provider name.
// hContext was set by SCardEstablishContext.
lReturn = SCardSetCardTypeProviderName(hContext,
                                      szCardName,
                                      SCARD_PROVIDER_CSP,
                                      szNewProvName);
if ( SCARD_S_SUCCESS != lReturn )
{
    printf("Failed SCardSetCardTypeProviderName - %x\n", lReturn);
    exit(1);
}
メモ

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

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

各言語での呼び出し定義

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

INT SCardSetCardTypeProviderNameW(
    UINT_PTR hContext,
    LPCWSTR szCardName,
    DWORD dwProviderId,
    LPCWSTR szProvider
);
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SCardSetCardTypeProviderNameW(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string szCardName,   // LPCWSTR
    uint dwProviderId,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string szProvider   // LPCWSTR
);
<DllImport("WinSCard.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SCardSetCardTypeProviderNameW(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> szCardName As String,   ' LPCWSTR
    dwProviderId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szProvider As String   ' LPCWSTR
) As Integer
End Function
' hContext : UINT_PTR
' szCardName : LPCWSTR
' dwProviderId : DWORD
' szProvider : LPCWSTR
Declare PtrSafe Function SCardSetCardTypeProviderNameW Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCardName As LongPtr, _
    ByVal dwProviderId As Long, _
    ByVal szProvider As LongPtr) 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

SCardSetCardTypeProviderNameW = ctypes.windll.winscard.SCardSetCardTypeProviderNameW
SCardSetCardTypeProviderNameW.restype = ctypes.c_int
SCardSetCardTypeProviderNameW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCWSTR,  # szCardName : LPCWSTR
    wintypes.DWORD,  # dwProviderId : DWORD
    wintypes.LPCWSTR,  # szProvider : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardSetCardTypeProviderNameW = Fiddle::Function.new(
  lib['SCardSetCardTypeProviderNameW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szCardName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwProviderId : DWORD
    Fiddle::TYPE_VOIDP,  # szProvider : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winscard")]
extern "system" {
    fn SCardSetCardTypeProviderNameW(
        hContext: usize,  // UINT_PTR
        szCardName: *const u16,  // LPCWSTR
        dwProviderId: u32,  // DWORD
        szProvider: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinSCard.dll", CharSet = CharSet.Unicode)]
public static extern int SCardSetCardTypeProviderNameW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szCardName, uint dwProviderId, [MarshalAs(UnmanagedType.LPWStr)] string szProvider);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardSetCardTypeProviderNameW' -Namespace Win32 -PassThru
# $api::SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
#uselib "WinSCard.dll"
#func global SCardSetCardTypeProviderNameW "SCardSetCardTypeProviderNameW" wptr, wptr, wptr, wptr
; SCardSetCardTypeProviderNameW hContext, szCardName, dwProviderId, szProvider   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szCardName : LPCWSTR -> "wptr"
; dwProviderId : DWORD -> "wptr"
; szProvider : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WinSCard.dll"
#cfunc global SCardSetCardTypeProviderNameW "SCardSetCardTypeProviderNameW" sptr, wstr, int, wstr
; res = SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
; hContext : UINT_PTR -> "sptr"
; szCardName : LPCWSTR -> "wstr"
; dwProviderId : DWORD -> "int"
; szProvider : LPCWSTR -> "wstr"
; INT SCardSetCardTypeProviderNameW(UINT_PTR hContext, LPCWSTR szCardName, DWORD dwProviderId, LPCWSTR szProvider)
#uselib "WinSCard.dll"
#cfunc global SCardSetCardTypeProviderNameW "SCardSetCardTypeProviderNameW" intptr, wstr, int, wstr
; res = SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
; hContext : UINT_PTR -> "intptr"
; szCardName : LPCWSTR -> "wstr"
; dwProviderId : DWORD -> "int"
; szProvider : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardSetCardTypeProviderNameW = winscard.NewProc("SCardSetCardTypeProviderNameW")
)

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

extern "winscard" fn SCardSetCardTypeProviderNameW(
    hContext: usize, // UINT_PTR
    szCardName: [*c]const u16, // LPCWSTR
    dwProviderId: u32, // DWORD
    szProvider: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SCardSetCardTypeProviderNameW(
    hContext: uint,  # UINT_PTR
    szCardName: WideCString,  # LPCWSTR
    dwProviderId: uint32,  # DWORD
    szProvider: WideCString  # LPCWSTR
): int32 {.importc: "SCardSetCardTypeProviderNameW", stdcall, dynlib: "WinSCard.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winscard");
extern(Windows)
int SCardSetCardTypeProviderNameW(
    size_t hContext,   // UINT_PTR
    const(wchar)* szCardName,   // LPCWSTR
    uint dwProviderId,   // DWORD
    const(wchar)* szProvider   // LPCWSTR
);
ccall((:SCardSetCardTypeProviderNameW, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Cwstring, UInt32, Cwstring),
      hContext, szCardName, dwProviderId, szProvider)
# hContext : UINT_PTR -> Csize_t
# szCardName : LPCWSTR -> Cwstring
# dwProviderId : DWORD -> UInt32
# szProvider : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardSetCardTypeProviderNameW(
    uintptr_t hContext,
    const uint16_t* szCardName,
    uint32_t dwProviderId,
    const uint16_t* szProvider);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
-- hContext : UINT_PTR
-- szCardName : LPCWSTR
-- dwProviderId : DWORD
-- szProvider : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WinSCard.dll');
const SCardSetCardTypeProviderNameW = lib.func('__stdcall', 'SCardSetCardTypeProviderNameW', 'int32_t', ['uintptr_t', 'str16', 'uint32_t', 'str16']);
// SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
// hContext : UINT_PTR -> 'uintptr_t'
// szCardName : LPCWSTR -> 'str16'
// dwProviderId : DWORD -> 'uint32_t'
// szProvider : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardSetCardTypeProviderNameW: { parameters: ["usize", "buffer", "u32", "buffer"], result: "i32" },
});
// lib.symbols.SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider)
// hContext : UINT_PTR -> "usize"
// szCardName : LPCWSTR -> "buffer"
// dwProviderId : DWORD -> "u32"
// szProvider : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardSetCardTypeProviderNameW(
    size_t hContext,
    const uint16_t* szCardName,
    uint32_t dwProviderId,
    const uint16_t* szProvider);
C, "WinSCard.dll");
// $ffi->SCardSetCardTypeProviderNameW(hContext, szCardName, dwProviderId, szProvider);
// hContext : UINT_PTR
// szCardName : LPCWSTR
// dwProviderId : DWORD
// szProvider : LPCWSTR
// 構造体/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 Winscard extends StdCallLibrary {
    Winscard INSTANCE = Native.load("winscard", Winscard.class, W32APIOptions.UNICODE_OPTIONS);
    int SCardSetCardTypeProviderNameW(
        long hContext,   // UINT_PTR
        WString szCardName,   // LPCWSTR
        int dwProviderId,   // DWORD
        WString szProvider   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winscard")]
lib LibWinSCard
  fun SCardSetCardTypeProviderNameW = SCardSetCardTypeProviderNameW(
    hContext : LibC::SizeT,   # UINT_PTR
    szCardName : UInt16*,   # LPCWSTR
    dwProviderId : UInt32,   # DWORD
    szProvider : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SCardSetCardTypeProviderNameWNative = Int32 Function(UintPtr, Pointer<Utf16>, Uint32, Pointer<Utf16>);
typedef SCardSetCardTypeProviderNameWDart = int Function(int, Pointer<Utf16>, int, Pointer<Utf16>);
final SCardSetCardTypeProviderNameW = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardSetCardTypeProviderNameWNative, SCardSetCardTypeProviderNameWDart>('SCardSetCardTypeProviderNameW');
// hContext : UINT_PTR -> UintPtr
// szCardName : LPCWSTR -> Pointer<Utf16>
// dwProviderId : DWORD -> Uint32
// szProvider : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardSetCardTypeProviderNameW(
  hContext: NativeUInt;   // UINT_PTR
  szCardName: PWideChar;   // LPCWSTR
  dwProviderId: DWORD;   // DWORD
  szProvider: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardSetCardTypeProviderNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SCardSetCardTypeProviderNameW"
  c_SCardSetCardTypeProviderNameW :: CUIntPtr -> CWString -> Word32 -> CWString -> IO Int32
-- hContext : UINT_PTR -> CUIntPtr
-- szCardName : LPCWSTR -> CWString
-- dwProviderId : DWORD -> Word32
-- szProvider : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let scardsetcardtypeprovidernamew =
  foreign "SCardSetCardTypeProviderNameW"
    (size_t @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* hContext : UINT_PTR -> size_t *)
(* szCardName : LPCWSTR -> (ptr uint16_t) *)
(* dwProviderId : DWORD -> uint32_t *)
(* szProvider : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winscard (t "WinSCard.dll"))
(cffi:use-foreign-library winscard)

(cffi:defcfun ("SCardSetCardTypeProviderNameW" scard-set-card-type-provider-name-w :convention :stdcall) :int32
  (h-context :uint64)   ; UINT_PTR
  (sz-card-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-provider-id :uint32)   ; DWORD
  (sz-provider (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardSetCardTypeProviderNameW = Win32::API::More->new('WinSCard',
    'int SCardSetCardTypeProviderNameW(WPARAM hContext, LPCWSTR szCardName, DWORD dwProviderId, LPCWSTR szProvider)');
# my $ret = $SCardSetCardTypeProviderNameW->Call($hContext, $szCardName, $dwProviderId, $szProvider);
# hContext : UINT_PTR -> WPARAM
# szCardName : LPCWSTR -> LPCWSTR
# dwProviderId : DWORD -> DWORD
# szProvider : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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