VLSgetCommuterInfo

NOTE    Starting v9.1.0 (and later), use the VLSgetCommuterInfoExt API to retrieve the commuter license information. The VLSgetCommuterInfo API is still being included for supporting backward compatibility.

Syntax

int VLSgetCommuterInfo (	 	 
unsigned char	 	*feature_name,
unsigned char	 	*version,
int	 		index,
VLScommuterInfo 	*commuter_info );

Argument	Description
feature_name	Name of the feature.
version	Version of the feature.
index	Used to specify a particular client. The index must be greater than 0. When the index crosses the maximum number of commuter features available, the error VLS_NO_MORE_COMMUTER_CODE will be returned.
commuter_info	The structure that returns the information about the checked-out license. Memory must be allocated by the caller.

Description

VLSgetCommuterInfo() returns LS_SUCCESS when the locally checked-out commuter token is available on the system whereas the function returns VLS_REMOTE_CHECKOUT, when the remotely checked-out commuter token is available on the system.

The return code "VLS_REMOTE_CHECKOUT" from this API should NOT be treated as an error condition, even though its value is non-zero. This particular value is returned by the API, when a remote-checked out commuter token is available on the standalone License Manager.

VLSgetCommuterInfo can be used two ways:

>Specify feature_name and version as non-NULL and the call will return information about this feature. The call will ignore the index argument.

>Specify feature_name and version as NULL and use the index field in a loop. This will return information about all feature-version checked-out licenses from no-net.

VLSgetCommuterInfo should be called until it returns VLS_NO_MORE_FEATURES by incrementing the index every time.

Returns

The status code LS_SUCCESS is returned if successful. For a complete list of the error codes, see Licensing Library Error and Result Codes.