NAME

xslm_query_api_level

SYNOPSIS

#include <libxslm.h>

xslm_uint32 xslm_query_api_level(
    xslm_uint32 * func_level,
    xslm_uint32 * func_tower_count,
    xslm_uint32 [] func_towers,
    xslm_uint32 * status
);

DESCRIPTION

xslm_query_api_level() returns the highest API levels supported by all license servers in the licensing system. (Individual license servers may support a higher API level.)

INPUT/OUTPUT PARAMETERS

func_tower_count

On input, contains the number of elements in the func_towers array, available for use by the licensing system to return information. On output, contains the number of elements actually used within the func_towers array. If the return value is XSLM_PARM_ERR and the status value is XSLM_TOO_SMALL, this word contains the number of elements required.

OUTPUT PARAMETERS

func_level

The highest functional level supported by all license servers within the licensing system. Individual license servers may support a higher functional level.

func_towers

An array of optional functional towers that are supported by all license servers within the licensing system.

status

Completion status. Detailed error code directly addressable by the caller. This value is set to XSLM_STATUS_OK if no error occurred. For other messages, see ERRORS.

RETURN VALUE

XSLM_OK

Query completed successfully

XSLM_COMM_ERR

Communications problem

XSLM_CERT_ERR

Problems with the license and/or certificate

XSLM_RESRC_UNAVL

Resources unavailable

XSLM_PARM_ERR

Bad parameters passed

ERRORS

The function return value gives an overall indication of the success or failure of the call. In addition, the status parameter will be set to one of the following values, to further help point to the reason for a failed request.

Note:

In the future, additional values may be defined for the status variable. An application must not rely upon these being the only possible values.

Return Value	Status Value	Explanation
XSLM_OK	XSLM_STATUS_OK	No errors occurred
XSLM_COMM_ERR	XSLM_COMM_UNAVAIL	Communications problem
XSLM_RESRC_UNAVL	XSLM_NO_RES	Local platform-specific environmental problems
	XSLM_SERVER_ERROR	Unrecoverable environmental error was encountered by the license server
XSLM_PARM_ERR	XSLM_TOO_SMALL	The number of available space in the func_towers array is insufficient

SEE ALSO

none.