---
product: Chilkat
product_version: 11.7.0
language: activex
language_label: ActiveX
class: SCard
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xChilkatSCardRef.html
---
# Chilkat SCard — ActiveX — v11.7.0

> Chilkat 11.7.0 · language=activex · class=SCard
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/SCard.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/activex/guide.md`.

## Purpose

**Communicate directly with smart card readers and cards through PC/SC.**

`Chilkat.SCard` is the low-level PC/SC smart card interface for applications that need direct reader and card communication. It supports reader discovery, reader connection, card status checking, APDU transmission, reader-control commands, status-change monitoring, transactions, and diagnostic access to underlying PC/SC errors. Use this class when the application needs APDU-level control rather than a higher-level certificate, minidriver, or PKCS#11 abstraction.

**Reader discovery**

Enumerate available PC/SC smart card readers and identify the reader the application should use.

**Connect to cards**

Connect to a reader/card, check card presence and status, and manage the active PC/SC connection.

**Transmit APDUs**

Send APDU commands directly to the card and receive the raw response bytes and status words.

**Reader-control commands**

Issue lower-level reader control commands when supported by the reader driver and PC/SC environment.

**Status monitoring**

Monitor reader or card status changes so applications can detect card insertion, removal, or state changes.

**Transactions and diagnostics**

Use PC/SC transactions for coordinated card access and inspect detailed error information when reader or card operations fail.

**Common pattern:** Establish the PC/SC context, list readers, connect to the selected reader, check card status, transmit APDU commands, process the response bytes, and disconnect when finished. Use `Chilkat.SCard` for direct PC/SC reader and APDU-level work; use `Chilkat.ScMinidriver` for card-minidriver certificate and key-container operations, and `Chilkat.Pkcs11` for PKCS#11 token or HSM sessions.

For an extended overview, see [SCard Class Overview](https://www.chilkatsoft.com/scard_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```clike
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')

