MP_GETPLUGINPROPERTIES(3MPAPI) Common Multipath Management Library Functions


NAME


MP_GetPluginProperties - get specified plugin properties

SYNOPSIS


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

MP_STATUS MP_GetPluginProperties(MP_OID oid,
MP_PLUGIN_PROPERTIES *pProps);


PARAMETERS


oid
The object ID of the plugin.


pProps
A pointer to an object ID that has type MP_PLUGIN_PR OPERTIES
structure allocated by the caller. With a successful return,
this structure contains the properties of the plugin specified
by oid.


DESCRIPTION


The MP_GetPluginProperties() function gets the properties of the
specified plugin.

RETURN VALUES


MP_STATUS_INVALID_PARAMETER

The pProps is null or specifies a memory area to which data cannot be
written, or the oid has a type subfield other than
MP_OBJECT_TYPE_PLUGIN.


MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify any valid object type. This is most likely
to happen if an uninitialized object ID is passed to the API.


MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.


ATTRIBUTES


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


+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: ANSI INCITS 412 |
| | Multipath Management API |
+--------------------+---------------------------+
|MT-Level | Safe |
+--------------------+---------------------------+

SEE ALSO


libMPAPI(3LIB), MP_GetProprietaryLoadBalanceProperties(3MPAPI),
MP_GetPluginOidList(3MPAPI), attributes(5)


Multipath Management API Version 1.0


February 15, 2006 MP_GETPLUGINPROPERTIES(3MPAPI)