VLSgetCommuterInfoExt

Syntax

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

Argument	Description
feature_name (IN)	Name of the feature.
version (IN)	Version of the feature.
index (IN)	Used to specify a particular feature. 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 (Out)	The structure that returns the information about the checked-out license. Memory must be allocated by the caller.

Description

This API is an extension of the VLSgetCommuterInfo function. It provides additional information about the start and expiration time of a checked-out commuter token, in hours and minutes of the local time zone.

Starting version 9.1.0, the following additional fields are also introduced in the VLScommuterInfo structure to provide additional information about the checked-out commuter token:

>structSz

>birth_hours

>birth_minutes

>death_hours

>death_minutes

For more information about these fields, see the VLScommuterInfo.

VLSgetCommuterInfoExt can be used two ways:

>Specify feature_name 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. VLSgetCommuterInfoExt should be called until it returns VLS_NO_MORE_FEATURES by incrementing the index every time.

VLSgetCommuterInfoExt 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.

NOTE   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.

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.