share/man/man3stmf/stmfGetTargetGroupMembers.3stmf

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH STMFGETTARGETGROUPMEMBERS 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfGetTargetGroupMembers \- retrieve the properties of the specified target
   9 port group
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  14 #include <libstmf.h>
  15
  16 \fBint\fR \fBstmfGetTargetGroupMembers\fR(\fBstmfGroupName *\fR\fItargetGroupName\fR,
  17      \fBstmfGroupProperties **\fR\fIgroupProperties\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fItargetGroupName\fR\fR
  25 .ad
  26 .RS 19n
  27 The name of the target port group whose member list is being retrieved.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIgroupProperties\fR\fR
  34 .ad
  35 .RS 19n
  36 A pointer to a pointer to an \fBstmfGroupProperties\fR structure. On successful
  37 return, this will contain the properties for the specified
  38 \fItargetGroupName\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBstmfGetTargetGroupMembers()\fR function retrieves the properties of the
  45 specified target port group. The caller should call \fBstmfFreeMemory\fR(3STMF)
  46 when this list is no longer needed.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 The following values are returned:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  55 .ad
  56 .RS 24n
  57 The specified \fItargetGroupName\fR was not found in the system.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  64 .ad
  65 .RS 24n
  66 The API call was successful.
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Committed
  83 _
  84 MT-Level        Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBlibstmf\fR(3LIB), \fBstmfFreeMemory\fR(3STMF), \fBattributes\fR(5)