RtGetLicenses

The function RtGetLicenses retrieves information about all licenses available on the system.

Syntax

BOOL RtGetLicenses(
	PRT_LICENSE_INFO result,
	PDWORD length
);

Parameters

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.

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 of the entries, this value will be updated with the number of array elements required to hold all of the license information. When there is enough space, this value is updated with the number of license entries written into the array.

Return Value

Returns TRUE if successful. Returns FALSE if unsuccessful. Call GetLastError to get extended error information if the call fails. The RTX64-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 RTX64:

Product Code	Description
RTX64	RTX64 Subsystem
TCP64	RT-TCP/IP Stack
SDK64	Software Development Kit (SDK)
BLD64	Rebuild support

Requirements

Minimum Supported Version	RTX64 2014 with Service Pack 2
Header	Rtapi.h
Library	RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)