Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The functions for LMX_SetOption are listed below.  

Note: Unless otherwise specified, the LMX_SetOption options affect checkout requests.

  • LMX_OPT_HEARTBEAT_CHECKOUT_SUCCESS_FUNCTION
  • LMX_OPT_HEARTBEAT_CHECKOUT_FAILURE_FUNCTION
  • LMX_OPT_HEARTBEAT_RETRY_FEATURE_FUNCTION
  • LMX_OPT_HEARTBEAT_CONNECTION_LOST_FUNCTION
  • LMX_OPT_HEARTBEAT_EXIT_FUNCTION
  • LMX_OPT_HEARTBEAT_CALLBACK_VENDORDATA
  • LMX_OPT_CUSTOM_HOSTID_FUNCTION
  • LMX_OPT_HOSTID_COMPARE_FUNCTION
  • LMX_OPT_LICENSE_PATH
  • LMX_OPT_LICENSE_STRING
  • LMX_OPT_EXACT_VERSION
  • LMX_OPT_ALLOW_BORROW
  • LMX_OPT_ALLOW_GRACE
  • LMX_OPT_TRIAL_DAYS
  • LMX_OPT_TRIAL_USES
  • LMX_OPT_TRIAL_VIRTUAL_MACHINE
  • LMX_OPT_TRIAL_TERMINAL_SERVER
  • LMX_OPT_AUTOMATIC_HEARTBEAT_ATTEMPTS
  • LMX_OPT_AUTOMATIC_HEARTBEAT_INTERVAL
  • LMX_OPT_CUSTOM_SHARE_STRING
  • LMX_OPT_SERVERSIDE_REQUEST_STRING
  • LMX_OPT_LICENSE_IDLE
  • LMX_OPT_CUSTOM_USERNAME
  • LMX_OPT_CUSTOM_HOSTNAME
  • LMX_OPT_BLACKLIST
  • LMX_OPT_ALLOW_MULTIPLE_SERVERS
  • LMX_OPT_HOSTID_CACHE_CLEANUP_INTERVAL
  • LMX_OPT_RESERVATION_TOKEN
  • LMX_OPT_BIND_ADDRESS
  • LMX_OPT_HOSTID_ENABLED
  • LMX_OPT_HOSTID_DISABLED

 

...

eOption

...


...

pSetting

...

Possible values:
An integer, as follows:
0 (disabled) >0 (seconds)
Default value:
120 (seconds)

 

...

eOption

...

pSetting

...

NULL-terminated string.
Default value:
NULL (disabled)

 

...

eOption

...

pSetting

...

NULL-terminated string.
Default value:
NULL (disabled)

 

...

eOption

...

pSetting

...

Enum value of type LMX_HOSTID_TYPE.
Default value:
LMX_HOSTID_ALL

 

...

eOption

...

pSetting

...

Enum value of type LMX_HOSTID_TYPE.
Default value:
None. By default, all HostID types are enabled.

 

Return values

On success, this function returns the status code LMX_SUCCESS.

On failure, this function returns an error code in the format described in Return codes.

...

Note that some of the flags are used in combination with checkout requests. This enables you to set flags for single checkout requests if needed.
For example:

/* First checkout request requires an exact version match to pass */
LMX_SetOption(..., LMX_OPT_EXACT_VERSION, (LMX_OPTION) 1);
LMX_Checkout(...);
/* Second checkout request does not require an exact version match to pass
  but can have a higher version in license file than function request */
LMX_SetOption(..., LMX_OPT_EXACT_VERSION, (LMX_OPTION) 0);
LMX_Checkout(...);