usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceOidList.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_GETPROPRIETARYLOADBALANCEOIDLIST 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetProprietaryLoadBalanceOidList \- get a list of object IDs
  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_GetProprietaryLoadBalanceOidList\fR(\fBMP_OID\fR \fIoid\fR
  17      \fBMP_OID_LIST\fR \fI**ppList\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIoid\fR\fR
  25 .ad
  26 .RS 10n
  27 The object ID of the plugin.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIppList\fR\fR
  34 .ad
  35 .RS 10n
  36 A pointer to a pointer to an object ID that has type \fBMP_OID_LIST\fR
  37 structure. With a successful return, this contains a pointer to an object ID
  38 that has type \fBMP_OID_LIST\fR that contains the object IDs of all the
  39 proprietary load balance types associated with the specified plugin.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBMP_GetProprietaryLoadBalanceOidList()\fR function returns a list of the
  46 object IDs of all the proprietary load balance algorithms associated with this
  47 plugin.
  48 .sp
  49 .LP
  50 When the caller is finished using the list, it must free the memory used by the
  51 list by calling \fBMP_FreeOidList\fR.
  52 .SH RETURN VALUES
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  57 .ad
  58 .sp .6
  59 .RS 4n
  60 The \fIoid\fR does not specify any valid object type. This is most likely to
  61 happen if an uninitialized object ID is passed to the API.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 The \fIppList\fR in null or specifies a memory area to which data cannot be
  72 written, or if the \fIoid\fR has a type subfield other than
  73 \fBMP_OBJECT_TYPE_PLUGIN\fR.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 The \fIoid\fR owner ID or object sequence number is invalid.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBMP_STATUS_SUCCESS\fR\fR
  90 .ad
  91 .sp .6
  92 .RS 4n
  93 The operation is successful.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBMP_STATUS_FAILED\fR\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 The plugin for the specified object ID  is not found.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR
 110 .ad
 111 .sp .6
 112 .RS 4n
 113 A memory allocation failure occurred.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 120 .ad
 121 .sp .6
 122 .RS 4n
 123 The implementation does not support the API.
 124 .RE
 125
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Interface Stability     T{
 140 Standard: ANSI INCITS 412 Multipath Management API
 141 T}
 142 _
 143 MT-Level        Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceProperties\fR(3MPAPI),
 150 \fBattributes\fR(5)
 151 .sp
 152 .LP
 153 \fIMultipath Management API Version 1.0\fR