usr/src/man/man3stmf/stmfAddToTargetGroup.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 STMFADDTOTARGETGROUP 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfAddToTargetGroup \- add a target to an existing target group
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfAddToTargetGroup\fR(\fBstmfGroupName *\fR\fItargetGroupName\fR,
  16      \fBstmfDevid\fR \fItargetName\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fItargetGroupName\fR\fR
  24 .ad
  25 .RS 19n
  26 The name of the target port group to which the specified \fItargetName\fR is
  27 added.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fItargetName\fR\fR
  34 .ad
  35 .RS 19n
  36 The device identifier of the target port to add to the specified target group.
  37 .RE
  38
  39 .SH DESCRIPTION
  40 .sp
  41 .LP
  42 The \fBstmfAddToTargetGroup()\fR function adds a target to an existing target
  43 group.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The following values are returned:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSTMF_ERROR_EXISTS\fR\fR
  52 .ad
  53 .RS 30n
  54 The specified \fItargetName\fR already exists in this \fItagettGroupName\fR or
  55 in another target group in the system.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
  62 .ad
  63 .RS 30n
  64 The specified \fItargetGroupName\fR was not found in the system.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  71 .ad
  72 .RS 30n
  73 The API call was successful.
  74 .RE
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Committed
  90 _
  91 MT-Level        Safe
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)