man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: July 2014
 
 

stmfGetHostGroupList(3STMF)

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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See also

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