usr/src/man/man3stmf/stmfSetProviderDataProt.3stmf

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STMFSETPROVIDERDATAPROT 3STMF "Oct 7, 2008"
   7 .SH NAME
   8 stmfSetProviderDataProt \- retrieve data for the specified provider
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13  #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfSetProviderDataProt\fR(\fBchar *\fR\fIproviderName\fR, \fBnvlist_t **\fR\fInvl\fR,
  16      \fBint\fR \fIproviderType\fR, \fBuint64_t *\fR\fItoken\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIproviderName\fR\fR
  24 .ad
  25 .RS 16n
  26 The name of the provider for which data is being set.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fInvl\fR\fR
  33 .ad
  34 .RS 16n
  35 A pointer to a pointer to an \fBnvlist_t\fR containing the nvlist to be set.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIproviderType\fR\fR
  42 .ad
  43 .RS 16n
  44 The value for this parameter must be either \fBSTMF_LU_PROVIDER_TYPE\fR or
  45 \fBSTMF_PORT_PROVIDER_TYPE\fR.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fItoken\fR\fR
  52 .ad
  53 .RS 16n
  54 A pointer to a \fBuint64_t\fR that contains the value returned from a
  55 successful call to \fBstmfGetProviderDataProt\fR(3STMF). If this argument is
  56 \fINULL\fR, the token is ignored. Otherwise, the token will be verified against
  57 the current data. If the token represents stale data, the call fails.
  58 .sp
  59 On success, \fItoken\fR will contain the new token for the data being set and
  60 can be used in subsequent calls to \fBstmfSetProviderData\fR(3STMF). On failure
  61 the contents are undefined.
  62 .RE
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBstmfSetProviderDataProt()\fR function sets the data for the specified
  68 provider.
  69 .SH RETURN VALUES
  70 .sp
  71 .LP
  72 The following values are returned:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBSTMF_ERROR_PROV_DATA_STALE\fR\fR
  77 .ad
  78 .RS 30n
  79 The token value represents stale data.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  86 .ad
  87 .RS 30n
  88 The API call was successful.
  89 .RE
  90
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     Committed
 105 _
 106 MT-Level        Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBlibstmf\fR(3LIB), \fBnvlist_free\fR(3NVPAIR),
 113 \fBstmfGetProviderDataProt\fR(3STMF), \fBstmfSetProviderData\fR(3STMF),
 114 \fBattributes\fR(5)