STMFGETLOGICALUNITLIST(3STMF) SCSI Target Mode Framework Library Functions
stmfGetLogicalUnitList - retrieve the list of logical units
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfGetLogicalUnitList(stmfGuidList **logicalUnitList);
logicalUnitList
A pointer to a pointer to an stmfGuidList
structure. On successful return, this will contain
a list of logical units in the system.
The stmfGetLogicalUnitList() function retrieves the list of logical
units. The caller should call stmfFreeMemory(3STMF) when this list is
no longer needed.
The following values are returned:
STMF_ERROR_NOMEM
The library was unable to allocate sufficient
memory for logicalUnitList.
STMF_STATUS_SUCCESS
The API call was successful.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
libstmf(3LIB), stmfFreeMemory(3STMF), attributes(7)
June 9, 2008 STMFGETLOGICALUNITLIST(3STMF)
NAME
stmfGetLogicalUnitList - retrieve the list of logical units
SYNOPSIS
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfGetLogicalUnitList(stmfGuidList **logicalUnitList);
PARAMETERS
logicalUnitList
A pointer to a pointer to an stmfGuidList
structure. On successful return, this will contain
a list of logical units in the system.
DESCRIPTION
The stmfGetLogicalUnitList() function retrieves the list of logical
units. 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 logicalUnitList.
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 STMFGETLOGICALUNITLIST(3STMF)