VLSgetQueuedLicense

Syntax

int VLSgetQueuedLicense (	 	 
LS_HANDLE	 	lshandle,
unsigned char	 	*log_comment,
LS_CHALLENGE	 	*challenge );

Argument	Description
lshandle	The handle previously returned by VLSqueuedRequest. The status of the handle must be VLS_QUEUED_HANDLE and the last call to VLSupdateQueuedClient must have reported that the licenses have been made available with the License Manager.
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).
challenge	The challenge-response for this operation. Pointer to a challenge structure. The challenge-response will also be returned.

Description

This function is called only after a call to VLSupdateQueuedClient reveals that a license is available for a queued client. Following that, call the VLSgetQueuedLicense API to obtain the license.

This API will be passed from the licensing library handle only and, internally, it will send all the memorized information to the License Manager. On return it will provide a valid client-handle value that will be used in later API calls.

Returns

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

Error Code	Description
VLS_CALLING_ERROR	>challenge argument is non-NULL, but cannot be understood. >The VLSqueuedRequest / VLSqueuedRequestExt API was called to serve a normal request. >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.
LS_BADHANDLE	Invalid handle.
LS_BUFFER_TOO_SMALL	An error occurred in the use of an internal buffer.
VLS_NO_LICENSE_GIVEN	Generic error indicating that the license is not granted.
VLS_NO_SUCH_FEATURE	License Manager does not have a license that matches requested feature, version and capacity.
LS_LICENSE_EXPIRED	License has expired.
VLS_TRIAL_LIC_EXHAUSTED	Trial license has expired.
LS_NOLICENSESAVAILABLE	All licenses are in use.
VLS_USER_EXCLUDED	User or machine excluded from accessing requested feature.
VLS_FINGERPRINT_ MISMATCH	Client-locked. Locking criteria does not match.
VLS_APP_NODE_LOCKED	Requested feature is node locked, but request was issued from unauthorized machine.
VLS_VENDORIDMISMATCH	This error can occur under the following scenarios: >The vendor of the requesting application does not match with the License vendor. >The License addition failed due to mismatch among the vendor of the license and vendor of the isolated License Manager.
VLS_INVALID_DOMAIN	The domain of the License Manager is different from that of the client.
VLS_NO_SERVER_RESPONSE	Communication with License Manager has timed out.
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.