* 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
* 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_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
* 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.
* ::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,
* 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);
/**
* 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)
* @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
* 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_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
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
* ::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
* 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);
+ 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.
* @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
* 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);
* 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);
* 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);
* 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.
* ::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
* 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.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
* @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.
* 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
* 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.
*
* 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
* If the string resolved to a single existing image, the number of that
const char *description);
/**
- * Changes what is written in the <FLAGS> element in the WIM XML data (something
- * like "Core" or "Ultimate")
+ * 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.
+ * \<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.
+ * 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
* @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.
* 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.
* @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
* The metadata resource for @a image in @a wim is invalid.
* @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
- * The security data for @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