At

Returns the reference counted interface at the requested location.

Syntax

Copied!

ADLX_RESULT     At (const adlx_uint location, IADLXDesktop ** ppItem)

Parameters

  1. [in] location const adlx_uint The location of the requested interface.

  2. [out] ppItem IADLXDesktop ** The address of a pointer to the returned interface. If the interface is not successfully returned then the method sets the dereferenced address *ppItem to nullptr.

Return Value

If the location is within the list bounds, ADLX_OK is returned.

If the location is not within the list bounds, 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