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

...

The functions for LMX_SetOption are listed below.  

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

• LMX_OPT_HEARTBEAT_CHECKOUT_SUCCESS_FUNCTIONALLOW_BORROW
  
• LMX_OPT_HEARTBEATALLOW_CHECKOUT_FAILURELESS_FUNCTIONLICENSES
• LMX_OPT_ALLOW_GRACE 
• LMX_OPT_ALLOW_MULTIPLE_SERVERS_HEARTBEAT_RETRY_FEATURE_FUNCTION
• LMX_OPT_AUTOMATIC_HEARTBEAT_CONNECTION_LOST_FUNCTIONATTEMPTS
• LMX_OPT_AUTOMATIC_HEARTBEAT_EXIT_FUNCTIONINTERVAL 
• LMX_OPT_BIND_HEARTBEATADDRESS
• LMX_CALLBACKOPT_VENDORDATABLACKLIST
• LMX_OPT_CLIENT_AUTOMATICHOSTIDS_HEARTBEATTO_ATTEMPTSSERVER
• LMX_OPT_AUTOMATICCUSTOM_HEARTBEATHOSTID_INTERVAL FUNCTION
• LMX_OPT_ALLOWCUSTOM_BORROW HOSTNAME
• LMX_OPT_CUSTOM_ALLOWSHARE_GRACESTRING 
• LMX_OPT_ALLOWCUSTOM_MULTIPLE_SERVERSUSERNAME
• LMX_OPT_TRIALEXACT_DAYSVERSION 
• LMX_OPT_HEARTBEAT_TRIALCALLBACK_USESVENDORDATA
• LMX_OPT_HEARTBEAT_TRIALCHECKOUT_TERMINALFAILURE_SERVERFUNCTION
• LMX_OPT_TRIALHEARTBEAT_CHECKOUT_VIRTUALSUCCESS_MACHINEFUNCTION
• LMX_OPT_HEARTBEAT_CONNECTION_HOSTIDLOST_ENABLED FUNCTION
• LMX_OPT_HEARTBEAT_HOSTIDEXIT_DISABLEDFUNCTION
• LMX_OPT_HOSTIDHEARTBEAT_RETRY_COMPAREFEATURE_FUNCTION
• LMX_OPT_HOSTID_CACHE_CLEANUP_INTERVAL
• LMX_OPT_CLIENTHOSTID_HOSTIDSCOMPARE_TO_SERVERFUNCTION
• LMX_OPT_CUSTOM_HOSTID_FUNCTIONDISABLED
• LMX_OPT_CUSTOMHOSTID_HOSTNAMEENABLED 

• LMX_OPT_HOSTID_

  CUSTOM

  ETHERNET_VIRTUAL_

  SHARE

  ADAPTER_

  STRING 

  FILTERING

• LMX_OPT_CUSTOMLICENSE_USERNAMEIDLE
• LMX_OPT_LICENSE_PATH 
• LMX_OPT_LICENSE_STRING
• LMX_OPT_RESERVATION_TOKEN
• LMX_OPT_SERVERSIDE_LICENSEREQUEST_IDLESTRING
• LMX_OPT_TRIAL_EXACTCLOUD_VERSION HOST
• LMX_OPT_BINDTRIAL_ADDRESSDAYS 
• LMX_OPT_TRIAL_TERMINAL_BLACKLISTSERVER
• LMX_OPT_RESERVATIONTRIAL_TOKENUSES
• LMX_OPT_SERVERSIDETRIAL_REQUESTVIRTUAL_STRINGMACHINE

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 SOAP API 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. For example:

Example

The following example shows the use of LMX_SetOption by activating and deactivating LMX_OPT_EXACT_VERSION.

#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 
   but and can haverequest a version higherup to versionthe inone licensespecified filein thanthe function.lic requestfile */
  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;
}