X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fwimlib.h;h=34f52e7e1d67170c8a0e780a4af638c72fc8afb3;hb=f15a63ac3f4a9be0e4989363814502e85bdaf495;hp=648345a5236bdd1655af4c16897485b1bc2776da;hpb=5ab1d0645f63d09334d1b2573e36c033d078f4f2;p=wimlib

diff --git a/src/wimlib.h b/src/wimlib.h
index 648345a5..34f52e7e 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -4,7 +4,7 @@
  * External header for wimlib.
  */
 
-/* 
+/*
  * Copyright (C) 2012 Eric Biggers
  *
  * This file is part of wimlib, a library for working with WIM files.
@@ -57,7 +57,7 @@
  * 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
@@ -160,7 +160,7 @@
  * 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.
  *
@@ -211,8 +211,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
@@ -252,7 +252,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
 
@@ -346,6 +346,7 @@ enum wimlib_error_code {
 	WIMLIB_ERR_READLINK,
 	WIMLIB_ERR_READ,
 	WIMLIB_ERR_RENAME,
+	WIMLIB_ERR_RESOURCE_ORDER,
 	WIMLIB_ERR_SPECIAL_FILE,
 	WIMLIB_ERR_SPLIT_INVALID,
 	WIMLIB_ERR_SPLIT_UNSUPPORTED,
@@ -388,8 +389,9 @@ enum wimlib_error_code {
  * 	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.
- * 	
+ * 	Length of the string @a config in bytes.  Ignored if @a config is @c
+ * 	NULL.
+ *
  * @param flags
  * 	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
@@ -404,9 +406,9 @@ enum wimlib_error_code {
  * 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.
@@ -417,6 +419,9 @@ 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.
@@ -424,7 +429,7 @@ enum wimlib_error_code {
  * 	@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, 
+extern int wimlib_add_image(WIMStruct *wim, const char *dir,
 			    const char *name, const char *config,
 			    size_t config_len, int flags);
 
@@ -455,10 +460,10 @@ extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
 					     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.
@@ -479,8 +484,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)
@@ -488,8 +494,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
@@ -498,10 +508,11 @@ 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.	
+ *	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.
+ *	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
@@ -511,7 +522,28 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
 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 stand-alone WIM or part 1 of a split
@@ -552,15 +584,14 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	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, @a 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
@@ -573,10 +604,10 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	::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.	
+ *	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 
+ *	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.
@@ -589,8 +620,8 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
  * 	@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, 
+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);
@@ -637,16 +668,16 @@ extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
  * @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.	
+ *	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
@@ -678,8 +709,8 @@ extern int wimlib_extract_image(WIMStruct *wim, int image,
  *
  * @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
@@ -689,7 +720,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.
@@ -703,7 +734,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).
@@ -715,7 +746,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.
@@ -757,8 +788,11 @@ extern const char *wimlib_get_error_string(enum wimlib_error_code code);
  * 	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);
 
@@ -772,7 +806,10 @@ extern const char *wimlib_get_image_description(const WIMStruct *wim, int 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);
 
@@ -783,7 +820,7 @@ extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
  * @param wim
  * 	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.
  */
@@ -798,7 +835,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);
@@ -823,8 +860,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);
 
@@ -855,7 +893,10 @@ 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, unsigned num_swms,
 		       const char *output_path, int flags);
@@ -869,9 +910,10 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  * 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.
+ * intervening wimlib_unmount()s.
+ *
+ * wimlib_mount() cannot be used on an image that was exported with
+ * wimlib_export() while the dentry trees for both images are still in memory.
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file to be mounted.
@@ -904,15 +946,18 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  * 	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().
  * @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.	
+ *	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.
@@ -939,7 +984,7 @@ extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
 /**
  * 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
@@ -1009,7 +1054,7 @@ 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);
 
 /**
@@ -1026,7 +1071,7 @@ extern int wimlib_open_wim(const char *wim_file, int flags,
  * 	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 flags
  * 	Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
  * 	::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
  *
@@ -1054,7 +1099,7 @@ extern int wimlib_overwrite(WIMStruct *wim, int flags);
  *
  * @param wim
  * 	Pointer to the ::WIMStruct for the WIM file to overwrite.
- * @param flags 
+ * @param flags
  * 	Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
  * 	::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
  *
@@ -1072,6 +1117,11 @@ extern int wimlib_overwrite(WIMStruct *wim, int flags);
  * 	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_RESOURCE_ORDER
+ * 	Stream resources appeared in the WIM after the XML data or integrity
+ * 	table, so we could not safely overwrite the XML data and integrity
+ * 	table.  Note: this error should never be received from WIMs that were
+ * 	written by this library.
  * @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.
@@ -1083,12 +1133,14 @@ extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
  *
  * @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);
 
@@ -1098,9 +1150,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
@@ -1141,7 +1193,7 @@ extern int wimlib_print_files(WIMStruct *wim, int image);
  */
 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
@@ -1158,11 +1210,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.
  *
@@ -1202,7 +1254,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);
 
@@ -1212,14 +1264,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
@@ -1238,7 +1290,7 @@ extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  * 	@a wim was @c NULL.
- * @retval ::WIMLIB_ERR_INVALID_IMAGE 
+ * @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
@@ -1269,7 +1321,7 @@ extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
  * 	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);
 
 /**
@@ -1399,7 +1451,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);
 
 /**
@@ -1416,7 +1468,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.
@@ -1472,7 +1524,7 @@ 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 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
@@ -1483,7 +1535,7 @@ extern int wimlib_unmount(const char *dir, int flags);
  * @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
@@ -1496,7 +1548,7 @@ extern int wimlib_unmount(const char *dir, int flags);
  * @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