usr/src/man/man3mpapi/MP_GetTargetPortOidList.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_GETTARGETPORTOIDLIST 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetTargetPortOidList \- get a list of  target  port 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_GetTargetPortOidList\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 target port group.
  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 target
  39 ports associated with the specified target port group \fIoid\fR.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBMP_GetTargetPortOidList()\fR function returns a list of the object IDs
  46 of the target ports  in the specified target port group.
  47 .sp
  48 .LP
  49 When the caller is finished using the list it must free the memory used by the
  50 list by calling \fBMP_FreeOidList\fR.
  51 .SH RETURN VALUES
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 The \fIoid\fR does not specify any valid object type. This is most likely to
  60 happen if an uninitialized object ID is passed to the API.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  70 The \fIppList\fR is null or specifies a memory area to which data cannot be
  71 written, or when the \fIoid\fR has a type subfield other than
  72 \fBMP_OBJECT_TYPE_TARGET_PORT\fR.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 The \fIoid\fR owner ID or object sequence number  is invalid.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBMP_STATUS_SUCCESS\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 The operation is successful.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBMP_STATUS_FAILED\fR\fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 The target port group for the specified object ID is not found.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBMP_STATUS_INSUFFICIENT_MEMORY\fR\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 A memory allocation failure occurred.
 113 .RE
 114
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     T{
 129 Standard: ANSI INCITS 412 Multipath Management API
 130 T}
 131 _
 132 MT-Level        Safe
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBlibMPAPI\fR(3LIB), \fBMP_GetTargetPortProperties\fR(3MPAPI),
 139 \fBattributes\fR(5)
 140 .sp
 141 .LP
 142 \fIMultipath Management API Version 1.0\fR