sntl_lmadmin_configure Supported in On-premises modeSupported in Lease mode

Library Information

>This API belongs to the License Manager administration library.

>The corresponding header is lmadmin.h.

Description

Use this API to configure the RMS admin library. The supported admin library configurations include:

>Enabling trace writer file for troubleshooting. By default, tracing is disabled for the admin library.

The API must be called before creating the first admin context because the library configuration becomes effective at the time of first admin context creation. The library configuration cannot be modified later.

Performs admin library configuration that is defined by the attribute object parameter.

Syntax

SNTL_DECLARE(sntl_lmadmin_status_t) sntl_lmadmin_configure(const sntl_lmadmin_attr_t 	      *attr);
Argument Description
attr [In]

Pointer to the attribute object.

The attributes that can be set are described in the following table.

Attributes

# Attribute for... Key and Description
1 Setting the Admin Trace Level Supported in On-premises modeSupported in Lease mode

>Attribute Key - SNTL_ATTR_LMADMINCONFIG_TRACE_LEVEL

>This attribute is used for setting the trace level required by the admin trace writer file.

>The allowed values are:

•SNTL_ATTR_LMADMINCONFIG_TRACE_ERROR - Traces the errors encountered at run time.

•SNTL_ATTR_LMADMINCONFIG_TRACE_FUNCTION - Traces the admin API functions along with errors encountered at run time. This option also includes the errors encountered at run time (SNTL_ATTR_LMADMINCONFIG_TRACE_ERROR).

2 Setting Admin Trace Writer File Name Supported in On-premises modeSupported in Lease mode

>Attribute Key - SNTL_ATTR_LMADMINCONFIG_TRACE_WRITER_FILE

>This attribute is used for setting the admin trace writer file name.

>The Sentinel RMS library writes traces to this file based on the specified admin trace level.

>To use the admin trace writer file, set the admin trace level attribute (mandatory).

NOTE   Tracing will not for be enabled for API calls placed before admin context creation (for example, sntl_lmadmin_attr_new and sntl_lmadmin_attr_set).

Returns

The status code SNTL_LMADMIN_SUCCESS is returned, if successful. Otherwise, an error code is returned indicating the reason for failure.

For the complete list of error codes, refer to LmAdmin Library Error and Result Codes.