---
product: Chilkat
product_version: 11.7.0
language: ckjava
language_label: Java
class: SCard
class_name: CkSCard
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/javaCkSCardRef.html
---
# Chilkat SCard — Java — v11.7.0

> Chilkat 11.7.0 · language=ckjava · class=SCard (CkSCard)
> 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/ckjava/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**

```java
CkSCard obj = new CkSCard();
```

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

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` | `void get_DebugLogFilePath(CkString str); String debugLogFilePath(); void put_DebugLogFilePath(String newVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void get_LastErrorHtml(CkString str); String lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void get_LastErrorText(CkString str); String lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void get_LastErrorXml(CkString str); String lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean get_LastMethodSuccess(); void put_LastMethodSuccess(boolean newVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `boolean get_VerboseLogging(); void put_VerboseLogging(boolean newVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void get_Version(CkString str); String version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `ActiveProtocol` | property, read-only | `void get_ActiveProtocol(CkString str); String activeProtocol();` |
| `CardAtr` | property, read-only | `void get_CardAtr(CkString str); String cardAtr();` |
| `ConnectedReader` | property, read-only | `void get_ConnectedReader(CkString str); String connectedReader();` |
| `Context` | property, read-only | `void get_Context(CkString str); String context();` |
| `PcscLibPath` | property, read/write | `void get_PcscLibPath(CkString str); String pcscLibPath(); void put_PcscLibPath(String newVal);` |
| `ReaderStatus` | property, read-only | `void get_ReaderStatus(CkString str); String readerStatus();` |
| `ScardError` | property, read-only | `void get_ScardError(CkString str); String scardError();` |
| `BeginTransaction` | method | `boolean BeginTransaction();` |
| `CheckStatus` | method | `boolean CheckStatus();` |
| `Connect` | method | `boolean Connect(String reader, String shareMode, String preferredProtocol);` |
| `Disconnect` | method | `boolean Disconnect(String disposition);` |
| `EndTransaction` | method | `boolean EndTransaction(String disposition);` |
| `EstablishContext` | method | `boolean EstablishContext(String scope);` |
| `FindSmartcards` | method | `boolean FindSmartcards(CkJsonObject json);` |
| `GetAttrib` | method | `boolean GetAttrib(String attr, CkBinData bd);` |
| `GetAttribStr` | method | `boolean GetAttribStr(String attr, CkString outStr); String getAttribStr(String attr);` |
| `GetAttribUint` | method | `int GetAttribUint(String attr);` |
| `GetStatusChange` | method | `boolean GetStatusChange(int maxWaitMs, CkStringTable stReaderNames, CkJsonObject json);` |
| `GetStatusChangeCancel` | method | `boolean GetStatusChangeCancel();` |
| `ListReaderGroups` | method | `boolean ListReaderGroups(CkStringTable readerGroups);` |
| `ListReaders` | method | `boolean ListReaders(CkStringTable st);` |
| `Reconnect` | method | `boolean Reconnect(String shareMode, String preferredProtocol, String action);` |
| `ReleaseContext` | method | `boolean ReleaseContext();` |
| `SendControl` | method | `boolean SendControl(int controlCode, CkBinData bdSend, CkBinData bdRecv);` |
| `SendControlHex` | method | `boolean SendControlHex(int controlCode, String sendData, CkBinData bdRecv);` |
| `Transmit` | method | `boolean Transmit(String protocolName, CkBinData bdSend, CkBinData bdRecv, int maxRecvLen);` |
| `TransmitHex` | method | `boolean TransmitHex(String protocolName, String apduHex, CkBinData bdRecv, int maxRecvLen);` |

## Properties

### SCard.ActiveProtocol

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

```java
void get_ActiveProtocol(CkString str);

String activeProtocol();
```

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 · ckjava · SCard · CardAtr · property · read-only · since 9.50.87`

```java
void get_CardAtr(CkString str);

String cardAtr();
```

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

### SCard.ConnectedReader

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

```java
void get_ConnectedReader(CkString str);

String connectedReader();
```

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

### SCard.Context

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

```java
void get_Context(CkString str);

String context();
```

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 · ckjava · SCard · PcscLibPath · property · read/write · since 9.50.87`

```java
void get_PcscLibPath(CkString str);

String pcscLibPath();

void put_PcscLibPath(String newVal);
```

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 · ckjava · SCard · ReaderStatus · property · read-only · since 9.50.87`

```java
void get_ReaderStatus(CkString str);

String readerStatus();
```

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 · ckjava · SCard · ScardError · property · read-only · since 9.50.87`

```java
void get_ScardError(CkString str);

String scardError();
```

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 · ckjava · SCard · BeginTransaction · method · since 9.50.87`

```java
boolean BeginTransaction();
```

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

Returns true for success, false for failure.

### SCard.CheckStatus

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

```java
boolean CheckStatus();
```

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.

### SCard.Connect

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

```java
boolean Connect(String reader, String shareMode, String preferredProtocol);
```

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.

### SCard.Disconnect

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

```java
boolean Disconnect(String disposition);
```

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.

### SCard.EndTransaction

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

```java
boolean EndTransaction(String disposition);
```

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.

### SCard.EstablishContext

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

```java
boolean EstablishContext(String scope);
```

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.

### SCard.FindSmartcards

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

```java
boolean FindSmartcards(CkJsonObject json);
```

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

Returns true for success, false for failure.

### SCard.GetAttrib

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

```java
boolean GetAttrib(String attr, CkBinData bd);
```

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.

### SCard.GetAttribStr

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

```java
boolean GetAttribStr(String attr, CkString outStr);

String getAttribStr(String attr);
```

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.

### SCard.GetAttribUint

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

```java
int GetAttribUint(String attr);
```

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 · ckjava · SCard · GetStatusChange · method · since 9.50.87`

```java
boolean GetStatusChange(int maxWaitMs, CkStringTable stReaderNames, CkJsonObject json);
```

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.

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

### SCard.GetStatusChangeCancel

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

```java
boolean GetStatusChangeCancel();
```

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.

### SCard.ListReaderGroups

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

```java
boolean ListReaderGroups(CkStringTable readerGroups);
```

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.

### SCard.ListReaders

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

```java
boolean ListReaders(CkStringTable st);
```

Returns a list of currently available readers on the system.

Returns true for success, false for failure.

### SCard.Reconnect

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

```java
boolean Reconnect(String shareMode, String preferredProtocol, String action);
```

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 true for success, false for failure.

### SCard.ReleaseContext

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

```java
boolean ReleaseContext();
```

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.

### SCard.SendControl

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

```java
boolean SendControl(int controlCode, CkBinData bdSend, CkBinData bdRecv);
```

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.

### SCard.SendControlHex

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

```java
boolean SendControlHex(int controlCode, String sendData, CkBinData bdRecv);
```

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.

### SCard.Transmit

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

```java
boolean Transmit(String protocolName, CkBinData bdSend, CkBinData bdRecv, int maxRecvLen);
```

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 true for success, false for failure.

### SCard.TransmitHex

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

```java
boolean TransmitHex(String protocolName, String apduHex, CkBinData bdRecv, int maxRecvLen);
```

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 true for success, false for failure.

## Events and callbacks

To receive events, define your own class that extends CkBaseProgress and override just the methods you want to handle. The base class provides an empty implementation of every method, so anything you don't override is simply ignored.

Then create an instance of your class and pass it to the object's put_EventCallbackObject method. From that point on, the object calls your methods as the work proceeds.

**For example:**

```java
// Install an event callback handler to get progress events.
MyBaseProgress scardProgress = new MyBaseProgress();
scard.put_EventCallbackObject(scardProgress);
```

**MyBaseProgress example:**

```java
import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;

public class MyBaseProgress extends CkBaseProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
}
```

### SCard.AbortCheck (event)

`Chilkat 11.7.0 · ckjava · SCard · AbortCheck · event`

```java
public boolean AbortCheck();
```

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. Return `true` to abort; return `false` to continue (not abort)

### SCard.PercentDone (event)

`Chilkat 11.7.0 · ckjava · SCard · PercentDone · event`

```java
public boolean PercentDone(int pctDone);
```

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.

Return `true` to abort; return `false` to continue (not abort)

### SCard.ProgressInfo (event)

`Chilkat 11.7.0 · ckjava · SCard · ProgressInfo · event`

```java
public void ProgressInfo(String name, String value);
```

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.

### SCard.TaskCompleted (event)

`Chilkat 11.7.0 · ckjava · SCard · TaskCompleted · event`

```java
public void TaskCompleted(CkTask task);
```

Called from the background thread when an asynchronous task completes.

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

```java
CkTask GetStatusChangeAsync(int maxWaitMs, CkStringTable stReaderNames, CkJsonObject json);
```

## Related classes

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

