X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=0618ff3801114645820b0584e99afeb6eb9dca88;hp=6d9eef48dc42a824d08470d605b381fad82a6eae;hb=5cdd60306facd14cc9dcc24471386451294ca73c;hpb=dff049d44d86598d82bf78d3fdcfedc28db83018

diff --git a/src/wimlib.h b/src/wimlib.h
index 6d9eef48..0618ff38 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -4,22 +4,22 @@
  * External header for wimlib.
  */
 
-/* 
+/*
  * Copyright (C) 2012 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
  *
  * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU Lesser General Public License as published by the Free
- * Software Foundation; either version 2.1 of the License, or (at your option)
+ * terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option)
  * any later version.
  *
  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * A PARTICULAR PURPOSE. See the GNU General Public License for more
  * details.
  *
- * You should have received a copy of the GNU Lesser General Public License
+ * You should have received a copy of the GNU General Public License
  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  */
 
@@ -33,19 +33,6 @@
  * implementetion of @c imagex for UNIX-based 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.
- * 
- * The main intended use of wimlib is to create customized images of Windows PE,
- * the Windows Preinstallation Environment, without having to rely on Windows.
- * Windows PE, which is the operating system that runs when you boot from the
- * Windows Vista or Windows 7 DVD, is a lightweight version of Windows that can
- * run entirely from memory. It can be used to install Windows from local media
- * or a network drive or perform maintenance. 
- * 
- * You can find Windows PE on the installation media for Windows Vista, Windows
- * 7, and Windows 8.  The Windows PE image itself is a WIM file, @c
- * sources/boot.wim, on the ISO filesystem.  Windows PE can also be found in the
- * Windows Automated Installation Kit (WAIK) inside the @c WinPE.cab file, which
- * you can extract if you install the @c cabextract program.
  *
  * \section format WIM files
  *
@@ -62,33 +49,68 @@
  * could do things like have 5 different versions of Windows that are almost
  * exactly the same.
  *
- * WIM files may contain a integrity table.  The integrity table, if it exists,
- * is located at the end of the WIM file and contains SHA1 message digests of
- * 10MB chunks of the WIM.
- *
  * Microsoft provides documentation for the WIM file format, XPRESS compression
- * format, and LZX compression format.  However, there are errors and omissions
- * in some places in their documentation.
+ * format, and LZX compression format.  The XPRESS documentation is acceptable,
+ * but the LZX documentation is not entirely correct, and the WIM documentation
+ * itself is very incomplete and is of unacceptable quality.
+ *
+ * A WIM file may be either stand-alone or split into multiple parts.
+ *
+ * \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.
+ *
+ * \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.
  *
  * \section starting Getting Started
  *
  * wimlib uses the GNU autotools, so it should be easy to install with
- * <code>configure && make && sudo make install</code>, provided that you have
- * @c libxml2 and @c libfuse installed.  To use wimlib in a program after
- * installing it, include @c wimlib.h and link your program with @c -lwim.
+ * <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.
+ * 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().
+ * 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, with the
- * following exceptions:  wimlib_set_print_errors() and
- * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
- * used by one ::WIMStruct at a time.
+ * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
+ * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
+ * both apply globally.
  *
  * To open an existing WIM, use wimlib_open_wim().
  *
@@ -97,10 +119,18 @@
  *
  * 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_open_wim() or from wimlib_create_new_wim().  Alternatively, if you
+ * want to capture a WIM image directly from a NTFS volume while preserving
+ * NTFS-specific data such as security descriptors, call
+ * wimlib_add_image_from_ntfs_volume() instead.
  *
- * To extract an image from a WIM file, call wimlib_set_output_dir() to set the
- * output directory, then call wimlib_extract_image().
+ * To extract an image from a WIM file, call wimlib_extract_image().
+ * Alternatively, if you want to apply a WIM image directly to a NTFS volume
+ * while setting NTFS-specific data such as security descriptors, call
+ * wimlib_apply_image_to_ntfs_volume().
+ *
+ * The NTFS functions will fail if wimlib was compiled with the
+ * <code>--without-ntfs-3g</code> flag.
  *
  * wimlib supports mounting WIM files either read-only or read-write.  Mounting
  * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
@@ -111,24 +141,29 @@
  *
  * After creating or modifying a WIM file, you can write it to a file using
  * wimlib_write().  Alternatively,  if the WIM was originally read from a file,
- * you can use wimlib_overwrite() to overwrite the original file.  In some
- * cases, wimlib_overwrite_xml_and_header() can be used instead.
+ * you can use wimlib_overwrite() to overwrite the original file.
+ *
+ * Please not: merely by calling wimlib_add_image() or many of the other
+ * functions in this library that operate on ::WIMStruct's, you are @b not
+ * modifing the WIM file on disk.  Changes are not saved until you explicitly
+ * call wimlib_write() or wimlib_overwrite().
  *
  * After you are done with the WIM file, use wimlib_free() to free all memory
  * associated with a ::WIMStruct and close all files associated with it.
  *
- * To see an example of how to use wimlib, see the file
- * @c programs/imagex.c in wimlib's source tree.
+ * To see an example of how to use wimlib, see the file @c programs/imagex.c in
+ * wimlib's source tree.
  *
  * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
- * for this.
+ * for this.  However, if wimlib calls into @c libntfs-3g, the custom memory
+ * allocator may not be used.
  *
  * \section imagex imagex
  *
  * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
  *
  * \section mkwinpeimg mkwinpeimg
- * 
+ *
  * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
  * page.
  *
@@ -136,25 +171,13 @@
  *
  * While wimlib supports the main features of WIM files, wimlib currently has
  * the following limitations:
- * - wimlib does not support modifying or creating "security data", which
- *   describes the access rights of the files in the WIM.  This data is very
- *   Windows-specific, and it would be difficult to do anything with it.
- *   Microsoft's software can still read a WIM without security data, including
- *   a boot.wim for Windows PE, but <b>do not expect to be able to use wimlib to
- *   image a Windows installation and preserve file attributes</b>.  However, by
- *   default, wimlib will preserve security data for existing WIMs.
- * - There is no way to directly extract or mount split WIMs.
- * - There is not yet any code to verify that there are no collisions between
- *   different files that happen to have the same SHA1 message digest.
- *   This is extremely unlikely, but could result in something bad such as a
- *   file going missing.
- * - Alternate stream entries for directory entries are ignored.
- * - Different versions of the WIM file format, if they even exist, are
- *   unsupported.  Let me know if you notice WIM files with a different version.
- * - Chunk sizes other than 32768 are unsupported (except for uncompressed WIMs,
- *   for which the chunk size field is ignored).  As far as I can tell, other
- *   chunk sizes are not used in compressed WIMs.  Let me know if you find a WIM
- *   file with a different chunk size.
+ * - Different versions of the WIM file format are unsupported.  There is one
+ *   different version of the format from development versions of Windows Vista,
+ *   but I'm not planning to support it.
+ * - Compressed resource chunk sizes other than 32768 are unsupported (except for
+ *   uncompressed WIMs, for which the chunk size field is ignored).  As far as I
+ *   can tell, other chunk sizes are not used in compressed WIMs.  Let me know
+ *   if you find a WIM file with a different chunk size.
  * - 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
