NAME

APR::Finfo - Perl API for XXX

Synopsis

use APR::Finfo ();

META: to be completed

Description

META: to be completed

API

APR::Finfo provides the following functions and/or methods:

stat

META: Autogenerated - needs to be reviewed/completed

get the specified file's stats. The file is specified by filename, instead of using a pre-opened file.

$ret = $finfo->stat($fname, $wanted, $cont);
arg1: $finfo (APR::Finfo)

Where to store the information about the file, which is never touched if the call fails.

arg2: $fname (string)

The name of the file to stat.

arg3: $wanted (string)

The desired apr_finfo_t fields, as a bit flag of APR_FINFO_ values

arg4: $cont (integer)

the pool to use to allocate the new file.

ret: $ret (integer)

pool

META: Autogenerated - needs to be reviewed/completed

Allocates memory and closes lingering handles in the specified pool

$ret = $obj->pool($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (APR::Pool)

valid

META: Autogenerated - needs to be reviewed/completed

The bitmask describing valid fields of this apr_finfo_t structure including all available 'wanted' fields and potentially more

$ret = $obj->valid($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

protection

META: Autogenerated - needs to be reviewed/completed

The access permissions of the file. Mimics Unix access rights.

$ret = $obj->protection($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

filetype

META: Autogenerated - needs to be reviewed/completed

The type of file. One of APR_REG, APR_DIR, APR_CHR, APR_BLK, APR_PIPE, APR_LNK or APR_SOCK. If the type is undetermined, the value is APR_NOFILE. If the type cannot be determined, the value is APR_UNKFILE.

$ret = $obj->filetype($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

user

META: Autogenerated - needs to be reviewed/completed

The user id that owns the file

$ret = $obj->user($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

group

META: Autogenerated - needs to be reviewed/completed

The group id that owns the file

$ret = $obj->group($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

inode

META: Autogenerated - needs to be reviewed/completed

The inode of the file.

$ret = $obj->inode($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

device

META: Autogenerated - needs to be reviewed/completed

The id of the device the file is on.

$ret = $obj->device($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (number)

META: Autogenerated - needs to be reviewed/completed

The number of hard links to the file.

$ret = $obj->nlink($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

size

META: Autogenerated - needs to be reviewed/completed

The size of the file

$ret = $obj->size($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

csize

META: Autogenerated - needs to be reviewed/completed

The storage size consumed by the file

$ret = $obj->csize($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (integer)

atime

META: Autogenerated - needs to be reviewed/completed

The time the file was last accessed

$ret = $obj->atime($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (number)

mtime

META: Autogenerated - needs to be reviewed/completed

The time the file was last modified

$ret = $obj->mtime($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (number)

ctime

META: Autogenerated - needs to be reviewed/completed

The time the file was last changed

$ret = $obj->ctime($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (number)

fname

META: Autogenerated - needs to be reviewed/completed

The pathname of the file (possibly unrooted)

$ret = $obj->fname($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (string)

name

META: Autogenerated - needs to be reviewed/completed

The file's name (no path) in filesystem case

$ret = $obj->name($newval);
arg1: $obj (APR::Finfo)
arg2: $newval (string)

See Also

mod_perl 2.0 documentation.

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.

Authors

The mod_perl development team and numerous contributors.