.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" 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.  \*(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<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    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
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Gnome2::VFS::Handle 3pm"
.TH Gnome2::VFS::Handle 3pm "2017-07-22" "perl v5.26.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
read, write, etc \- basic file operations
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "result = $handle\->\fBclose\fP"
.el .SS "result = \f(CW$handle\fP\->\fBclose\fP"
.IX Subsection "result = $handle->close"
.ie n .SS "list = $handle\->\fBget_file_info\fP ($options)"
.el .SS "list = \f(CW$handle\fP\->\fBget_file_info\fP ($options)"
.IX Subsection "list = $handle->get_file_info ($options)"
.IP "\(bu" 4
\&\f(CW$options\fR (Gnome2::VFS::FileInfoOptions)
.PP
Returns a GnomeVFSResult and a GnomeVFSFileInfo.
.ie n .SS "result = $handle\->\fBforget_cache\fP ($offset, $size)"
.el .SS "result = \f(CW$handle\fP\->\fBforget_cache\fP ($offset, \f(CW$size\fP)"
.IX Subsection "result = $handle->forget_cache ($offset, $size)"
.IP "\(bu" 4
\&\f(CW$offset\fR (unsigned)
.IP "\(bu" 4
\&\f(CW$size\fR (unsigned)
.PP
Since: vfs 2.12
.ie n .SS "list = $handle\->\fBread\fP ($bytes)"
.el .SS "list = \f(CW$handle\fP\->\fBread\fP ($bytes)"
.IX Subsection "list = $handle->read ($bytes)"
.IP "\(bu" 4
\&\f(CW$bytes\fR (unsigned)
.PP
Returns a GnomeVFSResult, the number of bytes read and the buffer containing
the read content.
.ie n .SS "result = $handle\->\fBseek\fP ($whence, $offset)"
.el .SS "result = \f(CW$handle\fP\->\fBseek\fP ($whence, \f(CW$offset\fP)"
.IX Subsection "result = $handle->seek ($whence, $offset)"
.IP "\(bu" 4
\&\f(CW$whence\fR (Gnome2::VFS::SeekPosition)
.IP "\(bu" 4
\&\f(CW$offset\fR (unsigned)
.ie n .SS "list = $handle\->\fBtell\fP"
.el .SS "list = \f(CW$handle\fP\->\fBtell\fP"
.IX Subsection "list = $handle->tell"
Returns a GnomeVFSResult and the offset.
.ie n .SS "result = $handle\->\fBtruncate\fP ($length)"
.el .SS "result = \f(CW$handle\fP\->\fBtruncate\fP ($length)"
.IX Subsection "result = $handle->truncate ($length)"
.IP "\(bu" 4
\&\f(CW$length\fR (unsigned)
.ie n .SS "list = $handle\->\fBwrite\fP ($buffer, $bytes)"
.el .SS "list = \f(CW$handle\fP\->\fBwrite\fP ($buffer, \f(CW$bytes\fP)"
.IX Subsection "list = $handle->write ($buffer, $bytes)"
.IP "\(bu" 4
\&\f(CW$buffer\fR (string)
.IP "\(bu" 4
\&\f(CW$bytes\fR (unsigned)
.PP
Returns a GnomeVFSResult and the number of bytes written.
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "flags Gnome2::VFS::FileInfoOptions"
.IX Subsection "flags Gnome2::VFS::FileInfoOptions"
.IP "\(bu" 4
\&'default' / '\s-1GNOME_VFS_FILE_INFO_DEFAULT\s0'
.IP "\(bu" 4
\&'get\-mime\-type' / '\s-1GNOME_VFS_FILE_INFO_GET_MIME_TYPE\s0'
.IP "\(bu" 4
\&'force\-fast\-mime\-type' / '\s-1GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE\s0'
.IP "\(bu" 4
\&'force\-slow\-mime\-type' / '\s-1GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE\s0'
.IP "\(bu" 4
\&'follow\-links' / '\s-1GNOME_VFS_FILE_INFO_FOLLOW_LINKS\s0'
.IP "\(bu" 4
\&'get\-access\-rights' / '\s-1GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS\s0'
.IP "\(bu" 4
\&'name\-only' / '\s-1GNOME_VFS_FILE_INFO_NAME_ONLY\s0'
.IP "\(bu" 4
\&'get\-acl' / '\s-1GNOME_VFS_FILE_INFO_GET_ACL\s0'
.IP "\(bu" 4
\&'get\-selinux\-context' / '\s-1GNOME_VFS_FILE_INFO_GET_SELINUX_CONTEXT\s0'
.SS "enum Gnome2::VFS::Result"
.IX Subsection "enum Gnome2::VFS::Result"
.IP "\(bu" 4
\&'ok' / '\s-1GNOME_VFS_OK\s0'
.IP "\(bu" 4
\&'error\-not\-found' / '\s-1GNOME_VFS_ERROR_NOT_FOUND\s0'
.IP "\(bu" 4
\&'error\-generic' / '\s-1GNOME_VFS_ERROR_GENERIC\s0'
.IP "\(bu" 4
\&'error\-internal' / '\s-1GNOME_VFS_ERROR_INTERNAL\s0'
.IP "\(bu" 4
\&'error\-bad\-parameters' / '\s-1GNOME_VFS_ERROR_BAD_PARAMETERS\s0'
.IP "\(bu" 4
\&'error\-not\-supported' / '\s-1GNOME_VFS_ERROR_NOT_SUPPORTED\s0'
.IP "\(bu" 4
\&'error\-io' / '\s-1GNOME_VFS_ERROR_IO\s0'
.IP "\(bu" 4
\&'error\-corrupted\-data' / '\s-1GNOME_VFS_ERROR_CORRUPTED_DATA\s0'
.IP "\(bu" 4
\&'error\-wrong\-format' / '\s-1GNOME_VFS_ERROR_WRONG_FORMAT\s0'
.IP "\(bu" 4
\&'error\-bad\-file' / '\s-1GNOME_VFS_ERROR_BAD_FILE\s0'
.IP "\(bu" 4
\&'error\-too\-big' / '\s-1GNOME_VFS_ERROR_TOO_BIG\s0'
.IP "\(bu" 4
\&'error\-no\-space' / '\s-1GNOME_VFS_ERROR_NO_SPACE\s0'
.IP "\(bu" 4
\&'error\-read\-only' / '\s-1GNOME_VFS_ERROR_READ_ONLY\s0'
.IP "\(bu" 4
\&'error\-invalid\-uri' / '\s-1GNOME_VFS_ERROR_INVALID_URI\s0'
.IP "\(bu" 4
\&'error\-not\-open' / '\s-1GNOME_VFS_ERROR_NOT_OPEN\s0'
.IP "\(bu" 4
\&'error\-invalid\-open\-mode' / '\s-1GNOME_VFS_ERROR_INVALID_OPEN_MODE\s0'
.IP "\(bu" 4
\&'error\-access\-denied' / '\s-1GNOME_VFS_ERROR_ACCESS_DENIED\s0'
.IP "\(bu" 4
\&'error\-too\-many\-open\-files' / '\s-1GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES\s0'
.IP "\(bu" 4
\&'error\-eof' / '\s-1GNOME_VFS_ERROR_EOF\s0'
.IP "\(bu" 4
\&'error\-not\-a\-directory' / '\s-1GNOME_VFS_ERROR_NOT_A_DIRECTORY\s0'
.IP "\(bu" 4
\&'error\-in\-progress' / '\s-1GNOME_VFS_ERROR_IN_PROGRESS\s0'
.IP "\(bu" 4
\&'error\-interrupted' / '\s-1GNOME_VFS_ERROR_INTERRUPTED\s0'
.IP "\(bu" 4
\&'error\-file\-exists' / '\s-1GNOME_VFS_ERROR_FILE_EXISTS\s0'
.IP "\(bu" 4
\&'error\-loop' / '\s-1GNOME_VFS_ERROR_LOOP\s0'
.IP "\(bu" 4
\&'error\-not\-permitted' / '\s-1GNOME_VFS_ERROR_NOT_PERMITTED\s0'
.IP "\(bu" 4
\&'error\-is\-directory' / '\s-1GNOME_VFS_ERROR_IS_DIRECTORY\s0'
.IP "\(bu" 4
\&'error\-no\-memory' / '\s-1GNOME_VFS_ERROR_NO_MEMORY\s0'
.IP "\(bu" 4
\&'error\-host\-not\-found' / '\s-1GNOME_VFS_ERROR_HOST_NOT_FOUND\s0'
.IP "\(bu" 4
\&'error\-invalid\-host\-name' / '\s-1GNOME_VFS_ERROR_INVALID_HOST_NAME\s0'
.IP "\(bu" 4
\&'error\-host\-has\-no\-address' / '\s-1GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS\s0'
.IP "\(bu" 4
\&'error\-login\-failed' / '\s-1GNOME_VFS_ERROR_LOGIN_FAILED\s0'
.IP "\(bu" 4
\&'error\-cancelled' / '\s-1GNOME_VFS_ERROR_CANCELLED\s0'
.IP "\(bu" 4
\&'error\-directory\-busy' / '\s-1GNOME_VFS_ERROR_DIRECTORY_BUSY\s0'
.IP "\(bu" 4
\&'error\-directory\-not\-empty' / '\s-1GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY\s0'
.IP "\(bu" 4
\&'error\-too\-many\-links' / '\s-1GNOME_VFS_ERROR_TOO_MANY_LINKS\s0'
.IP "\(bu" 4
\&'error\-read\-only\-file\-system' / '\s-1GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM\s0'
.IP "\(bu" 4
\&'error\-not\-same\-file\-system' / '\s-1GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM\s0'
.IP "\(bu" 4
\&'error\-name\-too\-long' / '\s-1GNOME_VFS_ERROR_NAME_TOO_LONG\s0'
.IP "\(bu" 4
\&'error\-service\-not\-available' / '\s-1GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE\s0'
.IP "\(bu" 4
\&'error\-service\-obsolete' / '\s-1GNOME_VFS_ERROR_SERVICE_OBSOLETE\s0'
.IP "\(bu" 4
\&'error\-protocol\-error' / '\s-1GNOME_VFS_ERROR_PROTOCOL_ERROR\s0'
.IP "\(bu" 4
\&'error\-no\-master\-browser' / '\s-1GNOME_VFS_ERROR_NO_MASTER_BROWSER\s0'
.IP "\(bu" 4
\&'error\-no\-default' / '\s-1GNOME_VFS_ERROR_NO_DEFAULT\s0'
.IP "\(bu" 4
\&'error\-no\-handler' / '\s-1GNOME_VFS_ERROR_NO_HANDLER\s0'
.IP "\(bu" 4
\&'error\-parse' / '\s-1GNOME_VFS_ERROR_PARSE\s0'
.IP "\(bu" 4
\&'error\-launch' / '\s-1GNOME_VFS_ERROR_LAUNCH\s0'
.IP "\(bu" 4
\&'error\-timeout' / '\s-1GNOME_VFS_ERROR_TIMEOUT\s0'
.IP "\(bu" 4
\&'error\-nameserver' / '\s-1GNOME_VFS_ERROR_NAMESERVER\s0'
.IP "\(bu" 4
\&'error\-locked' / '\s-1GNOME_VFS_ERROR_LOCKED\s0'
.IP "\(bu" 4
\&'error\-deprecated\-function' / '\s-1GNOME_VFS_ERROR_DEPRECATED_FUNCTION\s0'
.IP "\(bu" 4
\&'error\-invalid\-filename' / '\s-1GNOME_VFS_ERROR_INVALID_FILENAME\s0'
.IP "\(bu" 4
\&'error\-not\-a\-symbolic\-link' / '\s-1GNOME_VFS_ERROR_NOT_A_SYMBOLIC_LINK\s0'
.IP "\(bu" 4
\&'num\-errors' / '\s-1GNOME_VFS_NUM_ERRORS\s0'
.SS "enum Gnome2::VFS::SeekPosition"
.IX Subsection "enum Gnome2::VFS::SeekPosition"
.IP "\(bu" 4
\&'start' / '\s-1GNOME_VFS_SEEK_START\s0'
.IP "\(bu" 4
\&'current' / '\s-1GNOME_VFS_SEEK_CURRENT\s0'
.IP "\(bu" 4
\&'end' / '\s-1GNOME_VFS_SEEK_END\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gnome2::VFS
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2007, 2013 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gnome2::VFS for a full notice.