---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: ScMinidriver
license: bundle
platforms: windows
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkScMinidriverRef.html
---
# Chilkat ScMinidriver — C — v11.7.0

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

## Purpose

**Available only on: windows.** Do not use this class on other platforms.

**Access smart-card certificates, key containers, PINs, files, and on-card signing.**

`Chilkat.ScMinidriver` is a smart-card integration class for applications that need card minidriver access to certificates, key containers, PIN authentication, card files, and on-card signing. It can retrieve and link smart-card certificates for use in other Chilkat signing classes, generate or import RSA and ECC keys, sign data directly, inspect card and container state, and manage selected card files and certificates.

**Connect through minidriver**

Use the Windows smart-card minidriver layer to access card capabilities without working directly at the APDU level.

**Certificates and containers**

Enumerate and inspect smart-card certificates, key containers, container indexes, key types, and related card state.

**PIN authentication**

Authenticate to the card with the required PIN before accessing protected private-key operations or card objects.

**On-card signing**

Sign data using private keys that remain on the smart card, including workflows where the private key is non-exportable.

**Key generation and import**

Generate or import RSA and ECC keys into supported card containers when the card policy allows it.

**Use with Chilkat signing**

Link a smart-card certificate to other Chilkat classes so PDF, XML, CMS/PKCS7, S/MIME, or other signing operations can use the card-backed private key.

