xref: /illumos-gate/usr/src/man/man3c/getwd.3c (revision faeab80b5dcf1bc503f1f02494131eb0e6da46c3)
1.\" Copyright 2015 Garrett D'Amore <garrett@damore.org>
2.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
3.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4.\" http://www.opengroup.org/bookstore/.
5.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6.\"  This notice shall appear on any product containing this material.
7.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
9.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10.Dd Mar 30, 2015
11.Dt GETWD 3C
12.Os
13.Sh NAME
14.Nm getwd
15.Nd get current working directory pathname
16.Sh SYNOPSIS
17.In unistd.h
18.Ft "char *"
19.Fn getwd "char *path_name"
20.Sh DESCRIPTION
21The
22.Fn getwd
23function determines an absolute pathname of the current
24working directory of the calling process, and copies that pathname into the
25array pointed to by the
26.Fa path_name
27argument.
28.Lp
29If the length of the pathname of the current working directory is greater than
30.Pq Dv PATH_MAX + 1
31including the null byte,
32.Fn getwd
33fails and returns a null pointer.
34.Sh RETURN VALUES
35Upon successful completion, a pointer to the string containing the absolute
36pathname of the current working directory is returned.
37Otherwise,
38.Fn getwd
39returns a null pointer and the contents of the array pointed to by
40.Fa path_name
41are undefined.
42.Sh ERRORS
43No errors are defined.
44.Sh USAGE
45The
46.Fn getwd
47function is supplied for backwards compatibility.
48The
49.Xr getcwd 3C
50should be used instead.
51.Sh INTERFACE STABILITY
52.Sy Obsolete Standard .
53.Sh SEE ALSO
54.Xr getcwd 3C ,
55.Xr standards 5
56.Sh STANDARDS
57The
58.Fn getwd
59function is available in the following compilation environments.
60See
61.Xr standards 5 .
62.Lp
63.Bl -bullet -compact
64.It
65.St -xpg4.2
66.It
67.St -susv2
68.It
69.St -susv3
70.El
71.Lp
72It was marked obsolete in
73.St -susv3
74and removed from
75.St -p1003.1-2008 .
76