*
* \section intro Introduction
*
- * This is the documentation for the library interface of wimlib 1.3.3. If you
+ * This is the documentation for the library interface of wimlib 1.4.0. If you
* have installed wimlib and want to know how to use the @b wimlib-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 <a
#define WIMLIB_MAJOR_VERSION 1
/** Minor version of the library (for example, the 2 in 1.2.5). */
-#define WIMLIB_MINOR_VERSION 3
+#define WIMLIB_MINOR_VERSION 4
/** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 3
+#define WIMLIB_PATCH_VERSION 0
/**
* Opaque structure that represents a WIM file. This is an in-memory structure
/** Do not issue an error if the path to delete does not exist. */
#define WIMLIB_DELETE_FLAG_FORCE 0x00000001
-/** Delete a file or directory tree recursively; if not specified, an error is
+/** Delete the file or directory tree recursively; if not specified, an error is
* issued if the path to delete is a directory. */
#define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
* The 1-based number of the image in @a wim from which the files or
* directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
*
- * @param default_extract_flags
- * Default extraction flags; the behavior shall be as if these flags had
- * been specified in the ::wimlib_extract_command.extract_flags member in
- * each extraction command, in combination with any flags already present.
- *
* @param cmds
* An array of ::wimlib_extract_command structures that specifies the
* extractions to perform.
* @param num_cmds
* Number of commands in the @a cmds array.
*
+ * @param default_extract_flags
+ * Default extraction flags; the behavior shall be as if these flags had
+ * been specified in the ::wimlib_extract_command.extract_flags member in
+ * each extraction command, in combination with any flags already present.
+ *
* @param additional_swms
* Array of pointers to the ::WIMStruct for each additional part in the
* split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
extern int
wimlib_extract_files(WIMStruct *wim,
int image,
- int default_extract_flags,
const struct wimlib_extract_command *cmds,
size_t num_cmds,
+ int default_extract_flags,
WIMStruct **additional_swms,
unsigned num_additional_swms,
wimlib_progress_func_t progress_func);
* Attempted to perform an add command that conflicted with previously
* existing files in the WIM when an overlay was attempted.
* @retval ::WIMLIB_ERR_INVALID_PARAM
- * Attempted to perform an add command with ::WIMLIB_ADD_FLAG_NTFS set, but
- * the same image had previously already been added from a NTFS volume.
+ * An unknown operation type was specified in the update commands; or,
+ * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
+ * in the @a add_flags, but the same image had previously already been
+ * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
+ * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
+ * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
+ * specified in the @a add_flags for an add command in which @a
+ * wim_target_path was not the root directory of the WIM image.
* @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
* (Windows only): While executing an add command, tried to capture a
* reparse point with invalid data.
* directory.
* @retval ::WIMLIB_ERR_UNSUPPORTED
* ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
- * command, but wimlib was configured with the @c --without-ntfs-3g flag.
+ * command, but wimlib was configured with the @c --without-ntfs-3g flag;
+ * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
+ * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
+ * add_flags for an update command.
*/
extern int
wimlib_update_image(WIMStruct *wim,