RtkGetLicenses

The function RtkGetLicenses retrieves information about all licenses installed on the system.

Syntax

BOOLEAN RtkGetLicenses(
	RTSSINST RtssInst,
	PULONG pErrorCode,
	PRT_LICENSE_INFO_W pResult,
	PULONG pLength
);

Parameters

RtssInst

An RTSSINST value returned from a call to RtkRtssAttach.

pErrorCode

A pointer to a location where additional error information may be returned. This location need not be defined; the user may pass a NULL value. If defined, this location is set to NULL if no error occurred. See Error Codes for information on the custom RTX error codes.

pResult

A pointer to a buffer of the RT_LICENSE_INFO_W structure that will be filled in. When NULL, the length parameter returns the number of buffer entries the customer needed to provide in the result parameter. Note that the caller must allocate enough array entries for the result parameter or the call will return with a status STATUS_BUFFER_TOO_SMALL.

pLength

A pointer to the number of license info array entries provided in the results parameter. If the length of the array is less than the required length, this value will be updated with the number of array elements required to hold all of the license information.

Return Values

Returns true if the function succeeds; false if the function fails.

Remarks

If the dongleSerialNumber string in the returned RT_LICENSE_INFO_W structure is empty, the product is licensed to the system, not to a dongle.

Requirements

Minimum Supported Version RTX 2016
Header Rtkapi.h
Library rtx_rtk.lib
IntervalZero.com | Support | Give Feedback