---
name: "Gnome2::VFS::Handle"
section: "3pm"
platform: "linux"
package: "libgnome2-vfs-perl"
version: "1.082-1+b3"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/Gnome2::VFS::Handle"
---

# Gnome2::VFS::Handle(3pm)

basic file operations

## NAME

read, write, etc - basic file operations

## METHODS

### result = $handle-\>close

### list = $handle-\>get\_file\_info ($options)

- •

  `$options` (Gnome2::VFS::FileInfoOptions)

Returns a GnomeVFSResult and a GnomeVFSFileInfo.

### result = $handle-\>forget\_cache ($offset, $size)

- •

  `$offset` (unsigned)

- •

  `$size` (unsigned)

Since: vfs 2.12

### list = $handle-\>read ($bytes)

- •

  `$bytes` (unsigned)

Returns a GnomeVFSResult, the number of bytes read and the buffer containing the read content.

### result = $handle-\>seek ($whence, $offset)

- •

  `$whence` (Gnome2::VFS::SeekPosition)

- •

  `$offset` (unsigned)

### list = $handle-\>tell

Returns a GnomeVFSResult and the offset.

### result = $handle-\>truncate ($length)

- •

  `$length` (unsigned)

### list = $handle-\>write ($buffer, $bytes)

- •

  `$buffer` (string)

- •

  `$bytes` (unsigned)

Returns a GnomeVFSResult and the number of bytes written.

## ENUMS AND FLAGS

### flags Gnome2::VFS::FileInfoOptions

- •

  'default' / 'GNOME\_VFS\_FILE\_INFO\_DEFAULT'

- •

  'get-mime-type' / 'GNOME\_VFS\_FILE\_INFO\_GET\_MIME\_TYPE'

- •

  'force-fast-mime-type' / 'GNOME\_VFS\_FILE\_INFO\_FORCE\_FAST\_MIME\_TYPE'

- •

  'force-slow-mime-type' / 'GNOME\_VFS\_FILE\_INFO\_FORCE\_SLOW\_MIME\_TYPE'

- •

  'follow-links' / 'GNOME\_VFS\_FILE\_INFO\_FOLLOW\_LINKS'

- •

  'get-access-rights' / 'GNOME\_VFS\_FILE\_INFO\_GET\_ACCESS\_RIGHTS'

- •

  'name-only' / 'GNOME\_VFS\_FILE\_INFO\_NAME\_ONLY'

- •

  'get-acl' / 'GNOME\_VFS\_FILE\_INFO\_GET\_ACL'

- •

  'get-selinux-context' / 'GNOME\_VFS\_FILE\_INFO\_GET\_SELINUX\_CONTEXT'

### enum Gnome2::VFS::Result

- •

  'ok' / 'GNOME\_VFS\_OK'

- •

  'error-not-found' / 'GNOME\_VFS\_ERROR\_NOT\_FOUND'

- •

  'error-generic' / 'GNOME\_VFS\_ERROR\_GENERIC'

- •

  'error-internal' / 'GNOME\_VFS\_ERROR\_INTERNAL'

- •

  'error-bad-parameters' / 'GNOME\_VFS\_ERROR\_BAD\_PARAMETERS'

- •

  'error-not-supported' / 'GNOME\_VFS\_ERROR\_NOT\_SUPPORTED'

- •

  'error-io' / 'GNOME\_VFS\_ERROR\_IO'

- •

  'error-corrupted-data' / 'GNOME\_VFS\_ERROR\_CORRUPTED\_DATA'

- •

  'error-wrong-format' / 'GNOME\_VFS\_ERROR\_WRONG\_FORMAT'

- •

  'error-bad-file' / 'GNOME\_VFS\_ERROR\_BAD\_FILE'

- •

  'error-too-big' / 'GNOME\_VFS\_ERROR\_TOO\_BIG'

- •

  'error-no-space' / 'GNOME\_VFS\_ERROR\_NO\_SPACE'

- •

  'error-read-only' / 'GNOME\_VFS\_ERROR\_READ\_ONLY'

- •

  'error-invalid-uri' / 'GNOME\_VFS\_ERROR\_INVALID\_URI'

- •

  'error-not-open' / 'GNOME\_VFS\_ERROR\_NOT\_OPEN'

- •

  'error-invalid-open-mode' / 'GNOME\_VFS\_ERROR\_INVALID\_OPEN\_MODE'

- •

  'error-access-denied' / 'GNOME\_VFS\_ERROR\_ACCESS\_DENIED'

- •

  'error-too-many-open-files' / 'GNOME\_VFS\_ERROR\_TOO\_MANY\_OPEN\_FILES'

