---
name: "Gnome2::VFS::main"
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::main"
---

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

Filesystem Abstraction library

## NAME

Gnome2::VFS::main - Filesystem Abstraction library

## METHODS

### boolean = Gnome2::VFS-\>CHECK\_VERSION ($major, $minor, $micro)

- •

  `$major` (integer)

- •

  `$minor` (integer)

- •

  `$micro` (integer)

### list = Gnome2::VFS-\>GET\_VERSION\_INFO

Returns the major, minor and micro version numbers of GnomeVFS.

### list = Gnome2::VFS-\>check\_same\_fs ($source, $target)

- •

  `$source` (string)

- •

  `$target` (string)

Returns a GnomeVFSResult and a boolean.

### list = Gnome2::VFS-\>create ($text\_uri, $open\_mode, $exclusive, $perm)

- •

  `$text_uri` (string)

- •

  `$open_mode` (Gnome2::VFS::OpenMode)

- •

  `$exclusive` (boolean)

- •

  `$perm` (integer)

Returns a GnomeVFSResult and a GnomeVFSHandle.

### result = Gnome2::VFS-\>create\_symbolic\_link ($uri, $target\_reference)

- •

  `$uri` (Gnome2::VFS::URI)

- •

  `$target_reference` (string)

### string = Gnome2::VFS-\>escape\_host\_and\_path\_string ($path)

- •

  `$path` (string)

### string = Gnome2::VFS-\>escape\_path\_string ($path)

- •

  `$path` (string)

### string = Gnome2::VFS-\>escape\_set ($string, $match\_set)

- •

  `$string` (string)

- •

  `$match_set` (string)

### string = Gnome2::VFS-\>escape\_slashes ($string)

- •

  `$string` (string)

### string = Gnome2::VFS-\>escape\_string ($string)

- •

  `$string` (string)

Since: vfs 2.2

### string = Gnome2::VFS-\>expand\_initial\_tilde ($path)

- •

  `$path` (string)

### list = Gnome2::VFS-\>get\_file\_info ($text\_uri, $options)

- •

  `$text_uri` (string)

- •

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

Returns a GnomeVFSResult and a GnomeVFSFileInfo.

### result = Gnome2::VFS-\>set\_file\_info ($text\_uri, $info, $mask)

- •

  `$text_uri` (string)

- •

  `$info` (Gnome2::VFS::FileInfo)

- •

  `$mask` (Gnome2::VFS::SetFileInfoMask)

### list = Gnome2::VFS-\>find\_directory ($near\_uri, $kind, $create\_if\_needed, $find\_if\_needed, $permissions)

- •

  `$near_uri` (Gnome2::VFS::URI)

- •

  `$kind` (Gnome2::VFS::FindDirectoryKind)

- •

  `$create_if_needed` (boolean)

- •

  `$find_if_needed` (boolean)

- •

  `$permissions` (integer)

Returns a GnomeVFSResult and a GnomeVFSURI.

### string = Gnome2::VFS-\>format\_file\_size\_for\_display ($size)

- •

  `$size` (unsigned)

### string = Gnome2::VFS-\>format\_uri\_for\_display ($uri)

- •

  `$uri` (string)

Since: vfs 2.2

### string = Gnome2::VFS-\>icon\_path\_from\_filename ($filename)

- •

  `$filename` (string)

### boolean = Gnome2::VFS-\>init

### boolean = Gnome2::VFS-\>initialized

### boolean = Gnome2::VFS-\>is\_executable\_command\_string ($command\_string)

- •

  `$command_string` (string)

### boolean = Gnome2::VFS-\>is\_primary\_thread

### string = Gnome2::VFS-\>get\_local\_path\_from\_uri ($uri)

- •

  `$uri` (string)

### result = Gnome2::VFS-\>make\_directory ($text\_uri, $perm)

- •

  `$text_uri` (string)

- •

  `$perm` (integer)

### string = Gnome2::VFS-\>make\_path\_name\_canonical ($path)

- •

  `$path` (string)

### string = Gnome2::VFS-\>make\_uri\_canonical ($uri)

- •

  `$uri` (string)

### string = Gnome2::VFS-\>make\_uri\_canonical\_strip\_fragment ($uri)

- •

  `$uri` (string)

Since: vfs 2.2

### string = Gnome2::VFS-\>make\_uri\_from\_input ($uri)

- •

  `$uri` (string)

Since: vfs 2.2

### string = Gnome2::VFS-\>make\_uri\_from\_input\_with\_dirs ($uri, $dirs)

- •

  `$uri` (string)

- •

  `$dirs` (Gnome2::VFS::MakeURIDirs)

Since: vfs 2.4

### string = Gnome2::VFS-\>make\_uri\_from\_input\_with\_trailing\_ws ($location)

