Ignore:
Timestamp:
Jun 27, 2007, 11:22:09 PM (15 years ago)
Author:
charles
Message:

simplify tr_torrentParse() based on BWM's feedback

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/transmission.h

    r2207 r2210  
    275275 * Parses the specified metainfo file.
    276276 *
    277  * Returns TR_OK or TR_INVALID based on whether or not the
    278  * metainfo file is successfully parsed.
     277 * Returns TR_OK if it parsed and can be added to Transmission.
     278 * Returns TR_INVALID if it couldn't be parsed.
     279 * Returns TR_EDUPLICATE if it parsed but can't be added.
    279280 *
    280  * If parsing succeeded and "setme_info" is non-NULL,
    281  * it will be populated with the file's information.
     281 * "destination" can be NULL if you don't need to know whether
     282 * or not the torrent can be added.
    282283 *
    283  * If "setme_canAdd" is non-NULL, it will be set to TR_OK,
    284  * TR_EDUPLICATE, TR_ERROR_IO_DUP_DOWNLOAD, or TR_EINVALID.
    285  *
    286  * "destination" is used for the canAdd tests, so it can
    287  * be NULL if "setme_canAdd" is too.
     284 " "setme_info" can be NULL if you don't need the information.
     285 * If the metainfo can be parsed and setme_info is non-NULL,
     286 * it will be filled with the metadata's info.
    288287 */
    289288int tr_torrentParse( const tr_handle_t  * handle,
    290289                     const char         * metainfo_filename,
    291290                     const char         * destination,
    292                      tr_info_t          * setme_info,
    293                      int                * setme_canAdd );
     291                     tr_info_t          * setme_info );
    294292
    295293/***********************************************************************
Note: See TracChangeset for help on using the changeset viewer.