usr/src/man/man3scf/scf_limit.3scf

   1 '\" te
   2 .\" Copyright (c) 2004, 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SCF_LIMIT 3SCF "Aug 17, 2004"
   7 .SH NAME
   8 scf_limit \- limit information for Service Configuration Facility
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lscf\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <libscf.h>
  14
  15 \fBssize_t\fR \fBscf_limit\fR(\fBuint32_t\fR \fIname\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBscf_limit()\fR function returns information about implementation-defined
  22 limits in the service configuration facility. These limits are generally
  23 maximum lengths for various strings. The values returned do not change during
  24 the execution of a program, but they should not be cached between executions.
  25 .sp
  26 .LP
  27 The available values for \fIname\fR are:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fBSCF_LIMIT_MAX_FMRI_LENGTH\fR\fR
  32 .ad
  33 .sp .6
  34 .RS 4n
  35 Return the maximum length of an FMRI the service configuration facility
  36 accepts.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBSCF_LIMIT_MAX_PG_TYPE_LENGTH\fR\fR
  43 .ad
  44 .sp .6
  45 .RS 4n
  46 Return the maximum length for property group types in the service configuration
  47 facility.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBSCF_LIMIT_MAX_NAME_LENGTH\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 Return the maximum length for names in the service configuration facility. This
  58 value does not include space for the required terminating null byte.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBSCF_LIMIT_MAX_VALUE_LENGTH\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 Return the maximum string length a scf_value_t can hold, not including the
  69 terminating null byte.
  70 .RE
  71
  72 .sp
  73 .LP
  74 Lengths do not include space for the required terminating null byte.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Upon successful completion, \fBscf_limit()\fR returns the requested value.
  79 Otherwise, it returns -1.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 The \fBscf_limit()\fR function will fail if:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBSCF_ERROR_INVALID_ARGUMENT\fR\fR
  88 .ad
  89 .RS 30n
  90 The \fIname\fR argument is not a recognized request.
  91 .RE
  92
  93 .sp
  94 .LP
  95 The \fBscf_error\fR(3SCF) function can be used to retrieve the error value.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Evolving
 110 _
 111 MT-Level        MT-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBlibscf\fR(3LIB), \fBscf_error\fR(3SCF), \fBattributes\fR(5)