From c51f5863dd07bc9e010379dbcf781cfcbbb3532a Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Sat, 28 Feb 2009 20:14:51 +0000 Subject: [PATCH] added documentation for torrent_info::rename_file --- docs/manual.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/manual.rst b/docs/manual.rst index ea86dd123..fc47a28bc 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -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 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 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() -----------------------------------------------------