Difference between revisions of "API:EPrints/VFS"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
 
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/VFS.pm|package_name=EPrints::VFS}}[[Category:API|VFS]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_directory_operations -->==Directory Operations==
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_chdir -->===vfs_chdir===
 
  
  $child = $vfs-&gt;vfs_chdir( ID )
 
 
Return the child directory called ID, or undef if it doesn't exist.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_mkdir -->===vfs_mkdir===
 
 
  $ok = $vfs-&gt;vfs_mkdir( ID )
 
 
Make a child directory called ID.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_rmdir -->===vfs_rmdir===
 
 
  $ok = $vfs-&gt;vfs_rmdir( ID )
 
 
Remove a child directory called ID.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_listings -->==Listings==
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_list -->===vfs_list===
 
 
  $ok = $vfs-&gt;vfs_list(sub { ID })
 
 
Return a list of ids of objects we hold.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_list_details -->===vfs_list_details===
 
 
  $ok = $vfs-&gt;vfs_list_details(sub { DETAIL })
 
 
Return a detailed list of our children and objects.
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_object_operations -->==Object Operations==
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_read -->===vfs_read===
 
 
  $ok = $vfs-&gt;vfs_read(ID, sub { BUFFER })
 
 
Reads the content stored at ID.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_write -->===vfs_write===
 
 
  $ok = $vfs-&gt;vfs_write(ID, CONTENT_LENGTH, BUFFER = sub {})
 
 
Writes the content returned by sub{} to ID.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_delete -->===vfs_delete===
 
 
  $ok = $vfs-&gt;vfs_delete( ID )
 
 
Remove an object called ID.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_vfs_size -->===vfs_size===
 
 
  $bytes = $vfs-&gt;vfs_size( ID )
 
 
Return the size in bytes of ID, or undef if it doesn't exist.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Latest revision as of 15:41, 12 August 2009