Get Function

Description

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

Syntax

sntl_admin_status_t SNTL_ADMIN_CALLCONV sntl_admin_get(
                sntl_admin_context_t * admin_context,  
                const char * scope, 	  
                const char * format, 
                char ** info			  
                )

Parameters

admin_context

Pointer to the License Manager context to be used.

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.

info

Pointer to the information that is retrieved, in XML format, including status information.

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

Return Values

SNTL_ADMIN_STATUS_OK

SNTL_ADMIN_INSUF_MEM

SNTL_ADMIN_INVALID_CONTEXT

SNTL_ADMIN_LM_NOT_FOUND

SNTL_ADMIN_LM_TOO_OLD

SNTL_ADMIN_BAD_PARAMETERS

SNTL_ADMIN_LOCAL_NETWORK_ERR

SNTL_ADMIN_SCOPE_ERROR

SNTL_ADMIN_PASSWORD_REQUIRED

SNTL_ADMIN_INVALID_PTR

SNTL_ADMIN_NO_INTEGRATED_LM

SNTL_ADMIN_SCOPE_RESULTS_EMPTY

Usage Notes

This function allocates memory for the information it retrieves. To release allocated memory resources, use the Free function.

NOTE When using the Get function 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)