VLSgetFeatureInfo

Syntax

LS_STATUS_CODE  VLSgetFeatureInfo (	 	 
char	 	*name,
char	 	*version,
int	 	index,
char	 	*unused1,
VLSfeatureInfo 	*featureInfo );
Argument Description

name

Name of the feature whose information is retrieved. Maximum 24 characters.

version

Version of the feature.

index

Used to specify a particular client.

unused1

Use NULL as the value.

featureInfo (out)

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

Description

Retrieves licensing information about a feature using the structure, feature_info.

Returns information on all features. You will need to initialize the structSz field of the VLSfeatureInfo structure being passed to this call before actually calling it.

If name is not NULL, information about the feature indicated by name and version is returned.

If information about all licensed features is desired, name should be NULL, and index should be used in a loop as described for the function call, VLSgetClientInfo. Refer to the source code of the lsmon.c utility for additional information.

VLSgetFeatureInfo returns the status code, VLS_NO_MORE_FEATURES, when it runs out of features to describe. If an error occurs, for example, the feature is unknown to the Sentinel RMS License Manager, an appropriate error code is returned.

Returns

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

Error Code

Description

VLS_CALLING_ERROR

  • featureInfo is NULL
  • index is negative
  • Attempted to use standalone mode with network only library, or network mode with standalone library.
  • When max feature name length exceeds the limit.

VLS_APP_UNNAMED

version is NULL when name is non_NULL.

VLS_NO_MORE_FEATURES

Finished retrieving feature information for all features on License Manager.

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.