ISCard::AttachByHandle method

Article
01/07/2021

[The AttachByHandle 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 AttachByHandle method attaches the ISCard object to an open and configured smart card handle.

Syntax

HRESULT AttachByHandle(
  [in] HSCARD hCard
);

Parameters

hCard [in]: A handle to an open connection to a smart card.

Return value

The method returns one of the following possible values.

Return code	Description
S_OK	Operation completed successfully.
E_INVALIDARG	The hCard 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.

When you have finished using the handle, release the attachment by calling the ISCard::Detach method.

Examples

The following example shows attaching to a smart card handle.

HRESULT  hr;

// hSC is of type HSCARD and has been previously assigned.
// Attach SCard to the smart card using the value in hSC.
hr = pISCard->AttachByHandle(hSC);
if (FAILED(hr))
{
   printf("Failed AttachByHandle\n");
   // Take other error handling action as needed.
}
// Proceed using attached reader.

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