Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

SCardForgetCardType function

The SCardForgetCardType function removes an introduced smart card from the smart card subsystem.

Syntax


LONG WINAPI SCardForgetCardType(
  _In_  SCARDCONTEXT hContext,
  _In_  LPCTSTR szCardName
);

Parameters

hContext [in]

Handle that identifies the resource manager context. The resource manager context is set by a previous call to SCardEstablishContext. This parameter cannot be NULL.

szCardName [in]

Display name of the card to be removed from the smart card database.

Return value

This function returns different values depending on whether it succeeds or fails.

Return codeDescription
Success

SCARD_S_SUCCESS.

Failure

An error code. For more information, see Smart Card Return Values.

 

Remarks

This function is not redirected, but calling the function SCardForgetCardType when inside a Remote Desktop session will not result in an error. It only means that the result will be from the remote computer instead of the local computer.

The SCardForgetCardType function is a database management function. For more information about other database management functions, see Smart Card Database Management Functions.

Examples

The following example removes the specified card type from the system. The example assumes that lReturn is a valid variable of type LONG, that hContext is a valid handle received from a previous call to the SCardEstablishContext function, and that "MyCardName" was previously introduced by a call to the SCardIntroduceCardType function.



lReturn = SCardForgetCardType(hContext, 
                              L"MyCardName");
if ( SCARD_S_SUCCESS != lReturn )
    printf("Failed SCardForgetCardType\n");


Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Winscard.h

Library

Winscard.lib

DLL

Winscard.dll

Unicode and ANSI names

SCardForgetCardTypeW (Unicode) and SCardForgetCardTypeA (ANSI)

See also

SCardEstablishContext
SCardForgetReader
SCardForgetReaderGroup
SCardIntroduceCardType

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.