xref: /illumos-gate/usr/src/man/man3stmf/stmfGetPersistMethod.3stmf (revision 3ce5372277f4657ad0e52d36c979527c4ca22de2)
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]
STMFGETPERSISTMETHOD 3STMF "May 8, 2009"
NAME
stmfGetPersistMethod - get the current persistence method for stmf
SYNOPSIS

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

int stmfGetPersistMethod(uint8_t *persistType, boolean_t serviceState);
PARAMETERS
persistType

On success, contains the current persistence setting based on serviceState.

serviceState

When set to B_TRUE, persistType will contain the persist method currently set for the service. When set to B_FALSE, persistType will contain the persist method for the current library open.

DESCRIPTION

The stmfGetPersistMethod() function retrieves the current persistent method setting for the service or for a given library open. When set to B_TRUE, retrieves the setting from the service.

RETURN VALUES

The following values are returned: STMF_STATUS_SUCCESS

The API call was successful.

STMF_ERROR_PERSIST_TYPE

Unable to retrieve persist type from service.

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)