NAME

xslm_adv_confirm

SYNOPSIS

#include <libxslm.h>

xslm_uint32 xslm_adv_confirm(
    xslm_handle     session_handle,
    xslm_handle     lic_handle,
    xslm_uint32     * confirm_time,
    xslm_uint32     * status,
    xslm_uint32     auth_token,
    xslm_bin_string * auth_signature,
    xslm_uuid       * auth_lic_sys_id,
);

DESCRIPTION

xslm_adv_confirm() confirms that a license is currently in use. Should the license server not receive confirmation from the product within the default time period specified in the certificate, the license server will assume the license is no longer in use and will terminate the license and, if it is of the CONCURRENT type, return the respective number of units. This call allows the specification of the confirm_time value.

INPUT PARAMETERS

session_handle

A reference returned by xslm_adv_begin_session()

lic_handle

A reference returned by xslm_adv_request_license()

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.

INPUT/OUTPUT PARAMETERS

confirm_time

Elapsed time (in seconds) within which the license server will expect the next xslm_adv_confirm() call. Failure to confirm continued license use will cause the license server to assume that the product is no longer active and, if the license is reusable, return it to the pool of available licenses. If confirm_time is specified as 0, the license server will return the current value.

A confirm_time value specified by an application overrides any value contained within the license certificate, or any value set by the administrator.

OUTPUT PARAMETERS

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

License still valid

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_CAPACITY_LIMIT	A capacity limit attached to the license has been exceeded
XSLM_RESRC_UNAVL	XSLM_NO_RES	Platform dependent
XSLM_PARM_ERR	XSLM_BAD_LICENSE_HANDLE	The handle is invalid, perhaps because the xslm_adv_confirm() call was issued too late
	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().