Index for Section 3

Alphabetical listing for G

Bottom of page

getcwd(3)
NAME
  getcwd - Get the pathname of the current directory

SYNOPSIS
  Standard C Library:

  #include <unistd.h>

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

  System V Library:

  char *getcwd(
	  char *buffer,
	  int size );

LIBRARY
  Standard C Library (libc) System V Library (libsysv)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  getcwd() - libc version: XSH5.0

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

PARAMETERS
  buffer
      Points to a string space to hold the pathname.

  size
      Specifies the length of the string space in bytes. The value of the
      size parameter must be at least the length of the pathname to be
      returned plus one byte for the terminating null.

DESCRIPTION
  The getcwd() function returns a pointer to a string containing the absolute
  pathname of the current directory. The getwd() function is called to obtain
  the pathname.

  [Tru64 UNIX]	If the buffer parameter is a null pointer, the getcwd()
  function, using the malloc() function, obtains the number of bytes of free
  space as specified by the size parameter. In this case, the pointer
  returned by the getcwd() function can be used as the parameter in a
  subsequent call to the free() function.

NOTES
  [Tru64 UNIX]	The getcwd() function is supported for multithreaded
  applications.

RETURN VALUES
  Upon successful completion, getcwd() returns the buffer parameter.
  Otherwise, a null value is returned and errno is set to indicate the error.

ERRORS
  The getcwd() function sets errno to the specified values for the following
  conditions:

  [EACCES]
      Read or search permission was denied for a component of the pathname.

  [EINVAL]
      The size parameter is zero.

      [Tru64 UNIX]  The size parameter is less than or equal to zero (for the
      libsys5 version of getcwd() only).

  [ERANGE]
      The size parameter is greater than zero, but is smaller than the length
      of the pathname + 1.

  [ENOMEM]
      The requested amount of memory could not be allocated.

SEE ALSO
  Functions: malloc(3), getwd(3)

  Standards: standards(5)

Index for Section 3

Alphabetical listing for G

Top of page