xref: /titanic_50/usr/src/man/man3stmf/stmfSetPersistMethod.3stmf (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab)
te
Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
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.
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
the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
STMFSETPERSISTMETHOD 3STMF "May 8, 2009"
NAME
stmfSetPersistMethod - set persistence method for the stmf service
SYNOPSIS

cc [ flag... ] file... -lstmf [ library... ]
#include <libstmf.h>

int stmfSetPersistMethod(uint8_t persistType, boolean_t serviceSet);
PARAMETERS
persistType

The requested persistence setting. Can be either STMF_PERSIST_SMF or STMF_PERSIST_NONE.

serviceSet

Set to indicate whether the setting should persist on the stmf service. When set to B_FALSE, this setting is only applicable for the duration of the current library open or until a subsequent call is made to change the setting.

DESCRIPTION

The stmfSetPersistMethod() function sets the persistence method for stmf.

RETURN VALUES

The following values are returned: STMF_STATUS_SUCCESS

The API call was successful.

STMF_ERROR_PERSIST_TYPE

The persistType argument is invalid.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

libstmf(3LIB), attributes(5)