@@ -170,21 +193,17 @@
  *   can implement this if requested, but I intend the FUSE mount feature to be
  *   used for this purpose, as it is easy to do these things in whatever way you
  *   want after the image is mounted.
- *
- * Currently, Microsoft's @a image.exe can create slightly smaller WIM files
- * than wimlib when using maximum (LZX) compression because it knows how to
- * split up LZX compressed blocks, which is not yet implemented in wimlib.
- *
- * 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".
+ * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
+ *   than wimlib when using maximum (LZX) compression because it knows how to
+ *   split up LZX compressed blocks, which is not yet implemented in wimlib.
+ * - 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".
  *
  * \section legal License
  *
- * The wimlib library is licensed under the GNU Lesser General Public License
- * version 2.1 or later.
- *
- * @b imagex and @b mkwinpeiso are licensed under the GNU General Public License
- * version 3 or later.
+ * The wimlib library, as well as the programs and scripts distributed with it
+ * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
+ * License version 3 or later.
  */
 
 #ifndef _WIMLIB_H
@@ -195,8 +214,8 @@
 #include <stdbool.h>
 
 #ifndef _WIMLIB_INTERNAL_H
-/** 
- * Opaque structure that represents a WIM file. 
+/**
+ * Opaque structure that represents a WIM file.
  */
 typedef struct WIMStruct WIMStruct;
 #endif
