Gnome2::VFS::main(3pm)

1Gnome2::VFS::main(3)  User Contributed Perl Documentation Gnome2::VFS::main(3)
2
3
4

NAME

6       Gnome2::VFS::main
7

METHODS

9       boolean = Gnome2::VFS->CHECK_VERSION ($major, $minor, $micro)
10
11           * $major (integer)
12           * $minor (integer)
13           * $micro (integer)
14
15       list = Gnome2::VFS->GET_VERSION_INFO
16
17           Returns the major, minor and micro version numbers of GnomeVFS.
18
19       list = Gnome2::VFS->check_same_fs ($source, $target)
20
21           * $source (string)
22           * $target (string)
23
24           Returns a GnomeVFSResult and a boolean.
25
26       list = Gnome2::VFS->create ($text_uri, $open_mode, $exclusive, $perm)
27
28           * $text_uri (string)
29           * $open_mode (Gnome2::VFS::OpenMode)
30           * $exclusive (boolean)
31           * $perm (integer)
32
33           Returns a GnomeVFSResult and a GnomeVFSHandle.
34
35       result = Gnome2::VFS->create_symbolic_link ($uri, $target_reference)
36
37           * $uri (Gnome2::VFS::URI)
38           * $target_reference (string)
39
40       string = Gnome2::VFS->escape_host_and_path_string ($path)
41
42           * $path (string)
43
44       string = Gnome2::VFS->escape_path_string ($path)
45
46           * $path (string)
47
48       string = Gnome2::VFS->escape_set ($string, $match_set)
49
50           * $string (string)
51           * $match_set (string)
52
53       string = Gnome2::VFS->escape_slashes ($string)
54
55           * $string (string)
56
57       string = Gnome2::VFS->escape_string ($string)
58
59           * $string (string)
60
61       string = Gnome2::VFS->expand_initial_tilde ($path)
62
63           * $path (string)
64
65       list = Gnome2::VFS->get_file_info ($text_uri, $options)
66
67           * $text_uri (string)
68           * $options (Gnome2::VFS::FileInfoOptions)
69
70           Returns a GnomeVFSResult and a GnomeVFSFileInfo.
71
72       result = Gnome2::VFS->set_file_info ($text_uri, $info, $mask)
73
74           * $text_uri (string)
75           * $info (Gnome2::VFS::FileInfo)
76           * $mask (Gnome2::VFS::SetFileInfoMask)
77
78       list = Gnome2::VFS->find_directory ($near_uri, $kind, $cre‐
79       ate_if_needed, $find_if_needed, $permissions)
80
81           * $near_uri (Gnome2::VFS::URI)
82           * $kind (Gnome2::VFS::FindDirectoryKind)
83           * $create_if_needed (boolean)
84           * $find_if_needed (boolean)
85           * $permissions (integer)
86
87           Returns a GnomeVFSResult and a GnomeVFSURI.
88
89       string = Gnome2::VFS->format_file_size_for_display ($size)
90
91           * $size (unsigned)
92
93       string = Gnome2::VFS->format_uri_for_display ($uri)
94
95           * $uri (string)
96
97       string = Gnome2::VFS->icon_path_from_filename ($filename)
98
99           * $filename (string)
100
101       boolean = Gnome2::VFS->init
102
103       boolean = Gnome2::VFS->initialized
104
105       boolean = Gnome2::VFS->is_executable_command_string ($command_string)
106
107           * $command_string (string)
108
109       boolean = Gnome2::VFS->is_primary_thread
110
111       string = Gnome2::VFS->get_local_path_from_uri ($uri)
112
113           * $uri (string)
114
115       result = Gnome2::VFS->make_directory ($text_uri, $perm)
116
117           * $text_uri (string)
118           * $perm (integer)
119
120       string = Gnome2::VFS->make_path_name_canonical ($path)
121
122           * $path (string)
123
124       string = Gnome2::VFS->make_uri_canonical ($uri)
125
126           * $uri (string)
127
128       string = Gnome2::VFS->make_uri_canonical_strip_fragment ($uri)
129
130           * $uri (string)
131
132       string = Gnome2::VFS->make_uri_from_input ($uri)
133
134           * $uri (string)
135
136       string = Gnome2::VFS->make_uri_from_input_with_dirs ($uri, $dirs)
137
138           * $uri (string)
139           * $dirs (Gnome2::VFS::MakeURIDirs)
140
141       string = Gnome2::VFS->make_uri_from_input_with_trailing_ws ($location)
142
143           * $location (string)
144
145       string = Gnome2::VFS->make_uri_from_shell_arg ($uri)
146
147           * $uri (string)
148
149       result = Gnome2::VFS->move ($old_text_uri, $new_text_uri,
150       $force_replace)
151
152           * $old_text_uri (string)
153           * $new_text_uri (string)
154           * $force_replace (boolean)
155
156       list = Gnome2::VFS->open ($text_uri, $open_mode)
157
158           * $text_uri (string)
159           * $open_mode (Gnome2::VFS::OpenMode)
160
161           Returns a GnomeVFSResult and a GnomeVFSHandle.
162
163       list = Gnome2::VFS->read_entire_file ($uri)
164
165           * $uri (string)
166
167           Returns a GnomeVFSResult, the file size and the file content.
168
169       result = Gnome2::VFS->remove_directory ($text_uri)
170
171           * $text_uri (string)
172
173       string = Gnome2::VFS->result_to_string ($result)
174
175           * $result (Gnome2::VFS::Result)
176
177       Gnome2::VFS->shutdown
178
179       result = Gnome2::VFS->truncate ($text_uri, $length)
180
181           * $text_uri (string)
182           * $length (unsigned)
183
184       string = Gnome2::VFS->unescape_string ($escaped_string, $illegal_char‐
185       acters=undef)
186
187           * $escaped_string (string)
188           * $illegal_characters (string)
189
190       string = Gnome2::VFS->unescape_string_for_display ($escaped)
191
192           * $escaped (string)
193
194       result = Gnome2::VFS->unlink ($text_uri)
195
196           * $text_uri (string)
197
198       string = Gnome2::VFS->get_uri_from_local_path ($local_full_path)
199
200           * $local_full_path (string)
201
202       string = Gnome2::VFS->get_uri_scheme ($uri)
203
204           * $uri (string)
205
206       boolean = Gnome2::VFS->uris_match ($uri_1, $uri_2)
207
208           * $uri_1 (string)
209           * $uri_2 (string)
210
211       result = Gnome2::VFS->url_show ($url)
212
213           * $url (string)
214
215       result = Gnome2::VFS->url_show_with_env ($url, $env_ref)
216
217           * $url (string)
218           * $env_ref (scalar)
219
220       list = Gnome2::VFS->get_volume_free_space ($vfs_uri)
221
222           * $vfs_uri (Gnome2::VFS::URI)
223
224           Returns a GnomeVFSResult and a GnomeVFSFileSize.
225

