RtGetDongles

The function RtGetDongles retrieves a list of the IntervalZero-provided dongles attached to the machine.

Syntax

BOOL RtGetDongles(
    [in]    TCHAR** dongleData,
    [out]   PDWORD length
);

Parameters

[in] dongleData

Pointer to an array of character pointers that point to buffers where unique identifying information about each dongle is written. Each buffer must be allocated by the caller and must be at least DONGLE_ID_MAX_LENGTH +1 in length. This parameter can be NULL. When NULL, the function will work but will not return unique identifying information about each dongle.

[out] length

Before the call, this represents the number of elements passed from the dongleData array. After the call, this represents the number of dongles found. This value cannot be NULL.

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

When the dongleData parameter is NULL and one or more dongles are discovered, RtGetDongles will fail and set last error to ERROR_INSUFFICIENT_BUFFER, though it will correctly set the length parameter to the number of dongles found.

Requirements