[The get_Status 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_Status method retrieves the current state of the smart card.
Syntax
HRESULT get_Status(
[out] SCARD_STATES *pStatus
);
Parameters
pStatus [out]
Pointer to the state variable.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
| S_OK | Operation completed successfully. |
| E_INVALIDARG | The pStatus parameter is not valid. |
| E_POINTER | A bad pointer was passed in pStatus. |
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 current state of the smart card.
SCARD_STATES scState;
HRESULT hr;
// Determine the current state of the smart card.
hr = pISCard->get_Status(&scState);
if (FAILED(hr))
{
printf("Failed get_Status\n");
exit(1); // Or other error handling action.
}
// Use the retrieved value. (This example merely displays it.)
switch (scState)
{
case ABSENT:
printf("Absent state\n");
break;
case PRESENT:
printf("Present state\n");
break;
case SWALLOWED:
printf("Swallowed state\n");
break;
case POWERED:
printf("Powered state\n");
break;
case NEGOTIABLEMODE:
printf("Negotiable mode state\n");
break;
case SPECIFICMODE:
printf("Specific mode state\n");
break;
default:
printf("Unexpected state\n");
break;
}
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 | Scardmgr.h |
| Type library | Scardmgr.tlb |
| DLL | Scardssp.dll |
| IID | IID_ISCard is defined as 1461AAC3-6810-11D0-918F-00AA00C18068 |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
