share/man/man3stmf/stmfGetProviderDataProt.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 STMFGETPROVIDERDATAPROT 3STMF "Oct 7, 2008"
   7 .SH NAME
   8 stmfGetProviderDataProt \- 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 \fBstmfGetProviderDataProt\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 retrieved.
  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. On success, this will contain the
  36 nvlist retrieved. The caller is responsible for freeing the returned nvlist by
  37 calling \fBnvlist_free\fR(3NVPAIR).
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIproviderType\fR\fR
  44 .ad
  45 .RS 16n
  46 The value for this parameter must be either \fBSTMF_LU_PROVIDER_TYPE\fR or
  47 \fBSTMF_PORT_PROVIDER_TYPE\fR.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fItoken\fR\fR
  54 .ad
  55 .RS 16n
  56 A pointer to a \fBuint64_t\fR allocated by the caller. On success, this will
  57 contain a token for the returned data that can be used in a call to
  58 \fBstmfSetProviderDataProt\fR(3STMF) to ensure that the data returned in this
  59 call is not stale. If this value is \fINULL\fR, the token will be ignored.
  60 .RE
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 The \fBstmfGetProviderDataProt()\fR function retrieves the data for the
  66 specified provider.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 The following values are returned:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBSTMF_ERROR_NOMEM\fR\fR
  75 .ad
  76 .RS 23n
  77 The library was unable to allocate sufficient memory to return the data.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  84 .ad
  85 .RS 23n
  86 The API call was successful.
  87 .RE
  88
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Committed
 103 _
 104 MT-Level        Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBlibstmf\fR(3LIB), \fBnvlist_free\fR(3NVPAIR),
 111 \fBstmfSetProviderDataProt\fR(3STMF), \fBattributes\fR(5)