ISCardDatabase::GetProviderCardId method

Article
01/07/2021

[The GetProviderCardId 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 GetProviderCardId method retrieves the identifier (GUID) of the primary service provider for the specified smart card.

Syntax

HRESULT GetProviderCardId(
  [in]  BSTR   bstrCardName,
  [out] LPGUID *ppguidProviderId
);

Parameters

bstrCardName [in]: Name of the smart card.
ppguidProviderId [out]: Pointer to the primary service provider's identifier (GUID) if successful; NULL if operation 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 ppguidProviderId.
E_OUTOFMEMORY	Out of memory.

Remarks

To list the interfaces of the smart card, call ListCardInterfaces.

To retrieve all known smart cards, readers and reader groups call ListCards, ListReaders, and ListReaderGroups respectively.

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

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 retrieving the identifier of the primary service provider for the specified smart card.

BSTR     bstrCard = NULL;
LPGUID   pguidProvId = NULL;
HRESULT  hr;

bstrCard = SysAllocString(L"My Card");
hr = pISCDataBase->GetProviderCardId(bstrCard,&pguidProvId);
if (FAILED(hr))
{
   printf("Failed GetProviderCardId\n");
}
else
{
    // Use pguidProvId as needed.
}

// Free BSTR when done.
if ( NULL != bstrCard )
{
    SysFreeString(bstrCard);
    bstrCard=NULL;
}

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