home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / VFS / Handle.pod < prev    next >
Encoding:
Text File  |  2006-06-19  |  5.2 KB  |  275 lines

  1. =head1 NAME
  2.  
  3. Gnome2::VFS::Handle
  4.  
  5.  
  6. =head1 METHODS
  7.  
  8. =head2 result = $handle-E<gt>B<close> 
  9.  
  10. =over
  11.  
  12. =back
  13.  
  14. =head2 list = $handle-E<gt>B<get_file_info> ($options)
  15.  
  16. =over
  17.  
  18. =over
  19.  
  20. =item * $options (Gnome2::VFS::FileInfoOptions) 
  21.  
  22. =back
  23.  
  24.  
  25. Returns a GnomeVFSResult and a GnomeVFSFileInfo.
  26.  
  27.  
  28. =back
  29.  
  30. =head2 result = $handle-E<gt>B<forget_cache> ($offset, $size)
  31.  
  32. =over
  33.  
  34. =over
  35.  
  36. =item * $offset (unsigned) 
  37.  
  38. =item * $size (unsigned) 
  39.  
  40. =back
  41.  
  42. =back
  43.  
  44. =head2 list = $handle-E<gt>B<read> ($bytes)
  45.  
  46. =over
  47.  
  48. =over
  49.  
  50. =item * $bytes (unsigned) 
  51.  
  52. =back
  53.  
  54.  
  55. Returns a GnomeVFSResult, the number of bytes read and the buffer containing
  56. the read content.
  57.  
  58.  
  59. =back
  60.  
  61. =head2 result = $handle-E<gt>B<seek> ($whence, $offset)
  62.  
  63. =over
  64.  
  65. =over
  66.  
  67. =item * $whence (Gnome2::VFS::SeekPosition) 
  68.  
  69. =item * $offset (unsigned) 
  70.  
  71. =back
  72.  
  73. =back
  74.  
  75. =head2 list = $handle-E<gt>B<tell> 
  76.  
  77. =over
  78.  
  79.  
  80. Returns a GnomeVFSResult and the offset.
  81.  
  82.  
  83. =back
  84.  
  85. =head2 result = $handle-E<gt>B<truncate> ($length)
  86.  
  87. =over
  88.  
  89. =over
  90.  
  91. =item * $length (unsigned) 
  92.  
  93. =back
  94.  
  95. =back
  96.  
  97. =head2 list = $handle-E<gt>B<write> ($buffer, $bytes)
  98.  
  99. =over
  100.  
  101. =over
  102.  
  103. =item * $buffer (string) 
  104.  
  105. =item * $bytes (unsigned) 
  106.  
  107. =back
  108.  
  109.  
  110. Returns a GnomeVFSResult and the number of bytes written.
  111.  
  112.  
  113. =back
  114.  
  115.  
  116. =head1 ENUMS AND FLAGS
  117.  
  118. =head2 flags Gnome2::VFS::FileInfoOptions
  119.  
  120. =over
  121.  
  122. =item * 'default' / 'GNOME_VFS_FILE_INFO_DEFAULT'
  123.  
  124. =item * 'get-mime-type' / 'GNOME_VFS_FILE_INFO_GET_MIME_TYPE'
  125.  
  126. =item * 'force-fast-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_FAST_MIME_TYPE'
  127.  
  128. =item * 'force-slow-mime-type' / 'GNOME_VFS_FILE_INFO_FORCE_SLOW_MIME_TYPE'
  129.  
  130. =item * 'follow-links' / 'GNOME_VFS_FILE_INFO_FOLLOW_LINKS'
  131.  
  132. =item * 'get-access-rights' / 'GNOME_VFS_FILE_INFO_GET_ACCESS_RIGHTS'
  133.  
  134. =item * 'name-only' / 'GNOME_VFS_FILE_INFO_NAME_ONLY'
  135.  
  136. =back
  137.  
  138.  
  139. =head2 enum Gnome2::VFS::Result
  140.  
  141. =over
  142.  
  143. =item * 'ok' / 'GNOME_VFS_OK'
  144.  
  145. =item * 'error-not-found' / 'GNOME_VFS_ERROR_NOT_FOUND'
  146.  
  147. =item * 'error-generic' / 'GNOME_VFS_ERROR_GENERIC'
  148.  
  149. =item * 'error-internal' / 'GNOME_VFS_ERROR_INTERNAL'
  150.  
  151. =item * 'error-bad-parameters' / 'GNOME_VFS_ERROR_BAD_PARAMETERS'
  152.  
  153. =item * 'error-not-supported' / 'GNOME_VFS_ERROR_NOT_SUPPORTED'
  154.  
  155. =item * 'error-io' / 'GNOME_VFS_ERROR_IO'
  156.  
  157. =item * 'error-corrupted-data' / 'GNOME_VFS_ERROR_CORRUPTED_DATA'
  158.  
  159. =item * 'error-wrong-format' / 'GNOME_VFS_ERROR_WRONG_FORMAT'
  160.  
  161. =item * 'error-bad-file' / 'GNOME_VFS_ERROR_BAD_FILE'
  162.  
  163. =item * 'error-too-big' / 'GNOME_VFS_ERROR_TOO_BIG'
  164.  
  165. =item * 'error-no-space' / 'GNOME_VFS_ERROR_NO_SPACE'
  166.  
  167. =item * 'error-read-only' / 'GNOME_VFS_ERROR_READ_ONLY'
  168.  
  169. =item * 'error-invalid-uri' / 'GNOME_VFS_ERROR_INVALID_URI'
  170.  
  171. =item * 'error-not-open' / 'GNOME_VFS_ERROR_NOT_OPEN'
  172.  
  173. =item * 'error-invalid-open-mode' / 'GNOME_VFS_ERROR_INVALID_OPEN_MODE'
  174.  
  175. =item * 'error-access-denied' / 'GNOME_VFS_ERROR_ACCESS_DENIED'
  176.  
  177. =item * 'error-too-many-open-files' / 'GNOME_VFS_ERROR_TOO_MANY_OPEN_FILES'
  178.  
  179. =item * 'error-eof' / 'GNOME_VFS_ERROR_EOF'
  180.  
  181. =item * 'error-not-a-directory' / 'GNOME_VFS_ERROR_NOT_A_DIRECTORY'
  182.  
  183. =item * 'error-in-progress' / 'GNOME_VFS_ERROR_IN_PROGRESS'
  184.  
  185. =item * 'error-interrupted' / 'GNOME_VFS_ERROR_INTERRUPTED'
  186.  
  187. =item * 'error-file-exists' / 'GNOME_VFS_ERROR_FILE_EXISTS'
  188.  
  189. =item * 'error-loop' / 'GNOME_VFS_ERROR_LOOP'
  190.  
  191. =item * 'error-not-permitted' / 'GNOME_VFS_ERROR_NOT_PERMITTED'
  192.  
  193. =item * 'error-is-directory' / 'GNOME_VFS_ERROR_IS_DIRECTORY'
  194.  
  195. =item * 'error-no-memory' / 'GNOME_VFS_ERROR_NO_MEMORY'
  196.  
  197. =item * 'error-host-not-found' / 'GNOME_VFS_ERROR_HOST_NOT_FOUND'
  198.  
  199. =item * 'error-invalid-host-name' / 'GNOME_VFS_ERROR_INVALID_HOST_NAME'
  200.  
  201. =item * 'error-host-has-no-address' / 'GNOME_VFS_ERROR_HOST_HAS_NO_ADDRESS'
  202.  
  203. =item * 'error-login-failed' / 'GNOME_VFS_ERROR_LOGIN_FAILED'
  204.  
  205. =item * 'error-cancelled' / 'GNOME_VFS_ERROR_CANCELLED'
  206.  
  207. =item * 'error-directory-busy' / 'GNOME_VFS_ERROR_DIRECTORY_BUSY'
  208.  
  209. =item * 'error-directory-not-empty' / 'GNOME_VFS_ERROR_DIRECTORY_NOT_EMPTY'
  210.  
  211. =item * 'error-too-many-links' / 'GNOME_VFS_ERROR_TOO_MANY_LINKS'
  212.  
  213. =item * 'error-read-only-file-system' / 'GNOME_VFS_ERROR_READ_ONLY_FILE_SYSTEM'
  214.  
  215. =item * 'error-not-same-file-system' / 'GNOME_VFS_ERROR_NOT_SAME_FILE_SYSTEM'
  216.  
  217. =item * 'error-name-too-long' / 'GNOME_VFS_ERROR_NAME_TOO_LONG'
  218.  
  219. =item * 'error-service-not-available' / 'GNOME_VFS_ERROR_SERVICE_NOT_AVAILABLE'
  220.  
  221. =item * 'error-service-obsolete' / 'GNOME_VFS_ERROR_SERVICE_OBSOLETE'
  222.  
  223. =item * 'error-protocol-error' / 'GNOME_VFS_ERROR_PROTOCOL_ERROR'
  224.  
  225. =item * 'error-no-master-browser' / 'GNOME_VFS_ERROR_NO_MASTER_BROWSER'
  226.  
  227. =item * 'error-no-default' / 'GNOME_VFS_ERROR_NO_DEFAULT'
  228.  
  229. =item * 'error-no-handler' / 'GNOME_VFS_ERROR_NO_HANDLER'
  230.  
  231. =item * 'error-parse' / 'GNOME_VFS_ERROR_PARSE'
  232.  
  233. =item * 'error-launch' / 'GNOME_VFS_ERROR_LAUNCH'
  234.  
  235. =item * 'error-timeout' / 'GNOME_VFS_ERROR_TIMEOUT'
  236.  
  237. =item * 'error-nameserver' / 'GNOME_VFS_ERROR_NAMESERVER'
  238.  
  239. =item * 'error-locked' / 'GNOME_VFS_ERROR_LOCKED'
  240.  
  241. =item * 'error-deprecated-function' / 'GNOME_VFS_ERROR_DEPRECATED_FUNCTION'
  242.  
  243. =item * 'num-errors' / 'GNOME_VFS_NUM_ERRORS'
  244.  
  245. =back
  246.  
  247.  
  248. =head2 enum Gnome2::VFS::SeekPosition
  249.  
  250. =over
  251.  
  252. =item * 'start' / 'GNOME_VFS_SEEK_START'
  253.  
  254. =item * 'current' / 'GNOME_VFS_SEEK_CURRENT'
  255.  
  256. =item * 'end' / 'GNOME_VFS_SEEK_END'
  257.  
  258. =back
  259.  
  260.  
  261.  
  262. =head1 SEE ALSO
  263.  
  264. L<Gnome2::VFS>
  265.  
  266. =head1 COPYRIGHT
  267.  
  268. Copyright (C) 2003-2004 by the gtk2-perl team.
  269.  
  270. This software is licensed under the LGPL.  See L<Gnome2::VFS> for a full notice.
  271.  
  272.  
  273. =cut
  274.  
  275.