ISCard::UnlockSCard method

[The UnlockScard 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 UnlockScard method releases exclusive access to the smart card.

Syntax

HRESULT UnlockSCard(
  [in] SCARD_DISPOSITIONS Disposition
);

Parameters

Disposition [in]

Indicates what should be done with the card in the connected reader.

Value Meaning
LEAVE
Leaves the smart card in the current state.
RESET
Resets the smart card to some known state.
UNPOWER
Removes power from the smart card.
EJECT
Ejects the smart card if the reader has eject capabilities.

 

Return value

The method returns one of the following possible values.

Return code Description
S_OK
Operation completed successfully.
E_INVALIDARG
The Disposition parameter is not valid

 

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 releasing exclusive access to the smart card.

HRESULT    hr;

// Unlock the smart card.
hr = pISCard->UnlockSCard(LEAVE);
if (FAILED(hr))
{
   printf("Failed UnlockSCard\n");
   // Take error handling action 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
Scardmgr.h
Type library
Scardmgr.tlb
DLL
Scardssp.dll
IID
IID_ISCard is defined as 1461AAC3-6810-11D0-918F-00AA00C18068

See also

ISCard

LockSCard