VLSgetCapacityList

Syntax

VLSgetCapacityList (	 	 
ifndef LSNOPRONTO	 	 
unsigned char	 	LSFAR *feature_name,
unsigned char	 	LSFAR *feature_version,
int	 	LSFAR *index,
unsigned long	 	LSFAR *bufferSize,
char	 	LSFAR *capacityList,
char	 	LSFAR *log_comment,
unsigned long	 	LSFAR *unused2
#endif );	 	 
Argument Description
feature_name

Name of the feature.
feature_version

Version of the feature.
index

Returns the index of the license up to which the capacity has been retrieved based on the bufferSize
bufferSize

Specifies the size of capacityList.
capacityList

An array containing a list of all the capacities available for this feature and version, separated by space. The caller should allocate the space.
log_comment

Unused. Pass NULL as value.
unused1

Use NULL as value.

Description

Returns the list of all the capacities of all the licenses having specified feature and version but different capacity. This function returns list of capacities as one string, each capacity separated by a space character.  

If capacityList is passed as NULL, the API returns the buffersize required. VLSgetCapacityList returns an error if the license is a non-capacity license. For example if Sentinel RMS License Manager has following licenses:

  • Feature F1, version V1, capacity 500
  • Feature F1, version V1, capacity 1000
  • Feature F1, version V1, capacity 1500
  • Then this API would return "500 1000 5000" as the output string in "capacity_list"

For a discussion of pooled versus non-pooled capacity licenses, refer to the Sentinel RMS Development Kit Developer Guide.

Returns

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

Error Code Description

VLS_NO_SUCH_FEATURE

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

VLS_APP_UNNAMED

featureName is NULL.

VLS_CALLING_ERROR

Attempted to use standalone mode with network-only library, or network mode with standalone library.

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_BUFFER_TOO_SMALL

An error occurred in the use of an internal buffer.

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.