@@ -236,7 +255,7 @@ enum wim_compression_type {
  * alternate file stream name. */
 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS	0x00000040
 
-/** Include an integrity table in the new WIM being written during the unmount. 
+/** Include an integrity table in the new WIM being written during the unmount.
  * Ignored for read-only mounts. */
 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY	0x00000001
 
@@ -247,12 +266,33 @@ enum wim_compression_type {
 /** Include an integrity table in the new WIM file. */
 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY	0x00000001
 
-/** Print progress information when writing the integrity table. */
+/** Print progress information when writing streams and when writing the
+ * integrity table. */
 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS		0x00000002
 
 /** Print file paths as we write then */
 #define WIMLIB_WRITE_FLAG_VERBOSE		0x00000004
 
+/** Call fsync() when the WIM file is closed */
+#define WIMLIB_WRITE_FLAG_FSYNC			0x00000008
+
+/** Re-build the entire WIM file rather than appending data to it, if possible.
+ * (Applies to wimlib_overwrite(), not wimlib_write()). */
+#define WIMLIB_WRITE_FLAG_REBUILD		0x00000010
+
+/** Do not copy compressed resources between WIMs if the compression type is the
+ * same.  Instead, recompress them. */
+#define WIMLIB_WRITE_FLAG_RECOMPRESS		0x00000020
+
+/** Specifying this flag overrides the default behavior of wimlib_overwrite()
+ * after one or more calls to wimlib_delete_image(), which is to rebuild the
+ * entire WIM.  If you specifiy this flag to wimlib_overwrite() instead, only
+ * minimal changes to correctly remove the image from the WIM will be taken.  In
+ * particular, all streams will be left alone, even if they are no longer
+ * references.  This is probably not what you want, because almost no space will
+ * be spaced by deleting an image in this way. */
+#define WIMLIB_WRITE_FLAG_SOFT_DELETE		0x00000040
+
 /** Mark the image being added as the bootable image of the WIM. */
 #define WIMLIB_ADD_IMAGE_FLAG_BOOT		0x00000001
 
@@ -263,6 +303,9 @@ enum wim_compression_type {
 /** Follow symlinks; archive and dump the files they point to. */
 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE	0x00000004
 
+/** Show progress information when scanning a directory tree */
+#define WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS	0x00000008
+
 /** See documentation for wimlib_export_image(). */
 #define WIMLIB_EXPORT_FLAG_BOOT			0x00000001
 
@@ -288,6 +331,12 @@ enum wim_compression_type {
 /** Print the name of each file as it is extracted from the WIM image. */
 #define WIMLIB_EXTRACT_FLAG_VERBOSE		0x00000008
 
+/** Read the WIM file sequentially while extracting the image. */
+#define WIMLIB_EXTRACT_FLAG_SEQUENTIAL		0x00000010
+
+/** Print progress information while extracting the image. */
+#define WIMLIB_EXTRACT_FLAG_SHOW_PROGRESS	0x00000020
+
 /**
  * Possible values of the error code returned by many functions in wimlib.
  *
@@ -305,6 +354,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_IMAGE_COUNT,
 	WIMLIB_ERR_IMAGE_NAME_COLLISION,
 	WIMLIB_ERR_INTEGRITY,
+	WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
 	WIMLIB_ERR_INVALID_CHUNK_SIZE,
 	WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
 	WIMLIB_ERR_INVALID_DENTRY,
@@ -329,6 +379,8 @@ enum wimlib_error_code {
 	WIMLIB_ERR_READLINK,
 	WIMLIB_ERR_READ,
 	WIMLIB_ERR_RENAME,
+	WIMLIB_ERR_REOPEN,
+	WIMLIB_ERR_RESOURCE_ORDER,
 	WIMLIB_ERR_SPECIAL_FILE,
 	WIMLIB_ERR_SPLIT_INVALID,
 	WIMLIB_ERR_SPLIT_UNSUPPORTED,
@@ -355,11 +407,8 @@ enum wimlib_error_code {
  * directory entry tree in-memory.  Also, all files are read to calculate their
  * SHA1 message digests.  However, because the directory tree may contain a very
  * large amount of data, the files themselves are not read into memory
- * permanently, and instead references to their paths saved.  This means that
- * the directory tree must not be modified, other than by adding entirely new
- * files or directories, before executing a call to wimlib_write() or
- * wimlib_overwrite(). Otherwise, wimlib_write() may fail or incorrect files may
- * be included in the WIM written by wimlib_write().
+ * permanently, and instead references to their paths saved.  The files are then
+ * read on-demand if wimlib_write() or wimlib_overwrite() is called.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file to which the image will be
@@ -369,25 +418,33 @@ enum wimlib_error_code {
  * 	root directory for the WIM image.
  * @param name
  * 	The name to give the image.  This must be non-@c NULL.
- * @param description
- * 	The description to give the image.  This parameter may be left @c
- * 	NULL, in which case no description is given to the image.
- * @param flags_element
- * 	What to put in the &lt;FLAGS&gt; element for the image's XML data.  This
- * 	parameter may be left @c NULL, in which case no &lt;FLAGS&gt; element is
- * 	given to the image.
+ * @param config
+ * 	Pointer to the contents of an image capture configuration file.  If @c
+ * 	NULL, a default string is used.  Please see the manual page for
+ * 	<b>imagex capture</b> for more information.
+ * @param config_len
+ * 	Length of the string @a config in bytes.  Ignored if @a config is @c
+ * 	NULL.
+ *
  * @param flags
- * 	If set to ::WIMLIB_ADD_IMAGE_FLAG_BOOT, change the image in @a wim
- * 	marked as bootable to the one being added. Otherwise, leave the boot
- * 	index unchanged.
+ * 	Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.  If
+ * 	::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
+ * 	marked as bootable is changed to the one being added.  If
+ * 	::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
+ * 	printed as it is scanned or captured.  If
+ * 	::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
+ * 	directories pointed to by symbolic links are archived rather than the
+ * 	symbolic links themselves.  If ::WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS is
+ * 	specified, progress information will be printed (distinct from the
+ * 	verbose information).
  *
  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
  * discarded so that it appears to be in the same state as when this function
  * was called.
  *
- * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION 
+ * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
  * 	There is already an image named @a name in @a w.
- * @retval ::WIMLIB_ERR_INVALID_PARAM 
+ * @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.
@@ -398,28 +455,51 @@ enum wimlib_error_code {
  * 	dir.
  * @retval ::WIMLIB_ERR_READ
  * 	Failed to read a file in the directory tree rooted at @a dir.
+ * @retval ::WIMLIB_ERR_SPECIAL_FILE
+ * 	The directory tree rooted at @dir contains a special file that is not a
+ * 	directory, regular file, or symbolic link.
  * @retval ::WIMLIB_ERR_STAT
  * 	Failed obtain the metadata for a file or directory in the directory tree
  * 	rooted at @a dir.
- *
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim is part of a split WIM.  Adding an image to a split WIM is
+ * 	unsupported.
  */
-extern int wimlib_add_image(WIMStruct *wim, const char *dir, 
-			    const char *name, const char *description, 
-			    const char *flags_element, int flags);
+extern int wimlib_add_image(WIMStruct *wim, const char *dir,
+			    const char *name, const char *config,
+			    size_t config_len, int flags);
 
-extern int wimlib_add_image_from_ntfs_volume(WIMStruct *w, const char *device,
+/**
+ * This function is similar to wimlib_add_image(), except instead of capturing
+ * the WIM image from a directory, it is captured from a NTFS volume specified
+ * by @a device.  NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
+ * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
+ * the reparse points exactly as they are.
+ */
+extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
 					     const char *name,
-					     const char *description,
-					     const char *flags_element,
+					     const char *config,
+					     size_t config_len,
 					     int flags);
 
-extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *w, int image,
-				 	     const char *device, int flags);
+/**
+ * This function is similar to wimlib_extract_image(), except that @a image may
+ * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
+ * device containing a NTFS volume to apply the image to.  NTFS-3g errors are
+ * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
+ * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
+ * apply mode we apply the reparse points and hard links exactly as they are in
+ * the WIM.
+ */
+extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
+				 	     const char *device, int flags,
+					     WIMStruct **additional_swms,
+					     unsigned num_additional_swms);
 
-/** 
+/**
  * Creates a WIMStruct for a new WIM file.
  *
- * @param ctype 
+ * @param ctype
  * 	The type of compression to be used in the new WIM file.  Must be
  * 	::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
  * 	::WIM_COMPRESSION_TYPE_XPRESS.
@@ -440,8 +520,9 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
 /**
  * Deletes an image, or all images, from a WIM file.
  *
- * All file resources referenced by the image(s) being deleted are removed from
- * the WIM if they are not referenced by any other images in the WIM.
+ * All streams referenced by the image(s) being deleted are removed from the
+ * lookup table of the WIM if they are not referenced by any other images in the
+ * WIM.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file that contains the image(s)
@@ -449,8 +530,12 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
  * @param image
  * 	The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
  * 	images.
- * @return 0 on success; nonzero on error.  On error, @a wim is left in an
- * indeterminate state and should be freed with wimlib_free().
+ * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
+ * to be left unmodified only if @a image specified a single image.  If instead
+ * @a image was ::WIM_ALL_IMAGES and @a wim contained more than one image, it's
+ * possible for some but not all of the images to have been deleted when a
+ * failure status is returned.
+ *
  * @retval ::WIMLIB_ERR_DECOMPRESSION
  * 	Could not decompress the metadata resource for @a image.
  * @retval ::WIMLIB_ERR_INVALID_DENTRY
@@ -459,25 +544,52 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- *	The metadata resource for @a image in the WIM is invalid.	
- * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
+ *	The metadata resource for @a image in the WIM is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for @a image in the WIM is invalid.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * 	Failed to allocate needed memory.
  * @retval ::WIMLIB_ERR_READ
  * 	Could not read the metadata resource for @a image from the WIM.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim is part of a split WIM.  Deleting an image from a split WIM is
+ * 	unsupported.
  */
 extern int wimlib_delete_image(WIMStruct *wim, int image);
 
 /**
- * Copies an image, or all the images, from a WIM file, into another WIM file.
+ * Exports an image, or all the images, from a WIM file, into another WIM file.
+ *
+ * The destination image is made to share the same dentry tree and security data
+ * structure as the source image.  This places some restrictions on additional
+ * functions that may be called.  wimlib_mount() may not be called on either the
+ * source image or the destination image without an intervening call to a
+ * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
+ * wimlib_delete_image() on either the source or destination image.
+ * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
+ * src_wim before any calls to functions such as wimlib_write() 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.
+ *
+ * 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 user-visible
+ * changes are made to @a src_wim.
  *
  * @param src_wim
- * 	Pointer to the ::WIMStruct for a WIM file that contains the image(s)
- * 	being exported.
+ * 	Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
+ * 	WIM that contains the image(s) being exported.
  * @param src_image
  * 	The image to export from @a src_wim.  Can be the number of an image, or
  * 	::WIM_ALL_IMAGES to export all images.
  * @param dest_wim
- * 	Pointer to the ::WIMStruct for a WIM filethat will receive the images being
- * 	exported.
+ * 	Pointer to the ::WIMStruct for a WIM file that will receive the images
+ * 	being exported.
  * @param dest_name
  * 	The name to give the exported image in the new WIM file.  If left @c NULL,
  * 	the name from @a src_wim is used.  This parameter must be left @c NULL
@@ -497,16 +609,25 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
  * 	currently marked as bootable in @a src_wim; if that is the case, then
  * 	that image is marked as bootable in the destination WIM.
+ * @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
+ * 	need to be in any particular order, but they must include all parts of
+ * 	the split WIM other than the first part, which must be provided in the
+ * 	@a wim parameter.
+ * @param num_additional_swms
+ * 	Number of additional WIM parts provided in the @a additional_swms array.
+ * 	This number should be one less than the total number of parts in the
+ * 	split WIM.  Set to 0 if the WIM is a standalone WIM.
  *
- * @return 0 on success; nonzero on error.  On error, @dest_wim is left in an
- * indeterminate state and should be freed with wimlib_free().
+ * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_DECOMPRESSION
  * 	Could not decompress the metadata resource for @a src_image
  * 	in @a src_wim
  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
  * 	One or more of the names being given to an exported image was already in
  * 	use in the destination WIM.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY 
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
  * 	A directory entry in the metadata resource for @a src_image in @a
  * 	src_wim is invalid.
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
@@ -516,69 +637,116 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
  * 	@a src_wim are marked as bootable; or @a dest_name and/or @a
  * 	dest_description were non-<code>NULL</code>, @a src_image was
- * 	::WIM_ALL_IMAGES, and @a src_wim contains multiple images.
+ * 	::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
+ * 	or @a dest_wim was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- *	The metadata resource for @a src_image in @a src_wim is invalid.	
- * @retval ::WIMLIB_ERR_NOMEM 
+ *	The metadata resource for @a src_image in @a src_wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for @a src_image in @a src_wim is invalid.
+ * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
  * @retval ::WIMLIB_ERR_READ
  * 	Could not read the metadata resource for @a src_image from @a src_wim.
+ * @retval ::WIMLIB_ERR_SPLIT_INVALID
+ * 	The source WIM is a split WIM, but the parts specified do not form a
+ * 	complete split WIM because they do not include all the parts of the
+ * 	original WIM, there are duplicate parts, or not all the parts have the
+ * 	same GUID and compression type.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a dest_wim is part of a split WIM.  Exporting an image to a split WIM
+ * 	is unsupported.
  */
-extern int wimlib_export_image(WIMStruct *src_wim, int src_image, 
-			       WIMStruct *dest_wim, const char *dest_name, 
-			       const char *dest_description, int flags);
+extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
+			       WIMStruct *dest_wim, const char *dest_name,
+			       const char *dest_description, int flags,
+			       WIMStruct **additional_swms,
+			       unsigned num_additional_swms);
 
 /**
- * Extracts an image, or all images, from a WIM file.
- *
- * The output directory must have been previously set with
- * wimlib_set_output_dir().
- *
- * The link type used for extracted files is that specified by a previous call
- * to wimlib_set_link_type(), or ::WIM_LINK_TYPE_NONE by default.
+ * Extracts an image, or all images, from a standalone or split WIM file.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
+ * 	split WIM.
  * @param image
  * 	The image to extract.  Can be the number of an image, or ::WIM_ALL_IMAGES
  * 	to specify that all images are to be extracted.
+ * @param output_dir
+ * 	Directory to extract the WIM image(s) to.  It is created if it does not
+ * 	already exist.
+ * @param flags
+ * 	Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
+ *
+ * 	One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
+ * 	::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified.  These flags cause
+ * 	extracted files that are identical to be hardlinked or symlinked
+ * 	together, depending on the flag.  These flags override the hard link
+ * 	groups that are specified in the WIM file itself.  If ::WIM_ALL_IMAGES
+ * 	is provided as the @a image parameter, files may be hardlinked or
+ * 	symlinked across images if a file is found to occur in more than one
+ * 	image.
+ *
+ * 	You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
+ * 	informational messages to be printed during the extraction, including
+ * 	the name of each extracted file or directory.
+ * @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
+ * 	need to be in any particular order, but they must include all parts of
+ * 	the split WIM other than the first part, which must be provided in the
+ * 	@a wim parameter.
+ * @param num_additional_swms
+ * 	Number of additional WIM parts provided in the @a additional_swms array.
+ * 	This number should be one less than the total number of parts in the
+ * 	split WIM.  Set to 0 if the WIM is a standalone WIM.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_DECOMPRESSION
  * 	Could not decompress a resource (file or metadata) for @a image in @a
  * 	wim.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY 
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
  * 	A directory entry in the metadata resource for @a image in @a wim is
  * 	invalid.
+ * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
+ * 	The SHA1 message digest of an extracted stream did not match the SHA1
+ * 	message digest given in the WIM file.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- *	A resource (file or metadata) for @a image in @a wim is invalid.	
+ *	A resource (file or metadata) for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for @a image in @a wim is invalid.
  * @retval ::WIMLIB_ERR_LINK
  * 	Failed to create a symbolic link or a hard link.
  * @retval ::WIMLIB_ERR_MKDIR
  * 	Failed create a needed directory.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
- * @retval ::WIMLIB_ERR_NOTDIR
- * 	wimlib_set_output_dir() has not been successfully called on @a wim.
  * @retval ::WIMLIB_ERR_OPEN
  * 	Could not open one of the files being extracted for writing.
  * @retval ::WIMLIB_ERR_READ
  * 	A unexpected end-of-file or read error occurred when trying to read data
  * 	from the WIM file associated with @a wim.
+ * @retval ::WIMLIB_ERR_SPLIT_INVALID
+ * 	The WIM is a split WIM, but the parts specified do not form a complete
+ * 	split WIM because they do not include all the parts of the original WIM,
+ * 	there are duplicate parts, or not all the parts have the same GUID and
+ * 	compression type.
  * @retval ::WIMLIB_ERR_WRITE
  * 	Failed to write a file being extracted.
  */
 extern int wimlib_extract_image(WIMStruct *wim, int image,
-				const char *output_dir, int flags);
+				const char *output_dir, int flags,
+				WIMStruct **additional_swms,
+				unsigned num_additional_swms);
 
 /**
  * Extracts the XML data for a WIM file to a file stream.  Every WIM file
  * includes a string of XML that describes the images contained in the WIM.
+ * This function works on standalone WIMs as well as split WIM parts.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * @param fp 
- * 	@c stdout, or a FILE* opened for writing, to extract the data to.  
+ * @param fp
+ * 	@c stdout, or a FILE* opened for writing, to extract the data to.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_WRITE
@@ -588,7 +756,7 @@ extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
 
 /**
  * Frees all memory allocated for a WIMStruct and closes all files associated
- * with it. 
+ * with it.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
@@ -602,7 +770,7 @@ extern void wimlib_free(WIMStruct *wim);
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * 
+ *
  * @return
  * 	0 if no image is marked as bootable, or the number of the image marked
  * 	as bootable (numbered starting at 1).
@@ -614,7 +782,7 @@ extern int wimlib_get_boot_idx(const WIMStruct *wim);
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file
- * 
+ *
  * @return
  * 	::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
  * 	::WIM_COMPRESSION_TYPE_XPRESS.
@@ -650,13 +818,17 @@ extern const char *wimlib_get_error_string(enum wimlib_error_code code);
  * Returns the description of the specified image.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or a split WIM part.
  * @param image
  * 	The number of the image, numbered starting at 1.
  *
  * @return
- * 	The description of the image, or @c NULL if there is no such image, or @c NULL
- * 	if the specified image has no description.
+ * 	The description of the image, or @c NULL if there is no such image, or
+ * 	@c NULL if the specified image has no description.  The description
+ * 	string is in library-internal memory and may not be modified or freed;
+ * 	in addition, the string will become invalid if the description of the
+ * 	image is changed, the image is deleted, or the ::WIMStruct is destroyed.
  */
 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
 
