lib/libc/gen/confstr.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)confstr.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/confstr.3,v 1.5.2.5 2001/12/14 18:33:50 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/confstr.3,v 1.6 2008/05/02 02:05:03 swildner Exp $
  35 .\"
  36 .Dd December 6, 2006
  37 .Dt CONFSTR 3
  38 .Os
  39 .Sh NAME
  40 .Nm confstr
  41 .Nd get string-valued configurable variables
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft size_t
  47 .Fn confstr "int name" "char *buf" "size_t len"
  48 .Sh DESCRIPTION
  49 .Bf -symbolic
  50 This interface is obsoleted by
  51 .Xr sysctl 3 .
  52 .Ef
  53 .Pp
  54 The
  55 .Fn confstr
  56 function provides a method for applications to get configuration
  57 defined string values.
  58 .Pp
  59 The
  60 .Fa name
  61 argument specifies the system variable to be queried.
  62 Symbolic constants for each name value are found in the include file
  63 .In unistd.h .
  64 The
  65 .Fa len
  66 argument specifies the size of the buffer referenced by the
  67 argument
  68 .Fa buf .
  69 If
  70 .Fa len
  71 is non-zero,
  72 .Fa buf
  73 is a non-null pointer, and
  74 .Fa name
  75 has a value, up to
  76 .Fa len
  77 \- 1 bytes of the value are copied into the buffer
  78 .Fa buf .
  79 The copied value is always null terminated.
  80 .Pp
  81 The available values are as follows:
  82 .Bl -tag -width 6n
  83 .It Li _CS_PATH
  84 Return a value for the
  85 .Ev PATH
  86 environment variable that finds all the standard utilities.
  87 .El
  88 .Sh RETURN VALUES
  89 If the call to
  90 .Fn confstr
  91 is not successful, 0 is returned and
  92 .Va errno
  93 is set appropriately.
  94 Otherwise, if the variable does not have a configuration defined value,
  95 0 is returned and
  96 .Va errno
  97 is not modified.
  98 Otherwise, the buffer size needed to hold the entire configuration-defined
  99 value is returned.
 100 If this size is greater than the argument
 101 .Fa len ,
 102 the string in
 103 .Fa buf
 104 was truncated.
 105 .Sh ERRORS
 106 The
 107 .Fn confstr
 108 function may fail and set
 109 .Va errno
 110 for any of the errors specified for the library functions
 111 .Xr malloc 3
 112 and
 113 .Xr sysctl 3 .
 114 .Pp
 115 In addition, the following errors may be reported:
 116 .Bl -tag -width Er
 117 .It Bq Er EINVAL
 118 The value of the
 119 .Fa name
 120 argument is invalid.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr sysctl 3
 124 .Sh STANDARDS
 125 The
 126 .Fn confstr
 127 function conforms to
 128 .St -susv3 .
 129 .Sh HISTORY
 130 The
 131 .Fn confstr
 132 function first appeared in
 133 .Bx 4.4 .