GetDisplays

Gets the reference counted list of displays that show pixels from a desktop.

Syntax

Copied!

ADLX_RESULT     GetDisplays (IADLXDisplayList ** ppDisplays)

Parameters

  1. [out] ppDisplays IADLXDisplayList ** The address of a pointer to the returned interface. If the interface is not successfully returned, the method sets the dereferenced address *ppDisplays to nullptr.

Return Value

If the list of displays is successfully returned, ADLX_OK is returned.

If the list of displays is not successfully returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Remarks

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