@@ -664,12 +836,16 @@ extern const char *wimlib_get_image_description(const WIMStruct *wim, int image)
  * Returns the name of the specified image.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or a split WIM part.
  * @param image
  * 	The number of the image, numbered starting at 1.
  *
  * @return
- * 	The name of the image, or @c NULL if there is no such image.
+ * 	The name of the image, or @c NULL if there is no such image.  The name
+ * 	string is in library-internal memory and may not be modified or freed;
+ * 	in addition, the string will become invalid if the name of the image is
+ * 	changed, the image is deleted, or the ::WIMStruct is destroyed.
  */
 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
 
@@ -678,15 +854,16 @@ extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
  * Gets the number of images contained in the WIM.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
- * 
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or a split WIM part.
+ *
  * @return
  * 	The number of images contained in the WIM file.
  */
 extern int wimlib_get_num_images(const WIMStruct *wim);
 
 /**
- * Gets the part number of the wim (in a split WIM).
+ * Gets the part number of part of a split WIM.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
@@ -694,7 +871,7 @@ extern int wimlib_get_num_images(const WIMStruct *wim);
  * 	If non-@c NULL, the total number of parts in the split WIM (1 for
  * 	non-split WIMs) is written to this location.
  *
- * @return 
+ * @return
  * 	The part number of the WIM (1 for non-split WIMs)
  */
 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
