usr/src/man/man3mpapi/MP_GetProprietaryLoadBalanceProperties.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_GETPROPRIETARYLOADBALANCEPROPERTIES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetProprietaryLoadBalanceProperties \- get load balance 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_GetProprietaryLoadBalanceProperties\fR(\fBMP_OID\fR \fIoid\fR,
  17      \fBMP_PROPRIETARY_LOAD_BALANCE_PROPERTIES\fR \fI*pProps\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 proprietary load balance.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIpProps\fR\fR
  34 .ad
  35 .RS 10n
  36 A pointer to an object ID that has type
  37 \fBMP_PROPRIETARY_LOAD_BALANCE_PROPERTIES\fR structure allocated by the caller.
  38 With a successful return, this structure contains the properties of the
  39 proprietary load balance algorithm specified by the \fIoid\fR.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBMP_GetProprietaryLoadBalanceProperties()\fR function returns the
  46 properties of the specified load balance.
  47 .SH RETURN VALUES
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 The \fIpObjectType\fR is null or specifies a memory area to which data cannot
  56 be written, or when the \fIoid\fR has a type subfield other than
  57 \fBMP_OBJECT_TYPE_PROPRIETARY_LOAD_BALANCE\fR.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The \fIoid\fR does not specify any valid object type. This is most likely to
  68 happen if an uninitialized object ID is passed to the API.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 The \fIoid\fR owner ID or object sequence number is invalid.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBMP_STATUS_SUCCESS\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The operation is successful.
  89 .RE
  90
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     T{
 105 Standard: ANSI INCITS 412 Multipath Management API
 106 T}
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBlibMPAPI\fR(3LIB), \fBMP_GetProprietaryLoadBalanceOidList\fR(3MPAPI),
 115 \fBattributes\fR(5)
 116 .sp
 117 .LP
 118 \fIMultipath Management API Version 1.0\fR