Current File : //usr/share/man/man3mpapi/MP_GetTargetPortProperties.3mpapi

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

\fBMP_STATUS\fR \fBMP_GetTargetPortProperties\fR(\fBMP_OID\fR \fIoid\fR,
     \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR \fI*pProps\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIoid\fR\fR
.ad
.RS 10n
.rt  
The object ID of the target port group.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpProps\fR\fR
.ad
.RS 10n
.rt  
A pointer to an object ID that has type \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR structure allocated by the caller. With a successful return, this structure contains the properties of the target port group specified by the \fIoid\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBMP_GetTargetPortProperties()\fR function returns the properties of the specified target port.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
.ad
.sp .6
.RS 4n
The \fIpProps\fR is null or specifies a memory area to which data cannot be written or when the \fIoid\fR has a type subfield other than \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_GetTargetPortOidList\fR(3MPAPI), \fBattributes\fR(5)
.sp
.LP
\fIMultipath Management API Version 1.0\fR