STMFGETPERSISTMETHOD(3STMF) SCSI Target Mode Framework Library Functions
stmfGetPersistMethod - get the current persistence method for stmf
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfGetPersistMethod(uint8_t *persistType, boolean_t serviceState);
persistType
On success, contains the current persistence setting
based on serviceState.
serviceState
When set to B_TRUE, persistType will contain the
persist method currently set for the service. When
set to B_FALSE, persistType will contain the persist
method for the current library open.
The stmfGetPersistMethod() function retrieves the current persistent
method setting for the service or for a given library open. When set
to B_TRUE, retrieves the setting from the service.
The following values are returned:
STMF_STATUS_SUCCESS
The API call was successful.
STMF_ERROR_PERSIST_TYPE
Unable to retrieve persist type from
service.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
libstmf(3LIB), attributes(7)
May 8, 2009 STMFGETPERSISTMETHOD(3STMF)
NAME
stmfGetPersistMethod - get the current persistence method for stmf
SYNOPSIS
cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>
int stmfGetPersistMethod(uint8_t *persistType, boolean_t serviceState);
PARAMETERS
persistType
On success, contains the current persistence setting
based on serviceState.
serviceState
When set to B_TRUE, persistType will contain the
persist method currently set for the service. When
set to B_FALSE, persistType will contain the persist
method for the current library open.
DESCRIPTION
The stmfGetPersistMethod() function retrieves the current persistent
method setting for the service or for a given library open. When set
to B_TRUE, retrieves the setting from the service.
RETURN VALUES
The following values are returned:
STMF_STATUS_SUCCESS
The API call was successful.
STMF_ERROR_PERSIST_TYPE
Unable to retrieve persist type from
service.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
SEE ALSO
libstmf(3LIB), attributes(7)
May 8, 2009 STMFGETPERSISTMETHOD(3STMF)