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

SCardForgetReaderW

関数
登録済みのスマートカードリーダーを削除する。
DLLWinSCard.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT SCardForgetReaderW(
    UINT_PTR hContext,
    LPCWSTR szReaderName
);

パラメーター

名前方向説明
hContextUINT_PTRinリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、事前の SCardEstablishContextの呼び出しによって設定されます。このパラメーターをNULLにすることはできません。
szReaderNameLPCWSTRinスマートカードデータベースから削除するリーダーの表示名。

戻り値の型: INT

公式ドキュメント

以前に登録されたリーダーをスマートカードサブシステムの制御対象から削除します。このリーダーは、追加されている可能性のあるリーダーグループも含め、スマートカードデータベースから削除されます。(Unicode)

戻り値

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

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

解説(Remarks)

指定したリーダーがリーダーグループの最後のメンバーである場合、そのリーダーグループも自動的に削除されます。

SCardForgetReader関数はデータベース管理関数です。その他のデータベース管理関数の詳細については、 Smart Card Database Management Functionsを参照してください。

次の例では、指定したカードリーダーの表示名をシステムから削除します。この例では、lReturn がLONG型の有効な変数であり、hContext が事前のSCardEstablishContext関数の呼び出しから受け取った有効なハンドルであることを前提としています。


lReturn = SCardForgetReader(hContext, 
                            TEXT("MyReader"));
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardForgetReader\n");
メモ

winscard.h ヘッダーは、SCardForgetReader を、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)

各言語での呼び出し定義

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

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

SCardForgetReaderW = ctypes.windll.winscard.SCardForgetReaderW
SCardForgetReaderW.restype = ctypes.c_int
SCardForgetReaderW.argtypes = [
    ctypes.c_size_t,  # hContext : UINT_PTR
    wintypes.LPCWSTR,  # szReaderName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinSCard.dll')
SCardForgetReaderW = Fiddle::Function.new(
  lib['SCardForgetReaderW'],
  [
    Fiddle::TYPE_UINTPTR_T,  # hContext : UINT_PTR
    Fiddle::TYPE_VOIDP,  # szReaderName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winscard")]
extern "system" {
    fn SCardForgetReaderW(
        hContext: usize,  // UINT_PTR
        szReaderName: *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 SCardForgetReaderW(UIntPtr hContext, [MarshalAs(UnmanagedType.LPWStr)] string szReaderName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinSCard_SCardForgetReaderW' -Namespace Win32 -PassThru
# $api::SCardForgetReaderW(hContext, szReaderName)
#uselib "WinSCard.dll"
#func global SCardForgetReaderW "SCardForgetReaderW" wptr, wptr
; SCardForgetReaderW hContext, szReaderName   ; 戻り値は stat
; hContext : UINT_PTR -> "wptr"
; szReaderName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WinSCard.dll"
#cfunc global SCardForgetReaderW "SCardForgetReaderW" sptr, wstr
; res = SCardForgetReaderW(hContext, szReaderName)
; hContext : UINT_PTR -> "sptr"
; szReaderName : LPCWSTR -> "wstr"
; INT SCardForgetReaderW(UINT_PTR hContext, LPCWSTR szReaderName)
#uselib "WinSCard.dll"
#cfunc global SCardForgetReaderW "SCardForgetReaderW" intptr, wstr
; res = SCardForgetReaderW(hContext, szReaderName)
; hContext : UINT_PTR -> "intptr"
; szReaderName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winscard = windows.NewLazySystemDLL("WinSCard.dll")
	procSCardForgetReaderW = winscard.NewProc("SCardForgetReaderW")
)

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

extern "winscard" fn SCardForgetReaderW(
    hContext: usize, // UINT_PTR
    szReaderName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SCardForgetReaderW(
    hContext: uint,  # UINT_PTR
    szReaderName: WideCString  # LPCWSTR
): int32 {.importc: "SCardForgetReaderW", stdcall, dynlib: "WinSCard.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winscard");
extern(Windows)
int SCardForgetReaderW(
    size_t hContext,   // UINT_PTR
    const(wchar)* szReaderName   // LPCWSTR
);
ccall((:SCardForgetReaderW, "WinSCard.dll"), stdcall, Int32,
      (Csize_t, Cwstring),
      hContext, szReaderName)
# hContext : UINT_PTR -> Csize_t
# szReaderName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SCardForgetReaderW(
    uintptr_t hContext,
    const uint16_t* szReaderName);
]]
local winscard = ffi.load("winscard")
-- winscard.SCardForgetReaderW(hContext, szReaderName)
-- hContext : UINT_PTR
-- szReaderName : 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 SCardForgetReaderW = lib.func('__stdcall', 'SCardForgetReaderW', 'int32_t', ['uintptr_t', 'str16']);
// SCardForgetReaderW(hContext, szReaderName)
// hContext : UINT_PTR -> 'uintptr_t'
// szReaderName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WinSCard.dll", {
  SCardForgetReaderW: { parameters: ["usize", "buffer"], result: "i32" },
});
// lib.symbols.SCardForgetReaderW(hContext, szReaderName)
// hContext : UINT_PTR -> "usize"
// szReaderName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SCardForgetReaderW(
    size_t hContext,
    const uint16_t* szReaderName);
C, "WinSCard.dll");
// $ffi->SCardForgetReaderW(hContext, szReaderName);
// hContext : UINT_PTR
// szReaderName : 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 SCardForgetReaderW(
        long hContext,   // UINT_PTR
        WString szReaderName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winscard")]
lib LibWinSCard
  fun SCardForgetReaderW = SCardForgetReaderW(
    hContext : LibC::SizeT,   # UINT_PTR
    szReaderName : 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 SCardForgetReaderWNative = Int32 Function(UintPtr, Pointer<Utf16>);
typedef SCardForgetReaderWDart = int Function(int, Pointer<Utf16>);
final SCardForgetReaderW = DynamicLibrary.open('WinSCard.dll')
    .lookupFunction<SCardForgetReaderWNative, SCardForgetReaderWDart>('SCardForgetReaderW');
// hContext : UINT_PTR -> UintPtr
// szReaderName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SCardForgetReaderW(
  hContext: NativeUInt;   // UINT_PTR
  szReaderName: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'WinSCard.dll' name 'SCardForgetReaderW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let scardforgetreaderw =
  foreign "SCardForgetReaderW"
    (size_t @-> (ptr uint16_t) @-> returning int32_t)
(* hContext : UINT_PTR -> size_t *)
(* szReaderName : 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 ("SCardForgetReaderW" scard-forget-reader-w :convention :stdcall) :int32
  (h-context :uint64)   ; UINT_PTR
  (sz-reader-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SCardForgetReaderW = Win32::API::More->new('WinSCard',
    'int SCardForgetReaderW(WPARAM hContext, LPCWSTR szReaderName)');
# my $ret = $SCardForgetReaderW->Call($hContext, $szReaderName);
# hContext : UINT_PTR -> WPARAM
# szReaderName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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