IPB
>  Man Pages > Linux > openSUSE 10.2 > Section 3 > getcwd man page

getcwd man page

Section 3 - openSUSE 10.2 Man Pages

Other operating system man pages available here


Advanced Search

Hopefully, this page is exactly what you are looking for, but if not, you can always find further assistance on Unix/Linux Forum!


GETCWD(3)                  Linux Programmer's Manual                 GETCWD(3)



NAME
       getcwd, get_current_dir_name, getwd - Get current working directory

SYNOPSIS
       #include <unistd.h>

       char *getcwd(char *buf, size_t size);

       #define _BSD_SOURCE     /* Or: #define _XOPEN_SOURCE 500 */
       #include <unistd.h>

       char *getwd(char *buf);

       #define _GNU_SOURCE
       #include <unistd.h>

       char *get_current_dir_name(void);

DESCRIPTION
       The  getcwd() function copies an absolute pathname of the current work-
       ing directory to the array pointed to by buf, which is of length  size.

       If  the  current  absolute  pathname would require a buffer longer than
       size elements, NULL is returned, and errno is set to ERANGE; an  appli-
       cation  should  check  for  this error, and allocate a larger buffer if
       necessary.

       If buf is NULL, the behaviour of getcwd() is undefined.

       As an extension to the  POSIX.1-2001  standard,  Linux  (libc4,  libc5,
       glibc)  getcwd() allocates the buffer dynamically using malloc() if buf
       is NULL on call.  In this case, the allocated  buffer  has  the  length
       size  unless  size  is zero, when buf is allocated as big as necessary.
       It is possible (and, indeed, advisable) to free() the buffers  if  they
       have been obtained this way.

       get_current_dir_name(),  will malloc(3) an array big enough to hold the
       current directory name.  If the environment variable PWD  is  set,  and
       its value is correct, then that value will be returned.

       getwd(),  does  not malloc(3) any memory.  The buf argument should be a
       pointer to an array at least PATH_MAX bytes long.   getwd()  does  only
       return  the  first  PATH_MAX  bytes  of the actual pathname.  Note that
       PATH_MAX need not be a compile-time constant;  it  may  depend  on  the
       filesystem  and  may  even  be unlimited.  For portability and security
       reasons, use of getwd() is deprecated.

RETURN VALUE
       NULL on failure with errno set accordingly, and  buf  on  success.  The
       contents of the array pointed to by buf is undefined on error.

ERRORS
       EACCES Permission  to  read  or  search a component of the filename was
              denied.

       EFAULT buf points to a bad address.

       EINVAL The size argument is zero and buf is not a null pointer.

       ENOENT The current working directory has been unlinked.

       ERANGE The size argument is less than the length of the working  direc-
              tory name.  You need to allocate a bigger array and try again.

NOTES
       Under Linux, the function getcwd() is a system call (since 2.1.92).  On
       older systems it would query /proc/self/cwd.  If both system  call  and
       proc  file system are missing, a generic implementation is called. Only
       in that case can these calls fail under Linux with EACCES.

       These functions are often used to save  the  location  of  the  current
       working directory for the purpose of returning to it later. Opening the
       current directory (".") and calling fchdir(2) to return  is  usually  a
       faster  and  more  reliable  alternative  when  sufficiently  many file
       descriptors are available, especially on platforms other than Linux.

CONFORMING TO
       getcwd() conforms to POSIX.1-2001.  getwd() is present in POSIX.1-2001,
       but marked LEGACY.  get_current_dir_name() is a GNU extension.

SEE ALSO
       chdir(2),  fchdir(2),  open(2),  unlink(2),  free(3),  malloc(3),  fea-
       ture_test_macros(7)



GNU                               2002-04-22                         GETCWD(3)


Man(1) output converted with man2html and wrapped by fishsponge

This page was generated on Sat Sep 8 16:38:29 GMT 2007

Your favourite pages:

No pages logged yet.
Trying to save cookie...

Top 10 most popular pages:

svn man page (6143 hits)
(FreeBSD 6.2)

sqlite3 man page (5592 hits)
(openSUSE 10.2)

adv_cap_autoneg man page (5041 hits)
(Solaris 10 11_06)

CPAN man page (4787 hits)
(Suse Linux 10.1)

ssh man page (4438 hits)
(Suse Linux 10.1)

ssh-socks5-proxy-connect man page (3506 hits)
(Solaris 10 11_06)

signal man page (3363 hits)
(Suse Linux 10.1)

netcat man page (3359 hits)
(Suse Linux 10.1)

pprosetup man page (2876 hits)
(Solaris 10 11_06)

startproc man page (2732 hits)
(Suse Linux 10.1)

Useful Links

Go Back

Visitor Statistics


Valid XHTML 1.0 Transitional     Valid CSS!

Partners: Cambridge Plus :: Pyrenees Mountain Holidays Contact Us :: Electronic Design Bedfordshire :: <Link Available>
Unix Man Pages / Linux Man Pages :: HiFi Forum :: SIP VoIP Phone & Provider Reviews :: UNIX/Linux Forum Archives

More info on advertising on Unix/Linux Forum