share/man/man3stmf/stmfGetPersistMethod.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 STMFGETPERSISTMETHOD 3STMF "May 8, 2009"
   7 .SH NAME
   8 stmfGetPersistMethod \- get the current persistence method for stmf
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lstmf [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfGetPersistMethod\fR(\fBuint8_t *\fR\fIpersistType\fR, \fBboolean_t\fR \fIserviceState\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fIpersistType\fR\fR
  23 .ad
  24 .RS 16n
  25 On success, contains the current persistence setting based on
  26 \fIserviceState\fR.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIserviceState\fR\fR
  33 .ad
  34 .RS 16n
  35 When set to \fBB_TRUE\fR, \fIpersistType\fR will contain the persist method
  36 currently set for the service. When set to \fBB_FALSE\fR, \fIpersistType\fR
  37 will contain the persist method for the current library open.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBstmfGetPersistMethod()\fR function retrieves the current persistent
  44 method setting for the service or for a given library open. When set to
  45 \fBB_TRUE\fR, retrieves the setting from the service.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 The following values are returned:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  54 .ad
  55 .RS 27n
  56 The API call was successful.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBSTMF_ERROR_PERSIST_TYPE\fR\fR
  63 .ad
  64 .RS 27n
  65 Unable to retrieve persist type from service.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Interface Stability     Committed
  82 _
  83 MT-Level        Safe
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)