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