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

SCardSetCardTypeProviderNameA

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

シグネチャ

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

INT SCardSetCardTypeProviderNameA(
    UINT_PTR hContext,
    LPCSTR szCardName,
    DWORD dwProviderId,
    LPCSTR szProvider
);

パラメーター

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

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

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

戻り値の型: INT

公式ドキュメント

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

戻り値

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

戻り値 説明
成功
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  (ANSI / -A)
#include <windows.h>

INT SCardSetCardTypeProviderNameA(
    UINT_PTR hContext,
    LPCSTR szCardName,
    DWORD dwProviderId,
    LPCSTR szProvider
);
[DllImport("WinSCard.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int SCardSetCardTypeProviderNameA(
    UIntPtr hContext,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPStr)] string szCardName,   // LPCSTR
    uint dwProviderId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string szProvider   // LPCSTR
);
<DllImport("WinSCard.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SCardSetCardTypeProviderNameA(
    hContext As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPStr)> szCardName As String,   ' LPCSTR
    dwProviderId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> szProvider As String   ' LPCSTR
) As Integer
End Function
' hContext : UINT_PTR
' szCardName : LPCSTR
' dwProviderId : DWORD
' szProvider : LPCSTR
Declare PtrSafe Function SCardSetCardTypeProviderNameA Lib "winscard" ( _
    ByVal hContext As LongPtr, _
    ByVal szCardName As String, _
    ByVal dwProviderId As Long, _
    ByVal szProvider As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardSetCardTypeProviderNameA = winscard.NewProc("SCardSetCardTypeProviderNameA")
)

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

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

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

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

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

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

関連項目

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