usr/src/man/man3stmf/stmfRemoveFromTargetGroup.3stmf

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STMFREMOVEFROMTARGETGROUP 3STMF "Jun 15, 2009"
   7 .SH NAME
   8 stmfRemoveFromTargetGroup \- remove a target port from an target port 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 \fBstmfRemoveFromTargetGroup\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 from which the specified
  27 \fItargetGroupName\fR is being removed.
  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 remove from the specified target
  37 port group.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBstmfRemoveFromTargetGroup()\fR function removes a target port from an
  44 target port group.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The following values are returned:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
  53 .ad
  54 .sp .6
  55 .RS 4n
  56 The specified \fItargetGroupName\fR was not found in the system.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBSTMF_ERROR_MEMBER_NOT_FOUND\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 The specified \fItargetName\fR was not found in the system.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBSTMF_ERROR_TG_ONLINE\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 The specified \fItargetName\fR must be offline.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 The API call was successful.
  87 .RE
  88
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Committed
 103 _
 104 MT-Level        Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)