ISCard::get_CardHandle method
[The get_CardHandle method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The Smart Card Modules provide similar functionality.]
The get_CardHandle method retrieves the handle for a connected smart card. This method returns (*pHandle) == NULL if not connected.
Syntax
HRESULT get_CardHandle(
[out] HSCARD *pHandle
);
Parameters
-
pHandle [out]
-
Pointer to the card handle on return.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
Operation completed successfully. |
|
The pHandle parameter is not valid. |
|
A bad pointer was passed in pHandle. |
Remarks
In addition to the COM error codes listed above, this interface may return a smart card error code if a smart card function was called to complete the request. For more information, see Smart Card Return Values.
Examples
The following example shows retrieving the smart card handle.
HSCARD hSC;
HRESULT hr;
// Retrieve the card handle.
hr = pISCard->get_CardHandle(&hSC);
if (FAILED(hr))
{
printf("Failed get_CardHandle\n");
// Take other error handling action as needed.
}
// Use card handle as needed.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| End of client support |
Windows XP |
| End of server support |
Windows Server 2003 |
| Header |
|
| Type library |
|
| DLL |
|
| IID |
IID_ISCard is defined as 1461AAC3-6810-11D0-918F-00AA00C18068 |
See also