(Xbase++)
oObject := 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");
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in ActiveX.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `LastBinaryResult As Variant (read-only)` | 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. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Long` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As String (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `LastStringResultLen As Long (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Long` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `ActiveProtocol` | property, read-only | `ActiveProtocol As String (read-only)` |
| `CardAtr` | property, read-only | `CardAtr As String (read-only)` |
| `ConnectedReader` | property, read-only | `ConnectedReader As String (read-only)` |
| `Context` | property, read-only | `Context As String (read-only)` |
| `PcscLibPath` | property, read/write | `PcscLibPath As String` |
| `ReaderStatus` | property, read-only | `ReaderStatus As String (read-only)` |
| `ScardError` | property, read-only | `ScardError As String (read-only)` |
| `BeginTransaction` | method | `BeginTransaction() As Long` |
| `CheckStatus` | method | `CheckStatus() As Long` |
| `Connect` | method | `Connect(reader As String, shareMode As String, preferredProtocol As String) As Long` |
| `Disconnect` | method | `Disconnect(disposition As String) As Long` |
| `EndTransaction` | method | `EndTransaction(disposition As String) As Long` |
| `EstablishContext` | method | `EstablishContext(scope As String) As Long` |
| `FindSmartcards` | method | `FindSmartcards(json As ChilkatJsonObject) As Long` |
| `GetAttrib` | method | `GetAttrib(attr As String, bd As ChilkatBinData) As Long` |
| `GetAttribStr` | method | `GetAttribStr(attr As String) As String` |
| `GetAttribUint` | method | `GetAttribUint(attr As String) As Long` |
| `GetStatusChange` | method | `GetStatusChange(ByVal maxWaitMs As Long, stReaderNames As ChilkatStringTable, json As ChilkatJsonObject) As Long` |
| `GetStatusChangeCancel` | method | `GetStatusChangeCancel() As Long` |
| `ListReaderGroups` | method | `ListReaderGroups(readerGroups As ChilkatStringTable) As Long` |
| `ListReaders` | method | `ListReaders(st As ChilkatStringTable) As Long` |
| `Reconnect` | method | `Reconnect(shareMode As String, preferredProtocol As String, action As String) As Long` |
| `ReleaseContext` | method | `ReleaseContext() As Long` |
| `SendControl` | method | `SendControl(ByVal controlCode As Long, bdSend As ChilkatBinData, bdRecv As ChilkatBinData) As Long` |
| `SendControlHex` | method | `SendControlHex(ByVal controlCode As Long, sendData As String, bdRecv As ChilkatBinData) As Long` |
| `Transmit` | method | `Transmit(protocolName As String, bdSend As ChilkatBinData, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long` |
| `TransmitHex` | method | `TransmitHex(protocolName As String, apduHex As String, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long` |

## Properties

### SCard.ActiveProtocol

`Chilkat 11.7.0 · activex · SCard · ActiveProtocol · property · read-only · since 9.50.87`

```
ActiveProtocol As String (read-only)
```

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.

### SCard.CardAtr

`Chilkat 11.7.0 · activex · SCard · CardAtr · property · read-only · since 9.50.87`

```
CardAtr As String (read-only)
```

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

### SCard.ConnectedReader

`Chilkat 11.7.0 · activex · SCard · ConnectedReader · property · read-only · since 9.50.87`

```
ConnectedReader As String (read-only)
```

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

### SCard.Context

`Chilkat 11.7.0 · activex · SCard · Context · property · read-only · since 9.50.87`

```
Context As String (read-only)
```

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.

### SCard.PcscLibPath

`Chilkat 11.7.0 · activex · SCard · PcscLibPath · property · read/write · since 9.50.87`

```
PcscLibPath As String
```

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.

### SCard.ReaderStatus

`Chilkat 11.7.0 · activex · SCard · ReaderStatus · property · read-only · since 9.50.87`

```
ReaderStatus As String (read-only)
```

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.

### SCard.ScardError

`Chilkat 11.7.0 · activex · SCard · ScardError · property · read-only · since 9.50.87`

```
ScardError As String (read-only)
```

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

## Methods

### SCard.BeginTransaction

`Chilkat 11.7.0 · activex · SCard · BeginTransaction · method · since 9.50.87`

```
BeginTransaction() As Long
```

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

Returns 1 for success, 0 for failure.

### SCard.CheckStatus

`Chilkat 11.7.0 · activex · SCard · CheckStatus · method · since 9.50.87`

```
CheckStatus() As Long
```

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.

### SCard.Connect

`Chilkat 11.7.0 · activex · SCard · Connect · method · since 9.50.87`

```
Connect(reader As String, shareMode As String, preferredProtocol As String) As Long
```

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.

### SCard.Disconnect

`Chilkat 11.7.0 · activex · SCard · Disconnect · method · since 9.50.87`

```
Disconnect(disposition As String) As Long
```

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.

### SCard.EndTransaction

`Chilkat 11.7.0 · activex · SCard · EndTransaction · method · since 9.50.87`

```
EndTransaction(disposition As String) As Long
```

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.

### SCard.EstablishContext

`Chilkat 11.7.0 · activex · SCard · EstablishContext · method · since 9.5.0.87`

```
EstablishContext(scope As String) As Long
```

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.

### SCard.FindSmartcards

`Chilkat 11.7.0 · activex · SCard · FindSmartcards · method · since 9.50.87`

```
FindSmartcards(json As ChilkatJsonObject) As Long
```

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

Returns 1 for success, 0 for failure.

### SCard.GetAttrib

`Chilkat 11.7.0 · activex · SCard · GetAttrib · method · since 9.50.87`

```
GetAttrib(attr As String, bd As ChilkatBinData) As Long
```

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.

### SCard.GetAttribStr

`Chilkat 11.7.0 · activex · SCard · GetAttribStr · method · since 9.50.87`

```
GetAttribStr(attr As String) As String
```

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

### SCard.GetAttribUint

`Chilkat 11.7.0 · activex · SCard · GetAttribUint · method · since 9.50.87`

```
GetAttribUint(attr As String) As Long
```

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.

### SCard.GetStatusChange

`Chilkat 11.7.0 · activex · SCard · GetStatusChange · method · since 9.50.87`

```
GetStatusChange(ByVal maxWaitMs As Long, stReaderNames As ChilkatStringTable, json As ChilkatJsonObject) As Long
```

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.

Async variant: `GetStatusChangeAsync` — same arguments, returns a `Task` (see Async variants below).

### SCard.GetStatusChangeCancel

`Chilkat 11.7.0 · activex · SCard · GetStatusChangeCancel · method · since 9.50.87`

```
GetStatusChangeCancel() As Long
```

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.

### SCard.ListReaderGroups

`Chilkat 11.7.0 · activex · SCard · ListReaderGroups · method · since 9.50.87`

```
ListReaderGroups(readerGroups As ChilkatStringTable) As Long
```

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.

### SCard.ListReaders

`Chilkat 11.7.0 · activex · SCard · ListReaders · method · since 9.50.87`

```
ListReaders(st As ChilkatStringTable) As Long
```

Returns a list of currently available readers on the system.

Returns 1 for success, 0 for failure.

### SCard.Reconnect

`Chilkat 11.7.0 · activex · SCard · Reconnect · method · since 9.50.87`

```
Reconnect(shareMode As String, preferredProtocol As String, action As String) As Long
```

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.

### SCard.ReleaseContext

`Chilkat 11.7.0 · activex · SCard · ReleaseContext · method · since 9.50.87`

```
ReleaseContext() As Long
```

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.

### SCard.SendControl

`Chilkat 11.7.0 · activex · SCard · SendControl · method · since 9.50.87`

```
SendControl(ByVal controlCode As Long, bdSend As ChilkatBinData, bdRecv As ChilkatBinData) As Long
```

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.

### SCard.SendControlHex

`Chilkat 11.7.0 · activex · SCard · SendControlHex · method · since 9.50.87`

```
SendControlHex(ByVal controlCode As Long, sendData As String, bdRecv As ChilkatBinData) As Long
```

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.

### SCard.Transmit

`Chilkat 11.7.0 · activex · SCard · Transmit · method · since 9.50.87`

```
Transmit(protocolName As String, bdSend As ChilkatBinData, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long
```

Sends an APDU to the smart card contained in the currently connected reader. The `protocolName` 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.

### SCard.TransmitHex

`Chilkat 11.7.0 · activex · SCard · TransmitHex · method · since 9.50.87`

```
TransmitHex(protocolName As String, apduHex As String, bdRecv As ChilkatBinData, ByVal maxRecvLen As Long) As Long
```

Sends an APDU to the smart card contained in the currently connected reader. The `protocolName` 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.

## Events and callbacks

### SCard.AbortCheck (event)

`Chilkat 11.7.0 · activex · SCard · AbortCheck · event`

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

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_AbortCheck(abort As Long)

	'Insert application code here.

End Sub
```

### SCard.PercentDone (event)

`Chilkat 11.7.0 · activex · SCard · PercentDone · event`

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

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myScard As ChilkatSCard

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

	'Insert application code here.

End Sub
```

### SCard.ProgressInfo (event)

`Chilkat 11.7.0 · activex · SCard · ProgressInfo · event`

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

Note: Some Chilkat methods don't fire any ProgressInfo events.

**VB6 Event callback implementation:**

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. See [VB6 Event Callbacks](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myScard As ChilkatSCard

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

	'Insert application code here.

End Sub
```

### SCard.TaskCompleted (event)

`Chilkat 11.7.0 · activex · SCard · TaskCompleted · event`

```
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](https://www.chilkatsoft.com/vb6_event_callbacks.asp)

```vb
Dim WithEvents myScard As ChilkatSCard

Private Sub myScard_TaskCompleted(task As ChilkatTask)

	'Insert application code here.

End Sub
```

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```
GetStatusChangeAsync(ByVal maxWaitMs As Long, stReaderNames As ChilkatStringTable, json As ChilkatJsonObject) As ChilkatTask
```

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/activex/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/activex/classes/JsonObject.md), [`StringTable`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/activex/classes/StringTable.md)

