SCard Unicode C Reference Documentation

SCard

Current Version: 9.5.0.88

A wrapper around the Resource Manager API of the PC/SC architecture for smart cards. On Windows it is a wrapper around the WinSCard functions implemented in the winscard.dll. On other systems (such as Linux) it is a wrapper around the same API implemented in pcsc-lite.so.

This class is introduced in Chilkat v9.5.0.87.

Create/Dispose

HCkSCardW instance = CkSCardW_Create();
// ...
CkSCardW_Dispose(instance);
HCkSCardW CkSCardW_Create(void);

Creates an instance of the HCkSCardW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkSCardW_Dispose(HCkSCardW handle);

Objects created by calling CkSCardW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkSCardW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkSCardW_setAbortCheck(HCkSCardW cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkSCardW_setPercentDone(HCkSCardW cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkSCardW_setProgressInfo(HCkSCardW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkSCardW_setTaskCompleted(HCkSCardW cHandle, void (*fnTaskCompleted)(HCkTaskW hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

ActiveProtocol
void CkSCardW_getActiveProtocol(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_activeProtocol(HCkSCardW cHandle);
Introduced in version 9.50.87

The name of the active protocol if connected smart card reader, or an empty string if not connected. Possible values are "T0", "T1", "raw", "undefined", or "" if not connected to a reader.

top
CardAtr
void CkSCardW_getCardAtr(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_cardAtr(HCkSCardW cHandle);
Introduced in version 9.50.87

This is the Current ATR of a card in the connected reader.

top
ConnectedReader
void CkSCardW_getConnectedReader(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_connectedReader(HCkSCardW cHandle);
Introduced in version 9.50.87

The name of the currently connected smart card reader, or an empty string if not connected.

top
Context
void CkSCardW_getContext(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_context(HCkSCardW cHandle);
Introduced in version 9.50.87

Contains the string "user" or "system" if this object has established a context (by calling EstablishContext). Contains the empty string if no context is established.

top
DebugLogFilePath
void CkSCardW_getDebugLogFilePath(HCkSCardW cHandle, HCkString retval);
void CkSCardW_putDebugLogFilePath(HCkSCardW cHandle, const wchar_t *newVal);
const wchar_t *CkSCardW_debugLogFilePath(HCkSCardW cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void CkSCardW_getLastErrorHtml(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_lastErrorHtml(HCkSCardW cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void CkSCardW_getLastErrorText(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_lastErrorText(HCkSCardW cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void CkSCardW_getLastErrorXml(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_lastErrorXml(HCkSCardW cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkSCardW_getLastMethodSuccess(HCkSCardW cHandle);
void CkSCardW_putLastMethodSuccess(HCkSCardW cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
PcscLibPath
void CkSCardW_getPcscLibPath(HCkSCardW cHandle, HCkString retval);
void CkSCardW_putPcscLibPath(HCkSCardW cHandle, const wchar_t *newVal);
const wchar_t *CkSCardW_pcscLibPath(HCkSCardW cHandle);
Introduced in version 9.50.87

For Linux systems only. Specifies the full path of the libpcsclite.so shared lib. This property should only be used if the libpcsclite.so is in a non-standard location or if Chilkat cannot automatically located it.

top
ReaderStatus
void CkSCardW_getReaderStatus(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_readerStatus(HCkSCardW cHandle);
Introduced in version 9.50.87

The current status of the connected reader. Possible values are:

  • "absent" - There is no card in the reader.
  • "present" - There is a card in the reader, but it has not been moved into position for use.
  • "swallowed" - There is a card in the reader in position for use. The card is not powered.
  • "powered" - Power is being provided to the card, but the reader driver is unaware of the mode of the card.
  • "negotiable" - The card has been reset and is awaiting PTS negotiation.
  • "specific" - The card has been reset and specific communication protocols have been established.

top
ScardError
void CkSCardW_getScardError(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_scardError(HCkSCardW cHandle);
Introduced in version 9.50.87

The last error returned by an underlying PC/SC function. Can be one of the following:

  • "SCARDWREMOVED_CARD" - The smart card has been removed, so that further communication is not possible.
  • "SCARDWRESET_CARD" - The smart card has been reset, so any shared state information is invalid.
  • ...

top
VerboseLogging
BOOL CkSCardW_getVerboseLogging(HCkSCardW cHandle);
void CkSCardW_putVerboseLogging(HCkSCardW cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void CkSCardW_getVersion(HCkSCardW cHandle, HCkString retval);
const wchar_t *CkSCardW_version(HCkSCardW cHandle);

Version of the component/library, such as "9.5.0.63"

top

Methods

BeginTransaction
BOOL CkSCardW_BeginTransaction(HCkSCardW cHandle);
Introduced in version 9.50.87

Establishes a temporary exclusive access mode for doing a series of commands in a transaction.

Returns TRUE for success, FALSE for failure.

top
CheckStatus
BOOL CkSCardW_CheckStatus(HCkSCardW cHandle);
Introduced in version 9.50.87

Check the current status of the currently connected reader. Calling this method updates the ReaderStatus, ActiveProtocol, and CardAtr properties. If this method returns FALSE, none of the properties are updated.

Returns TRUE for success, FALSE for failure.

top
Connect
BOOL CkSCardW_Connect(HCkSCardW cHandle, const wchar_t *reader, const wchar_t *shareMode, const wchar_t *preferredProtocol);
Introduced in version 9.50.87

Establish a connection to a reader. The reader is the name of a reader returned from ListReaders. The shareMode can be "shared", "exclusive", or "direct". The preferredProtocol can be "0" (valid only if the shareMode = "direct"), "T0", "T1", "raw", or "no_preference". (No preference is effectively T0 or T1.)

If successful, the state of this object instance is that it's connected to the reader.

Returns TRUE for success, FALSE for failure.

top
Disconnect
BOOL CkSCardW_Disconnect(HCkSCardW cHandle, const wchar_t *disposition);
Introduced in version 9.50.87

Terminates a connection with a reader. The disposition can be one of the following values:

  • "leave": Do nothing.
  • "reset": Reset the card (warm reset).
  • "unpower": Power down the card (cold reset).
  • "eject": Eject the card.

Returns TRUE for success, FALSE for failure.

top
EndTransaction
BOOL CkSCardW_EndTransaction(HCkSCardW cHandle, const wchar_t *disposition);
Introduced in version 9.50.87

Ends a previously begun transaction. The disposition is the action to be taken on the reader, and can be "leave" which is to do nothing, "reset", "unpower", or "eject".

Returns TRUE for success, FALSE for failure.

top
EstablishContext
BOOL CkSCardW_EstablishContext(HCkSCardW cHandle, const wchar_t *scope);
Introduced in version 9.5.0.87

Creates an Application Context to the PC/SC Resource Manager. This must be the first WinSCard function called in a PC/SC application. The scope can be "user" or "system". After calling, this object will have context and all other methods will use the established context. The "Context" property will hold the value "user" or "system" if context was established, or will be empty if no context was established.

Returns TRUE for success, FALSE for failure.

top
FindSmartcards
BOOL CkSCardW_FindSmartcards(HCkSCardW cHandle, HCkJsonObjectW json);
Introduced in version 9.50.87

Returns JSON containing information about the smartcards currently inserted into readers.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
GetAttrib
BOOL CkSCardW_GetAttrib(HCkSCardW cHandle, const wchar_t *attr, HCkBinDataW bd);
Introduced in version 9.50.87

Get an attribute from the IFD Handler (reader driver).

The attr can be one of the following:

  • "ASYNC_PROTOCOL_TYPES"
  • "ATR_STRING"
  • "CHANNEL_ID"
  • "CHARACTERISTICS"
  • "CURRENT_BWT"
  • "CURRENT_CLK"
  • "CURRENT_CWT"
  • "CURRENT_D"
  • "CURRENT_EBC_ENCODING"
  • "CURRENT_F"
  • "CURRENT_IFSC"
  • "CURRENT_IFSD"
  • "CURRENT_IO_STATE"
  • "CURRENT_N"
  • "CURRENT_PROTOCOL_TYPE"
  • "CURRENT_W"
  • "DEFAULT_CLK"
  • "DEFAULT_DATA_RATE"
  • "DEVICE_FRIENDLY_NAME"
  • "DEVICE_IN_USE"
  • "DEVICE_SYSTEM_NAME"
  • "DEVICE_UNIT"
  • "ESC_AUTHREQUEST"
  • "ESC_CANCEL"
  • "ESC_RESET"
  • "EXTENDED_BWT"
  • "ICC_INTERFACE_STATUS"
  • "ICC_PRESENCE"
  • "ICC_TYPE_PER_ATR"
  • "MAX_CLK"
  • "MAX_DATA_RATE"
  • "MAX_IFSD"
  • "MAXINPUT"
  • "POWER_MGMT_SUPPORT"
  • "SUPRESS_T1_IFS_REQUEST"
  • "SYNC_PROTOCOL_TYPES"
  • "USER_AUTH_INPUT_DEVICE"
  • "USER_TO_CARD_AUTH_DEVICE"
  • "VENDOR_IFD_SERIAL_NO"
  • "VENDOR_IFD_TYPE"
  • "VENDOR_IFD_VERSION"
  • "VENDOR_NAME"

The attribute data is returned in bd.

Returns TRUE for success, FALSE for failure.

top
GetAttribStr
BOOL CkSCardW_GetAttribStr(HCkSCardW cHandle, const wchar_t *attr, const wchar_t *outStr);
const wchar_t *CkSCardW_getAttribStr(HCkSCardW cHandle, const wchar_t *attr);
Introduced in version 9.50.87

Get a string typed attribute from the IFD Handler (reader driver).

The attr can be one of the following, but should be limited to the particular attributes that return string values.

  • "ASYNC_PROTOCOL_TYPES"
  • "ATR_STRING"
  • "CHANNEL_ID"
  • "CHARACTERISTICS"
  • "CURRENT_BWT"
  • "CURRENT_CLK"
  • "CURRENT_CWT"
  • "CURRENT_D"
  • "CURRENT_EBC_ENCODING"
  • "CURRENT_F"
  • "CURRENT_IFSC"
  • "CURRENT_IFSD"
  • "CURRENT_IO_STATE"
  • "CURRENT_N"
  • "CURRENT_PROTOCOL_TYPE"
  • "CURRENT_W"
  • "DEFAULT_CLK"
  • "DEFAULT_DATA_RATE"
  • "DEVICE_FRIENDLY_NAME"
  • "DEVICE_IN_USE"
  • "DEVICE_SYSTEM_NAME"
  • "DEVICE_UNIT"
  • "ESC_AUTHREQUEST"
  • "ESC_CANCEL"
  • "ESC_RESET"
  • "EXTENDED_BWT"
  • "ICC_INTERFACE_STATUS"
  • "ICC_PRESENCE"
  • "ICC_TYPE_PER_ATR"
  • "MAX_CLK"
  • "MAX_DATA_RATE"
  • "MAX_IFSD"
  • "MAXINPUT"
  • "POWER_MGMT_SUPPORT"
  • "SUPRESS_T1_IFS_REQUEST"
  • "SYNC_PROTOCOL_TYPES"
  • "USER_AUTH_INPUT_DEVICE"
  • "USER_TO_CARD_AUTH_DEVICE"
  • "VENDOR_IFD_SERIAL_NO"
  • "VENDOR_IFD_TYPE"
  • "VENDOR_IFD_VERSION"
  • "VENDOR_NAME"

Returns TRUE for success, FALSE for failure.

top
GetAttribUint
unsigned long CkSCardW_GetAttribUint(HCkSCardW cHandle, const wchar_t *attr);
Introduced in version 9.50.87

Get an unsigned integer typed attribute from the IFD Handler (reader driver).

The attr can be one of the following, but should be limited to the particular attributes that return unsigned integer values.

  • "ASYNC_PROTOCOL_TYPES"
  • "ATR_STRING"
  • "CHANNEL_ID"
  • "CHARACTERISTICS"
  • "CURRENT_BWT"
  • "CURRENT_CLK"
  • "CURRENT_CWT"
  • "CURRENT_D"
  • "CURRENT_EBC_ENCODING"
  • "CURRENT_F"
  • "CURRENT_IFSC"
  • "CURRENT_IFSD"
  • "CURRENT_IO_STATE"
  • "CURRENT_N"
  • "CURRENT_PROTOCOL_TYPE"
  • "CURRENT_W"
  • "DEFAULT_CLK"
  • "DEFAULT_DATA_RATE"
  • "DEVICE_FRIENDLY_NAME"
  • "DEVICE_IN_USE"
  • "DEVICE_SYSTEM_NAME"
  • "DEVICE_UNIT"
  • "ESC_AUTHREQUEST"
  • "ESC_CANCEL"
  • "ESC_RESET"
  • "EXTENDED_BWT"
  • "ICC_INTERFACE_STATUS"
  • "ICC_PRESENCE"
  • "ICC_TYPE_PER_ATR"
  • "MAX_CLK"
  • "MAX_DATA_RATE"
  • "MAX_IFSD"
  • "MAXINPUT"
  • "POWER_MGMT_SUPPORT"
  • "SUPRESS_T1_IFS_REQUEST"
  • "SYNC_PROTOCOL_TYPES"
  • "USER_AUTH_INPUT_DEVICE"
  • "USER_TO_CARD_AUTH_DEVICE"
  • "VENDOR_IFD_SERIAL_NO"
  • "VENDOR_IFD_TYPE"
  • "VENDOR_IFD_VERSION"
  • "VENDOR_NAME"

Returns 0xFFFFFFFF on failure.

top
GetStatusChange
BOOL CkSCardW_GetStatusChange(HCkSCardW cHandle, int maxWaitMs, HCkStringTableW stReaderNames, HCkJsonObjectW json);
Introduced in version 9.50.87

Blocks execution until the current availability of the cards in a specific set of readers changes.

This function receives a list of reader names in stReaderNames. It then blocks waiting for a change in state to occur for a maximum blocking time of maxWaitMs (in milliseconds) or forever if 0 is used.

Information about the current reader states and which reader(s) changed is returned in json. See the example below for more information.

To wait for a reader event (reader added or removed) you may use the special reader name "\\?PnP?\Notification".

To cancel the ongoing call, call Cancel().

The stReaderNames contains the reader names to check. The json is empty on input, and if the call returns success contains information about the state (after the event change) of each reader.

Returns TRUE for success, FALSE for failure.

top
GetStatusChangeAsync (1)
HCkTaskW CkSCardW_GetStatusChangeAsync(HCkSCardW cHandle, int maxWaitMs, HCkStringTableW stReaderNames, HCkJsonObjectW json);
Introduced in version 9.50.87

Creates an asynchronous task to call the GetStatusChange method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns NULL on failure

top
GetStatusChangeCancel
BOOL CkSCardW_GetStatusChangeCancel(HCkSCardW cHandle);
Introduced in version 9.50.87

Cancels an ongoing GetStatusChange method call. This would be called from a separate thread in your application if GetStatusChange was called synchronously.

Returns TRUE for success, FALSE for failure.

top
ListReaderGroups
BOOL CkSCardW_ListReaderGroups(HCkSCardW cHandle, HCkStringTableW readerGroups);
Introduced in version 9.50.87

Returns a list of currently available reader groups on the system. The reader groups are returned in readerGroups.

Returns TRUE for success, FALSE for failure.

top
ListReaders
BOOL CkSCardW_ListReaders(HCkSCardW cHandle, HCkStringTableW st);
Introduced in version 9.50.87

Returns a list of currently available readers on the system.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
Reconnect
BOOL CkSCardW_Reconnect(HCkSCardW cHandle, const wchar_t *shareMode, const wchar_t *preferredProtocol, const wchar_t *action);
Introduced in version 9.50.87

Reestablishes a connection to a reader that was previously connected to using Connect().

In a multi application environment it is possible for an application to reset the card in shared mode. When this occurs any other application trying to access certain commands will be returned the value SCARDWRESET_CARD. When this occurs Reconnect() must be called in order to acknowledge that the card was reset and allow it to change its state accordingly.

The shareMode can be "shared", "exclusive", or "direct". The preferredProtocol can be "0" (valid only if the shareMode = "direct"), "T0", "T1", "raw", or "no_preference". (No preference is effectively T0 or T1.) The action is the desired action taken on the card/reader. It can be "leave", "reset", "unpower", or "eject".

If successful, the state of this object instance is that it's connected to the reader.

Returns TRUE for success, FALSE for failure.

top
ReleaseContext
BOOL CkSCardW_ReleaseContext(HCkSCardW cHandle);
Introduced in version 9.50.87

Destroys a communication context to the PC/SC Resource Manager. This must be the last function called in a PC/SC application.

Returns TRUE for success, FALSE for failure.

top
SendControl
BOOL CkSCardW_SendControl(HCkSCardW cHandle, unsigned long controlCode, HCkBinDataW bdSend, HCkBinDataW bdRecv);
Introduced in version 9.50.87

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

This is useful for creating client side reader drivers for functions like PIN pads, biometrics, or other extensions to the normal smart card reader that are not normally handled by PC/SC.

The command data is sent in bdSend. The response is written to bdRecv.

Returns TRUE for success, FALSE for failure.

top
SendControlHex
BOOL CkSCardW_SendControlHex(HCkSCardW cHandle, unsigned long controlCode, const wchar_t *sendData, HCkBinDataW bdRecv);
Introduced in version 9.50.87

Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

This is useful for creating client side reader drivers for functions like PIN pads, biometrics, or other extensions to the normal smart card reader that are not normally handled by PC/SC.

The command data is provided as a hex string in sendData. The response is written to bdRecv.

Returns TRUE for success, FALSE for failure.

top
Transmit
BOOL CkSCardW_Transmit(HCkSCardW cHandle, const wchar_t *protocol, HCkBinDataW bdSend, HCkBinDataW bdRecv, int maxRecvLen);
Introduced in version 9.50.87

Sends an APDU to the smart card contained in the currently connected reader. The protocol can be "T0", "T1", or "raw". The APDU to be sent is contained in bdSend. The response from the card is contained in bdRecv. The maxRecvLen is the maximum response size (in bytes) willing to be accepted.

Returns TRUE for success, FALSE for failure.

top
TransmitHex
BOOL CkSCardW_TransmitHex(HCkSCardW cHandle, const wchar_t *protocol, const wchar_t *apduHex, HCkBinDataW bdRecv, int maxRecvLen);
Introduced in version 9.50.87

Sends an APDU to the smart card contained in the currently connected reader. The protocol can be "T0", "T1", or "raw". The APDU (in hexadecimal) to be sent is passed in apduHex. The response from the card is contained in bdRecv. The maxRecvLen is the maximum response size (in bytes) willing to be accepted.

Returns TRUE for success, FALSE for failure.

top