NAME

xslm_remove_certificate

SYNOPSIS

#include <libxslm.h>

xslm_uint32 xslm_remove_certificate(
    xslm_uuid       server_id,
    xslm_uuid       publisher_id,
    xslm_uint32     product_id,
    xslm_uint32     version_id,
    xslm_uint32     feature_id,
    xslm_uint32     cert_serial_number,
    xslm_uint32     annotation_length,
    xslm_string     * annotation,
    xslm_uint32     * status,
    xslm_uint32     auth_token,
    xslm_bin_string * auth_signature,
    xslm_uuid       * auth_lic_sys_id
);

DESCRIPTION

Remove specified license certificate from license server.

INPUT PARAMETERS

server_id

Identification of server to which this request is being directed.

publisher_id

The Software Publisher UUID.

product_id

ID number of the product whose license is requested.

version_id

The version of the product whose license is being installed.

feature_id

The products associated feature number. If not used must be set to binary zeros.

cert_serial_number

The unique serial number assigned to the certificate by the publisher.

annotation

Arbitrary textual data to be logged together with the deletion event data.

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

annotation_length

Length in bytes of the annotation data. Specify a value of 0 to indicate that no annotation data should be logged.

A licensing server must support a length of at least 4,096 bytes, but may support any length longer than this. If the actual value passed in this parameter exceeds the maximum value the licensing server will reject the certificate deletion request, and will place in this field the maximum value it can accept.

OUTPUT PARAMETERS

status

Completion status. Detailed error code directly addressable by the caller. This value is set of XSLM_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

Query completed successfully

XSLM_COMM_ERR

Communications problem

XSLM_CERT_ERR

Problems with the license and/or certificate

XSLM_RESRC_UNAVL

Resources unavailable

XSLM_PARM_ERR

Bad parameters passed

XLSM_AUTH_ERROR

Requester is not authorized

PROGRAMMING NOTE

xslm_remove_certificate() requests that the license server remove the license certificate identified on the call from the license servers certificate database. Note that certificates can not be removed while any license associated with that certificate is still in use. Also note that consumptive license certificates can not be fully removed from the license server once they are installed, until the certificates expiration date has occurred (that is, the licensing system is required to maintain enough information about such certificates to prevent them from being reinstalled and thus reused).

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. Certificate removed from license server database.
XSLM_COMM_ERR	XSLM_COMM_UNAVAIL	Communications problem
XSLM_CERT_ERR	XSLM_CERT_NOT_FOUND	License certificate not found
	XSLM_CERT_IN_USE	Licenses associated with certificate still in use
	XSLM_CERT_NOT_REMOVABLE	License certificate type does not support removal
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 value specified for annotation_length exceeds the maximum value the server can support
	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

SEE ALSO

xslm_get_certificate(), xslm_install_certificate().