Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
System Callsfpathconf(2)


NAME

 fpathconf, pathconf - get configurable pathname variables

SYNOPSIS

 
#include <unistd.h>
long fpathconf(int fildes, int name);
 long pathconf(const char *path, int name);

DESCRIPTION

 

The fpathconf() and pathconf() functions provide a method for the application to determine the current value of a configurable limit or option ( variable ) that is associated with a file or directory.

For pathconf(), the path argument points to the pathname of a file or directory.

For fpathconf(), the fildes argument is an open file descriptor.

The name argument represents the variable to be queried relative to that file or directory. The variables in the following table come from <limits.h> or <unistd.h> and the symbolic constants, defined in <unistd.h>, are the corresponding values used for name:

VariableValue of nameNotes
FILESIZEBITS_PC_FILESIZEBITS3,4
LINK_MAX_PC_LINK_MAX1
MAX_CANON_PC_MAX_CANON2
MAX_INPUT_PC_MAX_INPUT2
NAME_MAX_PC_NAME_MAX3,4
PATH_MAX_PC_PATH_MAX4,5
PIPE_BUF_PC_PIPE_BUF6
XATTR_ENABLED_PC_XATTR_ENABLED1
XATTR_EXISTS_PC_XATTR_EXISTS1
_POSIX_CHOWN_RESTRICTED_PC_CHOWN_RESTRICTED7
_POSIX_NO_TRUNC_PC_NO_TRUNC3,4
_POSIX_VDISABLE_PC_VDISABLE2
_POSIX_ASYNC_IO_PC_ASYNC_IO8
_POSIX_PRIO_IO_PC_PRIO_IO8
_POSIX_SYNC_IO_PC_SYNC_IO8

Notes:

  1. If path or fildes refers to a directory, the value returned applies to the directory itself.
  2. If path or fildes does not refer to a terminal file, it is unspecified whether an implementation supports an association of the variable name with the specified file.
  3. If path or fildes refers to a directory, the value returned applies to filenames within the directory.
  4. If path or fildes does not refer to a directory, it is unspecified whether an implementation supports an association of the variable name with the specified file.
  5. If path or fildes refers to a directory, the value returned is the maximum length of a relative pathname when the specified directory is the working directory.
  6. If path refers to a FIFO, or fildes refers to a pipe or FIFO, the value returned applies to the referenced object. If path or fildes refers to a directory, the value returned applies to any FIFO that exists or can be created within the directory. If path or fildes refers to any other type of file, it is unspecified whether an implementation supports an association of the variable name with the specified file.
  7. If path or fildes refers to a directory, the value returned applies to any files, other than directories, that exist or can be created within the directory.
  8. If path or fildes refers to a directory, it is unspecified whether an implementation supports an association of the variable name with the specified file.

RETURN VALUES

 

If name is an invalid value, both pathconf() and fpathconf() return -1 and errno is set to indicate the error.

If the variable corresponding to name has no limit for the path or file descriptor, both pathconf() and fpathconf() return -1 without changing errno. If the implementation needs to use path to determine the value of name and the implementation does not support the association of name with the file specified by path, or if the process did not have appropriate privileges to query the file specified by path, or path does not exist, pathconf() returns -1 and errno is set to indicate the error.

If the implementation needs to use fildes to determine the value of name and the implementation does not support the association of name with the file specified by fildes, or if fildes is an invalid file descriptor, fpathconf() will return -1 and errno is set to indicate the error.

Otherwise pathconf() or fpathconf() returns the current variable value for the file or directory without changing errno. The value returned will not be more restrictive than the corresponding value available to the application when it was compiled with the implementation's <limits.h> or <unistd.h>.

ERRORS

 

The pathconf() function will fail if:

EINVAL
The value of name is not valid.
ELOOP
Too many symbolic links were encountered in resolving path.

The pathconf() function may fail if:

EACCES
Search permission is denied for a component of the path prefix.
EINVAL
The implementation does not support an association of the variable name with the specified file.
ENAMETOOLONG
The length of the path argument exceeds PATH_MAX or a pathname component is longer than NAME_MAX.
ENAMETOOLONG
Pathname resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX.
ENOENT
A component of path does not name an existing file or path is an empty string.
ENOTDIR
A component of the path prefix is not a directory.

The fpathconf() function will fail if:

EINVAL
The value of name is not valid.

The fpathconf() function may fail if:

EBADF
The fildes argument is not a valid file descriptor.
EINVAL
The implementation does not support an association of the variable name with the specified file.

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface Stabilityfpathconf is Standard; pathconf is Stable
MT-Levelpathconf is Async-Signal-Safe

SEE ALSO

 

sysconf(3C), limits(4), attributes(5), standards(5)


SunOS 5.9Go To TopLast Changed 16 Aug 2001

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.