| Current File : //usr/man/man3stmf/stmfRemoveFromTargetGroup.3stmf |
'\" te
.\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
.TH stmfRemoveFromTargetGroup 3STMF "15 Jun 2009" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.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
.mk
.na
\fB\fItargetGroupName\fR\fR
.ad
.RS 19n
.rt
The name of the target port group from which the specified \fItargetGroupName\fR is being removed.
.RE
.sp
.ne 2
.mk
.na
\fB\fItargetName\fR\fR
.ad
.RS 19n
.rt
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
.mk
.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
.mk
.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
.mk
.na
\fB\fBSTMF_ERROR_TG_ONLINE\fR\fR
.ad
.sp .6
.RS 4n
The specified \fItargetName\fR must be offline.
.RE
.sp
.ne 2
.mk
.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
tab() box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE
.SH SEE ALSO
.sp
.LP
\fBlibstmf\fR(3LIB), \fBattributes\fR(5)