#include <libxslm.h> xslm_uint32 xslm_query_cert_ids( xslm_uuid server_id, xslm_uuid publisher_id, xslm_uint32 product_id, xslm_uint32 version_id, xslm_uint32 feature_id, xslm_uint32 * certid_buffer_length, xslm_bin_string * certid_buffer, xslm_uint32 * status, xslm_uint32 auth_token, xslm_bin_string * auth_signature, xslm_uuid * auth_lic_sys_id );
xslm_query_cert_ids()requests a license server to return the IDs of all certificates belonging to the fully qualified publisher_id, product_id, version_id, and feature_id. Note that, unlike for the xslm_query_next_level_cert_names()call, the text strings for the key fields are not returned as part of the query results.
Identification of server to which this request is being directed.
The software publisher UUID being queried. It uniquely identifies the publisher.
ID number of the product being queried.
The version of the product being queried.
The associated feature number of the product being queried.
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 query. A value of zero on input indicates a request for the size of the buffer required to contain all the results of the query. No data is returned in the key buffer when a value of zero is passed.
As an output parameter, the length of data returned in the buffer or the size of the buffer required to contain the entire query result if the input value is zero.
Note that the buffer must be large enough to contain the entire output data. If it is not, no data is placed in the buffer and the output value of this parameter contains an estimate of the buffer length needed to contain the entire result. Note also that because the certificate data may change at any time, the actual size needed may be different from the returned value.
Buffer in which the query results are returned.
Completion status. Detailed error code directly addressable by the caller. This value is set to XSLM_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_PARTIAL_DATA Invalid certificate(s) encountered. Key fields from those certificates were not placed in the key buffer. XSLM_COMM_ERR XSLM_COMM_UNAVAIL Communications problem XSLM_CERT_ERR XSLM_NO_CERTIFICATES No certificates matched the query 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_BUFFER_LENGTH The non-zero value for the buffer length was too small for the data being retrieved XSLM_BAD_PARM One or more parameters were not correct 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 sequence of data elements, CERTIFICATE_ID (see
Data Elementsfor details), describing all certificates matching the specified parameters, that have been installed and not deleted or replaced. The order of the returned data elements is unspecified.