NAME

xslm_adv_release_license

SYNOPSIS

#include <libxslm.h>

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

DESCRIPTION

xslm_adv_release_license() releases all license units related to and acquired via a prior call to xslm_adv_request_license().

INPUT PARAMETERS

session_handle

A reference returned by xslm_adv_begin_session().

lic_handle

A reference returned by xslm_adv_request_license(). It is used to store information about a request/release transaction for a particular product.

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

status

br 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 returned

XSLM_COMM_ERR

Communications problem

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_RESRC_UNAVL	XSLM_NO_RES	Platform dependent
XSLM_PARM_ERR	XSLM_BAD_LICENSE_HANDLE	The specified 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 the same handle

SEE ALSO

xslm_adv_begin_session(), xslm_adv_request_license().