RT_LICENSE_INFO Structure

RT_LICENSE_INFO is a structure that specifies data for the function RtGetLicenses and RtkGetLicenses.

Syntax

Copy

typedef struct _RT_LICENSE_INFO {
    int size;
    int structureVersion;
    TCHAR featureName [RT_MAX_FEATURE_NAME_LENGTH];
    DWORD majorVersion;
    RT_FEATURE_LICENSE_STATUS status;
    int hasExpirationDate;
    RT_LICENSE_EXPIRATION_DATE expirationDate;
    RT_LICENSE_ISSUE_DATE issueDate;
    TCHAR hostId[HOST_ID_MAX_LENGTH];
    TCHAR dongleSerialNumber[DONGLE_ID_MAX_LENGTH];
    RT_LICENSE_OPTIONS options;
} RT_LICENSE_INFO, *PRT_LICENSE_INFO;

Fields

size

The size of the structure. Client code must set this field to sizeof(RT_LICENSE_INFO) for every instance of RT_LICENSE_INFO.

structureVersion

The version of the structure. This should always equal 1. Note that if your application sees an unexpected value in this field (i.e., not 1), application cannot trust the data in any other field, nor can it trust that the structure size is the same as when the application was compiled.

featureName

The name of the licensed feature.

Product code	Description
WBLD64	Allows you to build applications. This feature does not include debugging tools.
WECR64	wRTOS E-CAT Cable Redundancy allows for the EtherCAT MainDevice to support Cable Redundancy.
WEHC64	wRTOS E-CAT Hot Connect allows the EtherCAT MainDevice to support Hot Connect.
WEHST64	wRTOS E-CAT High Speed Timer allows the EtherCAT MainDevice to use a High-Speed Timer.
WEMM64	wRTOS E-CAT Multiple MainDevices supports running multiple EtherCAT MainDevices. These require the wRTOS Fieldbus (WFBS64) component package.
WFBS64	wRTOS Fieldbus supports the use of the EtherCAT MainDevice and future fieldbuses.
WNET64	wRTOS Basic Networking supports the use of TCP/IP Stack applications above the NL2.
WRTOS64	wRTOS Runtime includes the Real-time Subsystem and Network Link Layer (NL2), Network Relay, and Virtual Network. See Runtime Editions for a list of the wRTOS Runtime editions and the maximum number of Real-Time Subsystem (RTSS) cores they support.
WSDK64	wRTOS Software Development Kit (SDK) is used to develop, build, and debug applications.
WVIS64	wRTOS GigE Vision allows the use of GigE and GeniCam drivers. This component also requires the wRTOS Basic Networking (WNET64) component package.

majorVersion

The major version of the licensed feature.

Licensed feature	majorVersion value
wRTOS 1.x	1

RT_FEATURE_LICENSE_STATUS status

The license status. Listed below are the possible status enumerators:

Status code	Description
RT_FEATURE_STATUS_NOT_FOUND = 0	License entry not found.
RT_FEATURE_STATUS_FORMAT_ERROR	The license entry is found but is in an invalid format.
RT_FEATURE_STATUS_RETAIL_VALID	The license is a valid retail license (with or without an expiration date).
RT_FEATURE_STATUS_RETAIL_EXPIRED	The license is an expired retail license.
RT_FEATURE_STATUS_INVALID	The license is invalid for a reason other than expiration.
RT_FEATURE_STATUS_EVAL_VALID	The license entry found is a valid Evaluation license.
RT_FEATURE_STATUS_EVAL_EXPIRED	The license entry found is an expired Evaluation license.
RT_FEATURE_STATUS_EVAL_INVALID_HOST_ID	The license is a dongle-based evaluation license for which the host ID is not on the system.
RT_FEATURE_STATUS_RETAIL_INVALID_HOST_ID	The license is a dongle-based retail license for which the host ID is not on the system.

hasExpirationDate

Specifies whether the license has an expiration date. This field is non-zero if this license has an expiration date, otherwise it is zero.

expirationDate

The expiration date of the license if it has one. Otherwise, this field is undefined. Use field hasExpirationDate to determine if this license has an expiration date. The expiration date of the license. See RT_LICENSE_EXPIRATION_DATE for information on this structure.

issueDate

The issue date of the license. See RT_LICENSE_ISSUE_DATE for information on this structure.

HostId

The Host ID of the license.

dongleSerialNumber

The serial number of the dongle the license is node-locked against. An empty string indicates the feature is licensed to the system hard disk, not to a dongle.

options

License-specific options. See RT_LICENSE_OPTIONS for information on this structure.

Remarks

For all APIs that receive an instance of RT_LICENSE_INFO:

If the client's structure is smaller than in the current Runtime, the API does not access members that do not exist in the client's instance.
If the client's structure is larger than in the current Runtime, the API does not access members that do not exist in the current Runtime.

Requirements

Minimum supported version	Header
wRTOS 1.0 SDK	RtLicensing.h