premiere
/
premiere-libtorrent
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

added documentation for torrent_info::rename_file

This commit is contained in:
Arvid Norberg 2009-02-28 20:14:51 +00:00
parent c4e19e2ee7
commit c51f5863dd
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/manual.rst
View File

@ -1398,11 +1398,24 @@ to make its mapping differ from the one in the torrent file.
``orig_files()`` returns the original (unmodified) file storage for this torrent. This ``orig_files()`` returns the original (unmodified) file storage for this torrent. This
is used by the web server connection, which needs to request files with the original is used by the web server connection, which needs to request files with the original
names. names. Filename may be chaged using `rename_file()`_.
For more information on the ``file_storage`` object, see the separate document on how For more information on the ``file_storage`` object, see the separate document on how
to create torrents. to create torrents.
rename_file()
-------------
::
void rename_file(int index, std::string const& new_filename);
void rename_file(int index, std::wstring const& new_filename);
Renames a the file with the specified index to the new name. The new filename is
reflected by the ``file_storage`` returned by ``files()`` but not by the one
returned by ``orig_files()``.
begin_files() end_files() rbegin_files() rend_files() begin_files() end_files() rbegin_files() rend_files()
----------------------------------------------------- -----------------------------------------------------