- •

  `$location` (string)

Since: vfs 2.12

### string = Gnome2::VFS-\>make\_uri\_from\_shell\_arg ($uri)

- •

  `$uri` (string)

Since: vfs 2.2

### result = Gnome2::VFS-\>move ($old\_text\_uri, $new\_text\_uri, $force\_replace)

- •

  `$old_text_uri` (string)

- •

  `$new_text_uri` (string)

- •

  `$force_replace` (boolean)

### list = Gnome2::VFS-\>open ($text\_uri, $open\_mode)

- •

  `$text_uri` (string)

- •

  `$open_mode` (Gnome2::VFS::OpenMode)

Returns a GnomeVFSResult and a GnomeVFSHandle.

### list = Gnome2::VFS-\>read\_entire\_file ($uri)

- •

  `$uri` (string)

Returns a GnomeVFSResult, the file size and the file content.

Since: vfs 2.2

### result = Gnome2::VFS-\>remove\_directory ($text\_uri)

- •

  `$text_uri` (string)

### string = Gnome2::VFS-\>result\_to\_string ($result)

- •

  `$result` (Gnome2::VFS::Result)

### Gnome2::VFS-\>shutdown

### result = Gnome2::VFS-\>truncate ($text\_uri, $length)

- •

  `$text_uri` (string)

- •

  `$length` (unsigned)

### string = Gnome2::VFS-\>unescape\_string ($escaped\_string, $illegal\_characters=undef)

- •

  `$escaped_string` (string)

- •

  `$illegal_characters` (string)

### string = Gnome2::VFS-\>unescape\_string\_for\_display ($escaped)

- •

  `$escaped` (string)

### result = Gnome2::VFS-\>unlink ($text\_uri)

- •

  `$text_uri` (string)

### string = Gnome2::VFS-\>get\_uri\_from\_local\_path ($local\_full\_path)

- •

  `$local_full_path` (string)

### string = Gnome2::VFS-\>get\_uri\_scheme ($uri)

- •

  `$uri` (string)

Since: vfs 2.2

### boolean = Gnome2::VFS-\>uris\_match ($uri\_1, $uri\_2)

- •

  `$uri_1` (string)

- •

  `$uri_2` (string)

Since: vfs 2.2

### result = Gnome2::VFS-\>url\_show ($url)

- •

  `$url` (string)

Since: vfs 2.4

### result = Gnome2::VFS-\>url\_show\_with\_env ($url, $env\_ref)

- •

  `$url` (string)

- •

  `$env_ref` (scalar)

Since: vfs 2.4

### list = Gnome2::VFS-\>get\_volume\_free\_space ($vfs\_uri)

- •

  `$vfs_uri` (Gnome2::VFS::URI)

Returns a GnomeVFSResult and a GnomeVFSFileSize.

## 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::FindDirectoryKind

- •

  'desktop' / 'GNOME\_VFS\_DIRECTORY\_KIND\_DESKTOP'

- •

  'trash' / 'GNOME\_VFS\_DIRECTORY\_KIND\_TRASH'

### flags Gnome2::VFS::MakeURIDirs

- •

  'none' / 'GNOME\_VFS\_MAKE\_URI\_DIR\_NONE'

- •

  'homedir' / 'GNOME\_VFS\_MAKE\_URI\_DIR\_HOMEDIR'

- •

  'current' / 'GNOME\_VFS\_MAKE\_URI\_DIR\_CURRENT'

### flags Gnome2::VFS::OpenMode

- •

  'none' / 'GNOME\_VFS\_OPEN\_NONE'

- •

  'read' / 'GNOME\_VFS\_OPEN\_READ'

- •

  'write' / 'GNOME\_VFS\_OPEN\_WRITE'

- •

  'random' / 'GNOME\_VFS\_OPEN\_RANDOM'

- •

  'truncate' / 'GNOME\_VFS\_OPEN\_TRUNCATE'

### 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'

### flags Gnome2::VFS::SetFileInfoMask

- •

  'none' / 'GNOME\_VFS\_SET\_FILE\_INFO\_NONE'

- •

  'name' / 'GNOME\_VFS\_SET\_FILE\_INFO\_NAME'

- •

  'permissions' / 'GNOME\_VFS\_SET\_FILE\_INFO\_PERMISSIONS'

- •

  'owner' / 'GNOME\_VFS\_SET\_FILE\_INFO\_OWNER'

- •

  'time' / 'GNOME\_VFS\_SET\_FILE\_INFO\_TIME'

- •

  'acl' / 'GNOME\_VFS\_SET\_FILE\_INFO\_ACL'

- •

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

- •

  'symlink-name' / 'GNOME\_VFS\_SET\_FILE\_INFO\_SYMLINK\_NAME'

## 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.