SCardForgetReaderGroupA 関数 (winscard.h)

  • [アーティクル]

SCardForgetReaderGroup 関数は、以前に導入されたスマート カードreader グループをスマート カード サブシステムから削除します。 この関数はグループのすべてのリーダーを自動的にクリアしますが、データベース内の個々の リーダー の存在には影響しません。

構文

LONG SCardForgetReaderGroupA(
  [in] SCARDCONTEXT hContext,
  [in] LPCSTR       szGroupName
);

パラメーター

[in] hContext

リソース マネージャー コンテキストを識別するハンドル。 リソース マネージャー コンテキストは、 SCardEstablishContext の以前の呼び出しによって設定されます。 このパラメーターを NULL にすることはできません。

[in] szGroupName

削除するリーダー グループの表示名。 システム定義リーダー グループをデータベースから削除することはできません。

値 意味
SCARD_ALL_READERS
TEXT("SCard$AllReaders\000")
 リーダーを一覧表示するときにグループ名が指定されていない場合に使用されるグループ。 リーダーがどのグループに含まれているかに関係なく、すべてのリーダーの一覧を返します。
SCARD_DEFAULT_READERS
TEXT("SCard$DefaultReaders\000")
 システムに導入されたときにすべてのリーダーが追加される既定のグループ。
SCARD_LOCAL_READERS
TEXT("SCard$LocalReaders\000")
 未使用のレガシ値。 これは、リーダー グループ API を使用して変更できない内部管理グループです。 列挙にのみ使用することを目的としています。
SCARD_SYSTEM_READERS
TEXT("SCard$SystemReaders\000")
 未使用のレガシ値。 これは、リーダー グループ API を使用して変更できない内部管理グループです。 列挙にのみ使用することを目的としています。

戻り値

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

リターン コード 説明
Success
 SCARD_S_SUCCESS。
障害
 エラー コード。 詳細については、「 スマート カードの戻り値」を参照してください。

注釈

SCardForgetReaderGroup 関数はデータベース管理機能です。 その他のデータベース管理機能の詳細については、「 スマート カード データベース管理機能」を参照してください。

例

次の例は、システムからリーダー グループを削除する方法を示しています。 この例では、lReturn が LONG 型の既存の変数であり、hContext が SCardEstablishContext 関数の呼び出しから以前に取得したリソース マネージャー コンテキストへの有効なハンドルであることを前提としています。


lReturn = SCardForgetReaderGroup(hContext, 
                                 L"MyReaderGroup");
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardForgetReaderGroup\n");

注意

winscard.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SCardForgetReaderGroup を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winscard.h
Library Winscard.lib
[DLL] Winscard.dll

こちらもご覧ください

SCardEstablishContext

SCardForgetCardType

SCardForgetReader

SCardIntroduceReaderGroup