HASP_SESSIONINFO XML
Tags
You can request information on a specific login session with the GetSessionInfo function by specifying one of the following:
>
><haspformat root="sessioninfo"> in the format parameter of the function call. (For more information, see Using XML Tags to Define Format.)
This format contacts the Admin License Manager to verify that the session is alive and to retrieve the information described below. The format does not reset the idle timeout. If the remote session has terminated, an error is returned. (Other formats return cached information if the session has terminated.)
The table below describes the XML elements used by the API to format the returned information.
|
Parent Tag |
Child Tag |
Description |
|---|---|---|
|
none - root |
|
Root element for all retrieved information using the GetSessionInfo function |
|
<hasp_info> |
<feature> |
Element that contains licensing information related to the connected key |
| <feature> |
<featureid> |
Unique identifier for a specific Feature stored in a key. This is the number passed to the Login function to establish access to the Feature. See the Login function for more information. |
|
<feature> |
<vmenabled> |
Feature can be hosted by a virtual machine |
|
<feature> |
<concurrency> |
Identifies concurrency parameters |
|
<concurrency> |
<export> |
Machines from which access to a Feature is allowed. Possible values are export and current |
|
<concurrency> |
<count> |
Basis on which logins to a Feature are counted |
|
<feature> |
<license> |
License settings of the Feature. The number of output elements depend on the type of license. The output elements for a license with an expiration date will include license_type and exp_date, whereas the output elements for a trial license will include license_type, time_start, and total_time. The output elements for a counter-based license will include counter_fix and counter_var. |
|
<license> |
<license> |
Restrictions that relate to the use of a Sentinel protection key. For example, the duration of a trial application. |
|
<feature> |
<maxlogins> |
The maximum number of concurrent logins permitted according to license stored in key |
|
<feature> |
<currentlogins> |
Number of current logins to the Feature/application |
| <feature> | <session> | Identifies session parameters |
| <session> | <idle_timeout> |
Total amount of time (in seconds) that the session can be idle before it is terminated. This is applicable only for a remote session that is logged in to an HL key or an SL AdminMode key and for local sessions that use the local Admin License Manager. Note: Retrieving this information does not reset the idle timeout. |
| <session> | <idle_remaining> |
Amount of time (in seconds) remaining before a session that is idle is terminated. This is applicable for a remote session that is logged in to an HL key or an SL AdminMode key and for local sessions that use the local Admin License Manager. Note: Retrieving this information does not reset the idle timeout. |