'\" te
.\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
.TH stmfAddToHostGroupList 3STMF "23 Apr 2012" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.SH NAME
stmfAddToHostGroupList \- add an initiator port to a list of existing host groups
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

int stmfAddToHostGroupList(stmfGroupList *\fIhostGroupList\fR,
      stmfDevid *\fIinitiatorName\fR, void **\fIerrData\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIhostGroupList\fR\fR
.ad
.RS 17n
.rt  
The host group list to which the specified \fIinitiatorName\fR is to be added.
.RE

.sp
.ne 2
.mk
.na
\fB\fIinitiatorName\fR\fR
.ad
.RS 17n
.rt  
The device identifier of the initiator port to be added to the specified host group.
.RE

.sp
.ne 2
.mk
.na
\fB\fIerrData\fR\fR
.ad
.RS 17n
.rt  
A pointer to a pointer to \fBvoid\fR. On failure, this may contain appropriate information depending on the error value returned. For Some types of failure it is set to \fINULL\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfAddToHostGroupList()\fR function adds an initiator port to a list of host groups. The host groups mentioned in the list should already exist in the system.
.sp
.LP
If any one of the given host groups in the list fails the system validity checks or if adding the specified initiator to any of the host groups causes conflict, the initiator will not be added to any of the host groups. Depending on the type of error, the parameter \fIerrData\fR may get populated with the details of the error that caused the failure. The caller should call \fBstmfFreeMemory\fR(3STMF) when that data are no longer needed.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_MEMBER_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
The specified \fIinitiatorName\fR is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
One or more specified host group names mentioned in the \fIhostGroupList\fR is invalid. This failure also populates \fIerrData\fR with a pointer to a pointer to a \fBstmfGroupList\fR structure with the invalid host groups information.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_EXISTS\fR\fR
.ad
.sp .6
.RS 4n
One or more specified host group names mentioned in the \fIhostGroupList\fR is not found in the system. This failure also populates \fIerrData\fR with a pointer to a pointer to a \fBstmfGroupList\fR structure with information about the host groups that caused the error.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_VE_CONFLICT\fR\fR
.ad
.sp .6
.RS 4n
The specified \fIinitiatorName\fR could not be added to the \fIhostGroupsList\fR because such addition would cause unresolvable conflicts with existing view entries in the system. This failure also populates \fIerrData\fR with a pointer to a pointer to a \fBstmfViewList\fR structure with a list of views that caused the conflict.
.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), \fBstmfFreeMemory\fR(3STMF), \fBattributes\fR(5)