SCardListReaderGroupsA 函式 (winscard.h)

發行項
03/13/2024

SCardListReaderGroups 函式提供先前已導入系統的讀取器群組清單。

語法

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

參數

[in] hContext

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

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

[out] mszGroups

多字串，列出定義給系統的讀取器群組，並可供目前終端機上的目前使用者使用。如果此值為 NULL，SCardListReaderGroups 會忽略 pcchGroups 中提供的緩衝區長度、將此參數未傳回的緩衝區長度寫入 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 解除分配。

傳回值

此函式會傳回不同的值，視其成功或失敗而定。

傳回碼	Description
「成功」	SCARD_S_SUCCESS。
失敗	錯誤碼。如需詳細資訊，請參閱智慧卡傳回值。

備註

只有當群組包含至少一個讀取器時，才會傳回群組。這包括 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 標頭會將 SCardListReaderGroups 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

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