'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
.TH stmfSetProviderDataProt 3STMF "7 Oct 2008" "SunOS 5.11" "SCSI Target Mode Framework Library Functions"
.SH NAME
stmfSetProviderDataProt \- retrieve data for the specified provider
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
 #include <libstmf.h>

\fBint\fR \fBstmfSetProviderDataProt\fR(\fBchar *\fR\fIproviderName\fR, \fBnvlist_t **\fR\fInvl\fR,
     \fBint\fR \fIproviderType\fR, \fBuint64_t *\fR\fItoken\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIproviderName\fR\fR
.ad
.RS 16n
.rt  
The name of the provider for which data is being set.
.RE

.sp
.ne 2
.mk
.na
\fB\fInvl\fR\fR
.ad
.RS 16n
.rt  
A pointer to a pointer to an \fBnvlist_t\fR containing the nvlist to be set.
.RE

.sp
.ne 2
.mk
.na
\fB\fIproviderType\fR\fR
.ad
.RS 16n
.rt  
The value for this parameter must be either \fBSTMF_LU_PROVIDER_TYPE\fR or \fBSTMF_PORT_PROVIDER_TYPE\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fItoken\fR\fR
.ad
.RS 16n
.rt  
A pointer to a \fBuint64_t\fR that contains the value returned from a successful call to \fBstmfGetProviderDataProt\fR(3STMF). If this argument is \fINULL\fR, the token is ignored. Otherwise, the token will be verified against the current data. If the token represents stale data, the call fails.
.sp
On success, \fItoken\fR will contain the new token for the data being set and can be used in subsequent calls to \fBstmfSetProviderData\fR(3STMF). On failure the contents are undefined.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBstmfSetProviderDataProt()\fR function sets the data for the specified provider.
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBSTMF_ERROR_PROV_DATA_STALE\fR\fR
.ad
.RS 30n
.rt  
The token value represents stale data.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSTMF_STATUS_SUCCESS\fR\fR
.ad
.RS 30n
.rt  
The API call was successful.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibstmf\fR(3LIB), \fBnvlist_free\fR(3NVPAIR), \fBstmfGetProviderDataProt\fR(3STMF), \fBstmfSetProviderData\fR(3STMF), \fBattributes\fR(5)