Page History

The LMX_SetOption function sets flags that change licensing behavior prior to license checkout.

Prototype

LMX_STATUS LMX_SetOption
(
   LMX_HANDLE LmxHandle,
   LMX_SETTINGS eOption,
   const void *pSetting
);

Parameters

LmxHandle
[in/out] LM-X handle.

...

pSetting
See the Setting information for the specific option, listed below.

Note: To avoid warnings when using the pSetting parameter, you can typecast it to the type (LMX_OPTION).

...

• 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_AUTOMATIC_HEARTBEAT_ATTEMPTS
• LMX_OPT_AUTOMATIC_HEARTBEAT_INTERVAL 
• LMX_OPT_ALLOW_BORROW
  
• LMX_OPT_ALLOW_CHECKOUT_LESS_LICENSES
• LMX_OPT_ALLOW_GRACE 
• LMX_OPT_ALLOW_MULTIPLE_SERVERS
• LMX_OPT_TRIAL_DAYS 
• LMX_OPT_TRIAL_USES
• LMX_OPT_TRIAL_TERMINAL_SERVER
• LMX_OPT_TRIAL_VIRTUAL_MACHINE
• LMX_OPT_HOSTID_ENABLED 
• LMX_OPT_HOSTID_DISABLED
• LMX_OPT_HOSTID_COMPARE_FUNCTION
• LMX_OPT_HOSTID_CACHE_CLEANUP_INTERVAL
  
• LMX_OPT_CLIENT_HOSTIDS_TO_SERVER
• LMX_OPT_CUSTOM_HOSTID_FUNCTION
• LMX_OPT_CUSTOM_HOSTNAME
• LMX_OPT_CUSTOM_SHARE_STRING 
• LMX_OPT_CUSTOM_USERNAME
• LMX_OPT_LICENSE_PATH 
• LMX_OPT_LICENSE_STRING
• LMX_OPT_LICENSE_IDLE
• LMX_OPT_EXACT_VERSION 
• LMX_OPT_BIND_ADDRESS
• LMX_OPT_BLACKLIST
• LMX_OPT_RESERVATION_TOKEN
• LMX_OPT_SERVERSIDE_REQUEST_STRING

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.

Remarks

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.

...

#include <lmx.h>
#include <stdio.h>

LMX_HANDLE h;

int main() 
{
  exit_on_error(LMX_Init(&h));
  /* First checkout request requires an exact version match to pass */
  exit_on_error(LMX_SetOption(h, LMX_OPT_EXACT_VERSION, (LMX_OPTION) 1));
  exit_on_error(LMX_Checkout(h, "f2", 1, 0, 1));
  
  /* Second checkout request does not require an exact version match to pass 
    and can request a version up to the one specified in the .lic file */
  exit_on_error(LMX_SetOption(h, LMX_OPT_EXACT_VERSION, (LMX_OPTION) 0));
  exit_on_error(LMX_Checkout(h, "f2", 0, 5, 1));

  return 0;
}