STMFGETHOSTGROUPLIST(3STMF) SCSI Target Mode Framework Library Functions

NAME

stmfGetHostGroupList - retrieve the list of host groups

SYNOPSIS

cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>

int stmfGetInitiatorGroupList(stmfGroupList **hostGroupList);

PARAMETERS

hostGroupList
A pointer to a pointer to an stmfGroupList
structure. On successful return, this will contain a
list of host groups.

DESCRIPTION

The stmfGetInitiatorGroupList() function retrieves the list of host
groups. The caller should call stmfFreeMemory(3STMF) when this list
is no longer needed.

RETURN VALUES

The following values are returned:

STMF_ERROR_NOMEM
The library was unable to allocate sufficient
memory for hostGroupList.


STMF_STATUS_SUCCESS
The API call was successful.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+

SEE ALSO

libstmf(3LIB), stmfFreeMemory(3STMF), attributes(7)

June 9, 2008 STMFGETHOSTGROUPLIST(3STMF)