.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "IO::Seekable 3"
.TH IO::Seekable 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
IO::Seekable \- supply seek based methods for I/O objects
\& package IO::Something;
\& @ISA = qw(IO::Seekable);
\&\f(CW\*(C`IO::Seekable\*(C'\fR does not have a constructor of its own as it is intended to
be inherited by other \f(CW\*(C`IO::Handle\*(C'\fR based objects. It provides methods
which allow seeking of the file descriptors.
Returns an opaque value that represents the current position of the
IO::File, or \f(CW\*(C`undef\*(C'\fR if this is not possible (eg an unseekable stream such
as a terminal, pipe or socket). If the \fIfgetpos()\fR function is available in
your C library it is used to implements getpos, else perl emulates getpos
using C's \fIftell()\fR function.
Uses the value of a previous getpos call to return to a previously visited
position. Returns \*(L"0 but true\*(R" on success, \f(CW\*(C`undef\*(C'\fR on failure.
See perlfunc for complete descriptions of each of the following
supported \f(CW\*(C`IO::Seekable\*(C'\fR methods, which are just front ends for the
corresponding built-in functions:
.IP "$io\->seek ( \s-1POS\s0, \s-1WHENCE\s0 )" 4
.IX Item "$io->seek ( POS, WHENCE )"
Seek the IO::File to position \s-1POS\s0, relative to \s-1WHENCE:\s0
.IP "WHENCE=0 (\s-1SEEK_SET\s0)" 8
.IX Item "WHENCE=0 (SEEK_SET)"
\&\s-1POS\s0 is absolute position. (Seek relative to the start of the file)
.IP "WHENCE=1 (\s-1SEEK_CUR\s0)" 8
.IX Item "WHENCE=1 (SEEK_CUR)"
\&\s-1POS\s0 is an offset from the current position. (Seek relative to current)
.IP "WHENCE=2 (\s-1SEEK_END\s0)" 8
.IX Item "WHENCE=2 (SEEK_END)"
\&\s-1POS\s0 is an offset from the end of the file. (Seek relative to end)
The SEEK_* constants can be imported from the \f(CW\*(C`Fcntl\*(C'\fR module if you
don't wish to use the numbers \f(CW0\fR \f(CW1\fR or \f(CW2\fR in your code.
Returns \f(CW1\fR upon success, \f(CW0\fR otherwise.
.IP "$io\->sysseek( \s-1POS\s0, \s-1WHENCE\s0 )" 4
.IX Item "$io->sysseek( POS, WHENCE )"
Similar to \f(CW$io\fR\->seek, but sets the IO::File's position using the system
call \fIlseek\fR\|(2) directly, so will confuse most perl \s-1IO\s0 operators except
sysread and syswrite (see perlfunc for full details)
Returns the new position, or \f(CW\*(C`undef\*(C'\fR on failure. A position
of zero is returned as the string \f(CW"0 but true"\fR
Returns the IO::File's current position, or \-1 on error.
\&\*(L"I/O Operators\*(R" in perlop,
Derived from FileHandle.pm by Graham Barr <gbarr@pobox.com>
projects / OpenSPARC-T2-SAM / blob