share/man/man3stmf/stmfSetProviderData.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 STMFSETPROVIDERDATA 3STMF "Oct 7, 2008"
   7 .SH NAME
   8 stmfSetProviderData \- set the data for the specified provider
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfSetProviderData\fR(\fBchar *\fR\fIproviderName\fR, \fBnvlist_t *\fR\fInvl\fR,
  16      \fBint\fR \fIproviderType\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 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 must be either \fBSTMF_LU_PROVIDER_TYPE\fR or
  45 \fBSTMF_PORT_PROVIDER_TYPE\fR.
  46 .RE
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 The \fBstmfSetProviderData()\fR function sets the data for the specified
  52 provider.
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 The following values are returned:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBSTMF_ERROR_NOMEM\fR\fR
  61 .ad
  62 .RS 23n
  63 The library was unable to allocate sufficient memory to return the data.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  70 .ad
  71 .RS 23n
  72 The API call was successful.
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Committed (Obsolete)
  89 _
  90 MT-Level        Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBlibstmf\fR(3LIB), \fBstmfSetProviderDataProt\fR(3STMF), \fBattributes\fR(5)
  97 .SH NOTES
  98 .sp
  99 .LP
 100 The \fBstmfSetProviderData()\fR function is deprecated in favor of
 101 \fBstmfSetProviderDataProt\fR(3STMF) and may be removed in a future revision of
 102 \fBlibstmf\fR(3LIB).