RtGetLicenses

RtGetLicenses retrieves information about all licenses available on the system.

Syntax

Copy

BOOL RtGetLicenses(
    [out]   PRT_LICENSE_INFO result,
    [in]    PDWORD length
);

Parameters

[out] result

A pointer to an array of RT_LICENSE_INFO structures that will be filled in. Note that the caller must allocate enough array entries for the result parameter or RtGetLicenses will return FALSE and GetLastError will return with status ERROR_INSUFFICIENT_BUFFER.

[in] length

A pointer to the number of license info array entries provided in the result parameter. When there is not enough space in the array to hold all the entries, this value will be updated with the number of array elements required to hold all the license information. When there is enough space, this value is updated with the number of license entries written into the array.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code. The wRTOS-specific error codes are listed in the topic Error Codes.

Remarks

If the dongleSerialNumber string in any returned RT_LICENSE_INFO structure is empty, the corresponding product feature is licensed to the system hard disk, not to a dongle. The table below lists the common product codes and corresponding features for wRTOS:

Product code	Name	Description
WRTOS64	MaxRT wRTOS Runtime	Allows you to use the wRTOS Subsystem, Network Link Layer (NL2), Network Relay, and Virtual Network.
WNET64	MaxRT wRTOS Network	Allows you to use TCP/IP Stack applications above the NL2.
WVIS64	MaxRT wRTOS Vision	Allows you to use GigE and GeniCam features with the TCP/IP Stack. Note: You must also have a WNET64 license to use Vision.
WBLD64	MaxRT wRTOS Build Support	Allows you to build applications developed with the SDK. The feature does not include debugging.
WSDK64	MaxRT wRTOS Software Development Kit	Allows you to develop, build, and debug applications.
WFBS64	MaxRT wRTOS Fieldbus	Allows you to use available Fieldbuses (EtherCAT, other).
WFA64	MaxRT wRTOS Fieldbus Axis	Allows you to use axes for Fieldbus motion (see WFM64): Level 1 supports up to 8 axes. Level 2 supports up to 16 axes. Level 3 supports up to 32 axes. Level 4 supports unlimited axes.
WFM64	MaxRT wRTOS Fieldbus Motion	Allows you to use a Fieldbus motion package: Point to Point (PTP) Motion Synchronization Motion (includes PTP) Blending Motion (includes PTP and Synchronization) Kinematics Motion (includes PTP, Synchronization, and Blending) Note: Each motion package requires the Fieldbus package (WFBS64) and a Fieldbus Axis package (WFA64).
WEMM64	MaxRT wRTOS E-CAT Multiple MainDevices	Allows you to run multiple EtherCAT MainDevices. Note: This license also requires the WFB64 license.
WEHST64	MaxRT wRTOS E-CAT High Speed Timer	Allows the EtherCAT MainDevice to use a high-speed timer. Note: This license also requires the WFB64 license.
WEHC64	MaxRT wRTOS E-CAT Hot Connect	Allows the EtherCAT MainDevice to support Hot Connect. Note: This license also requires the WFB64 license.
WECR64	MaxRT wRTOS E-CAT Cable Redundancy	Allows the EtherCAT MainDevice to support Cable Redundancy. Note: This license also requires the WFB64 license.

Client code must set the Size field in structure RT_LICENSE_INFO to sizeof(RT_LICENSE_INFO) for every instance of RT_LICENSE_INFO.

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	Library
wRTOS 1.0 SDK	RtApi.h	RtApi.lib (Windows), Startup.lib (RTSS)