@@ -705,7 +882,7 @@ extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
  * @return
- * 	@c true if the WIM has an integrity table; false otherwise.
+ * 	@c true if the WIM has an integrity table; @c false otherwise.
  */
 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
 
@@ -719,8 +896,9 @@ extern bool wimlib_has_integrity_table(const WIMStruct *wim);
  * 	The name to check.
  *
  * @return
- * 	@c true if there is already an image in @a wim named @a name; @c
- * 	false if there is no image named @a name in @a wim.
+ * 	@c true if there is already an image in @a wim named @a name; @c false
+ * 	if there is no image named @a name in @a wim.  (If @a name is @c NULL,
+ * 	@c false is returned.)
  */
 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
 
@@ -751,9 +929,12 @@ extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
  * 	An error occurred when trying to write data to the new WIM at @a output_path.
  *
  * Note that this function merely copies the resources, so it will not check to
- * see if the resources, including the metadata resource, are valid or not.
+ * see if the resources, including the metadata resources, are valid or not.
+ *
+ * Also, after this function is called, the only function that may be called on
+ * the ::WIMStruct's in the @a swms array is wimlib_free().
  */
-extern int wimlib_join(const char **swms, int num_swms,
+extern int wimlib_join(const char **swms, unsigned num_swms,
 		       const char *output_path, int flags);
 
 /**
@@ -764,10 +945,16 @@ extern int wimlib_join(const char **swms, int num_swms,
  * If the mount is read-write, modifications to the WIM are staged in a staging
  * directory.
  *
- * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
- * intervening wimlib_unmount()s.  If there was a way to have libfuse pass a
- * pointer to user data to each FUSE callback, then this would be possible, but
- * there doesn't seem to be a way to do this currently.
+ * wimlib_mount() may be called from multiple threads without intervening calls
+ * to wimlib_unmount(), provided that different ::WIMStruct's are used.  (This
+ * was not the case for versions of this library 1.0.3 and earlier.)
+ *
+ * wimlib_mount() cannot be used on an image that was exported with
+ * wimlib_export_image() while the dentry trees for both images are still in
+ * memory.  In addition, wimlib_mount() may not be used to mount an image that
+ * has just been added with wimlib_add_image() or
+ * wimlib_add_image_from_ntfs_volume(), unless the WIM has been written and read
+ * into a new ::WIMStruct.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file to be mounted.
@@ -777,22 +964,42 @@ extern int wimlib_join(const char **swms, int num_swms,
  * @param dir
  * 	The path to an existing directory to mount the image on.
  * @param flags
- * 	Bitwise OR of the flags ::WIMLIB_MOUNT_FLAG_READWRITE or
- * 	::WIMLIB_MOUNT_FLAG_DEBUG.  If ::WIMLIB_MOUNT_FLAG_READWRITE is not
- * 	given, the WIM is mounted read-only.
+ * 	Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.  If
+ * 	::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
+ * 	read-only.  The interface to the WIM named data streams is specified by
+ * 	exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
+ * 	::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
+ * 	::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
+ * 	the XATTR interface.
+ * @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
+ * 	need to be in any particular order, but they must include all parts of
+ * 	the split WIM other than the first part, which must be provided in the
+ * 	@a wim parameter.
+ * @param num_additional_swms
+ * 	Number of additional WIM parts provided in the @a additional_swms array.
+ * 	This number should be one less than the total number of parts in the
+ * 	split WIM.  Set to 0 if the WIM is a standalone WIM.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_DECOMPRESSION
  * 	Could not decompress the metadata resource for @a image in @a wim.
  * @retval ::WIMLIB_ERR_FUSE
  * 	A non-zero status was returned by @c fuse_main().
- * @retval ::WIMLIB_ERR_INVALID_DENTRY 
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
  * 	A directory entry in the metadata resource for @a image in @a wim is
  * 	invalid.
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify an existing, single image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a image is shared among multiple ::WIMStruct's as a result of a call to
+ * 	wimlib_export_image(), or @a image has been added with
+ * 	wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- *	The metadata resource for @a image in @a wim is invalid.	
+ *	The metadata resource for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for @a image in @a wim is invalid.
  * @retval ::WIMLIB_ERR_MKDIR
  * 	::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
  * 	directory could not be created.
@@ -803,14 +1010,23 @@ extern int wimlib_join(const char **swms, int num_swms,
  * @retval ::WIMLIB_ERR_READ
  * 	An unexpected end-of-file or read error occurred when trying to read
  * 	data from the WIM file associated with @a wim.
- *
+ * @retval ::WIMLIB_ERR_SPLIT_INVALID
+ * 	The WIM is a split WIM, but the parts specified do not form a complete
+ * 	split WIM because they do not include all the parts of the original WIM,
+ * 	there are duplicate parts, or not all the parts have the same GUID and
+ * 	compression type.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	The WIM is a split WIM and a read-write mount was requested.  We only
+ * 	support mounting a split WIM read-only.
  */
-extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
+extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
+			WIMStruct **additional_swms,
+			unsigned num_additional_swms);
 
 /**
  * Opens a WIM file and creates a ::WIMStruct for it.
  *
- * @param wim_file 
+ * @param wim_file
  * 	The path to the WIM file to open.
  * @param flags
  * 	Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
@@ -823,10 +1039,9 @@ extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
  * 	If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
  * 	be shown if the integrity of the WIM is checked.
  * 	If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
- * 	WIM is part of a split WIM.  However, wimlib does not fully support
- * 	split WIMs, so not all functions will work correctly after opening a
- * 	split WIM.  For example, you cannot use wimlib_mount() or
- * 	wimlib_extract_image() on a split WIM.
+ * 	WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
+ * 	returned.  (This flag may be removed in the future, in which case no
+ * 	error will be issued when opening a split WIM.)
  *
  * @param wim_ret
  * 	On success, a pointer to an opaque ::WIMStruct for the opened WIM file
@@ -860,6 +1075,9 @@ extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
  * 	::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
  * 	wim_file contains an integrity table, but the integrity table is
  * 	invalid.
+ * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
+ * 	The lookup table for the WIM contained duplicate entries, or it
+ * 	contained an entry with a SHA1 message digest of all 0's.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocated needed memory.
  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
@@ -878,30 +1096,49 @@ extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
  * @retval ::WIMLIB_ERR_XML
  * 	The XML data for @a wim_file is invalid.
  */
