X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=src%2Fwimlib.h;h=05681b3a5c7b8420463174d7f1a27d24296679bb;hp=f8471f7890b5f6331f60bbff2b1267b85b2a1faf;hb=6f841e85af6215e88bce12a34a00548664fba6ea;hpb=28e195e762f05766ade7d5f04881ba1d5e04c1dd
diff --git a/src/wimlib.h b/src/wimlib.h
index f8471f78..05681b3a 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -10,16 +10,16 @@
* 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,28 +49,64 @@
* 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
- * configure && make && sudo make install, 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.
+ * configure && make && sudo make install; 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
@@ -97,10 +120,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
+ * --without-ntfs-3g 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().
@@ -121,7 +152,8 @@
* @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
*
@@ -136,25 +168,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 do not expect to be able to use wimlib to
- * image a Windows installation and preserve file attributes. 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 +190,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
@@ -356,11 +372,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
@@ -370,17 +383,22 @@ 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 <FLAGS> element for the image's XML data. This
- * parameter may be left @c NULL, in which case no <FLAGS> 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
+ * imagex capture for more information.
+ * @param config_size
+ * Length of the string @a config in bytes.
+ *
* @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.
*
* @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
@@ -402,24 +420,40 @@ enum wimlib_error_code {
* @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,
- const char *config, size_t config_len,
- int flags);
+ const char *name, const char *config,
+ size_t config_len, int flags);
+/**
+ * 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 *w, const char *device,
const char *name,
- const char *description,
- const char *flags_element,
const char *config,
size_t config_len,
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 *w, int image,
- const char *device, int flags);
+ const char *device, int flags,
+ WIMStruct **additional_swms,
+ unsigned num_additional_swms);
/**
* Creates a WIMStruct for a new WIM file.
@@ -465,9 +499,14 @@ extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
* @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_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);
@@ -475,8 +514,8 @@ extern int wimlib_delete_image(WIMStruct *wim, int image);
* Copies an image, or all the images, from a WIM file, into another WIM file.
*
* @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.
@@ -502,6 +541,16 @@ 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().
@@ -521,32 +570,68 @@ 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-NULL, @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_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);
+ 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
@@ -555,30 +640,41 @@ extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
* @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.
+ * @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.
@@ -655,7 +751,8 @@ 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.
*
@@ -669,7 +766,8 @@ 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.
*
@@ -683,7 +781,8 @@ 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.
@@ -691,7 +790,7 @@ extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
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.
@@ -710,7 +809,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);
@@ -758,7 +857,7 @@ extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
* 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.
*/
-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);
/**
@@ -782,9 +881,23 @@ 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
@@ -798,6 +911,8 @@ extern int wimlib_join(const char **swms, int num_swms,
* @a image does not specify an existing, single image in @a wim.
* @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 @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.
@@ -808,9 +923,18 @@ 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.
@@ -865,6 +989,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
@@ -990,13 +1117,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);
@@ -1004,7 +1138,8 @@ 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.
*
@@ -1046,13 +1181,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);
@@ -1099,9 +1241,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_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);
@@ -1109,7 +1256,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
@@ -1119,6 +1268,8 @@ 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.
@@ -1126,21 +1277,48 @@ extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
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")
+ *
+ * @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.
+ * @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.
+ *
+ * @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 *w, 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
@@ -1156,6 +1334,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
@@ -1179,8 +1360,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.
*
@@ -1313,8 +1495,16 @@ extern int wimlib_unmount(const char *dir, int flags);
* @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.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ * The security data for @a image in @wim is invalid.
* @retval ::WIMLIB_ERR_NOMEM
* Failed to allocate needed memory.
* @retval ::WIMLIB_ERR_OPEN
@@ -1326,6 +1516,9 @@ 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.