RtfwGetwRTOSDevices

RtfwGetwRTOSDevices retrieves the properties of all devices owned by wRTOS.

Syntax

Copy

bool RtfwGetwRTOSDevices(
    [out]   PRTFW_DEVICEEX * ppwRTOSDevices,
    [out]   size_t * pCountDevices
);

Parameters

[out] ppwRTOSDevices

Points to a pointer that will be set to point to an array of RTFW_DEVICEEX structures dynamically allocated by this API, each representing one device owned by wRTOS at the time this function was called. If this value is NULL, the function fails and sets the last error value to ERROR_INVALID_PARAMETER.

[out] pCountDevices

Points to a value that will be set by this API to the size of the array returned via parameter ppwRTOSDevices. This value cannot be NULL.

Return Value

If the function succeeds, it returns TRUE and sets the value pointed to by pCountDevices to the number of elements of the array that contain valid device data. If the function fails, it returns FALSE, sets the last error value, and leaves both out parameters undefined. Call GetLastError to obtain an error code.

Remarks

If the Subsystem is running when the RtfwGetwRTOSDevices API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib