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 .\"
  34 .Dd June 4, 1993
  35 .Dt CONFSTR 3
  36 .Os BSD 4
  37 .Sh NAME
  38 .Nm confstr
  39 .Nd get string-valued configurable variables
  40 .Sh SYNOPSIS
  41 .Fd #include <unistd.h>
  42 .Ft size_t
  43 .Fn confstr "int name" "char *buf" "size_t len"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 This interface is obsoleted by
  47 .Xr sysctl 3 .
  48 .Ef
  49 .Pp
  50 The
  51 .Fn confstr
  52 function provides a method for applications to get configuration
  53 defined string values.
  54 .Pp
  55 The
  56 .Fa name
  57 argument specifies the system variable to be queried.
  58 Symbolic constants for each name value are found in the include file
  59 .Li <unistd.h> .
  60 The
  61 .Fa len
  62 argument specifies the size of the buffer referenced by the
  63 argument
  64 .Fa buf .
  65 If
  66 .Fa len
  67 is non-zero,
  68 .Fa buf
  69 is a non-null pointer, and
  70 .Fa name
  71 has a value, up to
  72 .Fa len
  73 \- 1 bytes of the value are copied into the buffer
  74 .Fa buf .
  75 The copied value is always null terminated.
  76 .Pp
  77 The available values are as follows:
  78 .Pp
  79 .Bl -tag -width "123456"
  80 .Pp
  81 .It Li _CS_PATH
  82 Return a value for the
  83 .Ev PATH
  84 environment variable that finds all the standard utilities.
  85 .El
  86 .Sh RETURN VALUES
  87 If the call to
  88 .Fn confstr
  89 is not successful, \-1 is returned and
  90 .Va errno
  91 is set appropriately.
  92 Otherwise, if the variable does not have a configuration defined value,
  93 0 is returned and
  94 .Va errno
  95 is not modified.
  96 Otherwise, the buffer size needed to hold the entire configuration-defined
  97 value is returned.
  98 If this size is greater than the argument
  99 .Fa len ,
 100 the string in
 101 .Fa buf
 102 was truncated.
 103 .Sh ERRORS
 104 The
 105 .Fn confstr
 106 function may fail and set
 107 .Va error
 108 for any of the errors specified for the library functions
 109 .Xr malloc 3
 110 and
 111 .Xr sysctl 3 .
 112 .Pp
 113 In addition, the following errors may be reported:
 114 .Bl -tag -width Er
 115 .It Bq Er EINVAL
 116 The value of the
 117 .Fa name
 118 argument is invalid.
 119 .Sh SEE ALSO
 120 .Xr sysctl 3
 121 .Sh HISTORY
 122 The
 123 .Fn confstr
 124 function first appeared in
 125 .Bx 4.4 .