Versions Compared

Key

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

The LAC_CreateLicenseRequest function will create a license request and generate a license.

Prototype

LAC_STATUS LAC_CreateLicenseRequest
(
    const char *szActivationKey,
    const char *szHostid,
    const char *szUrl,
    const char *szProxyHostname,
    int nProxyPort,
    const char *szProxyUsername,
    const char *szProxyPassword,
    char *szResult
);

Parameters

szActivationKey

Wiki MarkupszActivationKey \[in\] Activation key (e.g. (for example, 9EFJK-TVJM0-MCDET-EZKXJ).

szHostid \

[in\] Hostid in the format ] A client-side HostID, in the format HostID_type=value (e.g. (for example, HOSTNAME=my_hostname) szUrl \[in\. To provide more than one HostID, use a comma-separated HostID list (HostID_type1=value1, HostID_type2=value2, etc.), from which LAC will select the first appropriate value. This value should be NULL if not relevant. See your license manager documentation for valid HostID types. (For LM-X License Manager, see the LM-X Developers Manual.)

When entering an Ethernet HostID, the format must be 12 hexadecimal characters with or without separators; for example, 48-2C-6A-1E-59-3D, 00:50:A7:B6-CC-1A or ABC82739BEFA. LM-X 16-character encrypted Ethernet HostIDs are no longer supported.

szUrl

[in] SOAP API endpoint URL. This value should be set to ] SOAP API endpoint url (it should be set to [http://license.x-formation.com/soap/type/enduser/version/2.

szProxyHostname

[in] An optional client-side proxy host to be used with a request. This value should be NULL if not relevant.

Note: This function will attempt to contact LAC directly if no proxy is specified, so if you have a firewall or router that redirects traffic, ensure your configuration handles this correctly.

nProxyPort

[in] An optional client-side proxy port number to be used with a request. This value should be 0 if not relevant.

szProxyUsername

[in] An optional client-side proxy username to be used with a request. This value should be NULL if not relevant.

szProxyPassword

[in] An optional client-side proxy password to be used with a request. This value should be NULL if not relevant.

szResult

[out] Pointer to a string that will hold the error message. The string length can be up to 1)|http://license.x-formation.com/soap/type/enduser/version/1%29] szProxyHostname \[in\] An optional client-side proxy host to be used with a request (should be NULL if not relevant). nProxyPort \[in\] An optional client-side proxy port number to be used with a request (should be 0 if not relevant). szProxyUsername \[in\] An optional client-side proxy username to be used with a request (should be NULL if not relevant). szProxyPassword \[in\] An optional client-side proxy password to be used with a request (should be NULL if not relevant). szResult \[out\] Pointer to a string that will hold the license or error message. The length of the string can be up to LAC_MAX_RESPONSE_LENGTH.

Return Values

On success, this function returns the status code LAC_SUCCESS. The license can then be retrieved using LAC_GetLicense.

On failure, functions return one of the error codes form LAC_STATUS enum and a proper error message.The special case is gSoap error. The returned value will be in range of 899-999 and is equivalent to gSoap error code with added LAC_SOAP_BASE = 900.
There is no error message then, and most popular gSoap errors are specified within LAC_STATUS enumthis function returns an error code in the format described in SOAP API return codes.