lib/libc/gen/confstr.3

   1 .\"     $NetBSD: confstr.3,v 1.18 2006/12/23 09:04:23 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)confstr.3   8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd December 2, 2006
  33 .Dt CONFSTR 3
  34 .Os
  35 .Sh NAME
  36 .Nm confstr
  37 .Nd get string-valued configurable variables
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In 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 \*[Lt]unistd.h\*[Gt] .
  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 .It Li _CS_PATH
  81 Return a value for the
  82 .Ev PATH
  83 environment variable that finds all the standard utilities.
  84 .El
  85 .Sh RETURN VALUES
  86 If the call to
  87 .Nm confstr
  88 is not successful, 0 is returned and
  89 .Va errno
  90 is set appropriately.
  91 Otherwise, if the variable does not have a configuration defined value,
  92 0 is returned and
  93 .Va errno
  94 is not modified.
  95 Otherwise, the buffer size needed to hold the entire configuration-defined
  96 value is returned.
  97 If this size is greater than the argument
  98 .Fa len ,
  99 the string in
 100 .Fa buf
 101 was truncated.
 102 .Sh ERRORS
 103 The
 104 .Nm confstr
 105 function may fail and set
 106 .Va error
 107 for any of the errors specified for the library functions
 108 .Xr malloc 3
 109 and
 110 .Xr sysctl 3 .
 111 .Pp
 112 In addition, the following errors may be reported:
 113 .Bl -tag -width Er
 114 .It Bq Er EINVAL
 115 The value of the
 116 .Fa name
 117 argument is invalid.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr sysctl 3
 121 .Sh STANDARDS
 122 The
 123 .Nm confstr
 124 function conforms to
 125 .St -p1003.2-92 .
 126 .Sh HISTORY
 127 The
 128 .Nm confstr
 129 function first appeared in
 130 .Bx 4.4 .
 131 .Sh BUGS
 132 The standards require us to return 0 both on errors, and when the value
 133 is not set.