'\" te
.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.TH scf_limit 3SCF "17 Aug 2004" "SunOS 5.11" "Service Configuration Facility Library Functions"
.SH NAME
scf_limit \- limit information for Service Configuration Facility
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <libscf.h>

\fBssize_t\fR \fBscf_limit\fR(\fBuint32_t\fR \fIname\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBscf_limit()\fR 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.
.sp
.LP
The available values for \fIname\fR are:
.sp
.ne 2
.mk
.na
\fB\fBSCF_LIMIT_MAX_FMRI_LENGTH\fR\fR
.ad
.sp .6
.RS 4n
Return the maximum length of an FMRI the service configuration facility accepts.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSCF_LIMIT_MAX_PG_TYPE_LENGTH\fR\fR
.ad
.sp .6
.RS 4n
Return the maximum length for property group types in the service configuration facility.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSCF_LIMIT_MAX_NAME_LENGTH\fR\fR
.ad
.sp .6
.RS 4n
Return the maximum length for names in the service configuration facility. This value does not include space for the required terminating null byte.
.RE

.sp
.ne 2
.mk
.na
\fB\fBSCF_LIMIT_MAX_VALUE_LENGTH\fR\fR
.ad
.sp .6
.RS 4n
Return the maximum string length a scf_value_t can hold, not including the terminating null byte.
.RE

.sp
.LP
Lengths do not include space for the required terminating null byte.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBscf_limit()\fR returns the requested value. Otherwise, it returns -1.
.SH ERRORS
.sp
.LP
The \fBscf_limit()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR
.ad
.RS 30n
.rt  
The \fIname\fR argument is not a recognized request.
.RE

.sp
.LP
The \fBscf_error\fR(3SCF) function can be used to retrieve the error value.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibscf\fR(3LIB), \fBscf_error\fR(3SCF), \fBattributes\fR(5)