github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

Update doc

pull/89/head
Tatsuhiro Tsujikawa 2013-05-15 22:58:55 +09:00
parent a4a4a10490
commit a8ef703b89
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/includes/aria2/aria2.h
View File

@ -280,12 +280,13 @@ bool isNull(const A2Gid& gid);
* and it should be BitTorrent Magnet URI. URIs in the |uris| must * and it should be BitTorrent Magnet URI. URIs in the |uris| must
* point to the same file. If you mix other URIs which point to * point to the same file. If you mix other URIs which point to
* another file, aria2 does not complain but download may fail. The * another file, aria2 does not complain but download may fail. The
* |options| is an array of a pair of option name and value. If the * |options| is an array of a pair of option name and value. If
* |position| is not negative integer, the new download is inserted at * unknown options are included in |options|, they are simply
* position in the waiting queue. If the |position| is negative or the * ignored. If the |position| is not negative integer, the new
* |position| is larger than the size of the queue, it is appended at * download is inserted at position in the waiting queue. If the
* the end of the queue. This function returns 0 if it succeeds, or * |position| is negative or the |position| is larger than the size of
* negative error code. * the queue, it is appended at the end of the queue. This function
* returns 0 if it succeeds, or negative error code.
*/ */
int addUri(Session* session, int addUri(Session* session,
A2Gid* gid, A2Gid* gid,
@ -300,11 +301,12 @@ int addUri(Session* session,
* the |metalinkFile|. On successful return, if the |gids| is not * the |metalinkFile|. On successful return, if the |gids| is not
* ``NULL``, the GIDs of added downloads are appended to the * ``NULL``, the GIDs of added downloads are appended to the
* |*gids|. The |options| is an array of a pair of option name and * |*gids|. The |options| is an array of a pair of option name and
* value. If the |position| is not negative integer, the new download * value. If unknown options are included in |options|, they are
* is inserted at position in the waiting queue. If the |position| is * simply ignored. If the |position| is not negative integer, the new
* negative or the |position| is larger than the size of the queue, it * download is inserted at position in the waiting queue. If the
* is appended at the end of the queue. This function returns 0 if it * |position| is negative or the |position| is larger than the size of
* succeeds, or negative error code. * the queue, it is appended at the end of the queue. This function
* returns 0 if it succeeds, or negative error code.
*/ */
int addMetalink(Session* session, int addMetalink(Session* session,
std::vector<A2Gid>* gids, std::vector<A2Gid>* gids,