#include <libxslm.h> xslm_uint32 xslm_query_server_info( xslm_uuid server_id, xslm_uint32 * server_buffer_length, xslm_bin_string * server_buffer, xslm_uint32 * status, xslm_uint32 auth_token, xslm_bin_string * auth_signature, xslm_uuid * auth_lic_sys_id );
xslm_query_server_info()returns the list of XSLM data element IDs supported by the specified server.
Identification of server to which this request is being directed.
A 32-bit arbitrary value created by the application and used as part of the licensing system authentication process. See
Process Descriptionfor more information.
As an input parameter, the length of the buffer to receive the results of the call. A value of zero on input indicates a request for the size of the buffer required to contain the all the results of the call. No data is returned in the server buffer when a value of zero is passed.
As an output parameter the length of usable data returned in the server buffer or the size of the buffer required to contain the entire result if the input value is zero.
Note that the buffer must be large enough to contain the entire result of the call. If it is not large enough, no data is placed in the buffer and the output value of server_buffer_length contains the buffer length needed to contain the entire result.
Pointer to the buffer which contains a list of all the data element IDs supported by the specified server.
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.
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.
Query completed successfully
- Problems with the license and/or certificate
Bad parameters passed
Requester is not authorized
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 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_BAD_PARM One or more parameters were not correct XSLM_BAD_BUFFER_LENGTH The non-zero value for the buffer length was too small for the certificate being retrieved. XSLM_BAD_SERVER_ID The server_id specified does not correspond to a known server XSLM_AUTH_ERROR XSLM_NOT_AUTHORIZED The requester is not authorized to perform the requested action
A data element, LICENSE_SERVER_INFORMATION (see
Data Elementsfor details).