SCardListReadersA 函式 (winscard.h)

發行項
03/09/2024

SCardListReaders 函式提供一組具名讀取器群組內的讀取器清單，消除重複專案。

呼叫端會提供讀取器群組的清單，並接收具名群組內的讀取器清單。忽略無法辨識的組名。此函式只會傳回目前附加至系統且可供使用的具名群組內的讀取器。

語法

LONG SCardListReadersA(
  [in]           SCARDCONTEXT hContext,
  [in, optional] LPCSTR       mszGroups,
  [out]          LPSTR        mszReaders,
  [in, out]      LPDWORD      pcchReaders
);

參數

[in] hContext

識別查詢之資源管理員內容的句柄。資源管理員內容可由先前呼叫 SCardEstablishContext 來設定。

如果此參數設定為 NULL，則搜尋讀取器不限於任何內容。

[in, optional] mszGroups

定義為系統之讀取器群組的名稱，做為多字串。使用 NULL 值來列出系統 (中的所有讀取器，也就是 SCard$AllReaders 群組) 。

值	意義
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 進行修改。它僅供列舉使用。

[out] mszReaders

多字串，列出所提供讀取器群組內的卡片讀取器。如果此值為 NULL，SCardListReaders 會忽略 pcchReaders 中提供的緩衝區長度、將此參數未為 NULL 傳回的緩衝區長度寫入 pcchReaders，並傳回成功的程式代碼。

[in, out] pcchReaders

以字元為單位的 mszReaders 緩衝區長度。此參數會接收多字串結構的實際長度，包括所有尾端 Null 字元。如果緩衝區長度指定為 SCARD_AUTOALLOCATE， 則 mszReaders 會轉換成位元組指標的指標，並接收包含多字串結構的記憶體區塊位址。此記憶體區塊必須與 SCardFreeMemory 解除分配。

傳回值

此函式會根據它是否成功或失敗，傳回不同的值。

傳回碼/值	Description
「成功」 0 (0x0)	SCARD_S_SUCCESS
群組不包含讀取器 2148532270 (0x8010002E)	SCARD_E_NO_READERS_AVAILABLE
指定的讀取器目前無法使用 2148532247 (0x80100017)	SCARD_E_READER_UNAVAILABLE
其他	錯誤碼。如需詳細資訊，請參閱智慧卡傳回值。

備註

SCardListReaders 函式是資料庫查詢函式。如需其他資料庫查詢函式的詳細資訊，請參閱智慧卡資料庫查詢函式。

範例

下列範例顯示列出讀取器。

LPTSTR          pmszReaders = NULL;
LPTSTR          pReader;
LONG            lReturn, lReturn2;
DWORD           cch = SCARD_AUTOALLOCATE;

// Retrieve the list the readers.
// hSC was set by a previous call to SCardEstablishContext.
lReturn = SCardListReaders(hSC,
                           NULL,
                           (LPTSTR)&pmszReaders,
                           &cch );
switch( lReturn )
{
    case SCARD_E_NO_READERS_AVAILABLE:
        printf("Reader is not in groups.\n");
        // Take appropriate action.
        // ...
        break;

    case SCARD_S_SUCCESS:
        // Do something with the multi string of readers.
        // Output the values.
        // A double-null terminates the list of values.
        pReader = pmszReaders;
        while ( '\0' != *pReader )
        {
            // Display the value.
            printf("Reader: %S\n", pReader );
            // Advance to the next value.
            pReader = pReader + wcslen((wchar_t *)pReader) + 1;
        }
        // Free the memory.
        lReturn2 = SCardFreeMemory( hSC,
                                   pmszReaders );
        if ( SCARD_S_SUCCESS != lReturn2 )
            printf("Failed SCardFreeMemory\n");
        break;

default:
        printf("Failed SCardListReaders\n");
        // Take appropriate action.
        // ...
        break;
}

注意

winscard.h 標頭會將 SCardListReaders 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	winscard.h
程式庫	Winscard.lib
Dll	Winscard.dll