API: ObGetInterface

Retrieves a pointer to an already-created interface.

Syntax

AurieStatus ObGetInterface(
    [in]  const char*          InterfaceName,
    [out] AurieInterfaceBase*& Interface
);

Parameters

InterfaceName

The unique name of the interface which to fetch. The interface lookup is case-insensitive, therefore accessing interface ABC is the same as interface Abc.

Interface

A reference to a pointer-sized buffer, into which a pointer to the interface instance is written. The pointer returned by this function is guaranteed to remain valid until the interface is destroyed by its owner or the framework itself.

Return Value

The function returns AURIE_SUCCESS on success, otherwise returns a matching error code. If the interface doesn't exist, the function returns AURIE_OBJECT_NOT_FOUND.