VLSgetClientInfoExt

Syntax

VLSgetClientInfoExt (	 	 
unsigned char	 	*feature_name,
unsigned char	 	*version,
unsigned long	 	*capacity,
int	 		index,
char	 		*log_comment,
unsigned long   	*unused1,
VLSclientInfo	 	*client_info );

Use the extension API VLSgetClientInfoExt2 to support EPOC time beyond the year 2038.

Argument Description
feature_name

Name of the feature.

version

Version of the feature.

capacity

Capacity of the feature.

index

Used to specify a particular client.

log_comment

Unused. Pass NULL as value.

unused1 Unused. Pass NULL as value.
client_info

The structure in which information will be returned. Space allocated by the caller.

Since version 8.6.0, the client_log_comment parameter of the client_info_struct is being used for storing the log comments passed in the license request using request, update or checkout API.

Description

Returns the list of all the clients running for a particular feature, version and capacity. If the capacity is specified as NULL, this API shall return the list of all the clients for a particular feature and version. The suggested use of this function is in a loop, where the first call is made with index 0 which retrieves information about the first client. Subsequent calls, when made with 1, 2, 3, and so on, will retrieve information about other clients of that feature type.

NOTE   Memory for client_info should be allocated before making the call.

Returns

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

Error Code Description

VLS_APP_UNNAMED

  • featureName is NULL.
  • version is NULL

Both feature name and version cannot be NULL at the same time.

VLS_CALLING_ERROR

  • clientInfo parameter is NULL
  • index is negative
  • Attempted to use standalone mode with network-only library, or network mode with standalone library.

VLS_NO_MORE_CLIENTS

Finished retrieving client information for all clients.

VLS_NO_SUCH_FEATURE

License Manager does not have a license that matches requested feature, version and capacity.

VLS_MULTIPLE_VENDORID_FOUND

The License Manager has licenses for the same feature and version from multiple vendors. It is ambiguous which feature is requested.

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

No License Manager has been set and unable to determine which License Manager to use.

VLS_BAD_SERVER_ MESSAGE

Message from 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 function.

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