ISCard::LockSCard method

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

Syntax

HRESULT LockSCard();

Parameters

This method has no parameters.

Return value

The method returns one of the following possible values.

Return code	Description
S_OK	Operation completed successfully.

 

Remarks

In addition to the COM error code 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.

To unlock the smart card, call the ISCard::UnlockSCard method.

Examples

The following example shows acquiring exclusive access to the smart card.

HRESULT    hr;

// Lock the smart card.
hr = pISCard->LockSCard();
if (FAILED(hr))
{
    printf("Failed LockSCard\n");
    // Take error handling action as needed.
}
// Use smart card; unlock the smart card when done.

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

UnlockSCard