RtkGetLicenses

The function RtkGetLicenses retrieves information about all licenses installed on the system. It can only be used in RTK drivers. It cannot be used in Windows or RTSS applications.

Syntax

NTSTATUS RtkGetLicenses(
	PRT_LICENSE_INFO result,
	PULONG 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 the call will return STATUS_BUFFER_TOO_SMALL.

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 an error code:

Error Code	Description
STATUS_SUCCESS	The call has succeeded
STATUS_INTERNAL_ERROR	The call failed with an internal system error
STATUS_INVALID_PARAMETER	An invalid <length> parameter was passed, or one of the required pointer parameters was NULL
STATUS_BUFFER_TOO_SMALL	The passed buffer length is too small
STATUS_DRIVER_INTERNAL_ERROR	The call failed with an internal driver error

Remarks

If the dongleSerialNumber string in any returned RT_LICENSE_INFO structure is empty, the corresponding product feature (e.g., SDK64, TCP64, etc.) is licensed to the system, not to a dongle.

Requirements

Minimum Supported Version	RTX64 2014 with Service Pack 2
Header	RtkApi.h
Library	RtkApi.lib