Scroll to navigation

Gnome2::VFS::main(3pm) User Contributed Perl Documentation Gnome2::VFS::main(3pm)
 

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.
•
$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)
•
$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.
2014-08-15 perl v5.20.0