-extern int wimlib_open_wim(const char *wim_file, int flags, 
+extern int wimlib_open_wim(const char *wim_file, int flags,
 			   WIMStruct **wim_ret);
 
 /**
  * Overwrites the file that the WIM was originally read from, with changes made.
  *
- * The new WIM is written to a temporary file and then renamed to the original
- * file after it is has been completely written.  The temporary file currently
- * is made in the same directory as the original WIM file.
- *
- * Note that it is not possible for this function to delete the original file
- * before having written the new file because it is very likely that file
- * resources in the new WIM file need to be retrieved from the old WIM file.
- *
- * After this function returns, @a wim must be freed using wimlib_free().  Any
- * further actions on @a wim before doing this are undefined.
+ * There are two ways that a WIM may be overwritten.  The first is to do a full
+ * rebuild: the new WIM is written to a temporary file and then renamed to the
+ * original file after it is has been completely written.  The temporary file
+ * currently is made in the same directory as the original WIM file.  A full
+ * rebuild may take a while, but can be used even if images have been modified
+ * or deleted, will produce a WIM with no holes, and has little chance of
+ * unintentional data loss because the temporary WIM is fsync()ed before being
+ * renamed to the original WIM.
+ *
+ * The second way to overwrite a WIM is by appending to the end of it.  This can
+ * be much faster than a full rebuild, but it only works if the only operations
+ * on the WIM have been to change the header or XML data, or to add new images.
+ * Writing a WIM in this mode begins with writing any new file resources *after*
+ * everything in the old WIM, even though this will leave a hole where the old
+ * lookup table, XML data, and integrity were.  This is done so that the WIM
+ * remains valid even if the operation is aborted mid-write.
+ *
+ * By default, the overwrite mode is chosen based on the past operations
+ * performed on the WIM.  Use the flag ::WIMLIB_WRITE_FLAG_REBUILD to explicitly
+ * request a full rebuild.
+ *
+ * In the temporary-file overwrite mode, no changes are made to the WIM on
+ * failure, and the temporary file is deleted (if possible).  Abnormal
+ * termination of the program will result in the temporary file being orphaned.
+ * In the direct append mode, the WIM is truncated to the original length on
+ * failure, while abnormal termination of the program will result in extra data
+ * appended to the original WIM, but it will still be a valid WIM.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file to write.  There may have
  * 	been in-memory changes made to it, which are then reflected in the
  * 	output file.
- * @param flags 
+ * @param write_flags
  * 	Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
  * 	::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
+ * @param num_threads
+ * 	Number of threads to use for compression (see wimlib_write()).
  *
  * @return 0 on success; nonzero on error.  This function may return any value
  * returned by wimlib_write() as well as the following error codes:
@@ -911,57 +1148,35 @@ extern int wimlib_open_wim(const char *wim_file, int flags,
  * @retval ::WIMLIB_ERR_RENAME
  * 	The temporary file that the WIM was written to could not be renamed to
  * 	the original filename of @a wim.
+ * @retval ::WIMLIB_ERR_REOPEN
+ * 	The WIM was overwritten successfully, but it could not be re-opened
+ * 	read-only.  Therefore, the resources in the WIM can no longer be
+ * 	accessed, so this limits the functions that can be called on @a wim
+ * 	before calling wimlib_free().
  */
-extern int wimlib_overwrite(WIMStruct *wim, int flags);
+extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
+			    unsigned num_threads);
 
 /**
- * Updates the header and XML data of the WIM file, without the need to write
- * out the entire WIM to a temporary file as in wimlib_write().
- *
- * This function must only be used if no files, directories, or images have been
- * added, removed, or changed in the WIM.  It must be used when only the boot
- * index or the name or description of image(s) has been changed.
- *
- * After this function returns, @a wim must be freed using wimlib_free().  Any
- * further actions on @a wim before doing this are undefined.
- *
- * @param wim
- * 	Pointer to the ::WIMStruct for the WIM file to overwrite.
- * @param flags 
- * 	Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
- * 	::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
- *
- * @return 0 on success; nonzero on error.
- *
- * @retval ::WIMLIB_ERR_NO_FILENAME
- * 	@a wim corresponds to a WIM created with wimlib_create_new_wim() rather
- * 	than a WIM read with wimlib_open_wim().
- * @retval ::WIMLIB_ERR_NOMEM
- * 	Failed to allocate needed memory.
- * @retval ::WIMLIB_ERR_OPEN
- * 	The WIM file associated with @a wim could not be re-opened read-write.
- * @retval ::WIMLIB_ERR_READ
- * 	::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
- * 	from the WIM file associated with @a wim could not be read to compute
- * 	the SHA1 message digests, or the old integrity table (if it existed)
- * 	could not be read.
- * @retval ::WIMLIB_ERR_WRITE
- * 	Failed to write the WIM header, the XML data, or the integrity table to
- * 	the WIM file associated with @a wim.
+ * This function is deprecated; call wimlib_overwrite() instead.
+ * (wimlib_overwrite() no longer rebuilds the full WIM unless it has to or is
+ * specified explicitly with ::WIMLIB_WRITE_FLAG_REBUILD)
  */
-extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
+extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags);
 
 /**
  * Prints information about one image, or all images, contained in a WIM.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * @param image 
+ * @param image
  * 	The image about which to print information.  Can be the number of an
  * 	image, or ::WIM_ALL_IMAGES to print information about all images in the
  * 	WIM.
- * 
- * @return This function has no return value.
+ *
+ * @return This function has no return value.  No error checking is done when
+ * printing the information.  If @a image is invalid, an error message is
+ * printed.
  */
 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
 
@@ -971,9 +1186,9 @@ extern void wimlib_print_available_images(const WIMStruct *wim, int image);
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * @param image 
+ * @param image
  * 	Which image to print files for.  Can be the number of an image, or
- * 	::WIM_ALL_IMAGES to print the files contained in all images.  
+ * 	::WIM_ALL_IMAGES to print the files contained in all images.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_DECOMPRESSION
@@ -985,13 +1200,20 @@ extern void wimlib_print_available_images(const WIMStruct *wim, int image);
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify a valid image in @a wim, and is not
  * 	::WIM_ALL_IMAGES.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
  * 	The metadata resource for one of the specified images is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for one of the specified images is invalid.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
  * @retval ::WIMLIB_ERR_READ
  * 	An unexpected read error or end-of-file occurred when reading the
  * 	metadata resource for one of the specified images.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim was not a standalone WIM and was not the first part of a split
+ * 	WIM.
  */
 extern int wimlib_print_files(WIMStruct *wim, int image);
 
@@ -999,14 +1221,15 @@ extern int wimlib_print_files(WIMStruct *wim, int image);
  * Prints detailed information from the header of a WIM file.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or part of a split WIM.
  *
  * @return This function has no return value.
  *
  */
 extern void wimlib_print_header(const WIMStruct *wim);
 
-/** 
+/**
  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
  * digests, as found in the directory entry tree in the WIM file, to file
  * resources in the WIM file.  This table includes one entry for each unique
@@ -1023,11 +1246,11 @@ extern void wimlib_print_lookup_table(WIMStruct *wim);
 /**
  * Prints the metadata of the specified image in a WIM file.  The metadata
  * consists of the security data as well as the directory entry tree, and each
- * image has its own metadata.  
+ * image has its own metadata.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * @param image 
+ * @param image
  * 	Which image to print the metadata for.  Can be the number of an image,
  * 	or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
  *
@@ -1041,13 +1264,20 @@ extern void wimlib_print_lookup_table(WIMStruct *wim);
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify a valid image in @a wim, and is not
  * 	::WIM_ALL_IMAGES.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
  * 	The metadata resource for one of the specified images is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for one of the specified images is invalid.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
  * @retval ::WIMLIB_ERR_READ
  * 	An unexpected read error or end-of-file occurred when reading the
  * 	metadata resource for one of the specified images.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim was not a standalone WIM and was not the first part of a split
+ * 	WIM.
  */
 extern int wimlib_print_metadata(WIMStruct *wim, int image);
 
@@ -1060,7 +1290,7 @@ extern int wimlib_print_metadata(WIMStruct *wim, int image);
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
  *
- * @return This function has no return value.  
+ * @return This function has no return value.
  */
 extern void wimlib_print_wim_information(const WIMStruct *wim);
 
@@ -1070,14 +1300,14 @@ extern void wimlib_print_wim_information(const WIMStruct *wim);
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for a WIM file.
- * @param image_name_or_num  
+ * @param image_name_or_num
  * 	A string specifying which image.  If it begins with a number, it is
  * 	taken to be a string specifying the image number.  Otherwise, it is
  * 	taken to be the name of an image, as specified in the XML data for the
- * 	WIM file.  It also may be the keyword "all", which will resolve to
- * 	::WIM_ALL_IMAGES.
+ * 	WIM file.  It also may be the keyword "all" or the string "*", both of
+ * 	which will resolve to ::WIM_ALL_IMAGES.
  *
- * @return 
+ * @return
  * 	If the string resolved to a single existing image, the number of that
  * 	image, counting starting at 1, is returned.  If the keyword "all" was
  * 	specified, ::WIM_ALL_IMAGES is returned.  Otherwise, ::WIM_NO_IMAGE is
@@ -1094,9 +1324,14 @@ extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
  * 	The number of the image to mark as bootable, or 0 to mark no image as
  * 	bootable.
  * @return 0 on success; nonzero on error.
- * @retval ::WIMLIB_ERR_INVALID_IMAGE 
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim was @c NULL.
+ * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a boot_idx does not specify an existing image in @a wim, and it was not
  * 	0.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim is part of a split WIM.  We do not support changing the boot
+ * 	index of a split WIM.
  */
 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
 
@@ -1104,7 +1339,9 @@ extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
  * Changes the description of an image in the WIM.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or part of a split WIM; however, you should set the same
+ * 	description on all parts of a split WIM.
  * @param image
  * 	The number of the image for which to change the description.
  * @param description
@@ -1114,28 +1351,56 @@ extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify a single existing image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim was @c NULL.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate the memory needed to duplicate the @a description
  * 	string.
  */
