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