STMFGETPROVIDERDATAPROT(3STMF) SCSI Target Mode Framework Library Functions

NAME

stmfGetProviderDataProt - retrieve data for the specified provider

SYNOPSIS

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

int stmfGetProviderDataProt(char *providerName, nvlist_t **nvl,
int providerType, uint64_t *token);

PARAMETERS

providerName
The name of the provider for which data is being
retrieved.


nvl
A pointer to a pointer to an nvlist_t. On success,
this will contain the nvlist retrieved. The caller is
responsible for freeing the returned nvlist by
calling nvlist_free(3NVPAIR).


providerType
The value for this parameter must be either
STMF_LU_PROVIDER_TYPE or STMF_PORT_PROVIDER_TYPE.


token
A pointer to a uint64_t allocated by the caller. On
success, this will contain a token for the returned
data that can be used in a call to
stmfSetProviderDataProt(3STMF) to ensure that the
data returned in this call is not stale. If this
value is NULL, the token will be ignored.

DESCRIPTION

The stmfGetProviderDataProt() function retrieves the data for the
specified provider.

RETURN VALUES

The following values are returned:

STMF_ERROR_NOMEM
The library was unable to allocate sufficient
memory to return the data.


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), nvlist_free(3NVPAIR), stmfSetProviderDataProt(3STMF),
attributes(7)

October 7, 2008
STMFGETPROVIDERDATAPROT(3STMF)