Skip to content

QueryInterface

Navigation: ADLX SDK ReferencesADLX InterfacesSystemIADLXSystem

Syntax

ADLX_RESULT    QueryInterface (const wchar_t* interfaceId, void** ppInterface)

Parameters

#DirectionNameTypeDescription
1.[in]interfaceIdconst wchar_t*The identifier of the interface being requested.
#DirectionNameTypeDescription
---------------
2.[out]ppInterfacevoid**The address of a pointer to the returned interface. If the interface is not successfully returned, the method sets the dereferenced address *ppInterface to nullptr.

Return Value

If the interface is successfully returned, ADLX_OK is returned.

If the interface 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 a smart pointer for the returned interface there is no need to call Release because the smart pointer calls it internally.

Requirements

Headerinclude “ISystem.h”
Minimum version1.0

See Also: Release, IADLXSystem, ADLX Enums