2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH MP_SETPROPRIETARYPROPERTIES 3MPAPI "Feb 15, 2006"
9 MP_SetProprietaryProperties \- set proprietary properties
13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
16 \fBMP_STATUS\fR \fBMP_SetProprietaryProperties\fR(\fBMP_OID\fR \fIoid\fR,
17 \fBMP_UINT32\fR \fIcount\fR, \fBMP_PROPRIETARY_PROPERTY\fR \fI*pPropertyList\fR);
27 The object ID representing an object ID that has type
28 \fBMP_LOAD_BALANCE_PROPIETARY_TYPE\fR, or \fBMP_PLUGIN_PROPERTIES\fR, or
29 \fBMP_MULTIPATH_LOGICAL_UNIT_PROPERTIES\fR instance.
38 The number of valid items in \fIpPropertyList\fR.
44 \fB\fIpPropertyList\fR\fR
47 A pointer to an array of property name/value pairs. This array must contain the
48 same number of elements as does \fIcount\fR.
54 The \fBMP_SetProprietaryProperties()\fR function sets proprietary properties in
55 supported object instances.
58 This API allows an application with a priori knowledge of proprietary plugin
59 capabilities to set proprietary properties. The \fIpPropertyList\fR is a list
60 of property name/value pairs. The property names shall be a subset of the
61 proprietary property names listed in the referenced object ID.
66 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
70 The \fIoid\fR does not specify a valid object type. This is most likely to
71 happen if an uninitialized object ID is passed to the API.
77 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
81 The \fIoid\fR owner ID or object sequence number is invalid.
87 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
91 The \fIpPropertyList\fR is null, or when one of the properties referenced in
92 the list is not associated with the specified object ID, or the \fIoid\fR has a
93 type subfield other than\fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR, or
94 \fBMP_OBJECT_TYPE_PLUGIN\fR, or \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
100 \fB\fBMP_STATUS_SUCCESS\fR\fR
104 The operation is successful.
110 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
114 The API is not supported.
120 See \fBattributes\fR(5) for descriptions of the following attributes:
128 ATTRIBUTE TYPE ATTRIBUTE VALUE
130 Interface Stability T{
131 Standard: ANSI INCITS 412 Multipath Management API
140 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
143 \fIMultipath Management API Version 1.0\fR