MAN page from Scientific Linux Other perl-5.8.8-43.el5_11.x86_64.rpm

IO::File

Section: Perl Programmers Reference Guide (3pm)
Updated: 2014-10-30
Index

NAME

IO::File - supply object methods for filehandles

SYNOPSIS

    use IO::File;

    $fh = new IO::File;    if ($fh->open("< file")) {        print <$fh>;        $fh->close;    }

    $fh = new IO::File "> file";    if (defined $fh) {        print $fh "bar\n";        $fh->close;    }

    $fh = new IO::File "file", "r";    if (defined $fh) {        print <$fh>;        undef $fh;       # automatically closes the file    }

    $fh = new IO::File "file", O_WRONLY|O_APPEND;    if (defined $fh) {        print $fh "corge\n";

        $pos = $fh->getpos;        $fh->setpos($pos);

        undef $fh;       # automatically closes the file    }

    autoflush STDOUT 1;

DESCRIPTION

"IO::File" inherits from "IO::Handle" and "IO::Seekable". It extendsthese classes with methods that are specific to file handles.

CONSTRUCTOR

new ( FILENAME [,MODE [,PERMS]] ): Creates an "IO::File". If it receives any parameters, they are passed tothe method "open"; if the open fails, the object is destroyed. Otherwise,it is returned to the caller.
new_tmpfile: Creates an "IO::File" opened for read/write on a newly created temporaryfile. On systems where this is possible, the temporary file is anonymous(i.e. it is unlinked after creation, but held open). If the temporaryfile cannot be created or opened, the "IO::File" object is destroyed.Otherwise, it is returned to the caller.

METHODS

open( FILENAME [,MODE [,PERMS]] )

open( FILENAME, IOLAYERS )

"open" accepts one, two or three parameters. With one parameter,it is just a front end for the built-in "open" function. With two or threeparameters, the first parameter is a filename that may includewhitespace or other special characters, and the second parameter isthe open mode, optionally followed by a file permission value.

If "IO::File::open" receives a Perl mode string (">``, ''+<``, etc.)or an ANSI C fopen() mode string (''w``, ''r+", etc.), it uses the basicPerl "open" operator (but protects any special characters).

If "IO::File::open" is given a numeric mode, it passes that modeand the optional permissions value to the Perl "sysopen" operator.The permissions default to 0666.

If "IO::File::open" is given a mode that includes the ":" character,it passes all the three arguments to the three-argument "open" operator.

For convenience, "IO::File" exports the O_XXX constants from theFcntl module, if this module is available.

binmode( [LAYER] )

"binmode" sets "binmode" on the underlying "IO" object, as documentedin "perldoc -f binmode".

"binmode" accepts one optional parameter, which is the layer to bepassed on to the "binmode" call.

NOTE

Some operating systems may perform "IO::File::new()" or "IO::File::open()"on a directory without errors. This behavior is not portable and notsuggested for use. Using "opendir()" and "readdir()" or "IO::Dir" aresuggested instead.

HISTORY

Derived from FileHandle.pm by Graham Barr <gbarrAATTpobox.com>.

This document was created byman2html,using the manual pages.