VLSremoveQueuedClient

Syntax

int VLSremoveQueuedClient (	 	 
unsigned char	 	*feature name,
unsigned char	 	*version,
int	 		qkey_id,
char	 		*log_comment );

Argument	Description
feature_name	Feature name of the client for which we are requesting information.
version	Version for which licenses are requested.
qkey_id	Identifier of the client queue, which needs to be removed.
log_comment	>If vendor usage data attribute consists of multiple words, each will be anonymized individually, only if they are separated using a space. In general, avoid specifying the same entry (or word) twice in the vendor usage data attribute as the "uniquely" anonymized data will be repeated. >The spaces in the vendor usage data attribute are replaced with underscores (_). Also, the keyword <an> itself is not anonymized and is replaced by an underscore (_) in the resulting usage log line record. >To complete the vendor usage data attribute anonymization process, the system administrator must have also allowed anonymity of user information (either by setting the LS_LOG_ANONYMITY environment variable or using the -log-anonymity License Manager start-up option).

Description

This API provides an administrative mechanism to remove a queued client.

VLSremoveQueuedClient will be available to:

>The user who started the License Manager, which actually signifies when the client was put in the queue.

>The root/administrator account.

>The user-account that originally goes to the queue placement.

Internally, this API will send a message to signal the License Manager that a specified client in the queue for a specified feature should be removed.

Returns

The status code LS_SUCCESS is returned if successful. Otherwise, it will return the following error codes:

Error Code	Description
VLS_CALLING_ERROR	>qkey_id parameter cannot be negative. >Attempted to use standalone mode with network only library, or network mode with standalone library. >The log comment value has exceeded the maximum allowed buffer size. Up to 50 characters are allowed (excluding the null character). If you plan to have only anonymized characters in the usage log file, then after the anonymization tag <an>, up to 3 words separated by a space can be included. If you plan to have only a part of data as anonymized, then use the following formula to calculate the maximum allowed data: 50 bytes = 17x + y, where "x" is the number of words to be anonymized and "y" is the length of the unanonymized data. >The log comment probably consists of the hash (#) sign in the beginning or end of the string. Also, it should not contain consecutive hash signs.
VLS_APP_UNNAMED	>feature_name is NULL >version is NULL Both feature name and version cannot be NULL.
VLS_NO_SUCH_CLIENT	License Manager does not have the specified client.
VLS_CLIENT_NOT_ AUTHORIZED	Client is not authorized to make the specified request.
VLS_NO_SERVER_ RUNNING	License Manager on specified host is not available for processing license operation requests.
VLS_NO_SERVER_ RESPONSE	Communication with License Manager has timed out.
VLS_HOST_UNKNOWN	Invalid hostName was specified.
VLS_NO_SERVER_FILE	The License Manager has not been set and is unable to determine which License Manager to use.
VLS_BAD_SERVER_ MESSAGE	Message returned by the License Manager could not be understood.
LS_NO_NETWORK	Generic error indicating that the network is unavailable for servicing the license operation.
LS_NORESOURCES	An error occurred in attempting to allocate memory needed by this function.

For a complete list of the error codes, see Licensing Library Error and Result Codes.