'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.TH stmfGetHostGroupMembers 3STMF "9 Jun 2008" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.SH NAME
stmfGetHostGroupMembers \- retrieve the properties of the specified host group
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
#include <libstmf.h>

\fBint\fR \fBstmfGetHostGroupMembers\fR(\fBstmfGroupName *\fR\fIhostGroupName\fR,
     \fBstmfGroupProperties **\fR\fIgroupProperties\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIhostGroupName\fR\fR
.ad
.RS 19n
.rt  
The name of the host group whose member list is being retrieved.
.RE

.sp
.ne 2
.mk
.na
\fB\fIgroupProperties\fR\fR
.ad
.RS 19n
.rt  
A pointer to a pointer to an \fBstmfGroupProperties\fR structure. On successful return, this will contain the properties for the specified \fIhostGroupName\fR.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfGetHostGroupMembers()\fR function retrieves the properties of the specified host group. The caller should call \fBstmfFreeMemory\fR(3STMF) when this list is no longer needed.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
.ad
.RS 24n
.rt  
The specified \fIhostGroupName\fR was not found in the system.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.RS 23n
.rt  
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
\fBstmfFreeMemory\fR(3STMF), \fBlibstmf\fR(3LIB), \fBattributes\fR(5)