X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fwimlib.h;h=6abb6e5b1f26c96b139ac28d121a4a10f5af6e0c;hb=7acdc3aecd7ce546727ae8239e0d942c2a00db43;hp=a8372fd63cda12aca01de8916b49e6c3af484ad7;hpb=bbde2575ce2318d34d2e556b3ffc285b5fb47f3a;p=wimlib diff --git a/src/wimlib.h b/src/wimlib.h index a8372fd6..6abb6e5b 100644 --- a/src/wimlib.h +++ b/src/wimlib.h @@ -31,7 +31,7 @@ * * \section intro Introduction * - * This is the documentation for the library interface of wimlib 1.2.7. If you + * This is the documentation for the library interface of wimlib 1.3.0. If you * have installed wimlib and want to know how to use the @c imagex program, * please see the man pages instead. Also: the actual project page where you * can download the source code for the library is at imagex capture for full - * details on how this mode works. + * source parameter of wimlib_add_image(). The rest of the parameters are the + * same as wimlib_add_image(). See the documentation for imagex capture + * for full details on how this mode works. * - * Additional notes: @a sources is not a @c const parameter and you cannot + * Additional note: @a sources is not a @c const parameter and you cannot * assume that its contents are valid after this function returns. You must * save pointers to the strings in these structures if you need to free them * later, and/or save copies if needed. * - * It is also possible for this function to return ::WIMLIB_ERR_INVALID_OVERLAY + * In addition to the error codes that wimlib_add_image() can return, + * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY * when trying to overlay a non-directory on a directory or when otherwise * trying to overlay multiple conflicting files to the same location in the WIM - * image. */ + * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if + * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there + * was not exactly one capture source with the target being the root directory. + * (In this respect, there is no advantage to using + * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting + * NTFS mode.) */ extern int wimlib_add_image_multisource(WIMStruct *w, struct wimlib_capture_source *sources, size_t num_sources,