SCardListReaderGroupsA 関数 (winscard.h)

[アーティクル]
03/04/2024

SCardListReaderGroups 関数は、以前にシステムに導入されたリーダーグループの一覧を提供します。

構文

LONG SCardListReaderGroupsA(
  [in]      SCARDCONTEXT hContext,
  [out]     LPSTR        mszGroups,
  [in, out] LPDWORD      pcchGroups
);

パラメーター

[in] hContext

クエリのリソースマネージャーコンテキストを識別するハンドル。リソースマネージャーコンテキストは、 SCardEstablishContext の以前の呼び出しによって設定できます。

このパラメーターが NULL に設定されている場合、リーダーグループの検索はどのコンテキストにも限定されません。

[out] mszGroups

システムに定義され、現在のターミナルで現在のユーザーが使用できるリーダーグループを一覧表示する複数文字列。この値が NULL の場合、 SCardListReaderGroups は pcchGroups で指定されたバッファー長を無視し、このパラメーターが NULL でない場合に返されるバッファーの長さを pcchGroups に書き込み、成功コードを返します。

値	意味
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 を使用して変更できない内部管理グループです。列挙にのみ使用することを目的としています。

[in, out] pcchGroups

mszGroups バッファーの長さを文字数で指定し、後続のすべての null 文字を含む複数文字列構造体の実際の長さを受け取ります。バッファー長が SCARD_AUTOALLOCATE として指定されている場合、 mszGroups はバイトポインターへのポインターに変換され、複数文字列構造を含むメモリブロックのアドレスを受け取ります。このメモリブロックは、SCardFreeMemory で割り当てを解除する必要があります。

戻り値

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

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

注釈

グループに少なくとも 1 つのリーダーが含まれている場合にのみ、グループが返されます。これには、グループ SCard$DefaultReaders が含まれます。 SCard$AllReaders グループは暗黙的にしか存在しないため、返すことができません。

SCardListReaderGroups 関数はデータベースクエリ関数です。その他のデータベースクエリ関数の詳細については、「スマートカードデータベースクエリ関数」を参照してください。

例

次の例は、リーダーグループの一覧を示しています。

LPTSTR          pmszReaderGroups = NULL;
LPTSTR          pReaderGroup;
LONG            lReturn;
DWORD           cch = SCARD_AUTOALLOCATE;
    
// Retrieve the list the reader groups.
// hSC was set by a previous call to SCardEstablishContext.
lReturn = SCardListReaderGroups(hSC,
                                (LPTSTR)&pmszReaderGroups,
                                &cch );
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardListReaderGroups\n");
else
{
    // Do something with the multi string of reader groups.
    // Output the values.
    // A double-null terminates the list of values.
    pReaderGroup = pmszReaderGroups;
    while ( '\0' != *pReaderGroup )
    {
        // Display the value.
        printf("%S\n", pReaderGroup );
        // Advance to the next value.
        pReaderGroup = pReaderGroup + wcslen((wchar_t *) pReaderGroup) + 1;
    }

    // Remember to free pmszReaderGroups by a call to SCardFreeMemory.
    // ...
}

注意

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

要件

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