NAME

xslm_adv_record

SYNOPSIS

#include <libxslm.h>

xslm_uint32 xslm_adv_record(
    xslm_handle      session_handle,
    xslm_handle      lic_handle,
    xslm_uint32      counter_id,
    xslm_float       counter_incr,
    xslm_float       * counter_value,
    xslm_uint32      * status,
    xslm_uint32      auth_token,
    xslm_byte_string * auth_signature,
    xslm_uuid        * auth_lic_sys_id
);

DESCRIPTION

xslm_adv_record() is used to record resource usage in one of the set of certificate-related counters defined by the application publisher.

INPUT PARAMETERS

session_handle

A reference returned by xslm_adv_begin_session().

lic_handle

A reference returned by xslm_adv_request_license().

counter_id

A number which identifies one of the counters defined within the license certificate.

counter_incr

The value that the licensing system should add to or subtract from (depending upon the counter type) the current counter value. This value must be greater than or equal to 0. If it is set to 0, then the current counter value is returned in the counter_value parameter and the event is not logged.

auth_token

A 32-bit arbitrary value created by the application and used as part of the licensing system authentication process. See Process Description for more information.

OUTPUT PARAMETERS

counter_value

The value of the counter following processing of the current request. Note that if counter_incr is set to 0, then the only processing done is the return of the current counter value.

status

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

auth_signature

An area large enough to contain a 16-byte digital signature created by the licensing system from the input parameters and auth_token. Used as part of the licensing system authentication process.

auth_lic_sys_id

A unique identifier for the particular type of licensing system handling the current license instance. Used as part of the licensing system authentication process.

RETURN VALUE

XSLM_OK

Data recorded

XSLM_COMM_ERR

Communications problem

XSLM_CERT_ERR

Problem with license and/or certificate

XSLM_RESRC_UNAVL

Local resources unavailable

XSLM_PARM_ERR

Parameter error

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_LIC_SYS_NOT_RESP	The licensing system does not respond
XSLM_CERT_ERR	XSLM_INV_COUNTER_ID	Counter not defined within license certificate
	XSLM_ZERO_REACHED	Counter has reached the value 0
	XSLM_COUNT_OVERFLOW	Counter has wrapped around
	XSLM_COUNT_UNDERFLOW	Counter has wrapped around
XSLM_RESRC_UNAVL	XSLM_NO_RES	Platform dependent
XSLM_PARM_ERR	XSLM_BAD_LICENSE_HANDLE	The license handle is invalid
	XSLM_BAD_PARM	One or more parameters were not correct
	XSLM_BAD_SESSION_HANDLE	The specified session handle is invalid
	XSLM_INVALID_API_USE	Attempt to combine basic and advanced API for same handle

SEE ALSO

xslm_adv_begin_session(), xslm_adv_request_license().