stmfGetStmfProp

- retrieve default stmf properties for luns and targets

Synopsis

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

int stmfGetStmfProp(uint8_t propType, char *propVal, size_t *propLen);

Parameters

propType

a property type value. See DESCRIPTION for valid values.

propVal

a property value

propLen

the length of the specified property value. If propLen was of an insufficient size to the hold the returned property value, propLen will contain the required size of the buffer and STMF_ERROR_INVALID_ARG will be returned.

Description

This function gets the default properties for the specified property type. All property values are expressed in human-readable form. The propType argument can be one of the following values:

STMF_DEFAULT_LU_STATE

Retrieve the current default state for luns. The default value is “online”.

STMF_DEFAULT_TARGET_PORT_STATE

Retrieve the current default state for target ports. the default value is “online”.

Return Values

The following values are returned:

STMF_STATUS_SUCCESS

The API call was successful.

STMF_ERROR_INVALID_ARG

Either the propType or propVal argument is invalid.

STMF_ERROR_NOT_FOUND

The specified propType was not found in the system.

Attributes

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

See Also

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