MP_GetPluginOidList

- get a list of the object IDs

Synopsis

cc [ flag… ] file… -lMPAPI [ library… ]
#include <mpapi.h>

MP_STATUS MP_GetPluginOidList(MP_OID_LIST **ppList);

Parameters

ppList

A pointer to a pointer to an object ID that has type MP_OID_LIST. With a successful return, this contains a pointer to an object ID that has type MP_OID_LIST that contains the object IDs of all of the plugins currently loaded by the library.

Description

The MP_GetPluginOidList() function returns a list of the object IDs of all currently loaded plugins. The returned list is guaranteed to not contain any duplicate entries.

When the caller is finished using the list it must free the memory used by the list by calling MP_FreeOidList(3MPAPI).

Return Values

MP_STATUS_INVALID_PARAMETER

The ppList is null or specifies a memory area to which data cannot be written.

MP_STATUS_SUCCESS

The operation is successful.

MP_STATUS_FAILED

The plugin for the specified object ID is not found.

MP_STATUS_INSUFFICIENT_MEMORY

A memory allocation failure occurred.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

libMPAPI(3LIB), MP_FreeOidList(3MPAPI), MP_GetPluginProperties(3MPAPI), attributes(5)

Multipath Management API Version 1.0