SCard

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.

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

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

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.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: .T. means success, .F. means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

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.

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.

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

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

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

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

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .F. on failure

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.

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 .T. for success, .F. for failure.

Creates an asynchronous task to call the GetStatusChange method with the arguments provided.

Returns .F. on failure

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

Returns .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

Returns a list of currently available readers on the system.

Returns .T. for success, .F. for failure.

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 SCARD_W_RESET_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 .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.