*
* \section intro Introduction
*
- * This is the documentation for the library interface of wimlib 1.3.3. 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
- * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
- *
- * wimlib is a C library to read, write, and mount archive files in the Windows
- * Imaging Format (WIM files). These files are normally created using the
- * ImageX (@a imagex.exe) utility on Windows, but this library provides a free
- * implementation of ImageX for UNIX-based systems (and, since v1.3.0, for
- * Windows systems) and an API to allow other programs to read, write, and mount
- * WIM files. wimlib is comparable to Microsoft's WIMGAPI, but was designed
- * independently and is not a clone of it.
- *
- * \section format WIM files
- *
- * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
- * formats such as ZIP, files in WIM archives may be compressed. WIM archives
- * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
- * Both are based on LZ77 and Huffman encoding, and both are supported by
- * wimlib.
- *
- * Unlike ZIP files, WIM files can contain multiple independent toplevel
- * directory trees known as @a images. While each image has its own metadata,
- * files are not duplicated for each image; instead, each file is included only
- * once in the entire WIM. Microsoft did this so that in one WIM file, they
- * could do things like have 5 different versions of Windows that are almost
- * exactly the same.
- *
- * Microsoft provides documentation for the WIM file format, XPRESS compression
- * format, and LZX compression format. The XPRESS documentation is acceptable,
- * but the LZX documentation is not entirely correct, and the WIM documentation
- * itself is incomplete.
- *
- * A WIM file may be either stand-alone or split into multiple parts.
- *
- * \section ntfs NTFS support
- *
- * As of version 1.0.0, wimlib supports capturing and applying images directly
- * to NTFS volumes. This was made possible with the help of libntfs-3g from the
- * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
- * data such as security descriptors, alternate data streams, and reparse point
- * data.
-
- * The code for NTFS image capture and image application is complete enough that
- * it is possible to apply an image from the "install.wim" contained in recent
- * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
- * NTFS volume, and then boot Windows from it after preparing the Boot
- * Configuration Data. In addition, a Windows installation can be captured (or
- * backed up) into a WIM file, and then re-applied later.
- *
- * wimlib v1.3.0 and later also supports NTFS capture and apply in the native
- * Windows build, which works slightly differently and relies on native Win32
- * API calls rather than libntfs-3g.
- *
- * \section winpe Windows PE
- *
- * A major use for this library is to create customized images of Windows PE, the
- * Windows Preinstallation Environment, without having to rely on Windows. Windows
- * PE is a lightweight version of Windows that can run entirely from memory and can
- * be used to install Windows from local media or a network drive or perform
- * maintenance. Windows PE is the operating system that runs when you boot from
- * the Windows installation media.
- *
- * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
- * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
- * in the Windows Automated Installation Kit (WAIK), which is free to download
- * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
- * install either the @c cabextract or @c p7zip programs.
- *
- * In addition, Windows installations and recovery partitions frequently contain a
- * WIM containing an image of the Windows Recovery Environment, which is similar to
- * Windows PE.
+ * This is the documentation for the library interface of wimlib 1.4.0, a C
+ * library for creating, modifying, extracting, and mounting files in the
+ * Windows Imaging Format. This documentation is intended for developers only.
+ * If you have installed wimlib and want to know how to use the @b wimlib-imagex
+ * program, please see the README file.
*
* \section starting Getting Started
*
- * wimlib uses the GNU autotools, so it should be easy to install with
- * <code>configure && make && sudo make install</code>; however, please see the
- * README for more information about installing it. To use wimlib in a program
- * after installing it, include @c wimlib.h and link your program with @c -lwim.
+ * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
+ * install with <code>configure && make && sudo make install</code>; however,
+ * please see the README for more information about installing it. To use
+ * wimlib in a program after installing it, include @c wimlib.h and link your
+ * program with @c -lwim.
*
* wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
* may represent either a stand-alone WIM or one part of a split WIM.
*
* All functions in wimlib's public API are prefixed with @c wimlib. Most
- * return an integer error code on failure. Use wimlib_get_error_string() to
- * get a string that describes an error code. wimlib also can print error
- * messages itself when an error happens, and these may be more informative than
- * the error code; to enable this, call wimlib_set_print_errors(). Please note
- * that this is for convenience only, and some errors can occur without a
- * message being printed.
- *
- * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
- * the following exceptions:
- * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
- * - You also must call wimlib_global_init() in the main thread to avoid any
- * race conditions with one-time allocations of memory.
- * - wimlib_mount_image(), while it can be used to mount multiple WIMs
- * concurrently in the same process, will daemonize the entire process when it
- * does so for the first time. This includes changing the working directory
- * to the root directory.
+ * return 0 on success and a positive error code on failure. Use
+ * wimlib_get_error_string() to get a string that describes an error code.
+ * wimlib also can print error messages itself when an error happens, and these
+ * may be more informative than the error code; to enable this, call
+ * wimlib_set_print_errors(). Please note that this is for convenience only,
+ * and some errors can occur without a message being printed.
*
* To open an existing WIM, use wimlib_open_wim().
*
*
* To add an image to a WIM file from a directory tree on your filesystem, call
* wimlib_add_image(). This can be done with a ::WIMStruct gotten from
- * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
- * also capture a WIM image directly from a NTFS volume if you provide the
- * ::WIMLIB_ADD_FLAG_NTFS flag, provided that wimlib was not compiled with
- * the <code>--without-ntfs-3g</code> flag.
- *
- * To extract an image from a WIM file, call wimlib_extract_image(). You may
- * extract an image either to a directory or directly to a NTFS volume, the
- * latter of which will preserve NTFS-specific data such as security
- * descriptors.
- *
- * wimlib supports mounting WIM files either read-only or read-write. Mounting
- * is done using wimlib_mount_image() and unmounting is done using
+ * wimlib_open_wim() or from wimlib_create_new_wim(). On UNIX,
+ * wimlib_add_image() can also capture a WIM image directly from a block device
+ * containing a NTFS filesystem.
+ *
+ * To extract an image from a WIM file, call wimlib_extract_image(). This can
+ * be done either to a directory, or, on UNIX, directly to a block device
+ * containing a NTFS filesystem.
+ *
+ * To extract individual files or directories from a WIM image, rather than a
+ * full image, call wimlib_extract_files().
+ *
+ * To programatically make changes to a WIM image without mounting it, call
+ * wimlib_update_image().
+ *
+ * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
+ * Mounting is done using wimlib_mount_image() and unmounting is done using
* wimlib_unmount_image(). Mounting can be done without root privileges because
* it is implemented using FUSE (Filesystem in Userspace). If wimlib is
* compiled with the <code>--without-fuse</code> flag, these functions will be
* the WIM operation(s) to report on the progress of the operation (for example,
* how many bytes have been written so far).
*
- * \section imagex wimlib-imagex
- *
- * wimlib comes with a command-line interface, the @b wimlib-imagex program. It
- * is documented with man pages. This program was originally just called @b
- * imagex, but has been changed to @b wimlib-imagex to avoid confusion with
- * Microsoft's @a imagex.exe (which would otherwise have exactly the same
- * filename on Windows).
- *
- * \section mkwinpeimg mkwinpeimg
- *
- * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
- * man page.
+ * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
+ * the following exceptions:
+ * - You must call wimlib_global_init() in one thread before calling any other
+ * functions.
+ * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
+ * race conditions with one-time allocations of memory.
+ * - wimlib_mount_image(), while it can be used to mount multiple WIMs
+ * concurrently in the same process, will daemonize the entire process when it
+ * does so for the first time. This includes changing the working directory
+ * to the root directory.
*
* \section encodings Locales and character encodings
*
* and the encoding is UTF-16LE.
*
* On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
-* encoding is the locale-dependent multibyte encoding. I recommend you set your
-* locale to a UTF-8 capable locale to avoid any issues. Also, by default,
- * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
-* wimlib_global_init() after having set your desired locale.
+ * encoding is the locale-dependent multibyte encoding. I recommend you set
+ * your locale to a UTF-8 capable locale to avoid any issues. Also, by default,
+ * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
+ * wimlib_global_init() after having set your desired locale.
*
* \section Limitations
*
- * While wimlib supports the main features of WIM files, wimlib currently has
- * the following limitations:
- * - There is no way to add, remove, modify, or extract specific files in a WIM
- * without mounting it, other than by adding, removing, or extracting an
- * entire image. The FUSE mount feature should be used for this purpose.
- * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
- * than wimlib (~2% or 3% smaller) when using maximum (LZX) compression.
- * - wimlib is experimental and likely contains bugs; use Microsoft's @a
- * imagex.exe if you want to make sure your WIM files are made "correctly".
+ * This section documents some technical limitations of wimlib not already
+ * documented in the man page for @b wimlib-imagex.
+ *
* - The old WIM format from Vista pre-releases is not supported.
- * - Compressed resource chunk sizes other than 32768 are not supported,
- * although this doesn't seem to be a problem because the chunk size always
- * seems to be this value.
- * - wimlib does not provide a clone of the @b PEImg tool that allows you to
- * make certain Windows-specific modifications to a Windows PE image, such as
- * adding a driver or Windows component. Such a tool could conceivably be
- * implemented on top of wimlib, although it likely would be hard to implement
- * because it would have to do very Windows-specific things such as
- * manipulating the driver store. wimlib does provide the @b mkwinpeimg
- * script for a similar purpose, however. With regards to adding drivers to
- * Windows PE, you have the option of putting them anywhere in the Windows PE
- * image, then loading them after boot using @b drvload.exe.
- * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
- * Windows build has some limitations compared to the UNIX build.
- * (The differences are documented better in the man pages for
- * @b wimlib-imagex than here.)
- *
- * \section legal License
- *
- * The wimlib library, as well as the programs and scripts distributed with it
- * (@b wimlib-imagex and @b mkwinpeimg), is licensed under the GNU General
- * Public License version 3 or later.
+ * - Compressed resource chunk sizes other than 32768 are not supported. This
+ * doesn't seem to be a real problem because the chunk size always seems to be
+ * this value.
+ * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
+ * functionality other than that already present in @b ImageX, that allows you
+ * to make certain Windows-specific modifications to a Windows PE image, such
+ * as adding a driver or Windows component. Such a tool possibly could be
+ * implemented on top of wimlib.
*/
#ifndef _WIMLIB_H
#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
/*****************************
- * WIMLIB_ADD_FLAG_* *
+ * WIMLIB_ADD_FLAG_*
*****************************/
/** Directly capture a NTFS volume rather than a generic directory. This flag
#define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
#define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
-#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
+#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
-#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
+#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
#define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
+/******************************
+ * WIMLIB_DELETE_FLAG_*
+ ******************************/
+
/** 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
/******************************
- * WIMLIB_EXPORT_FLAG_* *
+ * WIMLIB_EXPORT_FLAG_*
******************************/
/** See documentation for wimlib_export_image(). */
#define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
/******************************
- * WIMLIB_EXTRACT_FLAG_* *
+ * WIMLIB_EXTRACT_FLAG_*
******************************/
/** Extract the image directly to a NTFS volume rather than a generic directory.
#define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
/******************************
- * WIMLIB_MOUNT_FLAG_* *
+ * WIMLIB_MOUNT_FLAG_*
******************************/
/** Mount the WIM image read-write rather than the default of read-only. */
#define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
/******************************
- * WIMLIB_OPEN_FLAG_* *
+ * WIMLIB_OPEN_FLAG_*
******************************/
/** Verify the WIM contents against the WIM's integrity table, if present. */
#define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
/******************************
- * WIMLIB_UNMOUNT_FLAG_* *
+ * WIMLIB_UNMOUNT_FLAG_*
******************************/
/** Include an integrity table in the WIM after it's been unmounted. Ignored
#define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
/******************************
- * WIMLIB_WRITE_FLAG_* *
+ * WIMLIB_WRITE_FLAG_*
******************************/
/** Include an integrity table in the new WIM file. */
* deleting an image in this way. */
#define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
+/******************************
+ * WIMLIB_INIT_FLAG_*
+ ******************************/
+
/** Assume that strings are represented in UTF-8, even if this is not the
* locale's character encoding. */
#define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
-/** XXX */
+/** Specification of an update to perform on a WIM image. */
struct wimlib_update_command {
- enum {
+
+ /** The specific type of update to perform. */
+ enum wimlib_update_op {
+ /** Add a new file or directory tree to the WIM image in a
+ * certain location. */
WIMLIB_UPDATE_OP_ADD = 0,
+
+ /** Delete a file or directory tree from the WIM image. */
WIMLIB_UPDATE_OP_DELETE,
+
+ /** Rename a file or directory tree in the WIM image. */
WIMLIB_UPDATE_OP_RENAME,
} op;
union {
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
+ struct wimlib_add_command {
+ /** Filesystem path to the file or directory tree to
+ * add. */
wimlib_tchar *fs_source_path;
+ /** Path, specified from the root of the WIM image, at
+ * which to add the file or directory tree within the
+ * WIM image. */
wimlib_tchar *wim_target_path;
+
+ /** Configuration for excluded files. @c NULL means
+ * exclude no files. */
struct wimlib_capture_config *config;
+
+ /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
int add_flags;
} add;
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
+ struct wimlib_delete_command {
+ /** Path, specified from the root of the WIM image, for
+ * the file or directory tree within the WIM image to be
+ * deleted. */
wimlib_tchar *wim_path;
+ /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
int delete_flags;
} delete;
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
+ struct wimlib_rename_command {
+ /** Path, specified from the root of the WIM image, for
+ * the source file or directory tree within the WIM
+ * image. */
wimlib_tchar *wim_source_path;
+ /** Path, specified from the root of the WIM image, for
+ * the destination file or directory tree within the WIM
+ * image. */
wimlib_tchar *wim_target_path;
+ /** Reserved; set to 0. */
int rename_flags;
} rename;
};
* See the documentation for each wimlib function to see specifically what error
* codes can be returned by a given function, and what they mean.
*/
-/* Note: these are currently in alphabetic order, but new error codes should be
- * added at the end to maintain a compatible ABI, except when it's being broken
- * anyway. */
enum wimlib_error_code {
WIMLIB_ERR_SUCCESS = 0,
WIMLIB_ERR_ALREADY_LOCKED,
WIMLIB_ERR_PATH_DOES_NOT_EXIST,
WIMLIB_ERR_NOT_A_REGULAR_FILE,
WIMLIB_ERR_IS_DIRECTORY,
+ WIMLIB_ERR_NOTEMPTY,
};
* A path to a directory or unmounted NTFS volume that will be captured as
* a WIM image.
* @param name
- * The name to give the image. This must be non-@c NULL.
+ * The name to give the image. It must be nonempty and must specify a name
+ * that does not yet exist in @a wim.
* @param config
* Capture configuration that specifies files, directories, or path globs
* to exclude from being captured. If @c NULL, a dummy configuration where
* discarded so that it appears to be in the same state as when this function
* was called.
*
- * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
- * There is already an image named @a name in @a wim.
- * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
- * @a config was not @c NULL and did not specify a valid image capture
- * configuration.
- * @retval ::WIMLIB_ERR_INVALID_PARAM
- * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
- * @retval ::WIMLIB_ERR_NOMEM
- * Failed to allocate needed memory.
- * @retval ::WIMLIB_ERR_NOTDIR
- * @a source is not a directory (only if ::WIMLIB_ADD_FLAG_NTFS was
- * not specified in @a add_flags).
- * @retval ::WIMLIB_ERR_NTFS_3G
- * An error was returned from a libntfs-3g function when the NTFS volume
- * was being opened, scanned, or closed (only if
- * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags).
- * @retval ::WIMLIB_ERR_OPEN
- * Failed to open a file or directory in the directory tree rooted at @a
- * source (only if ::WIMLIB_ADD_FLAG_NTFS was not specified in @a
- * add_flags).
- * @retval ::WIMLIB_ERR_READ
- * Failed to read a file in the directory tree rooted at @a source (only if
- * ::WIMLIB_ADD_FLAG_NTFS was not specified in @a add_flags).
- * @retval ::WIMLIB_ERR_SPECIAL_FILE
- * The directory tree rooted at @a source contains a special file that is
- * not a directory, regular file, or symbolic link. This currently can
- * only be returned if ::WIMLIB_ADD_FLAG_NTFS was not specified in @a
- * add_flags, but it may be returned for unsupported NTFS files in
- * the future.
- * @retval ::WIMLIB_ERR_STAT
- * Failed obtain the metadata for a file or directory in the directory tree
- * rooted at @a source (only if ::WIMLIB_ADD_FLAG_NTFS was not
- * specified in @a add_flags).
- * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
- * @a wim is part of a split WIM. Adding an image to a split WIM is
- * unsupported.
- * @retval ::WIMLIB_ERR_UNSUPPORTED
- * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags, but
- * wimlib was configured with the @c --without-ntfs-3g flag.
+ * This function is implemented by calling wimlib_add_empty_image(), then
+ * calling wimlib_update_image() with a single "add" command, so any error code
+ * returned by wimlib_add_empty_image() may be returned, as well as any error
+ * codes returned by wimlib_update_image() other than ones documented as only
+ * being returned specifically by an update involving delete or rename commands.
*/
extern int
wimlib_add_image(WIMStruct *wim,
* wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
* NTFS mode.) */
extern int
-wimlib_add_image_multisource(WIMStruct *w,
+wimlib_add_image_multisource(WIMStruct *wim,
const struct wimlib_capture_source *sources,
size_t num_sources,
const wimlib_tchar *name,
* wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
* have references back to @a src_wim.
*
- * Previous versions of this function left @a dest_wim in an indeterminate state
- * on failure. This is no longer the case; all changes to @a dest_wim made by
- * this function are rolled back on failure.
+ * If this function fails, all changes to @a dest_wim are rolled back.
*
- * Previous versions of this function did not allow exporting an image that had
- * been added by wimlib_add_image(). This is no longer the case; you may now
- * export an image regardless of how it was added.
- *
- * Regardless of whether this function succeeds or fails, no changes are made to
- * @a src_wim.
+ * No changes shall be made to @a src_wim by this function.
*
* Please note that no changes are committed to the underlying WIM file of @a
* dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
* 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);
* If non-NULL, a function that will be called periodically with the
* progress of the current operation.
*
- * @return 0 on success; nonzero on error. There are many possible error codes
- * (TODO: document them.)
+ * @return 0 on success; nonzero on error. On failure, some but not all of the
+ * update commands may have been executed. No individual update command will
+ * have been partially executed. Possible error codes include:
+ *
+ * @retval ::WIMLIB_ERR_DECOMPRESSION
+ * Failed to decompress the metadata resource from @a image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
+ * The capture configuration structure specified for an add command was
+ * invalid.
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * A directory entry for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_IMAGE
+ * @a image did not specify a single, existing image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_OVERLAY
+ * 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
+ * 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.
+ * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
+ * The metadata resource for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ * The security data for image @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_IS_DIRECTORY
+ * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
+ * for a WIM path that corresponded to a directory; or, a rename command
+ * attempted to rename a directory to a non-directory.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * Failed to allocate needed memory.
+ * @retval ::WIMLIB_ERR_NOTDIR
+ * A rename command attempted to rename a directory to a non-directory; or,
+ * an add command was executed that attempted to set the root of the WIM
+ * image as a non-directory.
+ * @retval ::WIMLIB_ERR_NOTEMPTY
+ * A rename command attempted to rename a directory to a non-empty
+ * directory.
+ * @retval ::WIMLIB_ERR_NTFS_3G
+ * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
+ * error occurred while reading data from the NTFS volume using libntfs-3g.
+ * @retval ::WIMLIB_ERR_OPEN
+ * Failed to open a file to be captured while executing an add command.
+ * @retval ::WIMLIB_ERR_OPENDIR
+ * Failed to open a file to be captured while executing an add command.
+ * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
+ * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
+ * WIM path that did not exist; or, a component of the path of the source
+ * or destination of a rename command was used as a directory but was not,
+ * in fact, a directory.
+ * @retval ::WIMLIB_ERR_READ
+ * Failed to read the metadata resource for @a image in @a wim; or, while
+ * executing an add command, failed to read data from a file or directory
+ * to be captured.
+ * @retval ::WIMLIB_ERR_READLINK
+ * While executing an add command, failed to read the target of a symbolic
+ * link or junction point.
+ * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
+ * (Windows only) Failed to perform a reparse point fixup because of
+ * problems with the data of a reparse point.
+ * @retval ::WIMLIB_ERR_SPECIAL_FILE
+ * While executing an add command, attempted to capture a file that was not
+ * a supported file type, such as a regular file, directory, symbolic link,
+ * or (on Windows) a reparse point.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * @a wim is part of a split WIM. Updating a split WIM is unsupported.
+ * @retval ::WIMLIB_ERR_STAT
+ * While executing an add command, failed to get attributes for a file or
+ * 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;
+ * 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,