Legacy: PmGetPluginAttributes routine

You are reading the documentation of YYToolkit Legacy (v2.x.x) - for documentation on current-gen YYTK, see the Homepage.

---

Retrieves an opaque pointer to attributes for a given YYTKPlugin.

Syntax

YYTKStatus PmGetPluginAttributes(
    YYTKPlugin* pObject,
    PluginAttributes_t* &outAttributes
);

Parameters

pObject

The plugin object whose attributes you want to query.

outAttributes

A reference to a PluginAttributes_t* object. You needn't keep a pointer to this object.

Return Value

The function returns YYTK_OK if the function succeeds and outAttributes is set.

The function returns YYTK_INVALIDARG if pObject isn't valid.

The function returns YYTK_NOT_FOUND if the plugin attributes aren't present in the internal list.