VLSgetClientInfo

Returns information about a client feature.

Syntax

LS_STATUS_CODE VLSgetClientInfo (
char	 	*featureName,
char		*version,
int		index,
char		*unused1,
VLSclientInfo	*clientInfo );

There are two extensions of this API VLSgetClientInfoExt and VLSgetClientInfoExt2.

Argument Description
featureName

Name of the feature. An IN parameter.
version

Version of the feature. An IN parameter.
index

Used to specify a particular client. An IN parameter.
unused1

Use NULL as the value.
clientInfo

The structure in which information will be returned. Space allocated by caller. An OUT parameter.

Description

After this call, clientInfo contains information about all clients’ features. Since it is possible for multiple clients of a particular feature to be active on the network, index is used to retrieve information about a specific client. 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. So long as the index is valid, the function returns the success code, LS_SUCCESS. Otherwise, it returns the Sentinel RMS Development Kit status code, VLS_NO_MORE_CLIENTS. Memory for clientInfo should be allocated before making the call.

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.

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 and version.

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

The License Manager has not been set and the client application is 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.