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

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH STMFSETPERSISTMETHOD 3STMF "May 8, 2009"
   7 .SH NAME
   8 stmfSetPersistMethod \- set persistence method for the stmf service
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfSetPersistMethod\fR(\fBuint8_t\fR \fIpersistType\fR, \fBboolean_t\fR \fIserviceSet\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIpersistType\fR\fR
  23 .ad
  24 .RS 15n
  25 The requested persistence setting. Can be either \fBSTMF_PERSIST_SMF\fR or
  26 \fBSTMF_PERSIST_NONE\fR.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIserviceSet\fR\fR
  33 .ad
  34 .RS 15n
  35 Set to indicate whether the setting should persist on the stmf service. When
  36 set to \fBB_FALSE\fR, this setting is only applicable for the duration of the
  37 current library open or until a subsequent call is made to change the setting.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBstmfSetPersistMethod()\fR function sets the persistence method for stmf.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The following values are returned:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  52 .ad
  53 .RS 27n
  54 The API call was successful.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBSTMF_ERROR_PERSIST_TYPE\fR\fR
  61 .ad
  62 .RS 27n
  63 The \fIpersistType\fR argument is invalid.
  64 .RE
  65
  66 .SH ATTRIBUTES
  67 .sp
  68 .LP
  69 See \fBattributes\fR(5) for descriptions of the following attributes:
  70 .sp
  71
  72 .sp
  73 .TS
  74 box;
  75 c | c
  76 l | l .
  77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  78 _
  79 Interface Stability     Committed
  80 _
  81 MT-Level        Safe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .sp
  86 .LP
  87 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)