**Common pattern:** Connect to the smart card, verify the card and container state, authenticate with the PIN, locate the certificate and private-key container, then either sign directly or link the certificate for use by another Chilkat signing class. Use `ScMinidriver` for Windows card-minidriver certificate and key-container operations; use `Chilkat.SCard` for direct PC/SC APDU-level work, and `Chilkat.Pkcs11` for PKCS#11 token or HSM sessions.

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

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkScMinidriver instance = CkScMinidriver_Create();
// ...
CkScMinidriver_Dispose(instance);
```

`HCkScMinidriver CkScMinidriver_Create(void);`

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

`void CkScMinidriver_Dispose(HCkScMinidriver handle);`

Objects created by calling CkScMinidriver_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 CkScMinidriver_Dispose.

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

## 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 CkScMinidriver_getDebugLogFilePath(HCkScMinidriver cHandle, HCkString retval); void CkScMinidriver_putDebugLogFilePath(HCkScMinidriver cHandle, const char *newVal); const char *CkScMinidriver_debugLogFilePath(HCkScMinidriver cHandle);` | 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 CkScMinidriver_getLastErrorHtml(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_lastErrorHtml(HCkScMinidriver cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkScMinidriver_getLastErrorText(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_lastErrorText(HCkScMinidriver cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkScMinidriver_getLastErrorXml(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_lastErrorXml(HCkScMinidriver cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkScMinidriver_getLastMethodSuccess(HCkScMinidriver cHandle); void CkScMinidriver_putLastMethodSuccess(HCkScMinidriver cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkScMinidriver_getUtf8(HCkScMinidriver cHandle); void CkScMinidriver_putUtf8(HCkScMinidriver cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkScMinidriver_getVerboseLogging(HCkScMinidriver cHandle); void CkScMinidriver_putVerboseLogging(HCkScMinidriver cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkScMinidriver_getVersion(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_version(HCkScMinidriver cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Atr` | property, read-only | `void CkScMinidriver_getAtr(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_atr(HCkScMinidriver cHandle);` |
| `CardName` | property, read-only | `void CkScMinidriver_getCardName(HCkScMinidriver cHandle, HCkString retval); const char *CkScMinidriver_cardName(HCkScMinidriver cHandle);` |
| `MaxContainers` | property, read-only | `int CkScMinidriver_getMaxContainers(HCkScMinidriver cHandle);` |
| `RsaPaddingHash` | property, read/write | `void CkScMinidriver_getRsaPaddingHash(HCkScMinidriver cHandle, HCkString retval); void CkScMinidriver_putRsaPaddingHash(HCkScMinidriver cHandle, const char *newVal); const char *CkScMinidriver_rsaPaddingHash(HCkScMinidriver cHandle);` |
| `RsaPaddingScheme` | property, read/write | `void CkScMinidriver_getRsaPaddingScheme(HCkScMinidriver cHandle, HCkString retval); void CkScMinidriver_putRsaPaddingScheme(HCkScMinidriver cHandle, const char *newVal); const char *CkScMinidriver_rsaPaddingScheme(HCkScMinidriver cHandle);` |
| `UncommonOptions` | property, read/write | `void CkScMinidriver_getUncommonOptions(HCkScMinidriver cHandle, HCkString retval); void CkScMinidriver_putUncommonOptions(HCkScMinidriver cHandle, const char *newVal); const char *CkScMinidriver_uncommonOptions(HCkScMinidriver cHandle);` |
| `AcquireContext` | method | `BOOL CkScMinidriver_AcquireContext(HCkScMinidriver cHandle, const char *readerName);` |
| `CardDeleteFile` | method | `BOOL CkScMinidriver_CardDeleteFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName);` |
| `DeleteCert` | method | `BOOL CkScMinidriver_DeleteCert(HCkScMinidriver cHandle, HCkCert cert, BOOL delPrivKey);` |
| `DeleteContext` | method | `BOOL CkScMinidriver_DeleteContext(HCkScMinidriver cHandle);` |
| `DeleteKeyContainer` | method | `BOOL CkScMinidriver_DeleteKeyContainer(HCkScMinidriver cHandle, int containerIndex);` |
| `EnumFiles` | method | `BOOL CkScMinidriver_EnumFiles(HCkScMinidriver cHandle, const char *dirName, HCkStringTable st);` |
| `FindCert` | method | `BOOL CkScMinidriver_FindCert(HCkScMinidriver cHandle, const char *certPart, const char *partValue, HCkCert cert);` |
| `GenerateKey` | method | `BOOL CkScMinidriver_GenerateKey(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, const char *keyType, int keySize, const char *pinId);` |
| `GetCardProperties` | method | `BOOL CkScMinidriver_GetCardProperties(HCkScMinidriver cHandle, HCkJsonObject json);` |
| `GetCert` | method | `BOOL CkScMinidriver_GetCert(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, HCkCert cert);` |
| `GetContainerKeys` | method | `BOOL CkScMinidriver_GetContainerKeys(HCkScMinidriver cHandle, int containerIndex, HCkPublicKey sigKey, HCkPublicKey kexKey);` |
| `GetCspContainerMap` | method | `BOOL CkScMinidriver_GetCspContainerMap(HCkScMinidriver cHandle, HCkJsonObject json);` |
| `ImportCert` | method | `BOOL CkScMinidriver_ImportCert(HCkScMinidriver cHandle, HCkCert cert, int containerIndex, const char *keySpec, const char *pinId);` |
| `ImportKey` | method | `BOOL CkScMinidriver_ImportKey(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, HCkPrivateKey privKey, const char *pinId);` |
| `ListCerts` | method | `BOOL CkScMinidriver_ListCerts(HCkScMinidriver cHandle, const char *certPart, HCkStringTable st);` |
| `PinAuthenticate` | method | `int CkScMinidriver_PinAuthenticate(HCkScMinidriver cHandle, const char *pinId, const char *pin);` |
| `PinAuthenticateHex` | method | `int CkScMinidriver_PinAuthenticateHex(HCkScMinidriver cHandle, const char *pinId, const char *pin);` |
| `PinChange` | method | `int CkScMinidriver_PinChange(HCkScMinidriver cHandle, const char *pinId, const char *currentPin, const char *newPin);` |
| `PinDeauthenticate` | method | `BOOL CkScMinidriver_PinDeauthenticate(HCkScMinidriver cHandle, const char *pinId);` |
| `ReadFile` | method | `BOOL CkScMinidriver_ReadFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName, HCkBinData bd);` |
| `SignData` | method | `BOOL CkScMinidriver_SignData(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, const char *hashDataAlg, HCkBinData bdData, HCkBinData bdSignedData);` |
| `WriteFile` | method | `BOOL CkScMinidriver_WriteFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName, HCkBinData bd);` |

## Properties

### ScMinidriver.Atr

`Chilkat 11.7.0 · c · ScMinidriver · Atr · property · read-only · since 9.5.0.87`

```c
void CkScMinidriver_getAtr(HCkScMinidriver cHandle, HCkString retval);
const char *CkScMinidriver_atr(HCkScMinidriver cHandle);
```

The ATR of the card in the reader. This property is set by the AquireContext method.

### ScMinidriver.CardName

`Chilkat 11.7.0 · c · ScMinidriver · CardName · property · read-only · since 9.5.0.87`

```c
void CkScMinidriver_getCardName(HCkScMinidriver cHandle, HCkString retval);
const char *CkScMinidriver_cardName(HCkScMinidriver cHandle);
```

The name of the card in the reader. This property is set by the AquireContext method.

### ScMinidriver.MaxContainers

`Chilkat 11.7.0 · c · ScMinidriver · MaxContainers · property · read-only · since 9.5.0.87`

```c
int CkScMinidriver_getMaxContainers(HCkScMinidriver cHandle);
```

The maximum number of key containers available. The 1st key container is at index 0. Each key container can potentially contain one signature key, and one key exchange key.

### ScMinidriver.RsaPaddingHash

`Chilkat 11.7.0 · c · ScMinidriver · RsaPaddingHash · property · read/write · since 9.5.0.87`

```c
void CkScMinidriver_getRsaPaddingHash(HCkScMinidriver cHandle, HCkString retval);
void CkScMinidriver_putRsaPaddingHash(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_rsaPaddingHash(HCkScMinidriver cHandle);
```

If an RSA key is used for signing, this is the hash algorithm to used in conjunction with the padding scheme. It can be `SHA1`, `SHA256`, `SHA384`, or `SHA512`. The default is `SHA256`.

### ScMinidriver.RsaPaddingScheme

`Chilkat 11.7.0 · c · ScMinidriver · RsaPaddingScheme · property · read/write · since 9.5.0.87`

```c
void CkScMinidriver_getRsaPaddingScheme(HCkScMinidriver cHandle, HCkString retval);
void CkScMinidriver_putRsaPaddingScheme(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_rsaPaddingScheme(HCkScMinidriver cHandle);
```

If an RSA key is used for signing, this is the padding scheme to use. It can be `PKCS` or `PSS`. The default is `PSS`.

### ScMinidriver.UncommonOptions

`Chilkat 11.7.0 · c · ScMinidriver · UncommonOptions · property · read/write · since 9.5.0.87`

```c
void CkScMinidriver_getUncommonOptions(HCkScMinidriver cHandle, HCkString retval);
void CkScMinidriver_putUncommonOptions(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_uncommonOptions(HCkScMinidriver cHandle);
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

## Methods

### ScMinidriver.AcquireContext

`Chilkat 11.7.0 · c · ScMinidriver · AcquireContext · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_AcquireContext(HCkScMinidriver cHandle, const char *readerName);
```

Initializes communication with the card inserted in the given reader. Reader names can be discovered via the SCard.ListReaders or SCard.FindSmartcards methods. If successful, the Atr and CardName properties will be set.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.CardDeleteFile

`Chilkat 11.7.0 · c · ScMinidriver · CardDeleteFile · method · since 9.5.0.88`

```c
BOOL CkScMinidriver_CardDeleteFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName);
```

Deletes the file specified by `dirName` and `fileName`. `dirName` is the name of the directory that contains the file, or the empty string for root.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.DeleteCert

`Chilkat 11.7.0 · c · ScMinidriver · DeleteCert · method · since 9.5.0.88`

```c
BOOL CkScMinidriver_DeleteCert(HCkScMinidriver cHandle, HCkCert cert, BOOL delPrivKey);
```

Deletes a certificate and optionally its associated private key from the smart card. If `delPrivKey` is `TRUE`, then the associated private key, if it exists, is also deleted.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.DeleteContext

`Chilkat 11.7.0 · c · ScMinidriver · DeleteContext · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_DeleteContext(HCkScMinidriver cHandle);
```

This function reverses the effect of AcquireContext and severs the communication between the Base CSP/KSP and the card minidriver. The Atr and CardName properties are cleared.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.DeleteKeyContainer

`Chilkat 11.7.0 · c · ScMinidriver · DeleteKeyContainer · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_DeleteKeyContainer(HCkScMinidriver cHandle, int containerIndex);
```

Deletes the key container at the given `containerIndex`. This deletes both the `signature` and `key exchange` keys that may be contained in the specified key container.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.EnumFiles

`Chilkat 11.7.0 · c · ScMinidriver · EnumFiles · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_EnumFiles(HCkScMinidriver cHandle, const char *dirName, HCkStringTable st);
```

Get the list of files in the directory specified by `dirName`. Pass the empty string for the root directory. The filenames are returned in `st`.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.FindCert

`Chilkat 11.7.0 · c · ScMinidriver · FindCert · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_FindCert(HCkScMinidriver cHandle, const char *certPart, const char *partValue, HCkCert cert);
```

Finds the certificate where the given `certPart` equals the `partValue`. Possible values for `certPart` are: `subjectDN`, `subjectDN_withTags`, `subjectCN`, `serial`, or `serial:issuerCN`.

The `cert` is loaded with the certificate if successful.

Note: If successful, the `cert` will be linked internally with this ScMinidriver session such that certificate can be used for signing on the smart card when used in other Chilkat classes such as XmlDSigGen, Pdf, Crypt2, Mime, MailMan, etc.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.GenerateKey

`Chilkat 11.7.0 · c · ScMinidriver · GenerateKey · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_GenerateKey(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, const char *keyType, int keySize, const char *pinId);
```

Generates a key to be stored in either the `signature` or `key exchange` location within a key container. Creates the key container if it does not already exist. Otherwise replaces the key in the key container.

The `keySpec` can be `sig` or `kex` to specify either the `signature` or `key exchange` location.

The `keyType` can be `ecc` or `rsa`.

For RSA keys, the `keySize` is the size of the key in bits, such as 1024, 2048, 4096, etc. (2048 is a typical value.) For ECC keys, the size can be 256, 384, or 521.

The `pinId` can be `user`, or `3` through `7`. (It is typically `user`.)

Returns TRUE for success, FALSE for failure.

### ScMinidriver.GetCardProperties

`Chilkat 11.7.0 · c · ScMinidriver · GetCardProperties · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_GetCardProperties(HCkScMinidriver cHandle, HCkJsonObject json);
```

Gets all card properties and returns them in `json`. See the example below.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.GetCert

`Chilkat 11.7.0 · c · ScMinidriver · GetCert · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_GetCert(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, HCkCert cert);
```

Get the certificate at the specified `containerIndex` and `keySpec`. The `keySpec` can be `sig` or `kex` to specify either the `signature` or `key exchange` location within the container. The `containerIndex` can be -1 to choose the first key container with a certificate. The `keySpec` can also be `any` to choose either `sig` or `kex` based on which is present, with preference given to `sig` if both are present.

The `cert` is loaded with the certificate if successful.

Note: If successful, the `cert` will be linked internally with this ScMinidriver session such that certificate can be used for signing on the smart card when used in other Chilkat classes such as XmlDSigGen, Pdf, Crypt2, Mime, MailMan, etc.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.GetContainerKeys

`Chilkat 11.7.0 · c · ScMinidriver · GetContainerKeys · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_GetContainerKeys(HCkScMinidriver cHandle, int containerIndex, HCkPublicKey sigKey, HCkPublicKey kexKey);
```

Queries a key container to get the keys that are present. If the signature public key is present, it is returned in `sigKey`. If the key exchange key is present, it is returned in `kexKey`.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.GetCspContainerMap

`Chilkat 11.7.0 · c · ScMinidriver · GetCspContainerMap · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_GetCspContainerMap(HCkScMinidriver cHandle, HCkJsonObject json);
```

Returns the contents of the CSP container map file (cmapfile). The information is returned in the `json`. This gives an overview of what key containers and certificates exist in the smart card from a CSP's point of view. See the example linked below.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.ImportCert

`Chilkat 11.7.0 · c · ScMinidriver · ImportCert · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_ImportCert(HCkScMinidriver cHandle, HCkCert cert, int containerIndex, const char *keySpec, const char *pinId);
```

Imports a certificate with its private key onto the smart card. The `cert` must have an accessible private key, such as will be the case if the `cert` was loaded from a .pfx/.p12, or if the `cert` was loaded from a Windows certificate store where the private key exists (and can be exported from the Windows certificate store).

The `containerIndex` is the container index. It can range from 0 to the MaxContainers-1.

The `keySpec` can be `sig` or `kex` to specify either the `signature` or `key exchange` location within the container.

The `pinId` can be `user`, or `3` through `7`. (It is typically `user`.)

Returns TRUE for success, FALSE for failure.

### ScMinidriver.ImportKey

`Chilkat 11.7.0 · c · ScMinidriver · ImportKey · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_ImportKey(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, HCkPrivateKey privKey, const char *pinId);
```

Imports a key to be stored in either the `signature` or `key exchange` location within a key container. Creates the key container if it does not already exist. Otherwise replaces the specified key in the key container.

The `keySpec` can be `sig` or `kex` to specify either the `signature` or `key exchange` location.

The `privKey` is the private key to import.

The ARG5 can be `user`, or `3` through `7`. (It is typically `user`.)

Returns TRUE for success, FALSE for failure.

### ScMinidriver.ListCerts

`Chilkat 11.7.0 · c · ScMinidriver · ListCerts · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_ListCerts(HCkScMinidriver cHandle, const char *certPart, HCkStringTable st);
```

Lists the certs found on the smart card. The `certPart` indicates the information to be returned from each certificate. Possible values are: `subjectDN`, `subjectDN_withTags`, `subjectCN`, `serial`, or `serial:issuerCN`. The information is returned in `st`.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.PinAuthenticate

`Chilkat 11.7.0 · c · ScMinidriver · PinAuthenticate · method · since 9.5.0.87`

```c
int CkScMinidriver_PinAuthenticate(HCkScMinidriver cHandle, const char *pinId, const char *pin);
```

Performs regular PIN authentication. The `pinId` can be `user`, `admin`, or `3` through `7`. (It is typically `user`.) The `pin` is the alphanumeric PIN.

Returns 0 for success. If not successful, the return value indicates the number of attempts remaining before the PIN is locked. (The number of times an incorrect PIN may be presented to the card before the PIN is blocked, and requires the admin to unblock it.) If the PIN is already blocked, the return value is -1. If the method fails for some other reason, such as if a context has not yet been acquired, the return value is -2.

### ScMinidriver.PinAuthenticateHex

`Chilkat 11.7.0 · c · ScMinidriver · PinAuthenticateHex · method · since 9.5.0.87`

```c
int CkScMinidriver_PinAuthenticateHex(HCkScMinidriver cHandle, const char *pinId, const char *pin);
```

The same as PinAutheneticate, but the PIN is passed as a hex string. For example, to pass a PIN of 0x01, 0x02, 0x03, 0x04, pass `01020304`.

### ScMinidriver.PinChange

`Chilkat 11.7.0 · c · ScMinidriver · PinChange · method · since 9.5.0.87`

```c
int CkScMinidriver_PinChange(HCkScMinidriver cHandle, const char *pinId, const char *currentPin, const char *newPin);
```

Changes a PIN. The `pinId` can be `user`, `admin`, or `3` through `7`. (It is typically `user`.) The `currentPin` is the current alphanumeric PIN. The `newPin` is the new PIN.

Returns 0 for success. If not successful, the return value indicates the number of attempts remaining before the PIN is locked. (The number of times an incorrect PIN may be presented to the card before the PIN is blocked, and requires the admin to unblock it.) If the PIN is already blocked, the return value is -1. If the method fails for some other reason, such as if a context has not yet been acquired, the return value is -2.

### ScMinidriver.PinDeauthenticate

`Chilkat 11.7.0 · c · ScMinidriver · PinDeauthenticate · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_PinDeauthenticate(HCkScMinidriver cHandle, const char *pinId);
```

Reverses a previous PIN authentication without resetting the card. The `pinId` can be `user`, `admin`, or `3` through `7`. (It is typically `user`.)

Returns TRUE for success, FALSE for failure.

### ScMinidriver.ReadFile

`Chilkat 11.7.0 · c · ScMinidriver · ReadFile · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_ReadFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName, HCkBinData bd);
```

Reads the entire file specified by `dirName` and `fileName` into `bd`. `dirName` is the name of the directory that contains the file, or the empty string for root.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.SignData

`Chilkat 11.7.0 · c · ScMinidriver · SignData · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_SignData(HCkScMinidriver cHandle, int containerIndex, const char *keySpec, const char *hashDataAlg, HCkBinData bdData, HCkBinData bdSignedData);
```

Signs the data passed in `bdData`. The `hashDataAlg` can be `sha1`, `sha256`, `sha384`, `sha512`, or `none`. If not equal to `none`, then the hash of the data passed in `bdData` is signed.

The `containerIndex` specifies the key container. By specifying the key container, you are almost specifying the key. A key container can contain two keys: A signature key, and a key-exchange key. The `keySpec` indicates which of these two keys to use. `keySpec` should be set to `sig` or `kex`.

Note: The type of signature created, such as RSA or ECC, is determined by the type of key that exists in the key container (specified by `containerIndex` and `keySpec`). If it is an RSA key, additional options can be specified via the RsaPaddingScheme and RsaPaddingHash properties.

If successful, the signature is written to `bdSignedData`.

Returns TRUE for success, FALSE for failure.

### ScMinidriver.WriteFile

`Chilkat 11.7.0 · c · ScMinidriver · WriteFile · method · since 9.5.0.87`

```c
BOOL CkScMinidriver_WriteFile(HCkScMinidriver cHandle, const char *dirName, const char *fileName, HCkBinData bd);
```

Writes the entire file specified by `dirName` and `fileName`. `dirName` is the name of the directory that contains the file, or the empty string for root. The entire contents of `bd` are written to the file on the smart card.

Returns TRUE for success, FALSE for failure.

## Related classes

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

