Sentinel Admin API C Reference

The Sentinel Admin API C reference contains the following elements:

>Structural declarations and detailed information on individual API functions

>Description of XML tags that can be used to define scope and format of various API functions, and their usage

>Description of XML tags that can be used to perform actions in Sentinel License Manager, and their usage

>A summary and description of all API return codes

NOTE   You can use Admin API through Sentinel Licensing API libraries. It is not necessary to include both Admin API and Sentinel Licensing API libraries in the protected application.

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

NOTE   Using Sentinel LDK ToolBox, you can only establish an Admin API session to the local License Manager, and not to an Integrated License Manger or External License Manager. For information on the different types of License Managers, see the Sentinel LDK Software Protection and Licensing Guide (for Sentinel EMS or Sentinel LDK-EMS).

API Samples

Each Sentinel LDK installation includes API samples. Use the samples to integrate Admin API functionality into your own code.

API Function Overview

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

The Sentinel Admin API includes the functions described below.

ContextNewScope

Establishes a context to a Sentinel License Manager service, or to the Integrated License Manager of the Runtimeless API.

ContextDelete

Releases memory and other resources allocated by the creation of a Sentinel License Manager context.

Free

Releases memory resources allocated to store retrieved data from Admin API calls.

Get

Retrieves administration or monitoring information from a License Manager specified by a License Manager context.

Set

Sets configuration options or apply actions to a License Manager specified by a License Manager context.