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