share/man/man3mpapi/MP_GetMultipathLus.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_GETMULTIPATHLUS 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetMultipathLus \- return a list of multipath logical units
  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_GetMultipathLus\fR(\fBMP_OID\fR \fIoid\fR, \fBMP_OID_LIST\fR \fI**ppList\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIoid\fR\fR
  24 .ad
  25 .RS 10n
  26 The object ID of the plugin or device product object.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIppList\fR\fR
  33 .ad
  34 .RS 10n
  35 A pointer to a pointer to an object ID that has type  \fBMP_OID_LIST\fR
  36 structure. With a successful return, this contains a pointer to an
  37 \fBMP_OID_LIST\fR that contains the object IDs of all the (multipath) logical
  38 units associated with the specified plugin object ID.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_GetMultipathLus()\fR function returns a list of multipath logical
  45 units associated to a plugin.
  46 .sp
  47 .LP
  48 When the caller is finished using the list it must free the memory used by the
  49 list by calling \fBMP_FreeOidList\fR.
  50 .SH RETURN VALUES
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 The \fIoid\fR does not specify any valid object type. This is most likely to
  59 happen if an uninitialized object ID is passed to the API.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 The \fIppList\fR is null or specifies a memory area that cannot be written, or
  70 when \fIoid\fR has a type subfield other than
  71 \fBMP_OBJECT_TYPE_DEVICE_PRODUCT\fR or \fBMP_OBJECT_TYPE_PLUG IN\fR.
  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_SUCCESS\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 The operation is successful.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBMP_STATUS_FAILED\fR\fR
  98 .ad
  99 .sp .6
 100 .RS 4n
 101 The plugin for the specified object ID  is not found.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 A memory allocation failure occurred.
 112 .RE
 113
 114 .SH ATTRIBUTES
 115 .sp
 116 .LP
 117 See \fBattributes\fR(5) for descriptions of the following attributes:
 118 .sp
 119
 120 .sp
 121 .TS
 122 box;
 123 c | c
 124 l | l .
 125 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 126 _
 127 Interface Stability     T{
 128 Standard: ANSI INCITS 412 Multipath Management API
 129 T}
 130 _
 131 MT-Level        Safe
 132 .TE
 133
 134 .SH SEE ALSO
 135 .sp
 136 .LP
 137 \fBlibMPAPI\fR(3LIB), \fBMP_GetMPLogicalUnitProperties\fR(3MPAPI),
 138 \fBattributes\fR(5)
 139 .sp
 140 .LP
 141 \fIMultipath Management API Version 1.0\fR