RtGetLicenseFeatureStatusEx

The function RtGetLicenseFeatureStatusEx obtains the status of the license for the product feature specified by parameter featureName. The status is written to the location pointed to by parameter status. If the RTX runtime feature license contains an options string, it is copied to the buffer pointed to by parameter options, which must be at least 64 characters long.

If the RTX runtime feature license does not contain an options string, the buffer pointed to by parameter options is unchanged.

NOTE: This function has been deprecated and will be removed in a future release.

Syntax

BOOL RtGetLicenseFeatureStatusEx(
	TCHAR *featureName,
	RtxFeatureLicenseStatus *status,
	TCHAR *options,
);

Parameters

featureName

Product code for your IntervalZero features. Below are common product codes for RTX:

Feature	Product Code
IZRTX	RTX Subsystem
IZTCP	RT-TCP/IP Stack
IZSDK	Software Development Kit (SDK)

status

Pointer to an instance of RtxFeatureLicenseStatus, which is defined as:

Feature	Description
STATUS_LICENSE_ERROR	An error occurred reading the license information
STATUS_LICENSE_VALID	Valid license exists for features
STATUS_LICENSE_VALID_EVALUATION	Valid time-limited license for feature
STATUS_LICENSE_INVALID	The license is invalid for a reason other than it has expired
STATUS_LICENSE_EXPIRED	License for the feature has expired

options

The syntax of the RTX runtime feature options string is a comma-separated list of name/value pairs, where the name and value are separated by an '=' with no surrounding whitespace, and the value is guaranteed never to contain a comma. The following names may be present in the options string:

Feature	Name
CID	The customer ID, which is an arbitrary string of characters uniquely identifying the customer who purchased the RTX runtime license.
PID	The OEM product ID, which is an arbitrary string of characters uniquely identifying the OEM product of which RTX is a component.

Return Values

Returns TRUE if successful. Returns FALSE if unsuccessful. If this function fails, the contents of the memory pointed to by parameters status and options is undefined.

Remarks

RtGetLicenseFeatureStatusEx will not map the RTX feature names from previous versions (rtx, sdk, tcp) to the new feature names in RTX 2016 (izrtx, izsdk, iztcp). As a result, applications that contain code to check for the previous feature names will need to be updated to include the new feature names.

Requirements

Minimum Supported Version	RTX 2012 Update 1
Header	Rtapi.h
Library	Rtx_Rtss.lib

| |