'\" te
.\" Copyright (c) 2008, 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 STMFREMOVEFROMHOSTGROUP 3STMF "Jun 9, 2008"
.SH NAME
stmfRemoveFromHostGroup \- remove an initiator port from an host group
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

\fBint\fR \fBstmfRemoveFromHostGroup\fR(\fBstmfGroupName *\fR\fIhostGroupName\fR
     \fBstmfDevid *\fR\fIinitiatorPortName\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIhostGroupName\fR\fR
.ad
.RS 21n
The name of the host group from which the specified \fIhostGroupName\fR is
being removed.
.RE

.sp
.ne 2
.na
\fB\fIinitiatorPortName\fR\fR
.ad
.RS 21n
The device identifier of the initiator port to remove from the specified host
group.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfRemoveFromHostGroup()\fR function removes an initiator port from an
host 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 \fIhostGroupName\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 \fIinitiatorPortName\fR was not found in the system.
.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(7) 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
.BR libstmf (3LIB),
.BR attributes (7)