wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

added missing documentation of torrent_handle::rename_file

This commit is contained in:
Arvid Norberg 2008-11-30 07:04:21 +00:00
parent 490ad37c43
commit a10db6dad7
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/manual.rst
View File

@ -1710,6 +1710,7 @@ Its declaration looks like this::
boost::filesystem::path save_path() const; boost::filesystem::path save_path() const;
void move_storage(boost::filesystem::path const& save_path) const; void move_storage(boost::filesystem::path const& save_path) const;
void rename_file(int index, boost::filesystem::path) const;
storage_interface* get_storage_impl() const; storage_interface* get_storage_impl() const;
sha1_hash info_hash() const; sha1_hash info_hash() const;
@ -1841,6 +1842,16 @@ Since disk IO is performed in a separate thread, this operation is also asynchro
Once the operation completes, the ``storage_moved_alert`` is generated, with the new Once the operation completes, the ``storage_moved_alert`` is generated, with the new
path as the message. path as the message.
rename_file()
-------------
::
void rename_file(int index, boost::filesystem::path) const;
Renames the file with the given index asynchronously. The rename operation is complete
when either a ``file_renamed_alert`` or ``file_rename_failed_alert`` is posted.
get_storage_impl() get_storage_impl()
------------------ ------------------