- •

  'error-eof' / 'GNOME\_VFS\_ERROR\_EOF'

- •

  'error-not-a-directory' / 'GNOME\_VFS\_ERROR\_NOT\_A\_DIRECTORY'

- •

  'error-in-progress' / 'GNOME\_VFS\_ERROR\_IN\_PROGRESS'

- •

  'error-interrupted' / 'GNOME\_VFS\_ERROR\_INTERRUPTED'

- •

  'error-file-exists' / 'GNOME\_VFS\_ERROR\_FILE\_EXISTS'

- •

  'error-loop' / 'GNOME\_VFS\_ERROR\_LOOP'

- •

  'error-not-permitted' / 'GNOME\_VFS\_ERROR\_NOT\_PERMITTED'

- •

  'error-is-directory' / 'GNOME\_VFS\_ERROR\_IS\_DIRECTORY'

- •

  'error-no-memory' / 'GNOME\_VFS\_ERROR\_NO\_MEMORY'

- •

  'error-host-not-found' / 'GNOME\_VFS\_ERROR\_HOST\_NOT\_FOUND'

- •

  'error-invalid-host-name' / 'GNOME\_VFS\_ERROR\_INVALID\_HOST\_NAME'

- •

  'error-host-has-no-address' / 'GNOME\_VFS\_ERROR\_HOST\_HAS\_NO\_ADDRESS'

- •

  'error-login-failed' / 'GNOME\_VFS\_ERROR\_LOGIN\_FAILED'

- •

  'error-cancelled' / 'GNOME\_VFS\_ERROR\_CANCELLED'

- •

  'error-directory-busy' / 'GNOME\_VFS\_ERROR\_DIRECTORY\_BUSY'

- •

  'error-directory-not-empty' / 'GNOME\_VFS\_ERROR\_DIRECTORY\_NOT\_EMPTY'

- •

  'error-too-many-links' / 'GNOME\_VFS\_ERROR\_TOO\_MANY\_LINKS'

- •

  'error-read-only-file-system' / 'GNOME\_VFS\_ERROR\_READ\_ONLY\_FILE\_SYSTEM'

- •

  'error-not-same-file-system' / 'GNOME\_VFS\_ERROR\_NOT\_SAME\_FILE\_SYSTEM'

- •

  'error-name-too-long' / 'GNOME\_VFS\_ERROR\_NAME\_TOO\_LONG'

- •

  'error-service-not-available' / 'GNOME\_VFS\_ERROR\_SERVICE\_NOT\_AVAILABLE'

- •

  'error-service-obsolete' / 'GNOME\_VFS\_ERROR\_SERVICE\_OBSOLETE'

- •

  'error-protocol-error' / 'GNOME\_VFS\_ERROR\_PROTOCOL\_ERROR'

- •

  'error-no-master-browser' / 'GNOME\_VFS\_ERROR\_NO\_MASTER\_BROWSER'

- •

  'error-no-default' / 'GNOME\_VFS\_ERROR\_NO\_DEFAULT'

- •

  'error-no-handler' / 'GNOME\_VFS\_ERROR\_NO\_HANDLER'

- •

  'error-parse' / 'GNOME\_VFS\_ERROR\_PARSE'

- •

  'error-launch' / 'GNOME\_VFS\_ERROR\_LAUNCH'

- •

  'error-timeout' / 'GNOME\_VFS\_ERROR\_TIMEOUT'

- •

  'error-nameserver' / 'GNOME\_VFS\_ERROR\_NAMESERVER'

- •

  'error-locked' / 'GNOME\_VFS\_ERROR\_LOCKED'

- •

  'error-deprecated-function' / 'GNOME\_VFS\_ERROR\_DEPRECATED\_FUNCTION'

- •

  'error-invalid-filename' / 'GNOME\_VFS\_ERROR\_INVALID\_FILENAME'

- •

  'error-not-a-symbolic-link' / 'GNOME\_VFS\_ERROR\_NOT\_A\_SYMBOLIC\_LINK'

- •

  'num-errors' / 'GNOME\_VFS\_NUM\_ERRORS'

### enum Gnome2::VFS::SeekPosition

- •

  'start' / 'GNOME\_VFS\_SEEK\_START'

- •

  'current' / 'GNOME\_VFS\_SEEK\_CURRENT'

- •

  'end' / 'GNOME\_VFS\_SEEK\_END'

## SEE ALSO

Gnome2::VFS

## COPYRIGHT

Copyright (C) 2003-2007, 2013 by the gtk2-perl team.

This software is licensed under the LGPL.  See Gnome2::VFS for a full notice.