share/man/man3stmf/stmfClearProviderData.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 STMFCLEARPROVIDERDATA 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfClearProviderData \- delete all 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 \fBstmfClearProviderData\fR(\fBchar *\fR\fIproviderName\fR, \fBint\fR \fIproviderType\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIproviderName\fR\fR
  23 .ad
  24 .RS 16n
  25 The name of the provider whose data is being deleted.
  26 .RE
  27
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIproviderType\fR\fR
  32 .ad
  33 .RS 16n
  34 The value  must be either \fBSTMF_LU_PROVIDER_TYPE\fR or
  35 \fBSTMF_PORT_PROVIDER_TYPE\fR.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBstmfClearProviderData()\fR function deletes all data for the specified
  42 provider.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The following values are returned:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBSTMF_ERROR_NOT_FOUND\fR\fR
  51 .ad
  52 .RS 24n
  53 The value specified for \fIproviderName\fR was not found in the system.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  60 .ad
  61 .RS 24n
  62 The API call was successful.
  63 .RE
  64
  65 .SH ATTRIBUTES
  66 .sp
  67 .LP
  68 See \fBattributes\fR(5) for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Committed
  79 _
  80 MT-Level        Safe
  81 .TE
  82
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)