summaryrefslogtreecommitdiff
path: root/usr/src/man/man3stmf/stmfRemoveFromTargetGroup.3stmf
blob: 7270e7b08bd4e7066b623c7b18dc1f97510048d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
'\" te
.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
.\" 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.
.\"  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
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH STMFREMOVEFROMTARGETGROUP 3STMF "Jun 15, 2009"
.SH NAME
stmfRemoveFromTargetGroup \- remove a target port from an target port group
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

\fBint\fR \fBstmfRemoveFromTargetGroup\fR(\fBstmfGroupName *\fR\fItargetGroupName\fR
     \fBstmfDevid *\fR\fItargetName\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fItargetGroupName\fR\fR
.ad
.RS 19n
The name of the target  port group from which the specified
\fItargetGroupName\fR is being removed.
.RE

.sp
.ne 2
.na
\fB\fItargetName\fR\fR
.ad
.RS 19n
The device identifier of the target port to remove from the specified target
port group.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfRemoveFromTargetGroup()\fR function removes a target port from an
target port group.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.na
\fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
The specified \fItargetGroupName\fR was not found in the system.
.RE

.sp
.ne 2
.na
\fB\fBSTMF_ERROR_MEMBER_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
The specified \fItargetName\fR was not found in the system.
.RE

.sp
.ne 2
.na
\fB\fBSTMF_ERROR_TG_ONLINE\fR\fR
.ad
.sp .6
.RS 4n
The specified \fItargetName\fR must be offline.
.RE

.sp
.ne 2
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The API call was successful.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibstmf\fR(3LIB), \fBattributes\fR(5)