-extern int wimlib_set_image_descripton(WIMStruct *wim, int image, 
+extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
 				       const char *description);
 
+/**
+ * Changes what is written in the \<FLAGS\> element in the WIM XML data
+ * (something like "Core" or "Ultimate")
+ *
+ * @param wim
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or part of a split WIM; however, you should set the same
+ * 	\<FLAGS\> element on all parts of a split WIM.
+ * @param image
+ * 	The number of the image for which to change the description.
+ * @param flags
+ * 	The new \<FLAGS\> element to give the image.  It may be @c NULL, which
+ * 	indicates that the image is to be given no \<FLAGS\> element.
+ *
+ * @return 0 on success; nonzero on error.
+ * @retval ::WIMLIB_ERR_INVALID_IMAGE
+ * 	@a image does not specify a single existing image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim was @c NULL.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * 	Failed to allocate the memory needed to duplicate the @a flags string.
+ */
+extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
+
 /**
  * Changes the name of an image in the WIM.
  *
  * @param wim
- * 	Pointer to the ::WIMStruct for a WIM file.
+ * 	Pointer to the ::WIMStruct for a WIM file.  It may be either a
+ * 	standalone WIM or part of a split WIM; however, you should set the same
+ * 	name on all parts of a split WIM.
  * @param image
  * 	The number of the image for which to change the name.
  * @param name
- * 	The new name to give the image.  It must not be @c NULL.
+ * 	The new name to give the image.  It must not a nonempty string.
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
  * 	There is already an image named @a name in @a wim.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
- * 	@a name was @c NULL or the empty string.
+ * 	@a name was @c NULL or the empty string, or @a wim was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify a single existing image in @a wim.
  * @retval ::WIMLIB_ERR_NOMEM
@@ -1151,6 +1416,9 @@ extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
  * The default is to use the default @c malloc() and @c free() from the C
  * library.
  *
+ * Please note that some external functions we call still may use the standard
+ * memory allocation functions.
+ *
  * @param malloc_func
  * 	A function equivalent to @c malloc() that wimlib will use to allocate
  * 	memory.  If @c NULL, the allocator function is set back to the default
@@ -1174,8 +1442,9 @@ int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
 
 /**
  * Sets whether wimlib is to print error messages to @c stderr when a function
- * fails or not.  These error messages may provide information that cannot be
- * determined only from the error code that is returned.
+ * fails.  These error messages may provide information that cannot be
+ * determined only from the error code that is returned.  Not every error will
+ * result in an error message being printed.
  *
  * This setting is global and not per-WIM.
  *
@@ -1203,10 +1472,10 @@ extern int wimlib_set_print_errors(bool show_messages);
  * 	part.  The other parts will have the same name with 2, 3, 4, ..., etc.
  * 	appended.
  * @param part_size
- * 	The maximum size per part.  It is not guaranteed that this will really
- * 	be the maximum size per part, because some file resources in the WIM may
- * 	be larger than this size, and the WIM file format provides no way to
- * 	split up file resources among multiple WIMs.
+ * 	The maximum size per part, in bytes.  It is not guaranteed that this
+ * 	will really be the maximum size per part, because some file resources in
+ * 	the WIM may be larger than this size, and the WIM file format provides
+ * 	no way to split up file resources among multiple WIMs.
  * @param flags
  * 	Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
  * 	::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
@@ -1218,7 +1487,7 @@ extern int wimlib_set_print_errors(bool show_messages);
  * 	An error occurred when trying to write data to one of the split WIMs.
  *
  */
-extern int wimlib_split(const char *wimfile, const char *swm_name, 
+extern int wimlib_split(const char *wimfile, const char *swm_name,
 			size_t part_size, int flags);
 
 /**
@@ -1235,7 +1504,7 @@ extern int wimlib_split(const char *wimfile, const char *swm_name,
  * there should be no infinite loops or crashes in the code, so this wouldn't be
  * much of a problem.  Currently, a timeout of 600 seconds (so long because WIMs
  * can be very large) is implemented so that this function will not wait forever
- * before returning failure.  
+ * before returning failure.
  *
  * @param dir
  * 	The directory that the WIM image was mounted on.
@@ -1291,25 +1560,39 @@ extern int wimlib_unmount(const char *dir, int flags);
  * @param image
  * 	The image inside the WIM to write.  Use ::WIM_ALL_IMAGES to include all
  * 	images.
- * @param flags 
+ * @param write_flags
  * 	Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
  * 	::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.  If
  * 	::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
  * 	included in the WIM being written.  If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
  * 	is given, the progress of the calculation of the integrity table is
  * 	shown.
+ * @param num_threads
+ * 	Number of threads to use for compressing data.  Autodetected if set to
+ * 	0.  Note: if no data compression needs to be done, no threads will be
+ * 	created regardless of this parameter (e.g. if writing an uncompressed
+ * 	WIM, or exporting an image from a compressed WIM to another WIM of the
+ * 	same compression type).
  *
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_DECOMPRESSION
  * 	Failed to decompress a metadata or file resource in @a wim.
- * @retval ::WIMLIB_ERR_INVALID_DENTRY 
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
  * 	A directory entry in the metadata resource for @a image in @a wim is
  * 	invalid.
  * @retval ::WIMLIB_ERR_INVALID_IMAGE
  * 	@a image does not specify a single existing image in @a wim, and is not
  * 	::WIM_ALL_IMAGES.
+ * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
+ * 	A file that had previously been scanned for inclusion in the WIM by the
+ * 	wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
+ * 	concurrently modified, so it failed the SHA1 message digest check.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * 	@a wim or @a path was @c NULL.
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
- *	The metadata resource for @a image in @a wim is invalid.	
+ *	The metadata resource for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ *	The security data for @a image in @a wim is invalid.
  * @retval ::WIMLIB_ERR_NOMEM
  * 	Failed to allocate needed memory.
  * @retval ::WIMLIB_ERR_OPEN
@@ -1321,11 +1604,15 @@ extern int wimlib_unmount(const char *dir, int flags);
  * 	with @a wim, or some file resources in @a wim refer to files in the
  * 	outside filesystem, and a read error occurred when reading one of these
  * 	files.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * 	@a wim is part of a split WIM.  You may not call this function on a
+ * 	split WIM.
  * @retval ::WIMLIB_ERR_WRITE
  * 	An error occurred when trying to write data to the new WIM file at @a
  * 	path.
  */
-extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
+extern int wimlib_write(WIMStruct *wim, const char *path, int image,
+			int write_flags, unsigned num_threads);