ENUMS AND FLAGS

227       flags Gnome2::VFS::FileInfoOptions
228
229       * 'default' / 'GNOME_VFS_FILE_INFO_DEFAULT'
230       * 'get-mime-type' / 'GNOME_VFS_FILE_INFO_GET_MIME_TYPE'
231       * 'force-fast-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE'
232       * 'force-slow-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE'
233       * 'follow-links' / 'GNOME_VFS_FILE_INFO_FOLLOW_LINKS'
234       * 'get-access-rights' / 'GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS'
235       * 'name-only' / 'GNOME_VFS_FILE_INFO_NAME_ONLY'
236       * 'get-acl' / 'GNOME_VFS_FILE_INFO_GET_ACL'
237       * 'get-selinux-context' / 'GNOME_VFS_FILE_INFO_GET_SELINUX_CONTEXT'
238
239       enum Gnome2::VFS::FindDirectoryKind
240
241       * 'desktop' / 'GNOME_VFS_DIRECTORY_KIND_DESKTOP'
242       * 'trash' / 'GNOME_VFS_DIRECTORY_KIND_TRASH'
243
244       flags Gnome2::VFS::MakeURIDirs
245
246       * 'none' / 'GNOME_VFS_MAKE_URI_DIR_NONE'
247       * 'homedir' / 'GNOME_VFS_MAKE_URI_DIR_HOMEDIR'
248       * 'current' / 'GNOME_VFS_MAKE_URI_DIR_CURRENT'
249
250       flags Gnome2::VFS::OpenMode
251
252       * 'none' / 'GNOME_VFS_OPEN_NONE'
253       * 'read' / 'GNOME_VFS_OPEN_READ'
254       * 'write' / 'GNOME_VFS_OPEN_WRITE'
255       * 'random' / 'GNOME_VFS_OPEN_RANDOM'
256       * 'truncate' / 'GNOME_VFS_OPEN_TRUNCATE'
257
258       enum Gnome2::VFS::Result
259
260       * 'ok' / 'GNOME_VFS_OK'
261       * 'error-not-found' / 'GNOME_VFS_ERROR_NOT_FOUND'
262       * 'error-generic' / 'GNOME_VFS_ERROR_GENERIC'
263       * 'error-internal' / 'GNOME_VFS_ERROR_INTERNAL'
264       * 'error-bad-parameters' / 'GNOME_VFS_ERROR_BAD_PARAMETERS'
265       * 'error-not-supported' / 'GNOME_VFS_ERROR_NOT_SUPPORTED'
266       * 'error-io' / 'GNOME_VFS_ERROR_IO'
267       * 'error-corrupted-data' / 'GNOME_VFS_ERROR_CORRUPTED_DATA'
268       * 'error-wrong-format' / 'GNOME_VFS_ERROR_WRONG_FORMAT'
269       * 'error-bad-file' / 'GNOME_VFS_ERROR_BAD_FILE'
270       * 'error-too-big' / 'GNOME_VFS_ERROR_TOO_BIG'
271       * 'error-no-space' / 'GNOME_VFS_ERROR_NO_SPACE'
272       * 'error-read-only' / 'GNOME_VFS_ERROR_READ_ONLY'
273       * 'error-invalid-uri' / 'GNOME_VFS_ERROR_INVALID_URI'
274       * 'error-not-open' / 'GNOME_VFS_ERROR_NOT_OPEN'
275       * 'error-invalid-open-mode' / 'GNOME_VFS_ERROR_INVALID_OPEN_MODE'
276       * 'error-access-denied' / 'GNOME_VFS_ERROR_ACCESS_DENIED'
277       * 'error-too-many-open-files' / 'GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES'
278       * 'error-eof' / 'GNOME_VFS_ERROR_EOF'
279       * 'error-not-a-directory' / 'GNOME_VFS_ERROR_NOT_A_DIRECTORY'
280       * 'error-in-progress' / 'GNOME_VFS_ERROR_IN_PROGRESS'
281       * 'error-interrupted' / 'GNOME_VFS_ERROR_INTERRUPTED'
282       * 'error-file-exists' / 'GNOME_VFS_ERROR_FILE_EXISTS'
283       * 'error-loop' / 'GNOME_VFS_ERROR_LOOP'
284       * 'error-not-permitted' / 'GNOME_VFS_ERROR_NOT_PERMITTED'
285       * 'error-is-directory' / 'GNOME_VFS_ERROR_IS_DIRECTORY'
286       * 'error-no-memory' / 'GNOME_VFS_ERROR_NO_MEMORY'
287       * 'error-host-not-found' / 'GNOME_VFS_ERROR_HOST_NOT_FOUND'
288       * 'error-invalid-host-name' / 'GNOME_VFS_ERROR_INVALID_HOST_NAME'
289       * 'error-host-has-no-address' / 'GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS'
290       * 'error-login-failed' / 'GNOME_VFS_ERROR_LOGIN_FAILED'
291       * 'error-cancelled' / 'GNOME_VFS_ERROR_CANCELLED'
292       * 'error-directory-busy' / 'GNOME_VFS_ERROR_DIRECTORY_BUSY'
293       * 'error-directory-not-empty' / 'GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY'
294       * 'error-too-many-links' / 'GNOME_VFS_ERROR_TOO_MANY_LINKS'
295       * 'error-read-only-file-system' / 'GNOME_VFS_ERROR_READ_ONLY_FILE_SYS‐
296       TEM'
297       * 'error-not-same-file-system' / 'GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM'
298       * 'error-name-too-long' / 'GNOME_VFS_ERROR_NAME_TOO_LONG'
299       * 'error-service-not-available' / 'GNOME_VFS_ERROR_SERVICE_NOT_AVAIL‐
300       ABLE'
301       * 'error-service-obsolete' / 'GNOME_VFS_ERROR_SERVICE_OBSOLETE'
302       * 'error-protocol-error' / 'GNOME_VFS_ERROR_PROTOCOL_ERROR'
303       * 'error-no-master-browser' / 'GNOME_VFS_ERROR_NO_MASTER_BROWSER'
304       * 'error-no-default' / 'GNOME_VFS_ERROR_NO_DEFAULT'
305       * 'error-no-handler' / 'GNOME_VFS_ERROR_NO_HANDLER'
306       * 'error-parse' / 'GNOME_VFS_ERROR_PARSE'
307       * 'error-launch' / 'GNOME_VFS_ERROR_LAUNCH'
308       * 'error-timeout' / 'GNOME_VFS_ERROR_TIMEOUT'
309       * 'error-nameserver' / 'GNOME_VFS_ERROR_NAMESERVER'
310       * 'error-locked' / 'GNOME_VFS_ERROR_LOCKED'
311       * 'error-deprecated-function' / 'GNOME_VFS_ERROR_DEPRECATED_FUNCTION'
312       * 'error-invalid-filename' / 'GNOME_VFS_ERROR_INVALID_FILENAME'
313       * 'error-not-a-symbolic-link' / 'GNOME_VFS_ERROR_NOT_A_SYMBOLIC_LINK'
314       * 'num-errors' / 'GNOME_VFS_NUM_ERRORS'
315
316       flags Gnome2::VFS::SetFileInfoMask
317
318       * 'none' / 'GNOME_VFS_SET_FILE_INFO_NONE'
319       * 'name' / 'GNOME_VFS_SET_FILE_INFO_NAME'
320       * 'permissions' / 'GNOME_VFS_SET_FILE_INFO_PERMISSIONS'
321       * 'owner' / 'GNOME_VFS_SET_FILE_INFO_OWNER'
322       * 'time' / 'GNOME_VFS_SET_FILE_INFO_TIME'
323       * 'acl' / 'GNOME_VFS_SET_FILE_INFO_ACL'
324       * 'selinux-context' / 'GNOME_VFS_SET_FILE_INFO_SELINUX_CONTEXT'
325       * 'symlink-name' / 'GNOME_VFS_SET_FILE_INFO_SYMLINK_NAME'
326

COPYRIGHT

331       Copyright (C) 2003-2007 by the gtk2-perl team.
332
333       This software is licensed under the LGPL.  See Gnome2::VFS for a full
334       notice.
335
336
337
338perl v5.8.8                       2007-10-24              Gnome2::VFS::main(3)

NAME

METHODS

ENUMS AND FLAGS

SEE ALSO

COPYRIGHT