hasp_get_info Screen

Description

Retrieves information about system components, according to customizable search parameters, and presents it according to customizable formats.

You do not need to be logged in to a Sentinel protection key in order to use this function.

The hasp_get_info screen contains the following fields:

Scope template

Select the template that specifies the parameters within which the Licensing API will search for the required data.

Scope

Displays the search parameters specified in the selected Scope template, in XML format. The API searches within these parameters for the information specified in the Format field. You can modify the XML code as necessary.

Click Check XML Code to validate the XML code in the Scope field.

Format template

Select the template that specifies the information to be retrieved and the format in which to retrieve the information. Predefined Format templates exist for certain purposes.

Format

Displays, in XML code, the content and format of the information to be retrieved by the function. You can modify the XML code as necessary.

The Format string enables data to be returned in virtually any nesting-level context. For example, you may choose to display data related to containers and what they contain (for example, licenses), or you may choose to display that same data as licenses and their containers.

The root tag defines the root tag that you want to return. If the haspscope root tag is selected, the output will be in a format suitable for use in the LoginScope function.

Click Check XML Code to validate the XML code in the Format field.

Vendor Code

If you are working online, this field displays an automatically generated list of Vendor Codes. Select the code that you require.

If you are not working online, use the browse button to navigate to and select the required Vendor Code file.

Output

Displays the information according to the parameters specified in the Scope and Format fields, in XML format. For information on the XML tags used to format the information, see Format XML Tags.

This output can be saved as a Scope template (assuming that the output was correctly formatted) by clicking Save As Scope Template.

NOTE   To make best use of the functionality of Sentinel LDK ToolBox, Thales recommends that you work online.

>Select a Scope template and click Manage Templates to display the Scope Template Manager dialog box.

>Select a Format template and click Manage Templates to display the Format Template Manager dialog box.

>Click Save Template to open the Save Template dialog box. You can overwrite an existing template, or save a modified template with a new name.

>Click OK to save, or Cancel to close the dialog box without saving.

>Click Execute to transfer the function and field definitions to the Sentinel Licensing API. After the function is executed, corresponding values are displayed in the status fields and the executed function call is logged in the API Call History.

Related Topics

Generated Code Pane

Function Pane

Accessing the Sentinel Licensing API Reference

hasp_get_info()

Scope Input XML Tags

Scope Template Manager

Format XML Tags

Format Template Manager

About XML Tags