SCard ActiveX Reference Documentation

SCard

Current Version: 11.1.0

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.

Object Creation

Note:
For a specific major version, use "Chilkat.SCard.<major_version>", such as "Chilkat.SCard.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.SCard")

(AutoIt)
$obj = ObjCreate("Chilkat.SCard")

(Visual Basic 6.0)
Dim obj As New ChilkatSCard

(VBScript)
set obj = CreateObject("Chilkat.SCard")

(VBA, such as Excel)
Dim obj As New ChilkatSCard
See How to Use ActiveX in Excel

(Delphi)
obj := TChilkatSCard.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.SCard')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.SCard")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.SCard', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.SCard");

Properties

ActiveProtocol
ActiveProtocol As String (read-only)
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
CardAtr As String (read-only)
Introduced in version 9.50.87

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

top
ConnectedReader
ConnectedReader As String (read-only)
Introduced in version 9.50.87

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

top
Context
Context As String (read-only)
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
DebugLogFilePath As String

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.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
LastErrorHtml As String (read-only)

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.

top
LastErrorText
LastErrorText As String (read-only)

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.

top
LastErrorXml
LastErrorXml As String (read-only)

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.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 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.

top
LastStringResult
LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
PcscLibPath
PcscLibPath As String
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
ReaderStatus As String (read-only)
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
ScardError As String (read-only)
Introduced in version 9.50.87

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.
  • ...

top
VerboseLogging
VerboseLogging As Long

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

top
Version
Version As String (read-only)

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

top

Methods

BeginTransaction
BeginTransaction() As Long
Introduced in version 9.50.87

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

Returns 1 for success, 0 for failure.

top
CheckStatus
CheckStatus() As Long
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 0, none of the properties are updated.

Returns 1 for success, 0 for failure.

top
Connect
Connect(reader As String, shareMode As String, preferredProtocol As String) As Long
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 1 for success, 0 for failure.

top
Disconnect
Disconnect(disposition As String) As Long
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 1 for success, 0 for failure.

top
EndTransaction
EndTransaction(disposition As String) As Long
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 1 for success, 0 for failure.

top
EstablishContext
EstablishContext(scope As String) As Long
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 1 for success, 0 for failure.

top
FindSmartcards
FindSmartcards(json As ChilkatJsonObject) As Long
Introduced in version 9.50.87

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

Returns 1 for success, 0 for failure.

top
GetAttrib
GetAttrib(attr As String, bd As ChilkatBinData) As Long
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 1 for success, 0 for failure.

top
GetAttribStr
GetAttribStr(attr As String) As String
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 Nothing on failure

top
GetAttribUint
GetAttribUint(attr As String) As Long
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
GetStatusChange(ByVal maxWaitMs As Long, stReaderNames As ChilkatStringTable, json As ChilkatJsonObject) As Long
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 1 for success, 0 for failure.

top
GetStatusChangeAsync (1) (2) (AutoIt) (PowerBuilder) (VBScript) (Visual Basic 6.0) (Visual FoxPro)
GetStatusChangeAsync(ByVal maxWaitMs As Long, stReaderNames As ChilkatStringTable, json As ChilkatJsonObject) As ChilkatTask
Introduced in version 9.50.87

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

top
GetStatusChangeCancel
GetStatusChangeCancel() As Long
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 1 for success, 0 for failure.

top
ListReaderGroups
ListReaderGroups(readerGroups As ChilkatStringTable) As Long
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 1 for success, 0 for failure.

top
ListReaders
ListReaders(st As ChilkatStringTable) As Long
Introduced in version 9.50.87

Returns a list of currently available readers on the system.

Returns 1 for success, 0 for failure.

top
Reconnect
Reconnect(shareMode As String, preferredProtocol As String, action As String) As Long
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 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 1 for success, 0 for failure.

top
ReleaseContext
ReleaseContext() As Long
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 1 for success, 0 for failure.

top
SendControl
SendControl(ByVal controlCode As Long, bdSend As ChilkatBinData, bdRecv As ChilkatBinData) As Long
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 1 for success, 0 for failure.

top
SendControlHex
SendControlHex(ByVal controlCode As Long, sendData As String, bdRecv As ChilkatBinData) As Long
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 1 for success, 0 for failure.

top
Transmit
Transmit(protocol As String, bdSend As ChilkatBinData, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long
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 1 for success, 0 for failure.

top
TransmitHex
TransmitHex(protocol As String, apduHex As String, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long
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 1 for success, 0 for failure.

top

Events

AbortCheck
AbortCheck(abort As Long)

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

More Information and Examples

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_AbortCheck(abort As Long)

	'Insert application code here.

End Sub
top
PercentDone
PercentDone(ByVal pctDone As Long, abort As Long)

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to 1. This will cause the method to terminate and return a failure status or corresponding failure value.

More Information and Examples

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub
top
ProgressInfo
ProgressInfo(ByVal name As String, ByVal value As String)

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_ProgressInfo(ByVal name As String, ByVal value As String)

	'Insert application code here.

End Sub
top
TaskCompleted
TaskCompleted(task As ChilkatTask)

Called from the background thread when an asynchronous task completes.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_TaskCompleted(task As ChilkatTask)

	'Insert application code here.

End Sub
top