usr/src/lib/libc/gen/getcwd.3

.\" Copyright (c) 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)getcwd.3    6.4 (Berkeley) %G%
.\"
.Dd
.Dt GETCWD 3
.Os BSD 4.2
.Sh NAME
.Nm getwd
.Nd get working directory pathname
.Sh SYNOPSIS
.Fd #include <stdio.h>
.Ft char *
.Fn getcwd "char *buf" "size_t size"
.Ft char *
.Fn getwd "char *buf"
.Sh DESCRIPTION
The
.Fn getcwd
function copies the absolute pathname of the current working directory
into the memory referenced by
.Fa buf
and returns a pointer to
.Fa buf .
The
.Fa size
argument is the size, in bytes, of the array referenced by
.Fa buf .
.Pp
If
.Fa buf
is
.Dv NULL ,
space is allocated as necessary to store the pathname.
This space may later be
.Xr free 3 Ns 'd.
.Pp
The function
.Fn getwd
is a compatibility routine which calls
.Fn getcwd
with its
.Fa buf
argument and a size of
.Dv MAXPATHLEN
(as defined in the include
file
.Aq Pa sys/param.h ) .
Obviously,
.Fa buf
should be at least
.Dv MAXPATHLEN
bytes in length.
.Pp
These routines have traditionally been used by programs to save the
name of a working directory for the purpose of returning to it.
A much faster and less error-prone method of accomplishing this is to
open the current directory
.Pq Ql \&.
and use the
.Xr fchdir 2
function to return.
.Sh RETURN VALUES
Upon successful completion, a pointer to the pathname is returned.
Otherwise a
.Dv NULL
pointer is returned and the global variable
.Va errno
is set to indicate the error.
In addition,
.Fn getwd
copies the error message associated with
.Va errno
into the memory referenced by
.Fa buf .
.Sh ERRORS
The
.Fn getcwd
function
will fail if:
.Bl -tag -width [EACCESS]
.It Bq Er EACCESS
Read or search permission was denied for a component of the pathname.
.It Bq Er EINVAL
The
.Fa size
argument is zero.
.It Bq Er ENOENT
A component of the pathname no longer exists.
.It Bq Er ENOMEM
Insufficient memory is available.
.It Bq Er ERANGE
The
.Fa size
argument is greater than zero but smaller than the length of the pathname
plus 1.
.El
.Sh SEE ALSO
.Xr chdir 2 ,
.Xr fchdir 2 ,
.Xr malloc 3 ,
.Xr strerror 3
.Sh STANDARDS
The
.Fn getcwd
function
conforms to
.St -ansiC .
The ability to specify a
.Dv NULL
pointer and have
.Fn getcwd
allocate memory as necessary is an extension.
.Sh HISTORY
The
.Fn getwd
function appeared in
.Bx 4.0 .
.Sh BUGS
The
.Fn getwd
function
does not do sufficient error checking and is not able to return very
long, but valid, paths.
It is provided for compatibility.