DocumentLicense.checkLicenseWithCard Method

Module: DocumentLicense

Definition

Checks the license by using a card-based verification process.

It takes the path to the license file and outputs a challenge response for further verification.

@staticmethod
check_license_with_card(license_path: str) -> bytearray

Parameters

license_path str
in The file path to the license that needs to be checked.

Returns

bytearray
An array to hold the challenge response generated by the host.
This 16-byte array is used in the license verification process.

Exceptions

DocumentException
An error has occurred during Document Library execution.
static Uint8List checkLicenseWithCard(String? licensePath)

Parameters

licensePath String
in The file path to the license that needs to be checked.

Returns

Uint8List
An array to hold the challenge response generated by the host.
This 16-byte array is used in the license verification process.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static byte[] CheckLicenseWithCard(string licensePath)

Parameters

licensePath string
in The file path to the license that needs to be checked.

Returns

byte[]
An array to hold the challenge response generated by the host.
This 16-byte array is used in the license verification process.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static byte[] checkLicenseWithCard(String licensePath) throws DocumentException

Parameters

licensePath String
in The file path to the license that needs to be checked.

Returns

byte[]
An array to hold the challenge response generated by the host.
This 16-byte array is used in the license verification process.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static func checkLicenseWithCard(licensePath: String) throws -> [UInt8]

Parameters

licensePath String
in The file path to the license that needs to be checked.

Returns

[UInt8]
An array to hold the challenge response generated by the host.
This 16-byte array is used in the license verification process.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentLicense_CheckLicenseWithCard (
    const char * licensePath,
    unsigned char * challengeR1,
    int * challengeR1Size)

Parameters

licensePath const char *
in The file path to the license that needs to be checked.

challengeR1 unsigned char *
out An array to hold the challenge response generated by the host.

challengeR1Size int *
in Size of the ‘challengeR1’ buffer. Receives the number of elements in the ‘challengeR1’ array.

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.