X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fwimlib.h;h=076aee176fab516609ee461ed2a33b1b70477b2b;hb=16e3b6e5615abcefc9e5bb9607e2804b64d19cc2;hp=0debc5c249e03feea012b3747aab3564dd17ad30;hpb=35dd893208119869db6a90b1d1663f9aea88a3f7;p=wimlib
diff --git a/src/wimlib.h b/src/wimlib.h
index 0debc5c2..076aee17 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.
@@ -54,8 +54,10 @@
* 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
@@ -158,7 +160,7 @@
* wimlib comes with the imagex program, which is documented in man pages.
*
* \section mkwinpeimg mkwinpeimg
- *
+ *
* wimlib comes with the mkwinpeimg script, which is documented in a man
* page.
*
@@ -209,8 +211,8 @@
#include
#ifndef _WIMLIB_INTERNAL_H
-/**
- * Opaque structure that represents a WIM file.
+/**
+ * Opaque structure that represents a WIM file.
*/
typedef struct WIMStruct WIMStruct;
#endif
@@ -250,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
@@ -344,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,
@@ -385,9 +388,10 @@ enum wimlib_error_code {
* Pointer to the contents of an image capture configuration file. If @c
* NULL, a default string is used. Please see the manual page for
* imagex capture for more information.
- * @param config_size
- * Length of the string @a config in bytes.
- *
+ * @param config_len
+ * 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
@@ -402,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.
@@ -415,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.
@@ -422,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);
@@ -433,7 +440,7 @@ extern int wimlib_add_image(WIMStruct *wim, const char *dir,
* ::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 *w, const char *device,
+extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
const char *name,
const char *config,
size_t config_len,
@@ -448,15 +455,15 @@ extern int wimlib_add_image_from_ntfs_volume(WIMStruct *w, const char *device,
* 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 *w, int image,
+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.
@@ -477,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)
@@ -486,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
@@ -496,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
@@ -509,17 +522,38 @@ 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 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
@@ -539,16 +573,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
@@ -561,20 +604,27 @@ 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.
+ * @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 src_wim or @a dest_wim is part of a split WIM. Exporting an image
- * from or to a split WIM is 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 standalone or split WIM file.
@@ -612,22 +662,22 @@ extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
* @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.
+ * 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.
+ * 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
@@ -659,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
@@ -670,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.
@@ -684,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).
@@ -696,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.
@@ -738,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);
@@ -753,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);
@@ -764,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.
*/
@@ -779,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);
@@ -804,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);
@@ -850,9 +907,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.
@@ -869,21 +927,34 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
* ::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().
* @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.
@@ -894,13 +965,23 @@ extern int wimlib_join(const char **swms, unsigned 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
@@ -913,10 +994,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
@@ -971,7 +1051,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);
/**
@@ -981,10 +1061,6 @@ extern int wimlib_open_wim(const char *wim_file, int flags,
* 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.
*
@@ -992,7 +1068,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.
*
@@ -1020,7 +1096,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.
*
@@ -1038,6 +1114,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.
@@ -1049,12 +1130,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);
@@ -1064,9 +1147,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
@@ -1107,7 +1190,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
@@ -1124,11 +1207,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.
*
@@ -1168,7 +1251,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);
@@ -1178,14 +1261,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
@@ -1204,7 +1287,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
@@ -1235,22 +1318,22 @@ 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);
/**
- * Changes what is written in the element in the WIM XML data (something
- * like "Core" or "Ultimate")
+ * Changes what is written in the \ 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
- * element on all parts of a split WIM.
+ * \ 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 element to give the image. It may be @c NULL, which
- * indicates that the image is to be given no element.
+ * The new \ element to give the image. It may be @c NULL, which
+ * indicates that the image is to be given no \ element.
*
* @return 0 on success; nonzero on error.
* @retval ::WIMLIB_ERR_INVALID_IMAGE
@@ -1260,8 +1343,7 @@ extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
* @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate the memory needed to duplicate the @a flags string.
*/
-extern int wimlib_set_image_flags(WIMStruct *w, int image,
- const char *flags);
+extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
/**
* Changes the name of an image in the WIM.
@@ -1351,10 +1433,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.
@@ -1366,7 +1448,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);
/**
@@ -1383,7 +1465,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.
@@ -1439,7 +1521,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
@@ -1450,7 +1532,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
@@ -1463,9 +1545,9 @@ 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 @wim is invalid.
+ * The security data for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate needed memory.
* @retval ::WIMLIB_ERR_OPEN