'\" te
.\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
.\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
.TH MP_GetAssociatedPathOidList 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions"
.SH NAME
MP_GetAssociatedPathOidList \- get a list of object IDs
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <mpapi.h>

\fBMP_STATUS\fR \fBMP_GetAssociatedPathOidList\fR(
     \fBMP_OID\fR \fIoid\fR, \fBMP_OID MP_OID_LIST\fR \fI**ppList\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIoid\fR\fR
.ad
.RS 10n
.rt  
The object ID of the multipath logical unit, initiator port, or target port.
.RE

.sp
.ne 2
.mk
.na
\fB\fIppList\fR\fR
.ad
.RS 10n
.rt  
A pointer to a pointer to an object ID that has type  \fBMP_OID_LIST\fR structure. With a successful return, this will contain a pointer to an object ID that has type \fBMP_OID_LIST\fR that contains the object IDs of all the paths associated with the specified (multipath) logical unit, initiator port, or  target port \fIoid\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBMP_GetAssociatedPathOidList()\fR function gets a list of oid object IDs for all the path logica l units associated with the specified multipath logical unit , initiator port, or target port.
.sp
.LP
Returns a list of  object IDs for all the path logical units associated with the specified mult ipath logical unit, initiator port, or target port.
.sp
.LP
When the caller is finished using the list it must free the memory used by the list by calling \fBMP_FreeOidList\fR.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
.ad
.sp .6
.RS 4n
The \fIppList\fR is null or specifies a memory area to that the data cannot be written or when the \fIoid\fR has a type subfield other than \fBMP_OBJECT_TYPE_MULTI PATH_LU\fR, \fBMP_OBJECT_TYPE_INITIATOR_PORT\fR, or \fBMP_OBJECT_TYPE_TARGET_PORT\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
.ad
.sp .6
.RS 4n
The \fIoid\fR does not specify any valid object type. This is most likely to happen if an uninitialized object ID is passed to the API.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
The \fIoid\fR owner ID or object sequence number is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The operation is successful.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
_
StandardANSI INCITS 412 Multipath Management API
.TE

.SH SEE ALSO
.sp
.LP
\fBlibMPAPI\fR(3LIB), \fBMP_GetPathLogicalUnitProperties\fR(3MPAPI), \fBattributes\fR(5)
.sp
.LP
\fIMultipath Management API Version 1.0\fR