ISCardLocate::ConfigureCardNameSearch method
[The ConfigureCardNameSearch 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 ConfigureCardNameSearch method specifies the card names to be used in the search for the smart card.
Syntax
HRESULT ConfigureCardNameSearch(
[in] LPSAFEARRAY pCardNames,
[in] LPSAFEARRAY pGroupNames,
[in] BSTR bstrTitle,
[in] LONG lFlags
);
Parameters
-
pCardNames [in]
-
A pointer to an Automation safe array of card names in BSTR form.
-
pGroupNames [in]
-
A pointer to an Automation safe array of names of card/reader groups in BSTR form to add to the search.
-
bstrTitle [in]
-
Dialog box title for the search common control.
-
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.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
Operation completed successfully. |
|
Invalid parameter. |
|
A bad pointer was passed in pCardNames or pGroupNames. |
|
Out of memory. |
Remarks
To locate the smart card, call FindCard.
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 |
|
| Type library |
|
| DLL |
|
| IID |
IID_ISCardLocate is defined as 1461AACD-6810-11D0-918F-00AA00C18068 |
See also