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)
o $major (integer)
o $minor (integer)
o $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)
o $source (string)
o $target (string)
Returns a GnomeVFSResult and a boolean.
list = Gnome2::VFS->create ($text_uri, $open_mode, $exclusive, $perm)
o $text_uri (string)
o $open_mode (Gnome2::VFS::OpenMode)
o $exclusive (boolean)
o $perm (integer)
Returns a GnomeVFSResult and a GnomeVFSHandle.
result = Gnome2::VFS->create_symbolic_link ($uri, $target_reference)
o $uri (Gnome2::VFS::URI)
o $target_reference (string)
string = Gnome2::VFS->escape_host_and_path_string ($path)
o $path (string)
string = Gnome2::VFS->escape_path_string ($path)
o $path (string)
string = Gnome2::VFS->escape_set ($string, $match_set)
o $string (string)
o $match_set (string)
string = Gnome2::VFS->escape_slashes ($string)
o $string (string)
string = Gnome2::VFS->escape_string ($string)
o $string (string)
Since: vfs 2.2
string = Gnome2::VFS->expand_initial_tilde ($path)
o $path (string)
list = Gnome2::VFS->get_file_info ($text_uri, $options)
o $text_uri (string)
o $options (Gnome2::VFS::FileInfoOptions)
Returns a GnomeVFSResult and a GnomeVFSFileInfo.
result = Gnome2::VFS->set_file_info ($text_uri, $info, $mask)
o $text_uri (string)
o $info (Gnome2::VFS::FileInfo)
o $mask (Gnome2::VFS::SetFileInfoMask)
list = Gnome2::VFS->find_directory ($near_uri, $kind, $create_if_needed, $find_if_needed, $permissions)
o $near_uri (Gnome2::VFS::URI)
o $kind (Gnome2::VFS::FindDirectoryKind)
o $create_if_needed (boolean)
o $find_if_needed (boolean)
o $permissions (integer)
Returns a GnomeVFSResult and a GnomeVFSURI.
string = Gnome2::VFS->format_file_size_for_display ($size)
o $size (unsigned)
string = Gnome2::VFS->format_uri_for_display ($uri)
o $uri (string)
Since: vfs 2.2
string = Gnome2::VFS->icon_path_from_filename ($filename)
o $filename (string)
boolean = Gnome2::VFS->init
boolean = Gnome2::VFS->initialized
boolean = Gnome2::VFS->is_executable_command_string ($command_string)
o $command_string (string)
boolean = Gnome2::VFS->is_primary_thread
string = Gnome2::VFS->get_local_path_from_uri ($uri)
o $uri (string)
result = Gnome2::VFS->make_directory ($text_uri, $perm)
o $text_uri (string)
o $perm (integer)
string = Gnome2::VFS->make_path_name_canonical ($path)
o $path (string)
string = Gnome2::VFS->make_uri_canonical ($uri)
o $uri (string)
string = Gnome2::VFS->make_uri_canonical_strip_fragment ($uri)
o $uri (string)
Since: vfs 2.2
string = Gnome2::VFS->make_uri_from_input ($uri)
o $uri (string)
Since: vfs 2.2
string = Gnome2::VFS->make_uri_from_input_with_dirs ($uri, $dirs)
o $uri (string)
o $dirs (Gnome2::VFS::MakeURIDirs)
Since: vfs 2.4
string = Gnome2::VFS->make_uri_from_input_with_trailing_ws ($location)
o $location (string)
Since: vfs 2.12
string = Gnome2::VFS->make_uri_from_shell_arg ($uri)
o $uri (string)
Since: vfs 2.2
result = Gnome2::VFS->move ($old_text_uri, $new_text_uri, $force_replace)
o $old_text_uri (string)
o $new_text_uri (string)
o $force_replace (boolean)
list = Gnome2::VFS->open ($text_uri, $open_mode)
o $text_uri (string)
o $open_mode (Gnome2::VFS::OpenMode)
Returns a GnomeVFSResult and a GnomeVFSHandle.
list = Gnome2::VFS->read_entire_file ($uri)
o $uri (string)
Returns a GnomeVFSResult, the file size and the file content.
Since: vfs 2.2
result = Gnome2::VFS->remove_directory ($text_uri)
o $text_uri (string)
string = Gnome2::VFS->result_to_string ($result)
o $result (Gnome2::VFS::Result)
Gnome2::VFS->shutdown
result = Gnome2::VFS->truncate ($text_uri, $length)
o $text_uri (string)
o $length (unsigned)
string = Gnome2::VFS->unescape_string ($escaped_string, $illegal_characters=undef)
o $escaped_string (string)
o $illegal_characters (string)
string = Gnome2::VFS->unescape_string_for_display ($escaped)
o $escaped (string)
result = Gnome2::VFS->unlink ($text_uri)
o $text_uri (string)
string = Gnome2::VFS->get_uri_from_local_path ($local_full_path)
o $local_full_path (string)
string = Gnome2::VFS->get_uri_scheme ($uri)
o $uri (string)
Since: vfs 2.2
boolean = Gnome2::VFS->uris_match ($uri_1, $uri_2)
o $uri_1 (string)
o $uri_2 (string)
Since: vfs 2.2
result = Gnome2::VFS->url_show ($url)
o $url (string)
Since: vfs 2.4
result = Gnome2::VFS->url_show_with_env ($url, $env_ref)
o $url (string)
o $env_ref (scalar)
Since: vfs 2.4
list = Gnome2::VFS->get_volume_free_space ($vfs_uri)
o $vfs_uri (Gnome2::VFS::URI)
Returns a GnomeVFSResult and a GnomeVFSFileSize.
ENUMS AND FLAGS
flags Gnome2::VFS::FileInfoOptions
o 'default' / 'GNOME_VFS_FILE_INFO_DEFAULT'
o 'get-mime-type' / 'GNOME_VFS_FILE_INFO_GET_MIME_TYPE'
o 'force-fast-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE'
o 'force-slow-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE'
o 'follow-links' / 'GNOME_VFS_FILE_INFO_FOLLOW_LINKS'
o 'get-access-rights' / 'GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS'
o 'name-only' / 'GNOME_VFS_FILE_INFO_NAME_ONLY'
o 'get-acl' / 'GNOME_VFS_FILE_INFO_GET_ACL'
o 'get-selinux-context' / 'GNOME_VFS_FILE_INFO_GET_SELINUX_CONTEXT'
enum Gnome2::VFS::FindDirectoryKind
o 'desktop' / 'GNOME_VFS_DIRECTORY_KIND_DESKTOP'
o 'trash' / 'GNOME_VFS_DIRECTORY_KIND_TRASH'
flags Gnome2::VFS::MakeURIDirs
o 'none' / 'GNOME_VFS_MAKE_URI_DIR_NONE'
o 'homedir' / 'GNOME_VFS_MAKE_URI_DIR_HOMEDIR'
o 'current' / 'GNOME_VFS_MAKE_URI_DIR_CURRENT'
flags Gnome2::VFS::OpenMode
o 'none' / 'GNOME_VFS_OPEN_NONE'
o 'read' / 'GNOME_VFS_OPEN_READ'
o 'write' / 'GNOME_VFS_OPEN_WRITE'
o 'random' / 'GNOME_VFS_OPEN_RANDOM'
o 'truncate' / 'GNOME_VFS_OPEN_TRUNCATE'
enum Gnome2::VFS::Result
o 'ok' / 'GNOME_VFS_OK'
o 'error-not-found' / 'GNOME_VFS_ERROR_NOT_FOUND'
o 'error-generic' / 'GNOME_VFS_ERROR_GENERIC'
o 'error-internal' / 'GNOME_VFS_ERROR_INTERNAL'
o 'error-bad-parameters' / 'GNOME_VFS_ERROR_BAD_PARAMETERS'
o 'error-not-supported' / 'GNOME_VFS_ERROR_NOT_SUPPORTED'
o 'error-io' / 'GNOME_VFS_ERROR_IO'
o 'error-corrupted-data' / 'GNOME_VFS_ERROR_CORRUPTED_DATA'
o 'error-wrong-format' / 'GNOME_VFS_ERROR_WRONG_FORMAT'
o 'error-bad-file' / 'GNOME_VFS_ERROR_BAD_FILE'
o 'error-too-big' / 'GNOME_VFS_ERROR_TOO_BIG'
o 'error-no-space' / 'GNOME_VFS_ERROR_NO_SPACE'
o 'error-read-only' / 'GNOME_VFS_ERROR_READ_ONLY'
o 'error-invalid-uri' / 'GNOME_VFS_ERROR_INVALID_URI'
o 'error-not-open' / 'GNOME_VFS_ERROR_NOT_OPEN'
o 'error-invalid-open-mode' / 'GNOME_VFS_ERROR_INVALID_OPEN_MODE'
o 'error-access-denied' / 'GNOME_VFS_ERROR_ACCESS_DENIED'
o 'error-too-many-open-files' / 'GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES'
o 'error-eof' / 'GNOME_VFS_ERROR_EOF'
o 'error-not-a-directory' / 'GNOME_VFS_ERROR_NOT_A_DIRECTORY'
o 'error-in-progress' / 'GNOME_VFS_ERROR_IN_PROGRESS'
o 'error-interrupted' / 'GNOME_VFS_ERROR_INTERRUPTED'
o 'error-file-exists' / 'GNOME_VFS_ERROR_FILE_EXISTS'
o 'error-loop' / 'GNOME_VFS_ERROR_LOOP'
o 'error-not-permitted' / 'GNOME_VFS_ERROR_NOT_PERMITTED'
o 'error-is-directory' / 'GNOME_VFS_ERROR_IS_DIRECTORY'
o 'error-no-memory' / 'GNOME_VFS_ERROR_NO_MEMORY'
o 'error-host-not-found' / 'GNOME_VFS_ERROR_HOST_NOT_FOUND'
o 'error-invalid-host-name' / 'GNOME_VFS_ERROR_INVALID_HOST_NAME'
o 'error-host-has-no-address' / 'GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS'
o 'error-login-failed' / 'GNOME_VFS_ERROR_LOGIN_FAILED'
o 'error-cancelled' / 'GNOME_VFS_ERROR_CANCELLED'
o 'error-directory-busy' / 'GNOME_VFS_ERROR_DIRECTORY_BUSY'
o 'error-directory-not-empty' / 'GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY'
o 'error-too-many-links' / 'GNOME_VFS_ERROR_TOO_MANY_LINKS'
o 'error-read-only-file-system' / 'GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM'
o 'error-not-same-file-system' / 'GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM'
o 'error-name-too-long' / 'GNOME_VFS_ERROR_NAME_TOO_LONG'
o 'error-service-not-available' / 'GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE'
o 'error-service-obsolete' / 'GNOME_VFS_ERROR_SERVICE_OBSOLETE'
o 'error-protocol-error' / 'GNOME_VFS_ERROR_PROTOCOL_ERROR'
o 'error-no-master-browser' / 'GNOME_VFS_ERROR_NO_MASTER_BROWSER'
o 'error-no-default' / 'GNOME_VFS_ERROR_NO_DEFAULT'
o 'error-no-handler' / 'GNOME_VFS_ERROR_NO_HANDLER'
o 'error-parse' / 'GNOME_VFS_ERROR_PARSE'
o 'error-launch' / 'GNOME_VFS_ERROR_LAUNCH'
o 'error-timeout' / 'GNOME_VFS_ERROR_TIMEOUT'
o 'error-nameserver' / 'GNOME_VFS_ERROR_NAMESERVER'
o 'error-locked' / 'GNOME_VFS_ERROR_LOCKED'
o 'error-deprecated-function' / 'GNOME_VFS_ERROR_DEPRECATED_FUNCTION'
o 'error-invalid-filename' / 'GNOME_VFS_ERROR_INVALID_FILENAME'
o 'error-not-a-symbolic-link' / 'GNOME_VFS_ERROR_NOT_A_SYMBOLIC_LINK'
o 'num-errors' / 'GNOME_VFS_NUM_ERRORS'
flags Gnome2::VFS::SetFileInfoMask
o 'none' / 'GNOME_VFS_SET_FILE_INFO_NONE'
o 'name' / 'GNOME_VFS_SET_FILE_INFO_NAME'
o 'permissions' / 'GNOME_VFS_SET_FILE_INFO_PERMISSIONS'
o 'owner' / 'GNOME_VFS_SET_FILE_INFO_OWNER'
o 'time' / 'GNOME_VFS_SET_FILE_INFO_TIME'
o 'acl' / 'GNOME_VFS_SET_FILE_INFO_ACL'
o 'selinux-context' / 'GNOME_VFS_SET_FILE_INFO_SELINUX_CONTEXT'
o 'symlink-name' / 'GNOME_VFS_SET_FILE_INFO_SYMLINK_NAME'
SEE ALSO
Gnome2::VFS
COPYRIGHT
Copyright (C) 2003-2007 by the gtk2-perl team.
This software is licensed under the LGPL. See Gnome2::VFS for a full notice.
perl v5.14.2 2011-11-15 Gnome2::VFS::main(3pm)