ISCardLocate::FindCard method

[The FindCard 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 FindCard method searches for the smart card and opens a valid connection to it.

Syntax

HRESULT FindCard(
  [in]  SCARD_SHARE_MODES ShareMode,
  [in]  SCARD_PROTOCOLS   Protocols,
  [in]  LONG              lFlags,
  [out] LPSCARDINFO       *ppCardInfo
);

Parameters

ShareMode [in]

Mode in which to share or not share the smart card when a connection is opened to it.

Value	Meaning
EXCLUSIVE	No one else use this connection to the smart card.
SHARED	Other applications can use this connection.

 

Protocols [in]

Protocol to use when connecting to the card.

T0

T1

RAW

T0|T1

lFlags [in]

Specifies when user interface is displayed:

Value	Meaning
SC_DLG_MINIMAL_UI	Displays the dialog box only if the card being searched for by the calling application is not located and available for use in a reader. This allows the card to be found, connected (either through an internal dialog box mechanism or by using the user callback functions), and returned to the calling application.
SC_DLG_NO_UI	Causes no UI display, regardless of the search outcome.
SC_DLG_FORCE_UI	Causes UI display regardless of the search outcome.

 

ppCardInfo [out]

Pointer to a pointer to a data structure that contains or returns information about the opened smart card, if successful. Will be NULL if operation has failed.

Return value

The method returns one of the following possible values.

Return code	Description
S_OK	Operation completed successfully.
E_INVALIDARG	Invalid parameter.
E_POINTER	A bad pointer was passed in ppCardInfo.
E_OUTOFMEMORY	Out of memory.

 

Remarks

To set the search criteria of the search, call ConfigureCardNameSearch to specify a smart card's card names.

For a list of all the methods provided by this interface, see ISCardLocate.

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.

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_ISCardLocate is defined as 1461AACD-6810-11D0-918F-00AA00C18068

See also

ConfigureCardNameSearch

ISCardLocate