Changeset 3152

Show
Ignore:
Timestamp:
12/18/07 23:03:45
Author:
pvanhoof
Message:

Added doc about a callback

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/libtinymail/tny-mime-part.c

    r3150 r3152  
    692692} 
    693693 
     694 
     695/**  
     696 * TnyMimePartCallback: 
     697 * @self: a #TnyFolderStore that caused the callback 
     698 * @cancelled: if the operation got cancelled 
     699 * @stream: the stream you passed 
     700 * @err (null-ok): if an error occurred 
     701 * @user_data (null-ok):  user data that was passed to the callbacks 
     702 * 
     703 * A MIME part callback for when a MIME part decode was requested. If allocated, 
     704 * you must cleanup @user_data at the end of your implementation of the callback. 
     705 * All other fields in the parameters of the callback are read-only. 
     706 * 
     707 * When cancelled, @cancelled will be TRUE while @err might nonetheless be NULL. 
     708 * If @err is not NULL, an error occurred that you should handle gracefully. 
     709 * The @stream parameter will contain the stream that you passed but will now be 
     710 * written, if the operation succeeded. 
     711 * 
     712 * since: 1.0 
     713 * audience: application-developer 
     714 **/ 
     715 
     716 
    694717/** 
    695718 * tny_mime_part_decode_to_stream_async: