GetDesktops
Navigation: ADLX SDK References → ADLX Interfaces → Desktop → IADLXDesktopServices
Syntax
ADLX_RESULT GetDesktops (IADLXDesktopList** ppDesktops)
Parameters
| # | Direction | Name | Type | Description |
|---|---|---|---|---|
| 1. | [out] | ppDesktops | IADLXDesktopList | The address of a pointer to the returned interface. If the interface is not successfully returned, the method sets the dereferenced address *ppDesktops to nullptr. |
Return Value
If the list of desktops is successfully returned, ADLX_OK is returned.
If the list of desktops is not successfully returned, an error code is returned.
Refer to ADLX_RESULT for success codes and error codes.
Remarks
For more information about the AMD GPUs, refer to ADLX GPU Support.
The returned interface must be discarded with Release when it is no longer needed.
Additional Info
In C++, when using ADLX interfaces as smart pointers, there is no need to call Release because smart pointers call it in their internal implementation.
Requirements
| Header | include “IDesktops.h” |
|---|---|
| Minimum version | 1.0 |
Related Pages
See Also: IADLXDesktopList, Release, Compatibility