diff --git a/include/libtorrent/read_resume_data.hpp b/include/libtorrent/read_resume_data.hpp index 7784f9279..da9010aa4 100644 --- a/include/libtorrent/read_resume_data.hpp +++ b/include/libtorrent/read_resume_data.hpp @@ -42,9 +42,13 @@ namespace libtorrent struct bdecode_node; // these functions are used to parse resume data and populate the appropriate - // fields in an add_torrent_param object. This object can then be used to add + // fields in an add_torrent_params object. This object can then be used to add // the actual torrent_info object to and pass to session::add_torrent() or - // session::async_add_torrent() + // session::async_add_torrent(). + // + // If the client wants to override any field that was loaded from the resume + // data, e.g. save_path, those fields must be changed after loading resume + // data but before adding the torrent. TORRENT_EXPORT add_torrent_params read_resume_data(bdecode_node const& rd , error_code& ec); TORRENT_EXPORT add_torrent_params read_resume_data(char const* buffer