Sentinel License Generation API Reference

The Sentinel License Generation API reference contains the following elements:

>Structural declarations and detailed information on individual API functions

>Description of XML tags that are used to create license definition templates

>Examples of different methods that can be used to apply license definition templates

>A summary and description of all API return codes

NOTE   To generate licenses, the Sentinel Master key must be connected to the machine where the program that calls Sentinel License Generation API is running. To connect to the Sentinel Master key from a remote machine, refer to the Sentinel LDK Installation Guide (for Sentinel EMS or Sentinel LDK-EMS).

Sentinel LDK ToolBox

Use Sentinel LDK ToolBox to assist you to fully understand the functionality of each API call. This tool enables you to:

>Test function calls

>Understand the required parameters

>Generate source code for use in your software source code

>Anticipate return values

API Samples

Each Sentinel LDK installation includes API samples for various programming languages. Use the samples to integrate Sentinel LDK license generation into your own code.

API Function Overview

The Sentinel License Generation API functions in this reference apply to the C programming language interface. Sentinel License Generation API supports languages other than C. APIs for supported languages can be accessed in the %ProgramFiles(x86)%\Thales\Sentinel LDK\API\LicGen directory.

The Sentinel License Generation API includes the functions described below.

Function	Description
sntl_lg_initialize()	Initializes the license generator library and returns a handle that is used for subsequent functions.
sntl_lg_cleanup()	Releases all the resources associated with a handle and resets the handle value after a successful cleanup.
sntl_lg_start()	Starts the license definition.
sntl_lg_apply_template()	Applies a license definition to the license state associated with the handle.
sntl_lg_generate_license()	Generates a V2C file that contains a license.
sntl_lg_free_memory()	Releases memory resources utilized by other License Generation API functions.
sntl_lg_decode_current_state()	Decodes a "current state" file or buffer and writes the decoded information as an XML buffer.
sntl_lg_get_info()	Retrieves information associated with a handle, such as capable device information.
sntl_lg_get_version()	Retrieves the version and build number of the LicGen library.