xref: /illumos-gate/usr/src/man/man3scf/scf_limit.3scf (revision 66582b606a8194f7f3ba5b3a3a6dca5b0d346361)
te
Copyright (c) 2004, 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]
SCF_LIMIT 3SCF "Aug 17, 2004"
NAME
scf_limit - limit information for Service Configuration Facility
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lscf [ library.\|.\|. ]
#include <libscf.h>

ssize_t scf_limit(uint32_t name);
DESCRIPTION

The scf_limit() function returns information about implementation-defined limits in the service configuration facility. These limits are generally maximum lengths for various strings. The values returned do not change during the execution of a program, but they should not be cached between executions.

The available values for name are: SCF_LIMIT_MAX_FMRI_LENGTH

Return the maximum length of an FMRI the service configuration facility accepts.

SCF_LIMIT_MAX_PG_TYPE_LENGTH

Return the maximum length for property group types in the service configuration facility.

SCF_LIMIT_MAX_NAME_LENGTH

Return the maximum length for names in the service configuration facility. This value does not include space for the required terminating null byte.

SCF_LIMIT_MAX_VALUE_LENGTH

Return the maximum string length a scf_value_t can hold, not including the terminating null byte.

Lengths do not include space for the required terminating null byte.

RETURN VALUES

Upon successful completion, scf_limit() returns the requested value. Otherwise, it returns -1.

ERRORS

The scf_limit() function will fail if: SCF_ERROR_INVALID_ARGUMENT

The name argument is not a recognized request.

The scf_error(3SCF) function can be used to retrieve the error value.

ATTRIBUTES

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

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

libscf(3LIB), scf_error(3SCF), attributes(5)