MP_SETPROPRIETARYPROPERTIES(3MPAPI)
Common Multipath Management Library Functions


NAME


MP_SetProprietaryProperties - set proprietary properties

SYNOPSIS


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

MP_STATUS MP_SetProprietaryProperties(MP_OID oid,
MP_UINT32 count, MP_PROPRIETARY_PROPERTY *pPropertyList);


PARAMETERS


oid
The object ID representing an object ID that has type
MP_LOAD_BALANCE_PROPIETARY_TYPE, or
MP_PLUGIN_PROPERTIES, or
MP_MULTIPATH_LOGICAL_UNIT_PROPERTIES instance.


count
The number of valid items in pPropertyList.


pPropertyList
A pointer to an array of property name/value pairs. This
array must contain the same number of elements as does
count.


DESCRIPTION


The MP_SetProprietaryProperties() function sets proprietary properties in
supported object instances.


This API allows an application with a priori knowledge of proprietary
plugin capabilities to set proprietary properties. The pPropertyList is a
list of property name/value pairs. The property names shall be a subset
of the proprietary property names listed in the referenced object ID.

RETURN VALUES


MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify a 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_INVALID_PARAMETER

The pPropertyList is null, or when one of the properties referenced
in the list is not associated with the specified object ID, or the
oid has a type subfield other
thanMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE, or
MP_OBJECT_TYPE_PLUGIN, or MP_OBJECT_TYPE_MULTIPATH_LU.


MP_STATUS_SUCCESS

The operation is successful.


MP_STATUS_UNSUPPORTED

The API is not supported.


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), attributes(5)


Multipath Management API Version 1.0


February 15, 2006
MP_SETPROPRIETARYPROPERTIES(3MPAPI)