#include <libxslm.h> xslm_uint32 xslm_adv_log( xslm_handle session_handle, xslm_handle lic_handle, xslm_uint32 * msg_length, xslm_string msg, xslm_uint32 * status, xslm_uint32 auth_token, xslm_bin_string * auth_signature, xslm_uuid * auth_lic_sys_id );
xslm_adv_log()logs an application-specified text message into the license server's log. Publisher-specific message logging can usually be disabled by an administrator. When application message logging is disabled, XSLM_MASK_APPLIED status value is returned and no message is logged.
A return code of XSLM_OK merely indicates that the message to be logged has been accepted by the license server; it may not have been committed to a physical log file.
A reference returned by
A reference returned by
Text of the message. This can be of any length; however, a licensing system is not required to accept more than 4,096 bytes.
A 32-bit arbitrary value created by the application and used as part of the licensing system authentication process. See
Process Descriptionfor more information.
Length in bytes of the msg parameter. If specified as 0, or a value higher than the licensing system can handle, this value is updated to indicate the maximum number of bytes that can be accepted (in these cases, no data is written).
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.
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.
A unique identifier for the particular type of licensing system handling the current license instance. Used as part of the licensing system authentication process.
Problem with license and/or certificate
Local resources unavailable
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.
- 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 (including the case when the input length is 0) XSLM_MASK_APPLIED Log record not written due to log masking as set by an administrator XSLM_COMM_ERR XSLM_LIC_SYS_NOT_RESP The licensing system does not respond XSLM_CERT_ERR XSLM_LOG_ERROR Error accessing log 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 same handle XSLM_MSG_TOO_LONG The specified message length exceeds the maximum length that the licensing system can handle. No data is written. The maximum length supported is returned in the msg_length parameter.