RtGetLicenses retrieves information about all licenses available on the system.
Syntax
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 | 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. |
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) |
See Also:
