share/man/man3mpapi/MP_SetProprietaryProperties.3mpapi

   1 '\" te
   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"
   8 .SH NAME
   9 MP_SetProprietaryProperties \- set proprietary properties
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  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);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIoid\fR\fR
  25 .ad
  26 .RS 17n
  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.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIcount\fR\fR
  36 .ad
  37 .RS 17n
  38 The number of valid items in \fIpPropertyList\fR.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIpPropertyList\fR\fR
  45 .ad
  46 .RS 17n
  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.
  49 .RE
  50
  51 .SH DESCRIPTION
  52 .sp
  53 .LP
  54 The \fBMP_SetProprietaryProperties()\fR function sets proprietary properties in
  55 supported object instances.
  56 .sp
  57 .LP
  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.
  62 .SH RETURN VALUES
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  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.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 The \fIoid\fR owner ID or object sequence number is invalid.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  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.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBMP_STATUS_SUCCESS\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 The operation is successful.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 111 .ad
 112 .sp .6
 113 .RS 4n
 114 The API is not supported.
 115 .RE
 116
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 Interface Stability     T{
 131 Standard: ANSI INCITS 412 Multipath Management API
 132 T}
 133 _
 134 MT-Level        Safe
 135 .TE
 136
 137 .SH SEE ALSO
 138 .sp
 139 .LP
 140 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 141 .sp
 142 .LP
 143 \fIMultipath Management API Version 1.0\fR