AdminApi.getConfig Method

Package: SafeNet

Description

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

Syntax

public String getConfig ( String scope, 
                          String format
                        );

Parameters

`scope`	Definition of the data that is to be searched, in XML format. For more information, see Scope XML Tags.
`format`	Definition of the data to be retrieved, in XML format. For more information, see Format XML Tags.

Returns

The status information that is retrieved for the applied actions/settings, in XML format.

Use the GetLastApiError method to retrieve the last API status code.

For Sentinel protection keys, the type of key is as described below.

For Sentinel SL keys:

<hasp>
   <typename>keyType</typename>
   <configuration>keyConfiguration</configuration>
</hasp>

The values for keyType and keyConfiguration are as follows:

Sentinel SL Key	keyType	keyConfiguration
AdminMode	HASP-SL-AdminMode	haspsl-adminmode
UserMode	HASP-SL-UserMode	haspsl-usermode
Legacy	HASP SL	haspsl-legacy

For HASP HL keys:

<hasp>
   <typename>keyType</typename>
   <configuration>hasphl</configuration>
</hasp>

The value for keyType is one of the following:

HASP HL NetTime 250+
HASP HL NetTime 50
HASP HL NetTime 10
HASP HL Net 250+
HASP HL Net 50
HASP HL Net 10
HASP HL Time
HASP HL Max
HASP HL MaxMicro
HASP HL Drive
HASP HL ExpressCard
HASP HL Pro

For Sentinel HL keys:

<hasp>
   <typename>keyType</typename>
   <configuration>keyConfiguration</configuration>
</hasp>

The value for keyType is the same as for HASP HL keys, but Sentinel replaces HASP. For example: Sentinel HL Max

The value for keyConfiguration is one of the following:

>Sentinel HL (HASP configuration) keys: hasphl,sentinelhl

>Sentinel HL (Driverless configuration) keys: sentinelhl,driverless

Usage Notes

NOTE When using the getConfig method to retrieve a list of identities, if the scope specified in the call returns no identities, the return code depends on the version of the Run-time Environment:

>With RTE <= 8.43, the return code is 0 (SNTL_ADMIN_STATUS_OK)