share/man/man3mpapi/MP_GetTargetPortGroupProperties.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_GETTARGETPORTGROUPPROPERTIES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_GetTargetPortGroupProperties \- return properties of the target port group
  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_GetTargetPortGroupProperties\fR(\fBMP_OID\fR \fIoid\fR,
  17      \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR \fI*pProps\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\fIpProps\fR\fR
  34 .ad
  35 .RS 10n
  36 A pointer to an object ID that has type \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR
  37 structure allocated by the caller. With a successful return, this structure
  38 contains the properties of the target port group specified by the \fIoid\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_GetTargetPortGroupProperties()\fR function returns the properties of
  45 the specified target port group.
  46 .SH RETURN VALUES
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 The \fIpProps\fR is null or specifies a memory area to which data cannot be
  55 written, or when the \fIoid\fR has a type subfield other than
  56 \fBMP_OBJECT_TYPE_TARGET_PORT_GROUP\fR.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 The \fIoid\fR does not specify a valid object type. This is most likely to
  67 happen if an uninitialized object ID is passed to the API.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 The \fIoid\fR owner ID or object sequence number  is invalid.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBMP_STATUS_SUCCESS\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 The operation is successful.
  88 .RE
  89
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     T{
 104 Standard: ANSI INCITS 412 Multipath Management API
 105 T}
 106 _
 107 MT-Level        Safe
 108 .TE
 109
 110 .SH SEE ALSO
 111 .sp
 112 .LP
 113 \fBlibMPAPI\fR(3LIB), \fBMP_GetAssociatedTPGOidList\fR(3MPAPI),
 114 \fBattributes\fR(5)
 115 .sp
 116 .LP
 117 \fIMultipath Management API Version 1.0\fR