3 * @brief External header for wimlib.
5 * This file contains comments for generating documentation with Doxygen. The
6 * built HTML documentation can be viewed at https://wimlib.net/apidoc. Make
7 * sure to see the <a href="modules.html">Modules page</a> to make more sense of
8 * the declarations in this header.
14 * This is the documentation for the library interface of wimlib 1.10.0, a C
15 * library for creating, modifying, extracting, and mounting files in the
16 * Windows Imaging Format. This documentation is intended for developers only.
17 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
18 * program, please see the manual pages and also the <a
19 * href="https://wimlib.net/git/?p=wimlib;a=blob;f=README">README file</a>.
21 * @section sec_installing Installing
25 * Download the source code from https://wimlib.net. Install the library by
26 * running <c>configure && make && sudo make install</c>. See the README for
27 * information about configuration options. To use wimlib in your program after
28 * installing it, include wimlib.h and link your program with <c>-lwim</c>.
32 * Download the Windows binary distribution with the appropriate architecture
33 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from
34 * https://wimlib.net. Link your program with libwim-15.dll. If needed by your
35 * programming language or development environment, the import library
36 * libwim.lib and C/C++ header wimlib.h can be found in the directory "devel" in
39 * If you need to access the DLL from non-C/C++ programming languages, note that
40 * the calling convention is "cdecl".
42 * If you want to build wimlib from source on Windows, see README.WINDOWS. This
43 * is only needed if you are making modifications to wimlib.
45 * @section sec_examples Examples
47 * Several examples are located in the "examples" directory of the source
48 * distribution. Also see @ref sec_basic_wim_handling_concepts below.
50 * There is also the <a
51 * href="https://wimlib.net/git/?p=wimlib;a=blob;f=programs/imagex.c">
52 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
53 * capabilities of wimlib.
55 * @section backward_compatibility Backward Compatibility
57 * New releases of wimlib are intended to be backward compatible with old
58 * releases, except when the libtool "age" is reset. This most recently
59 * occurred for the v1.7.0 (libwim15) release (June 2014). Since the library is
60 * becoming increasingly stable, the goal is to maintain the current API/ABI for
61 * as long as possible unless there is a strong reason not to.
63 * As with any other library, applications should not rely on internal
64 * implementation details that may be subject to change.
66 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
68 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
69 * two ways to create such a structure:
71 * 1. wimlib_open_wim() opens an on-disk WIM file and creates a ::WIMStruct for
73 * 2. wimlib_create_new_wim() creates a new ::WIMStruct that initially contains
74 * no images and does not yet have a backing on-disk file.
76 * A ::WIMStruct contains zero or more independent directory trees called @a
77 * images. Images may be extracted, added, deleted, exported, and updated using
78 * various API functions. (See @ref G_extracting_wims and @ref G_modifying_wims
81 * Changes made to a WIM represented by a ::WIMStruct have no persistent effect
82 * until the WIM is actually written to an on-disk file. This can be done using
83 * wimlib_write(), but if the WIM was originally opened using wimlib_open_wim(),
84 * then wimlib_overwrite() can be used instead. (See @ref
85 * G_writing_and_overwriting_wims for more details.)
87 * wimlib's API is designed to let you combine functions to accomplish tasks in
88 * a flexible way. Here are some example sequences of function calls:
90 * Apply an image from a WIM file, similar to the command-line program
93 * 1. wimlib_open_wim()
94 * 2. wimlib_extract_image()
96 * Capture an image into a new WIM file, similar to <b>wimcapture</b>:
98 * 1. wimlib_create_new_wim()
99 * 2. wimlib_add_image()
102 * Append an image to an existing WIM file, similar to <b>wimappend</b>:
104 * 1. wimlib_open_wim()
105 * 2. wimlib_add_image()
106 * 3. wimlib_overwrite()
108 * Delete an image from an existing WIM file, similar to <b>wimdelete</b>:
110 * 1. wimlib_open_wim()
111 * 2. wimlib_delete_image()
112 * 3. wimlib_overwrite()
114 * Export an image from one WIM file to another, similar to <b>wimexport</b>:
116 * 1. wimlib_open_wim() (on source)
117 * 2. wimlib_open_wim() (on destination)
118 * 3. wimlib_export_image()
119 * 4. wimlib_overwrite() (on destination)
121 * The API also lets you do things the command-line tools don't directly allow.
122 * For example, you could make multiple changes to a WIM before efficiently
123 * committing the changes with just one call to wimlib_overwrite(). Perhaps you
124 * want to both delete an image and add a new one; or perhaps you want to
125 * customize an image with wimlib_update_image() after adding it. All these use
126 * cases are supported by the API.
128 * @section sec_cleaning_up Cleaning up
130 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
131 * all resources associated with it. Also, when you are completely done with
132 * using wimlib in your program, you can call wimlib_global_cleanup() to free
133 * any other resources allocated by the library.
135 * @section sec_error_handling Error Handling
137 * Most functions in wimlib return 0 on success and a positive
138 * ::wimlib_error_code value on failure. Use wimlib_get_error_string() to get a
139 * string that describes an error code. wimlib also can print error messages to
140 * standard error or a custom file when an error occurs, and these may be more
141 * informative than the error code; to enable this, call
142 * wimlib_set_print_errors(). Please note that this is for convenience only,
143 * and some errors can occur without a message being printed. Currently, error
144 * messages and strings (as well as all documentation, for that matter) are only
145 * available in English.
147 * @section sec_encodings Character encoding
149 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
150 * and returns strings of ::wimlib_tchar which have a platform-dependent type
153 * On Windows, each ::wimlib_tchar is a 2-byte <tt>wchar_t</tt>. The encoding
154 * is meant to be UTF-16LE. However, unpaired surrogates are permitted because
155 * neither Windows nor the NTFS filesystem forbids them in filenames.
157 * On UNIX-like systems, each ::wimlib_tchar is a 1 byte <tt>char</tt>. The
158 * encoding is meant to be UTF-8. However, for compatibility with Windows-style
159 * filenames that are not valid UTF-16LE, surrogate codepoints are permitted.
160 * Other multibyte encodings (e.g. ISO-8859-1) or garbage sequences of bytes are
163 * @section sec_advanced Additional information and features
166 * @subsection subsec_mounting_wim_images Mounting WIM images
168 * See @ref G_mounting_wim_images.
170 * @subsection subsec_progress_functions Progress Messages
172 * See @ref G_progress.
174 * @subsection subsec_non_standalone_wims Non-standalone WIMs
176 * See @ref G_nonstandalone_wims.
178 * @subsection subsec_pipable_wims Pipable WIMs
180 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
181 * compatible with Microsoft's software. To create a pipable WIM, call
182 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
183 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
184 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
185 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
186 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
187 * s using a seekable file descriptor using the regular function calls (e.g.
188 * wimlib_open_wim(), wimlib_extract_image()).
190 * See the documentation for the <b>--pipable</b> flag of <b>wimcapture</b> for
191 * more information about pipable WIMs.
193 * @subsection subsec_thread_safety Thread Safety
195 * A ::WIMStruct is not thread-safe and cannot be accessed by multiple threads
196 * concurrently, even for "read-only" operations such as extraction. However,
197 * users are free to use <i>different</i> ::WIMStruct's from different threads
198 * concurrently. It is even allowed for multiple ::WIMStruct's to be backed by
199 * the same on-disk WIM file, although "overwrites" should never be done in such
202 * In addition, several functions change global state and should only be called
203 * when a single thread is active in the library. These functions are:
205 * - wimlib_global_init()
206 * - wimlib_global_cleanup()
207 * - wimlib_set_memory_allocator()
208 * - wimlib_set_print_errors()
209 * - wimlib_set_error_file()
210 * - wimlib_set_error_file_by_name()
212 * @subsection subsec_limitations Limitations
214 * This section documents some technical limitations of wimlib not already
215 * described in the documentation for @b wimlib-imagex.
217 * - The old WIM format from Vista pre-releases is not supported.
218 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
219 * functionality other than that already present in @b ImageX, that allows you
220 * to make certain Windows-specific modifications to a Windows PE image, such
221 * as adding a driver or Windows component. Such a tool could be implemented
224 * @subsection more_info More information
226 * You are advised to read the README as well as the documentation for
227 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
228 * the API documentation.
231 /** @defgroup G_general General
233 * @brief Declarations and structures shared across the library.
236 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
238 * @brief Open an existing WIM file as a ::WIMStruct, or create a new
239 * ::WIMStruct which can be used to create a new WIM file.
242 /** @defgroup G_wim_information Retrieving WIM information and directory listings
244 * @brief Retrieve information about a WIM or WIM image.
247 /** @defgroup G_modifying_wims Modifying WIMs
249 * @brief Make changes to a ::WIMStruct, in preparation of persisting the
250 * ::WIMStruct to an on-disk file.
252 * @section sec_adding_images Capturing and adding WIM images
254 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
255 * appending an image to an existing WIM is a multi-step process, but at its
256 * core is wimlib_add_image() or an equivalent function. Normally,
257 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
258 * ::WIMStruct as a new image. However, when supported by the build of the
259 * library, there is also a special NTFS volume capture mode (entered when
260 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
261 * from an unmounted NTFS volume.
263 * Another function, wimlib_add_image_multisource() is also provided. It
264 * generalizes wimlib_add_image() to allow combining multiple files or directory
265 * trees into a single WIM image in a configurable way.
267 * For maximum customization of WIM image creation, it is also possible to add a
268 * completely empty WIM image with wimlib_add_empty_image(), then update it with
269 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
270 * wimlib_add_image_multisource() do internally.)
272 * Note that some details of how image addition/capture works are documented
273 * more fully in the documentation for <b>wimcapture</b>.
275 * @section sec_deleting_images Deleting WIM images
277 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
278 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
279 * be made persistent in an on-disk WIM file.
281 * @section sec_exporting_images Exporting WIM images
283 * wimlib_export_image() can copy, or "export", an image from one WIM to
286 * @section sec_other_modifications Other modifications
288 * wimlib_update_image() can add, delete, and rename files in a WIM image.
290 * wimlib_set_image_property() can change other image metadata.
292 * wimlib_set_wim_info() can change information about the WIM file itself, such
296 /** @defgroup G_extracting_wims Extracting WIMs
298 * @brief Extract files, directories, and images from a WIM.
300 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
301 * represented by a ::WIMStruct. This normally extracts the image to a
302 * directory, but when supported by the build of the library there is also a
303 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
304 * is specified) that allows extracting a WIM image directly to an unmounted
305 * NTFS volume. Various other flags allow further customization of image
308 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
309 * of (possibly wildcard) paths from a WIM image.
311 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
312 * over a pipe; see @ref subsec_pipable_wims.
314 * Some details of how WIM extraction works are described more fully in the
315 * documentation for <b>wimapply</b> and <b>wimextract</b>.
318 /** @defgroup G_mounting_wim_images Mounting WIM images
320 * @brief Mount and unmount WIM images.
322 * On Linux, wimlib supports mounting images from WIM files either read-only or
323 * read-write. To mount an image, call wimlib_mount_image(). To unmount an
324 * image, call wimlib_unmount_image(). Mounting can be done without root
325 * privileges because it is implemented using FUSE (Filesystem in Userspace).
327 * If wimlib is compiled using the <c>--without-fuse</c> flag, these functions
328 * will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
330 * Note: if mounting is unsupported, wimlib still provides another way to modify
331 * a WIM image (wimlib_update_image()).
335 * @defgroup G_progress Progress Messages
337 * @brief Track the progress of long WIM operations.
339 * Library users can provide a progress function which will be called
340 * periodically during operations such as extracting a WIM image or writing a
341 * WIM image. A ::WIMStruct can have a progress function of type
342 * ::wimlib_progress_func_t associated with it by calling
343 * wimlib_register_progress_function() or by opening the ::WIMStruct using
344 * wimlib_open_wim_with_progress(). Once this is done, the progress function
345 * will be called automatically during many operations, such as
346 * wimlib_extract_image() and wimlib_write().
348 * Some functions that do not operate directly on a user-provided ::WIMStruct,
349 * such as wimlib_join(), also take the progress function directly using an
350 * extended version of the function, such as wimlib_join_with_progress().
352 * Since wimlib v1.7.0, progress functions are no longer just unidirectional.
353 * You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause the current
354 * operation to be aborted. wimlib v1.7.0 also added the third argument to
355 * ::wimlib_progress_func_t, which is a user-supplied context.
358 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
360 * @brief Create or update an on-disk WIM file.
362 * wimlib_write() creates a new on-disk WIM file, whereas wimlib_overwrite()
363 * updates an existing WIM file. See @ref sec_basic_wim_handling_concepts for
364 * more information about the API design.
367 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
369 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
371 * A ::WIMStruct backed by an on-disk file normally represents a fully
372 * standalone WIM archive. However, WIM archives can also be arranged in
373 * non-standalone ways, such as a set of on-disk files that together form a
374 * single "split WIM" or "delta WIM". Such arrangements are fully supported by
375 * wimlib. However, as a result, in such cases a ::WIMStruct created from one
376 * of these on-disk files initially only partially represents the full WIM and
377 * needs to, in effect, be logically combined with other ::WIMStruct's before
378 * performing certain operations, such as extracting files with
379 * wimlib_extract_image() or wimlib_extract_paths(). This is done by calling
380 * wimlib_reference_resource_files() or wimlib_reference_resources(). Note: if
381 * you fail to do so, you may see the error code
382 * ::WIMLIB_ERR_RESOURCE_NOT_FOUND; this just indicates that data is not
383 * available because the appropriate WIM files have not yet been referenced.
385 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
386 * specialized function (wimlib_split()) is needed to create a split WIM.
395 # if defined(_MSC_VER) && _MSC_VER < 1800 /* VS pre-2013? */
396 typedef unsigned char bool;
398 # include <stdbool.h>
404 /** @addtogroup G_general
407 /** Major version of the library (for example, the 1 in 1.2.5). */
408 #define WIMLIB_MAJOR_VERSION 1
410 /** Minor version of the library (for example, the 2 in 1.2.5). */
411 #define WIMLIB_MINOR_VERSION 10
413 /** Patch version of the library (for example, the 5 in 1.2.5). */
414 #define WIMLIB_PATCH_VERSION 0
421 * To represent file timestamps, wimlib's API uses the POSIX 'struct timespec'.
422 * This was probably a mistake because it doesn't play well with Visual Studio.
423 * In old VS versions it isn't present at all; in newer VS versions it is
424 * supposedly present, but I wouldn't trust it to be the same size as the one
425 * MinGW uses. The solution is to define a compatible structure ourselves when
426 * this header is included on Windows and the compiler is not MinGW.
428 #if defined(_WIN32) && !defined(__GNUC__)
430 /* Seconds since start of UNIX epoch (January 1, 1970) */
436 /* Nanoseconds (0-999999999) */
440 # define wimlib_timespec struct timespec /* standard definition */
444 * Opaque structure that represents a WIM, possibly backed by an on-disk file.
445 * See @ref sec_basic_wim_handling_concepts for more information.
447 #ifndef WIMLIB_WIMSTRUCT_DECLARED
448 typedef struct WIMStruct WIMStruct;
449 #define WIMLIB_WIMSTRUCT_DECLARED
453 typedef wchar_t wimlib_tchar;
455 /** See @ref sec_encodings */
456 typedef char wimlib_tchar;
460 /** Path separator for WIM paths passed back to progress callbacks.
461 * This is forward slash on UNIX and backslash on Windows. */
462 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
463 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
465 /** Path separator for WIM paths passed back to progress callbacks.
466 * This is forward slash on UNIX and backslash on Windows. */
467 # define WIMLIB_WIM_PATH_SEPARATOR '/'
468 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
471 /** A string containing a single path separator; use this to specify the root
472 * directory of a WIM image. */
473 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
475 /** Use this to test if the specified path refers to the root directory of the
477 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
478 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
481 /** Length of a Globally Unique Identifier (GUID), in bytes. */
482 #define WIMLIB_GUID_LEN 16
485 * Specifies a compression type.
487 * A WIM file has a default compression type, indicated by its file header.
488 * Normally, each resource in the WIM file is compressed with this compression
489 * type. However, resources may be stored as uncompressed; for example, wimlib
490 * may do so if a resource does not compress to less than its original size. In
491 * addition, a WIM with the new version number of 3584, or "ESD file", might
492 * contain solid resources with different compression types.
494 enum wimlib_compression_type {
498 * This is a valid argument to wimlib_create_new_wim() and
499 * wimlib_set_output_compression_type(), but not to the functions in the
500 * compression API such as wimlib_create_compressor().
502 WIMLIB_COMPRESSION_TYPE_NONE = 0,
505 * The XPRESS compression format. This format combines Lempel-Ziv
506 * factorization with Huffman encoding. Compression and decompression
507 * are both fast. This format supports chunk sizes that are powers of 2
508 * between <c>2^12</c> and <c>2^16</c>, inclusively.
510 * wimlib's XPRESS compressor will, with the default settings, usually
511 * produce a better compression ratio, and work more quickly, than the
512 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
513 * Non-default compression levels are also supported. For example,
514 * level 80 will enable two-pass optimal parsing, which is significantly
515 * slower but usually improves compression by several percent over the
516 * default level of 50.
518 * If using wimlib_create_compressor() to create an XPRESS compressor
519 * directly, the @p max_block_size parameter may be any positive value
520 * up to and including <c>2^16</c>.
522 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
525 * The LZX compression format. This format combines Lempel-Ziv
526 * factorization with Huffman encoding, but with more features and
527 * complexity than XPRESS. Compression is slow to somewhat fast,
528 * depending on the settings. Decompression is fast but slower than
529 * XPRESS. This format supports chunk sizes that are powers of 2
530 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
531 * other than <c>2^15</c> are not compatible with the Microsoft
534 * wimlib's LZX compressor will, with the default settings, usually
535 * produce a better compression ratio, and work more quickly, than the
536 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
537 * Non-default compression levels are also supported. For example,
538 * level 20 will provide fast compression, almost as fast as XPRESS.
540 * If using wimlib_create_compressor() to create an LZX compressor
541 * directly, the @p max_block_size parameter may be any positive value
542 * up to and including <c>2^21</c>.
544 WIMLIB_COMPRESSION_TYPE_LZX = 2,
547 * The LZMS compression format. This format combines Lempel-Ziv
548 * factorization with adaptive Huffman encoding and range coding.
549 * Compression and decompression are both fairly slow. This format
550 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
551 * <c>2^30</c>, inclusively. This format is best used for large chunk
552 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
553 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
554 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
555 * with the Microsoft implementation.
557 * wimlib's LZMS compressor will, with the default settings, usually
558 * produce a better compression ratio, and work more quickly, than the
559 * implementation in Microsoft's WIMGAPI (as of Windows 8.1). There is
560 * limited support for non-default compression levels, but compression
561 * will be noticeably faster if you choose a level < 35.
563 * If using wimlib_create_compressor() to create an LZMS compressor
564 * directly, the @p max_block_size parameter may be any positive value
565 * up to and including <c>2^30</c>.
567 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
571 /** @addtogroup G_progress
574 /** Possible values of the first parameter to the user-supplied
575 * ::wimlib_progress_func_t progress function */
576 enum wimlib_progress_msg {
578 /** A WIM image is about to be extracted. @p info will point to
579 * ::wimlib_progress_info.extract. This message is received once per
580 * image for calls to wimlib_extract_image() and
581 * wimlib_extract_image_from_pipe(). */
582 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
584 /** One or more file or directory trees within a WIM image is about to
585 * be extracted. @p info will point to ::wimlib_progress_info.extract.
586 * This message is received only once per wimlib_extract_paths() and
587 * wimlib_extract_pathlist(), since wimlib combines all paths into a
588 * single extraction operation for optimization purposes. */
589 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
591 /** This message may be sent periodically (not for every file) while
592 * files and directories are being created, prior to file data
593 * extraction. @p info will point to ::wimlib_progress_info.extract.
594 * In particular, the @p current_file_count and @p end_file_count
595 * members may be used to track the progress of this phase of
597 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
599 /** File data is currently being extracted. @p info will point to
600 * ::wimlib_progress_info.extract. This is the main message to track
601 * the progress of an extraction operation. */
602 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
604 /** Starting to read a new part of a split pipable WIM over the pipe.
605 * @p info will point to ::wimlib_progress_info.extract. */
606 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
608 /** This message may be sent periodically (not necessarily for every
609 * file) while file and directory metadata is being extracted, following
610 * file data extraction. @p info will point to
611 * ::wimlib_progress_info.extract. The @p current_file_count and @p
612 * end_file_count members may be used to track the progress of this
613 * phase of extraction. */
614 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
616 /** The image has been successfully extracted. @p info will point to
617 * ::wimlib_progress_info.extract. This is paired with
618 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
619 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
621 /** The files or directory trees have been successfully extracted. @p
622 * info will point to ::wimlib_progress_info.extract. This is paired
623 * with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
624 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
626 /** The directory or NTFS volume is about to be scanned for metadata.
627 * @p info will point to ::wimlib_progress_info.scan. This message is
628 * received once per call to wimlib_add_image(), or once per capture
629 * source passed to wimlib_add_image_multisource(), or once per add
630 * command passed to wimlib_update_image(). */
631 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
633 /** A directory or file has been scanned. @p info will point to
634 * ::wimlib_progress_info.scan, and its @p cur_path member will be
635 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
637 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
639 /** The directory or NTFS volume has been successfully scanned. @p info
640 * will point to ::wimlib_progress_info.scan. This is paired with a
641 * previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message, possibly with many
642 * intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY messages. */
643 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
645 /** File data is currently being written to the WIM. @p info will point
646 * to ::wimlib_progress_info.write_streams. This message may be
647 * received many times while the WIM file is being written or appended
648 * to with wimlib_write(), wimlib_overwrite(), or wimlib_write_to_fd().
650 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
652 /** Per-image metadata is about to be written to the WIM file. @p info
653 * will not be valid. */
654 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
656 /** The per-image metadata has been written to the WIM file. @p info
657 * will not be valid. This message is paired with a preceding
658 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message. */
659 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
661 /** wimlib_overwrite() has successfully renamed the temporary file to
662 * the original WIM file, thereby committing the changes to the WIM
663 * file. @p info will point to ::wimlib_progress_info.rename. Note:
664 * this message is not received if wimlib_overwrite() chose to append to
665 * the WIM file in-place. */
666 WIMLIB_PROGRESS_MSG_RENAME = 15,
668 /** The contents of the WIM file are being checked against the integrity
669 * table. @p info will point to ::wimlib_progress_info.integrity. This
670 * message is only received (and may be received many times) when
671 * wimlib_open_wim_with_progress() is called with the
672 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
673 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
675 /** An integrity table is being calculated for the WIM being written.
676 * @p info will point to ::wimlib_progress_info.integrity. This message
677 * is only received (and may be received many times) when a WIM file is
678 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
679 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
681 /** A wimlib_split() operation is in progress, and a new split part is
682 * about to be started. @p info will point to
683 * ::wimlib_progress_info.split. */
684 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
686 /** A wimlib_split() operation is in progress, and a split part has been
687 * finished. @p info will point to ::wimlib_progress_info.split. */
688 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
690 /** A WIM update command is about to be executed. @p info will point to
691 * ::wimlib_progress_info.update. This message is received once per
692 * update command when wimlib_update_image() is called with the flag
693 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
694 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
696 /** A WIM update command has been executed. @p info will point to
697 * ::wimlib_progress_info.update. This message is received once per
698 * update command when wimlib_update_image() is called with the flag
699 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
700 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
702 /** A file in the image is being replaced as a result of a
703 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
704 * @p info will point to ::wimlib_progress_info.replace. This is only
705 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
707 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
709 /** An image is being extracted with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
710 * a file is being extracted normally (not as a "WIMBoot pointer file")
711 * due to it matching a pattern in the <c>[PrepopulateList]</c> section
712 * of the configuration file
713 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image. @p
714 * info will point to ::wimlib_progress_info.wimboot_exclude. */
715 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
717 /** Starting to unmount an image. @p info will point to
718 * ::wimlib_progress_info.unmount. */
719 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
721 /** wimlib has used a file's data for the last time (including all data
722 * streams, if it has multiple). @p info will point to
723 * ::wimlib_progress_info.done_with_file. This message is only received
724 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
725 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
727 /** wimlib_verify_wim() is starting to verify the metadata for an image.
728 * @p info will point to ::wimlib_progress_info.verify_image. */
729 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
731 /** wimlib_verify_wim() has finished verifying the metadata for an
732 * image. @p info will point to ::wimlib_progress_info.verify_image.
734 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
736 /** wimlib_verify_wim() is verifying file data integrity. @p info will
737 * point to ::wimlib_progress_info.verify_streams. */
738 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
741 * The progress function is being asked whether a file should be
742 * excluded from capture or not. @p info will point to
743 * ::wimlib_progress_info.test_file_exclusion. This is a bidirectional
744 * message that allows the progress function to set a flag if the file
745 * should be excluded.
747 * This message is only received if the flag
748 * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used. This method for file
749 * exclusions is independent of the "capture configuration file"
752 WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
755 * An error has occurred and the progress function is being asked
756 * whether to ignore the error or not. @p info will point to
757 * ::wimlib_progress_info.handle_error. This is a bidirectional
760 * This message provides a limited capability for applications to
761 * recover from "unexpected" errors (i.e. those with no in-library
762 * handling policy) arising from the underlying operating system.
763 * Normally, any such error will cause the library to abort the current
764 * operation. By implementing a handler for this message, the
765 * application can instead choose to ignore a given error.
767 * Currently, only the following types of errors will result in this
768 * progress message being sent:
770 * - Directory tree scan errors, e.g. from wimlib_add_image()
771 * - Most extraction errors; currently restricted to the Windows
772 * build of the library only.
774 WIMLIB_PROGRESS_MSG_HANDLE_ERROR = 31,
777 /** Valid return values from user-provided progress functions
778 * (::wimlib_progress_func_t).
780 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
783 enum wimlib_progress_status {
785 /** The operation should be continued. This is the normal return value.
787 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
789 /** The operation should be aborted. This will cause the current
790 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
791 WIMLIB_PROGRESS_STATUS_ABORT = 1,
795 * A pointer to this union is passed to the user-supplied
796 * ::wimlib_progress_func_t progress function. One (or none) of the structures
797 * contained in this union will be applicable for the operation
798 * (::wimlib_progress_msg) indicated in the first argument to the progress
800 union wimlib_progress_info {
802 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
803 * the primary message for tracking the progress of writing a WIM file.
805 struct wimlib_progress_info_write_streams {
807 /** An upper bound on the number of bytes of file data that will
808 * be written. This number is the uncompressed size; the actual
809 * size may be lower due to compression. In addition, this
810 * number may decrease over time as duplicated file data is
812 uint64_t total_bytes;
814 /** An upper bound on the number of distinct file data "blobs"
815 * that will be written. This will often be similar to the
816 * "number of files", but for several reasons (hard links, named
817 * data streams, empty files, etc.) it can be different. In
818 * addition, this number may decrease over time as duplicated
819 * file data is discovered. */
820 uint64_t total_streams;
822 /** The number of bytes of file data that have been written so
823 * far. This starts at 0 and ends at @p total_bytes. This
824 * number is the uncompressed size; the actual size may be lower
825 * due to compression. */
826 uint64_t completed_bytes;
828 /** The number of distinct file data "blobs" that have been
829 * written so far. This starts at 0 and ends at @p
831 uint64_t completed_streams;
833 /** The number of threads being used for data compression; or,
834 * if no compression is being performed, this will be 1. */
835 uint32_t num_threads;
837 /** The compression type being used, as one of the
838 * ::wimlib_compression_type constants. */
839 int32_t compression_type;
841 /** The number of on-disk WIM files from which file data is
842 * being exported into the output WIM file. This can be 0, 1,
843 * or more than 1, depending on the situation. */
844 uint32_t total_parts;
846 /** This is currently broken and will always be 0. */
847 uint32_t completed_parts;
850 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
851 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
852 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
853 struct wimlib_progress_info_scan {
855 /** Top-level directory being scanned; or, when capturing an NTFS
856 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
857 * to the file or block device that contains the NTFS volume
859 const wimlib_tchar *source;
861 /** Path to the file (or directory) that has been scanned, valid
862 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
863 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
864 * relative to the root of the NTFS volume. */
865 const wimlib_tchar *cur_path;
867 /** Dentry scan status, valid on
868 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
870 /** File looks okay and will be captured. */
871 WIMLIB_SCAN_DENTRY_OK = 0,
873 /** File is being excluded from capture due to the
874 * capture configuration. */
875 WIMLIB_SCAN_DENTRY_EXCLUDED = 1,
877 /** File is being excluded from capture due to being of
878 * an unsupported type. */
879 WIMLIB_SCAN_DENTRY_UNSUPPORTED = 2,
881 /** The file is an absolute symbolic link or junction
882 * that points into the capture directory, and
883 * reparse-point fixups are enabled, so its target is
884 * being adjusted. (Reparse point fixups can be
885 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
887 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK = 3,
889 /** Reparse-point fixups are enabled, but the file is an
890 * absolute symbolic link or junction that does
891 * <b>not</b> point into the capture directory, so its
892 * target is <b>not</b> being adjusted. */
893 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK = 4,
897 /** Target path in the image. Only valid on messages
898 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
899 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
900 const wimlib_tchar *wim_target_path;
902 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
903 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
904 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
905 * target of the absolute symbolic link or junction. */
906 const wimlib_tchar *symlink_target;
909 /** The number of directories scanned so far, not counting
910 * excluded/unsupported files. */
911 uint64_t num_dirs_scanned;
913 /** The number of non-directories scanned so far, not counting
914 * excluded/unsupported files. */
915 uint64_t num_nondirs_scanned;
917 /** The number of bytes of file data detected so far, not
918 * counting excluded/unsupported files. */
919 uint64_t num_bytes_scanned;
922 /** Valid on messages
923 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
924 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
925 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
926 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
927 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
928 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
929 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
930 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
932 * Note: most of the time of an extraction operation will be spent
933 * extracting file data, and the application will receive
934 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
935 * completed_bytes and @p total_bytes, the application can calculate a
936 * percentage complete. However, there is no way for applications to
937 * know which file is currently being extracted. This is by design
938 * because the best way to complete the extraction operation is not
939 * necessarily file-by-file.
941 struct wimlib_progress_info_extract {
943 /** The 1-based index of the image from which files are being
947 /** Extraction flags being used. */
948 uint32_t extract_flags;
950 /** If the ::WIMStruct from which the extraction being performed
951 * has a backing file, then this is an absolute path to that
952 * backing file. Otherwise, this is @c NULL. */
953 const wimlib_tchar *wimfile_name;
955 /** Name of the image from which files are being extracted, or
956 * the empty string if the image is unnamed. */
957 const wimlib_tchar *image_name;
959 /** Path to the directory or NTFS volume to which the files are
960 * being extracted. */
961 const wimlib_tchar *target;
964 const wimlib_tchar *reserved;
966 /** The number of bytes of file data that will be extracted. */
967 uint64_t total_bytes;
969 /** The number of bytes of file data that have been extracted so
970 * far. This starts at 0 and ends at @p total_bytes. */
971 uint64_t completed_bytes;
973 /** The number of file streams that will be extracted. This
974 * will often be similar to the "number of files", but for
975 * several reasons (hard links, named data streams, empty files,
976 * etc.) it can be different. */
977 uint64_t total_streams;
979 /** The number of file streams that have been extracted so far.
980 * This starts at 0 and ends at @p total_streams. */
981 uint64_t completed_streams;
983 /** Currently only used for
984 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
985 uint32_t part_number;
987 /** Currently only used for
988 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
989 uint32_t total_parts;
991 /** Currently only used for
992 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
993 uint8_t guid[WIMLIB_GUID_LEN];
995 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
996 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
997 * number of files that have been processed so far. Once the
998 * corresponding phase of extraction is complete, this value
999 * will be equal to @c end_file_count. */
1000 uint64_t current_file_count;
1002 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1003 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
1004 * total number of files that will be processed.
1006 * This number is provided for informational purposes only, e.g.
1007 * for a progress bar. This number will not necessarily be
1008 * equal to the number of files actually being extracted. This
1009 * is because extraction backends are free to implement an
1010 * extraction algorithm that might be more efficient than
1011 * processing every file in the "extract file structure" and
1012 * "extract file metadata" phases. */
1013 uint64_t end_file_count;
1016 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
1017 struct wimlib_progress_info_rename {
1018 /** Name of the temporary file that the WIM was written to. */
1019 const wimlib_tchar *from;
1021 /** Name of the original WIM file to which the temporary file is
1023 const wimlib_tchar *to;
1026 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1027 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
1028 struct wimlib_progress_info_update {
1029 /** Pointer to the update command that will be executed or has
1030 * just been executed. */
1031 const struct wimlib_update_command *command;
1033 /** Number of update commands that have been completed so far.
1035 size_t completed_commands;
1037 /** Number of update commands that are being executed as part of
1038 * this call to wimlib_update_image(). */
1039 size_t total_commands;
1042 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
1043 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
1044 struct wimlib_progress_info_integrity {
1046 /** The number of bytes in the WIM file that are covered by
1047 * integrity checks. */
1048 uint64_t total_bytes;
1050 /** The number of bytes that have been checksummed so far. This
1051 * starts at 0 and ends at @p total_bytes. */
1052 uint64_t completed_bytes;
1054 /** The number of individually checksummed "chunks" the
1055 * integrity-checked region is divided into. */
1056 uint32_t total_chunks;
1058 /** The number of chunks that have been checksummed so far.
1059 * This starts at 0 and ends at @p total_chunks. */
1060 uint32_t completed_chunks;
1062 /** The size of each individually checksummed "chunk" in the
1063 * integrity-checked region. */
1064 uint32_t chunk_size;
1066 /** For ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages, this is
1067 * the path to the WIM file being checked. */
1068 const wimlib_tchar *filename;
1071 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1072 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1073 struct wimlib_progress_info_split {
1074 /** Total size of the original WIM's file and metadata resources
1076 uint64_t total_bytes;
1078 /** Number of bytes of file and metadata resources that have
1079 * been copied out of the original WIM so far. Will be 0
1080 * initially, and equal to @p total_bytes at the end. */
1081 uint64_t completed_bytes;
1083 /** Number of the split WIM part that is about to be started
1084 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1085 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1086 unsigned cur_part_number;
1088 /** Total number of split WIM parts that are being written. */
1089 unsigned total_parts;
1091 /** Name of the split WIM part that is about to be started
1092 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1093 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). Since
1094 * wimlib v1.7.0, the library user may change this when
1095 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1096 * cause the next split WIM part to be written to a different
1098 wimlib_tchar *part_name;
1101 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1102 struct wimlib_progress_info_replace {
1103 /** Path to the file in the image that is being replaced */
1104 const wimlib_tchar *path_in_wim;
1107 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1108 struct wimlib_progress_info_wimboot_exclude {
1109 /** Path to the file in the image */
1110 const wimlib_tchar *path_in_wim;
1112 /** Path to which the file is being extracted */
1113 const wimlib_tchar *extraction_path;
1116 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1117 struct wimlib_progress_info_unmount {
1118 /** Path to directory being unmounted */
1119 const wimlib_tchar *mountpoint;
1121 /** Path to WIM file being unmounted */
1122 const wimlib_tchar *mounted_wim;
1124 /** 1-based index of image being unmounted. */
1125 uint32_t mounted_image;
1127 /** Flags that were passed to wimlib_mount_image() when the
1128 * mountpoint was set up. */
1129 uint32_t mount_flags;
1131 /** Flags passed to wimlib_unmount_image(). */
1132 uint32_t unmount_flags;
1135 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1136 struct wimlib_progress_info_done_with_file {
1138 * Path to the file whose data has been written to the WIM file,
1139 * or is currently being asynchronously compressed in memory,
1140 * and therefore is no longer needed by wimlib.
1142 * WARNING: The file data will not actually be accessible in the
1143 * WIM file until the WIM file has been completely written.
1144 * Ordinarily you should <b>not</b> treat this message as a
1145 * green light to go ahead and delete the specified file, since
1146 * that would result in data loss if the WIM file cannot be
1147 * successfully created for any reason.
1149 * If a file has multiple names (hard links),
1150 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1151 * for one name. Also, this message will not be received for
1152 * empty files or reparse points (or symbolic links), unless
1153 * they have nonempty named data streams.
1155 const wimlib_tchar *path_to_file;
1158 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1159 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1160 struct wimlib_progress_info_verify_image {
1161 const wimlib_tchar *wimfile;
1162 uint32_t total_images;
1163 uint32_t current_image;
1166 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1167 struct wimlib_progress_info_verify_streams {
1168 const wimlib_tchar *wimfile;
1169 uint64_t total_streams;
1170 uint64_t total_bytes;
1171 uint64_t completed_streams;
1172 uint64_t completed_bytes;
1175 /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION. */
1176 struct wimlib_progress_info_test_file_exclusion {
1179 * Path to the file for which exclusion is being tested.
1181 * UNIX capture mode: The path will be a standard relative or
1182 * absolute UNIX filesystem path.
1184 * NTFS-3G capture mode: The path will be given relative to the
1185 * root of the NTFS volume, with a leading slash.
1187 * Windows capture mode: The path will be a Win32 namespace
1190 const wimlib_tchar *path;
1193 * Indicates whether the file or directory will be excluded from
1194 * capture or not. This will be <c>false</c> by default. The
1195 * progress function can set this to <c>true</c> if it decides
1196 * that the file needs to be excluded.
1199 } test_file_exclusion;
1201 /** Valid on messages ::WIMLIB_PROGRESS_MSG_HANDLE_ERROR. */
1202 struct wimlib_progress_info_handle_error {
1204 /** Path to the file for which the error occurred, or NULL if
1206 const wimlib_tchar *path;
1208 /** The wimlib error code associated with the error. */
1212 * Indicates whether the error will be ignored or not. This
1213 * will be <c>false</c> by default; the progress function may
1214 * set it to <c>true</c>.
1221 * A user-supplied function that will be called periodically during certain WIM
1224 * The first argument will be the type of operation that is being performed or
1225 * is about to be started or has been completed.
1227 * The second argument will be a pointer to one of a number of structures
1228 * depending on the first argument. It may be @c NULL for some message types.
1229 * Note that although this argument is not @c const, users should not modify it
1230 * except in explicitly documented cases.
1232 * The third argument will be a user-supplied value that was provided when
1233 * registering or specifying the progress function.
1235 * This function must return one of the ::wimlib_progress_status values. By
1236 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1238 typedef enum wimlib_progress_status
1239 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1240 union wimlib_progress_info *info,
1244 /** @addtogroup G_modifying_wims
1247 /** An array of these structures is passed to wimlib_add_image_multisource() to
1248 * specify the sources from which to create a WIM image. */
1249 struct wimlib_capture_source {
1250 /** Absolute or relative path to a file or directory on the external
1251 * filesystem to be included in the image. */
1252 wimlib_tchar *fs_source_path;
1254 /** Destination path in the image. To specify the root directory of the
1255 * image, use ::WIMLIB_WIM_ROOT_PATH. */
1256 wimlib_tchar *wim_target_path;
1258 /** Reserved; set to 0. */
1262 /** Set or unset the "readonly" WIM header flag (<c>WIM_HDR_FLAG_READONLY</c> in
1263 * Microsoft's documentation), based on the ::wimlib_wim_info.is_marked_readonly
1264 * member of the @p info parameter. This is distinct from basic file
1265 * permissions; this flag can be set on a WIM file that is physically writable.
1267 * wimlib disallows modifying on-disk WIM files with the readonly flag set.
1268 * However, wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG
1269 * will override this --- and in fact, this is necessary to set the readonly
1270 * flag persistently on an existing WIM file.
1272 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1274 /** Set the GUID (globally unique identifier) of the WIM file to the value
1275 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1276 #define WIMLIB_CHANGE_GUID 0x00000002
1278 /** Change the bootable image of the WIM to the value specified in
1279 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1280 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1282 /** Change the <c>WIM_HDR_FLAG_RP_FIX</c> flag of the WIM file to the value
1283 * specified in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag
1284 * generally indicates whether an image in the WIM has been captured with
1285 * reparse-point fixups enabled. wimlib also treats this flag as specifying
1286 * whether to do reparse-point fixups by default when capturing or applying WIM
1288 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1292 /** @addtogroup G_wim_information */
1297 * General information about a WIM file.
1299 * This info can also be requested for a ::WIMStruct that does not have a
1300 * backing file. In this case, fields that only make sense given a backing file
1301 * are set to default values.
1303 struct wimlib_wim_info {
1305 /** The globally unique identifier for this WIM. (Note: all parts of a
1306 * split WIM normally have identical GUIDs.) */
1307 uint8_t guid[WIMLIB_GUID_LEN];
1309 /** The number of images in this WIM file. */
1310 uint32_t image_count;
1312 /** The 1-based index of the bootable image in this WIM file, or 0 if no
1313 * image is bootable. */
1314 uint32_t boot_index;
1316 /** The version of the WIM file format used in this WIM file. */
1317 uint32_t wim_version;
1319 /** The default compression chunk size of resources in this WIM file.
1321 uint32_t chunk_size;
1323 /** For split WIMs, the 1-based index of this part within the split WIM;
1325 uint16_t part_number;
1327 /** For split WIMs, the total number of parts in the split WIM;
1329 uint16_t total_parts;
1331 /** The default compression type of resources in this WIM file, as one
1332 * of the ::wimlib_compression_type constants. */
1333 int32_t compression_type;
1335 /** The size of this WIM file in bytes, excluding the XML data and
1336 * integrity table. */
1337 uint64_t total_bytes;
1339 /** 1 iff this WIM file has an integrity table. */
1340 uint32_t has_integrity_table : 1;
1342 /** 1 iff this info struct is for a ::WIMStruct that has a backing file.
1344 uint32_t opened_from_file : 1;
1346 /** 1 iff this WIM file is considered readonly for any reason (e.g. the
1347 * "readonly" header flag is set, or this is part of a split WIM, or
1348 * filesystem permissions deny writing) */
1349 uint32_t is_readonly : 1;
1351 /** 1 iff the "reparse point fix" flag is set in this WIM's header */
1352 uint32_t has_rpfix : 1;
1354 /** 1 iff the "readonly" flag is set in this WIM's header */
1355 uint32_t is_marked_readonly : 1;
1357 /** 1 iff the "spanned" flag is set in this WIM's header */
1358 uint32_t spanned : 1;
1360 /** 1 iff the "write in progress" flag is set in this WIM's header */
1361 uint32_t write_in_progress : 1;
1363 /** 1 iff the "metadata only" flag is set in this WIM's header */
1364 uint32_t metadata_only : 1;
1366 /** 1 iff the "resource only" flag is set in this WIM's header */
1367 uint32_t resource_only : 1;
1369 /** 1 iff this WIM file is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1370 uint32_t pipable : 1;
1371 uint32_t reserved_flags : 22;
1372 uint32_t reserved[9];
1376 * Information about a "blob", which is a fixed length sequence of binary data.
1377 * Each nonempty stream of each file in a WIM image is associated with a blob.
1378 * Blobs are deduplicated within a WIM file.
1380 * TODO: this struct needs to be renamed, and perhaps made into a union since
1381 * there are several cases. I'll try to list them below:
1383 * 1. The blob is "missing", meaning that it is referenced by hash but not
1384 * actually present in the WIM file. In this case we only know the
1385 * sha1_hash. This case can only occur with wimlib_iterate_dir_tree(), never
1386 * wimlib_iterate_lookup_table().
1388 * 2. Otherwise we know the sha1_hash, the uncompressed_size, the
1389 * reference_count, and the is_metadata flag. In addition:
1391 * A. If the blob is located in a non-solid WIM resource, then we also know
1392 * the compressed_size and offset.
1394 * B. If the blob is located in a solid WIM resource, then we also know the
1395 * offset, raw_resource_offset_in_wim, raw_resource_compressed_size, and
1396 * raw_resource_uncompressed_size. But the "offset" is actually the
1397 * offset in the uncompressed solid resource rather than the offset from
1398 * the beginning of the WIM file.
1400 * C. If the blob is *not* located in any type of WIM resource, then we don't
1401 * know any additional information.
1403 * Unknown or irrelevant fields are left zeroed.
1405 struct wimlib_resource_entry {
1407 /** If this blob is not missing, then this is the uncompressed size of
1408 * this blob in bytes. */
1409 uint64_t uncompressed_size;
1411 /** If this blob is located in a non-solid WIM resource, then this is
1412 * the compressed size of that resource. */
1413 uint64_t compressed_size;
1415 /** If this blob is located in a non-solid WIM resource, then this is
1416 * the offset of that resource within the WIM file containing it. If
1417 * this blob is located in a solid WIM resource, then this is the offset
1418 * of this blob within that solid resource when uncompressed. */
1421 /** The SHA-1 message digest of the blob's uncompressed contents. */
1422 uint8_t sha1_hash[20];
1424 /** If this blob is located in a WIM resource, then this is the part
1425 * number of the WIM file containing it. */
1426 uint32_t part_number;
1428 /** If this blob is not missing, then this is the number of times this
1429 * blob is referenced over all images in the WIM. This number is not
1430 * guaranteed to be correct. */
1431 uint32_t reference_count;
1433 /** 1 iff this blob is located in a non-solid compressed WIM resource.
1435 uint32_t is_compressed : 1;
1437 /** 1 iff this blob contains the metadata for an image. */
1438 uint32_t is_metadata : 1;
1440 uint32_t is_free : 1;
1441 uint32_t is_spanned : 1;
1443 /** 1 iff a blob with this hash was not found in the blob lookup table
1444 * of the ::WIMStruct. This normally implies a missing call to
1445 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1446 uint32_t is_missing : 1;
1448 /** 1 iff this blob is located in a solid resource. */
1449 uint32_t packed : 1;
1451 uint32_t reserved_flags : 26;
1453 /** If this blob is located in a solid WIM resource, then this is the
1454 * offset of that solid resource within the WIM file containing it. */
1455 uint64_t raw_resource_offset_in_wim;
1457 /** If this blob is located in a solid WIM resource, then this is the
1458 * compressed size of that solid resource. */
1459 uint64_t raw_resource_compressed_size;
1461 /** If this blob is located in a solid WIM resource, then this is the
1462 * uncompressed size of that solid resource. */
1463 uint64_t raw_resource_uncompressed_size;
1465 uint64_t reserved[1];
1469 * Information about a stream of a particular file in the WIM.
1471 * Normally, only WIM images captured from NTFS filesystems will have multiple
1472 * streams per file. In practice, this is a rarely used feature of the
1475 * TODO: the library now explicitly tracks stream types, which allows it to have
1476 * multiple unnamed streams (e.g. both a reparse point stream and unnamed data
1477 * stream). However, this isn't yet exposed by wimlib_iterate_dir_tree().
1479 struct wimlib_stream_entry {
1481 /** Name of the stream, or NULL if the stream is unnamed. */
1482 const wimlib_tchar *stream_name;
1484 /** Info about this stream's data, such as its hash and size if known.*/
1485 struct wimlib_resource_entry resource;
1487 uint64_t reserved[4];
1491 * Since wimlib v1.9.1: an object ID, which is an extra piece of metadata that
1492 * may be associated with a file on NTFS filesystems. See:
1493 * https://msdn.microsoft.com/en-us/library/windows/desktop/aa363997(v=vs.85).aspx
1495 struct wimlib_object_id {
1496 uint8_t object_id[WIMLIB_GUID_LEN];
1497 uint8_t birth_volume_id[WIMLIB_GUID_LEN];
1498 uint8_t birth_object_id[WIMLIB_GUID_LEN];
1499 uint8_t domain_id[WIMLIB_GUID_LEN];
1502 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1503 * Roughly, the information about a "file" in the WIM image --- but really a
1504 * directory entry ("dentry") because hard links are allowed. The
1505 * hard_link_group_id field can be used to distinguish actual file inodes. */
1506 struct wimlib_dir_entry {
1507 /** Name of the file, or NULL if this file is unnamed. Only the root
1508 * directory of an image will be unnamed. */
1509 const wimlib_tchar *filename;
1511 /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1512 * this file has no such name. */
1513 const wimlib_tchar *dos_name;
1515 /** Full path to this file within the image. Path separators will be
1516 * ::WIMLIB_WIM_PATH_SEPARATOR. */
1517 const wimlib_tchar *full_path;
1519 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1520 * children, ..., etc. */
1523 /** Pointer to the security descriptor for this file, in Windows
1524 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1525 * security descriptor. */
1526 const char *security_descriptor;
1528 /** Size of the above security descriptor, in bytes. */
1529 size_t security_descriptor_size;
1531 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1532 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1533 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1534 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1535 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1536 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1537 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1538 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1539 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1540 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1541 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1542 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1543 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1544 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1545 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1546 /** File attributes, such as whether the file is a directory or not.
1547 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1548 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1549 * on other platforms. */
1550 uint32_t attributes;
1552 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1553 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1554 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1555 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1556 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1557 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1558 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1559 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1560 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1561 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1562 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1563 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1564 /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1565 * the attributes), this will give the reparse tag. This tells you
1566 * whether the reparse point is a symbolic link, junction point, or some
1567 * other, more unusual kind of reparse point. */
1568 uint32_t reparse_tag;
1570 /** Number of links to this file's inode (hard links).
1572 * Currently, this will always be 1 for directories. However, it can be
1573 * greater than 1 for nondirectory files. */
1576 /** Number of named data streams this file has. Normally 0. */
1577 uint32_t num_named_streams;
1579 /** A unique identifier for this file's inode. However, as a special
1580 * case, if the inode only has a single link (@p num_links == 1), this
1583 * Note: if a WIM image is captured from a filesystem, this value is not
1584 * guaranteed to be the same as the original number of the inode on the
1586 uint64_t hard_link_group_id;
1588 /** Time this file was created. */
1589 wimlib_timespec creation_time;
1591 /** Time this file was last written to. */
1592 wimlib_timespec last_write_time;
1594 /** Time this file was last accessed. */
1595 wimlib_timespec last_access_time;
1597 /** The UNIX user ID of this file. This is a wimlib extension.
1599 * This field is only valid if @p unix_mode != 0. */
1602 /** The UNIX group ID of this file. This is a wimlib extension.
1604 * This field is only valid if @p unix_mode != 0. */
1607 /** The UNIX mode of this file. This is a wimlib extension.
1609 * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1610 * @p unix_rdev are all unknown (fields are not present in the WIM
1614 /** The UNIX device ID (major and minor number) of this file. This is a
1617 * This field is only valid if @p unix_mode != 0. */
1620 /* The object ID of this file, if any. Only valid if
1621 * object_id.object_id is not all zeroes. */
1622 struct wimlib_object_id object_id;
1624 uint64_t reserved[6];
1627 * Variable-length array of streams that make up this file.
1629 * The first entry will always exist and will correspond to the unnamed
1630 * data stream (default file contents), so it will have <c>stream_name
1631 * == NULL</c>. Alternatively, for reparse point files, the first entry
1632 * will correspond to the reparse data stream. Alternatively, for
1633 * encrypted files, the first entry will correspond to the encrypted
1636 * Then, following the first entry, there be @p num_named_streams
1637 * additional entries that specify the named data streams, if any, each
1638 * of which will have <c>stream_name != NULL</c>.
1640 struct wimlib_stream_entry streams[];
1644 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1647 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1651 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1654 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1657 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1658 * just on the specified path. */
1659 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1661 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1662 * itself; only its children (in the case of a non-empty directory) */
1663 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1665 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any file data blobs needed to fill
1666 * in the ::wimlib_resource_entry's for the iteration cannot be found in the
1667 * blob lookup table of the ::WIMStruct. The default behavior without this flag
1668 * is to fill in the @ref wimlib_resource_entry::sha1_hash "sha1_hash" and set
1669 * the @ref wimlib_resource_entry::is_missing "is_missing" flag. */
1670 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1674 /** @addtogroup G_modifying_wims
1677 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1678 * generic directory. This requires that wimlib was compiled with support for
1681 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1682 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1684 * Do not use this flag on Windows, where wimlib already supports all
1685 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1686 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1688 /** Follow symbolic links when scanning the directory tree. Currently only
1689 * supported on UNIX-like systems. */
1690 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1692 /** Call the progress function with the message
1693 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1695 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1697 /** Mark the image being added as the bootable image of the WIM. This flag is
1698 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1700 * Note that you can also change the bootable image of a WIM using
1701 * wimlib_set_wim_info().
1703 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1704 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1705 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1707 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1708 * (major and minor number) of each file. In addition, capture special files
1709 * such as device nodes and FIFOs. Since wimlib v1.11.0, on Linux also capture
1710 * extended attributes. See the documentation for the <b>--unix-data</b> option
1711 * to <b>wimcapture</b> for more information. */
1712 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1714 /** Do not capture security descriptors. Only has an effect in NTFS-3G capture
1715 * mode, or in Windows native builds. */
1716 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1718 /** Fail immediately if the full security descriptor of any file or directory
1719 * cannot be accessed. Only has an effect in Windows native builds. The
1720 * default behavior without this flag is to first try omitting the SACL from the
1721 * security descriptor, then to try omitting the security descriptor entirely.
1723 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1725 /** Call the progress function with the message
1726 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1727 * capture. This is a subset of the messages provided by
1728 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1729 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1731 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1732 * case of Windows) that point inside the directory being captured to instead be
1733 * absolute relative to the directory being captured.
1735 * Without this flag, the default is to do reparse-point fixups if
1736 * <c>WIM_HDR_FLAG_RP_FIX</c> is set in the WIM header or if this is the first
1737 * image being added. */
1738 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1740 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1741 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1743 /** Do not automatically exclude unsupported files or directories from capture,
1744 * such as encrypted files in NTFS-3G capture mode, or device files and FIFOs on
1745 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1746 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1747 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1750 * Automatically select a capture configuration appropriate for capturing
1751 * filesystems containing Windows operating systems. For example,
1752 * <c>/pagefile.sys</c> and <c>"/System Volume Information"</c> will be
1755 * When this flag is specified, the corresponding @p config parameter (for
1756 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1757 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1759 * Note that the default behavior--- that is, when neither
1760 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1761 * config is @c NULL--- is to use no capture configuration, meaning that no
1762 * files are excluded from capture.
1764 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1767 * Capture image as "WIMBoot compatible". In addition, if no capture
1768 * configuration file is explicitly specified use the capture configuration file
1769 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1770 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1771 * configuration file is explicitly specified, use it and also place it at
1772 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image.
1774 * This flag does not, by itself, change the compression type or chunk size.
1775 * Before writing the WIM file, you may wish to set the compression format to
1776 * be the same as that used by WIMGAPI and DISM:
1779 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1780 * wimlib_set_output_chunk_size(wim, 4096);
1783 * However, "WIMBoot" also works with other XPRESS chunk sizes as well as LZX
1784 * with 32768 byte chunks.
1786 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1787 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1789 * Since wimlib v1.8.3, ::WIMLIB_ADD_FLAG_WIMBOOT also causes offline WIM-backed
1790 * files to be added as the "real" files rather than as their reparse points,
1791 * provided that their data is already present in the WIM. This feature can be
1792 * useful when updating a backing WIM file in an "offline" state.
1794 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1797 * If the add command involves adding a non-directory file to a location at
1798 * which there already exists a nondirectory file in the image, issue
1799 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This was the
1800 * default behavior before wimlib v1.7.0.
1802 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1805 * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1808 * Note: This method for file exclusions is independent from the capture
1809 * configuration file mechanism.
1811 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1814 * Since wimlib v1.9.0: create a temporary filesystem snapshot of the source
1815 * directory and add the files from it. Currently, this option is only
1816 * supported on Windows, where it uses the Volume Shadow Copy Service (VSS).
1817 * Using this option, you can create a consistent backup of the system volume of
1818 * a running Windows system without running into problems with locked files.
1819 * For the VSS snapshot to be successfully created, your application must be run
1820 * as an Administrator, and it cannot be run in WoW64 mode (i.e. if Windows is
1821 * 64-bit, then your application must be 64-bit as well).
1823 #define WIMLIB_ADD_FLAG_SNAPSHOT 0x00008000
1826 * Since wimlib v1.9.0: permit the library to discard file paths after the
1827 * initial scan. If the application won't use
1828 * ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES while writing the WIM
1829 * archive, this flag can be used to allow the library to enable optimizations
1830 * such as opening files by inode number rather than by path. Currently this
1831 * only makes a difference on Windows.
1833 #define WIMLIB_ADD_FLAG_FILE_PATHS_UNNEEDED 0x00010000
1836 /** @addtogroup G_modifying_wims
1839 /** Do not issue an error if the path to delete does not exist. */
1840 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1842 /** Delete the file or directory tree recursively; if not specified, an error is
1843 * issued if the path to delete is a directory. */
1844 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1847 /** @addtogroup G_modifying_wims
1851 * If a single image is being exported, mark it bootable in the destination WIM.
1852 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1853 * the image in the source WIM (if any) that is marked as bootable is also
1854 * marked as bootable in the destination WIM.
1856 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1858 /** Give the exported image(s) no names. Avoids problems with image name
1861 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1863 /** Give the exported image(s) no descriptions. */
1864 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1866 /** This advises the library that the program is finished with the source
1867 * WIMStruct and will not attempt to access it after the call to
1868 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1869 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1872 * Mark each exported image as WIMBoot-compatible.
1874 * Note: by itself, this does change the destination WIM's compression type, nor
1875 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1876 * image. Before writing the destination WIM, it's recommended to do something
1880 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1881 * wimlib_set_output_chunk_size(wim, 4096);
1882 * wimlib_add_tree(wim, image, L"myconfig.ini",
1883 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1886 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1889 /** @addtogroup G_extracting_wims
1892 /** Extract the image directly to an NTFS volume rather than a generic directory.
1893 * This mode is only available if wimlib was compiled with libntfs-3g support;
1894 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1895 * extraction target will be interpreted as the path to an NTFS volume image (as
1896 * a regular file or block device) rather than a directory. It will be opened
1897 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1898 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1899 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1900 * wimlib_extract_paths() when passed multiple paths. */
1901 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1903 /** UNIX-like systems only: Extract UNIX-specific metadata captured with
1904 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1905 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1906 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1908 /** Do not extract security descriptors. This flag cannot be combined with
1909 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1910 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1913 * Fail immediately if the full security descriptor of any file or directory
1914 * cannot be set exactly as specified in the WIM image. On Windows, the default
1915 * behavior without this flag when wimlib does not have permission to set the
1916 * correct security descriptor is to fall back to setting the security
1917 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1918 * owner omitted, then not at all. This flag cannot be combined with
1919 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS.
1921 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1924 * This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1925 * reparse-point fixups on, so absolute symbolic links or junction points will
1926 * be fixed to be absolute relative to the actual extraction root. Reparse-
1927 * point fixups are done by default for wimlib_extract_image() and
1928 * wimlib_extract_image_from_pipe() if <c>WIM_HDR_FLAG_RP_FIX</c> is set in the
1929 * WIM header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.
1931 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1933 /** Force reparse-point fixups on extraction off, regardless of the state of the
1934 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1935 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1936 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1938 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1939 * paths, each of which must name a regular file, to standard output. */
1940 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1943 * Instead of ignoring files and directories with names that cannot be
1944 * represented on the current platform (note: Windows has more restrictions on
1945 * filenames than POSIX-compliant systems), try to replace characters or append
1946 * junk to the names so that they can be extracted in some form.
1948 * Note: this flag is unlikely to have any effect when extracting a WIM image
1949 * that was captured on Windows.
1951 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1954 * On Windows, when there exist two or more files with the same case insensitive
1955 * name but different case sensitive names, try to extract them all by appending
1956 * junk to the end of them, rather than arbitrarily extracting only one.
1958 * Note: this flag is unlikely to have any effect when extracting a WIM image
1959 * that was captured on Windows.
1961 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1963 /** Do not ignore failure to set timestamps on extracted files. This flag
1964 * currently only has an effect when extracting to a directory on UNIX-like
1966 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1968 /** Do not ignore failure to set short names on extracted files. This flag
1969 * currently only has an effect on Windows. */
1970 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1972 /** Do not ignore failure to extract symbolic links and junctions due to
1973 * permissions problems. This flag currently only has an effect on Windows. By
1974 * default, such failures are ignored since the default configuration of Windows
1975 * only allows the Administrator to create symbolic links. */
1976 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1979 * For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1980 * paths to extract as wildcard patterns ("globs") which may contain the
1981 * wildcard characters @c ? and @c *. The @c ? character matches any
1982 * non-path-separator character, whereas the @c * character matches zero or more
1983 * non-path-separator characters. Consequently, each glob may match zero or
1984 * more actual paths in the WIM image.
1986 * By default, if a glob does not match any files, a warning but not an error
1987 * will be issued. This is the case even if the glob did not actually contain
1988 * wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1991 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1993 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1994 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1995 * one of the provided globs did not match a file. */
1996 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1999 * Do not extract Windows file attributes such as readonly, hidden, etc.
2001 * This flag has an effect on Windows as well as in the NTFS-3G extraction mode.
2003 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
2006 * For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
2007 * preserve the directory structure of the archive when extracting --- that is,
2008 * place each extracted file or directory tree directly in the target directory.
2009 * The target directory will still be created if it does not already exist.
2011 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
2014 * Windows only: Extract files as "pointers" back to the WIM archive.
2016 * The effects of this option are fairly complex. See the documentation for the
2017 * <b>--wimboot</b> option of <b>wimapply</b> for more information.
2019 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
2022 * Since wimlib v1.8.2 and Windows-only: compress the extracted files using
2023 * System Compression, when possible. This only works on either Windows 10 or
2024 * later, or on an older Windows to which Microsoft's wofadk.sys driver has been
2025 * added. Several different compression formats may be used with System
2026 * Compression; this particular flag selects the XPRESS compression format with
2029 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K 0x01000000
2031 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
2032 * 8192 byte chunks. */
2033 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K 0x02000000
2035 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
2036 * 16384 byte chunks. */
2037 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K 0x04000000
2039 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use LZX compression with
2040 * 32768 byte chunks. */
2041 #define WIMLIB_EXTRACT_FLAG_COMPACT_LZX 0x08000000
2044 /** @addtogroup G_mounting_wim_images
2047 /** Mount the WIM image read-write rather than the default of read-only. */
2048 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
2050 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main(). */
2051 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
2053 /** Do not allow accessing named data streams in the mounted WIM image. */
2054 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
2056 /** Access named data streams in the mounted WIM image through extended file
2057 * attributes named "user.X", where X is the name of a data stream. This is the
2059 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
2061 /** Access named data streams in the mounted WIM image by specifying the file
2062 * name, a colon, then the name of the data stream. */
2063 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
2065 /** Use UNIX owners, groups, and modes if available in the WIM image. */
2066 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
2068 /** Allow other users to see the mounted filesystem. This passes the @c
2069 * allow_other option to fuse_main(). */
2070 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
2073 /** @addtogroup G_creating_and_opening_wims
2076 /** Verify the WIM contents against the WIM's integrity table, if present. The
2077 * integrity table stores checksums for the raw data of the WIM file, divided
2078 * into fixed size chunks. Verification will compute checksums and compare them
2079 * with the stored values. If there are any mismatches, then
2080 * ::WIMLIB_ERR_INTEGRITY will be issued. If the WIM file does not contain an
2081 * integrity table, then this flag has no effect. */
2082 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
2084 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
2085 * WIM. Software can provide this flag for convenience if it explicitly does
2086 * not want to support split WIMs. */
2087 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
2089 /** Check if the WIM is writable and issue an error
2090 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
2091 * only if it is writable at the filesystem level, does not have the
2092 * <c>WIM_HDR_FLAG_READONLY</c> flag set in its header, and is not part of a
2093 * spanned set. It is not required to provide this flag before attempting to
2094 * make changes to the WIM, but with this flag you get an error immediately
2095 * rather than potentially much later, when wimlib_overwrite() is finally
2097 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
2100 /** @addtogroup G_mounting_wim_images
2103 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
2104 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2105 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
2107 /** Commit changes to the read-write mounted WIM image.
2108 * If this flag is not specified, changes will be discarded. */
2109 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
2111 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
2112 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2113 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
2115 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2116 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2117 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
2120 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2121 * image, forces all file descriptors to the open WIM image to be closed before
2124 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2125 * this flag has no effect.
2127 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
2129 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2130 * WIM image, causes the modified image to be committed to the WIM file as a
2131 * new, unnamed image appended to the archive. The original image in the WIM
2132 * file will be unmodified. */
2133 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
2136 /** @addtogroup G_modifying_wims
2139 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2140 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
2141 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
2144 /** @addtogroup G_writing_and_overwriting_wims
2148 * Include an integrity table in the resulting WIM file.
2150 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2151 * include an integrity table if and only if one was present before. For
2152 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2153 * to not include an integrity table.
2155 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
2158 * Do not include an integrity table in the resulting WIM file. This is the
2159 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2162 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
2165 * Write the WIM as "pipable". After writing a WIM with this flag specified,
2166 * images from it can be applied directly from a pipe using
2167 * wimlib_extract_image_from_pipe(). See the documentation for the
2168 * <b>--pipable</b> option of <b>wimcapture</b> for more information. Beware:
2169 * WIMs written with this flag will not be compatible with Microsoft's software.
2171 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2172 * write the WIM as pipable if and only if it was pipable before. For
2173 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2174 * to write the WIM as non-pipable.
2176 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
2179 * Do not write the WIM as "pipable". This is the default behavior, unless the
2180 * ::WIMStruct was created by opening a pipable WIM.
2182 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
2185 * When writing data to the WIM file, recompress it, even if the data is already
2186 * available in the desired compressed form (for example, in a WIM file from
2187 * which an image has been exported using wimlib_export_image()).
2189 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2190 * compression ratio for the same compression type and chunk size. Simply using
2191 * the default compression settings may suffice for this, especially if the WIM
2192 * file was created using another program/library that may not use as
2193 * sophisticated compression algorithms. Or,
2194 * wimlib_set_default_compression_level() can be called beforehand to set an
2195 * even higher compression level than the default.
2197 * If the WIM contains solid resources, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can
2198 * be used in combination with ::WIMLIB_WRITE_FLAG_SOLID to prevent any solid
2199 * resources from being re-used. Otherwise, solid resources are re-used
2200 * somewhat more liberally than normal compressed resources.
2202 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of data
2203 * that would not otherwise be written. For example, a call to
2204 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2205 * cause already-existing data in the WIM file to be recompressed. To force the
2206 * WIM file to be fully rebuilt and recompressed, combine
2207 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2209 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
2212 * Immediately before closing the WIM file, sync its data to disk.
2214 * This flag forces the function to wait until the data is safely on disk before
2215 * returning success. Otherwise, modern operating systems tend to cache data
2216 * for some time (in some cases, 30+ seconds) before actually writing it to
2217 * disk, even after reporting to the application that the writes have succeeded.
2219 * wimlib_overwrite() will set this flag automatically if it decides to
2220 * overwrite the WIM file via a temporary file instead of in-place. This is
2221 * necessary on POSIX systems; it will, for example, avoid problems with delayed
2222 * allocation on ext4.
2224 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
2227 * For wimlib_overwrite(): rebuild the entire WIM file, even if it otherwise
2228 * could be updated in-place by appending to it. Any data that existed in the
2229 * original WIM file but is not actually needed by any of the remaining images
2230 * will not be included. This can free up space left over after previous
2231 * in-place modifications to the WIM file.
2233 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2234 * data to be recompressed. Otherwise, compressed data is re-used if possible.
2236 * wimlib_write() ignores this flag.
2238 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
2241 * For wimlib_overwrite(): override the default behavior after one or more calls
2242 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
2243 * flag, only minimal changes to correctly remove the image from the WIM file
2244 * will be taken. This can be much faster, but it will result in the WIM file
2245 * getting larger rather than smaller.
2247 * wimlib_write() ignores this flag.
2249 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
2252 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2253 * flag (<c>WIM_HDR_FLAG_READONLY</c>) is set in the WIM header. This can be
2254 * used following a call to wimlib_set_wim_info() with the
2255 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2258 * wimlib_write() ignores this flag.
2260 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
2263 * Do not include file data already present in other WIMs. This flag can be
2264 * used to write a "delta" WIM after the WIM files on which the delta is to be
2265 * based were referenced with wimlib_reference_resource_files() or
2266 * wimlib_reference_resources().
2268 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
2270 /** Deprecated; this flag should not be used outside of the library itself. */
2271 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
2274 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2276 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2279 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
2282 * Concatenate files and compress them together, rather than compress each file
2283 * independently. This is also known as creating a "solid archive". This tends
2284 * to produce a better compression ratio at the cost of much slower random
2287 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2288 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2289 * created with this flag use a different version number in their header (3584
2290 * instead of 68864) and are also called "ESD files".
2292 * Note that providing this flag does not affect the "append by default"
2293 * behavior of wimlib_overwrite(). In other words, wimlib_overwrite() with just
2294 * ::WIMLIB_WRITE_FLAG_SOLID can be used to append solid-compressed data to a
2295 * WIM file that originally did not contain any solid-compressed data. But if
2296 * you instead want to rebuild and recompress an entire WIM file in solid mode,
2297 * then also provide ::WIMLIB_WRITE_FLAG_REBUILD and
2298 * ::WIMLIB_WRITE_FLAG_RECOMPRESS.
2300 * Currently, new solid resources will, by default, be written using LZMS
2301 * compression with 64 MiB (67108864 byte) chunks. Use
2302 * wimlib_set_output_pack_compression_type() and/or
2303 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2304 * the WIM's main compression type and chunk size; you can have a WIM that
2305 * nominally uses LZX compression and 32768 byte chunks but actually contains
2306 * LZMS-compressed solid resources, for example. However, if including solid
2307 * resources, I suggest that you set the WIM's main compression type to LZMS as
2308 * well, either by creating the WIM with
2309 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2310 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2312 * This flag will be set by default when writing or overwriting a WIM file that
2313 * either already contains solid resources, or has had solid resources exported
2314 * into it and the WIM's main compression type is LZMS.
2316 #define WIMLIB_WRITE_FLAG_SOLID 0x00001000
2319 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2320 * file. This is only needed in the unusual case that the library user needs to
2321 * know exactly when wimlib has read each file for the last time.
2323 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2326 * Do not consider content similarity when arranging file data for solid
2327 * compression. Providing this flag will typically worsen the compression
2328 * ratio, so only provide this flag if you know what you are doing.
2330 #define WIMLIB_WRITE_FLAG_NO_SOLID_SORT 0x00004000
2333 * Since wimlib v1.8.3 and for wimlib_overwrite() only: <b>unsafely</b> compact
2334 * the WIM file in-place, without appending. Existing resources are shifted
2335 * down to fill holes and new resources are appended as needed. The WIM file is
2336 * truncated to its final size, which may shrink the on-disk file. <b>This
2337 * operation cannot be safely interrupted. If the operation is interrupted,
2338 * then the WIM file will be corrupted, and it may be impossible (or at least
2339 * very difficult) to recover any data from it. Users of this flag are expected
2340 * to know what they are doing and assume responsibility for any data corruption
2341 * that may result.</b>
2343 * If the WIM file cannot be compacted in-place because of its structure, its
2344 * layout, or other requested write parameters, then wimlib_overwrite() fails
2345 * with ::WIMLIB_ERR_COMPACTION_NOT_POSSIBLE, and the caller may wish to retry
2346 * the operation without this flag.
2348 #define WIMLIB_WRITE_FLAG_UNSAFE_COMPACT 0x00008000
2351 /** @addtogroup G_general
2354 /** Deprecated; no longer has any effect. */
2355 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2357 /** Windows-only: do not attempt to acquire additional privileges (currently
2358 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege,
2359 * SeTakeOwnershipPrivilege, and SeManageVolumePrivilege) when initializing the
2360 * library. This flag is intended for the case where the calling program
2361 * manages these privileges itself. Note: by default, no error is issued if
2362 * privileges cannot be acquired, although related errors may be reported later,
2363 * depending on if the operations performed actually require additional
2364 * privileges or not. */
2365 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2367 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2368 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2369 * to read all possible data and metadata for a capture operation could not be
2370 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2372 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2374 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2375 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2376 * to restore all possible data and metadata for an apply operation could not be
2377 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2379 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2381 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2383 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2385 /** Default to interpreting WIM paths case insensitively (default on Windows).
2386 * This does not apply to mounted images. */
2387 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2390 /** @addtogroup G_nonstandalone_wims
2393 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2394 * Ignored by wimlib_reference_resources(). */
2395 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2397 /** For wimlib_reference_resource_files(), issue an error
2398 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2399 * default behavior without this flag is to issue no error at that point, but
2400 * then attempt to open the glob as a literal path, which of course will fail
2401 * anyway if no file exists at that path. No effect if
2402 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2403 * wimlib_reference_resources(). */
2404 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2407 /** @addtogroup G_modifying_wims
2410 /** The specific type of update to perform. */
2411 enum wimlib_update_op {
2412 /** Add a new file or directory tree to the image. */
2413 WIMLIB_UPDATE_OP_ADD = 0,
2415 /** Delete a file or directory tree from the image. */
2416 WIMLIB_UPDATE_OP_DELETE = 1,
2418 /** Rename a file or directory tree in the image. */
2419 WIMLIB_UPDATE_OP_RENAME = 2,
2422 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2423 struct wimlib_add_command {
2424 /** Filesystem path to the file or directory tree to add. */
2425 wimlib_tchar *fs_source_path;
2427 /** Destination path in the image. To specify the root directory of the
2428 * image, use ::WIMLIB_WIM_ROOT_PATH. */
2429 wimlib_tchar *wim_target_path;
2431 /** Path to capture configuration file to use, or @c NULL if not
2433 wimlib_tchar *config_file;
2435 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2439 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2440 struct wimlib_delete_command {
2442 /** The path to the file or directory within the image to delete. */
2443 wimlib_tchar *wim_path;
2445 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2449 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2450 struct wimlib_rename_command {
2452 /** The path to the source file or directory within the image. */
2453 wimlib_tchar *wim_source_path;
2455 /** The path to the destination file or directory within the image. */
2456 wimlib_tchar *wim_target_path;
2458 /** Reserved; set to 0. */
2462 /** Specification of an update to perform on a WIM image. */
2463 struct wimlib_update_command {
2465 enum wimlib_update_op op;
2468 struct wimlib_add_command add;
2469 struct wimlib_delete_command delete_; /* Underscore is for C++
2471 struct wimlib_rename_command rename;
2476 /** @addtogroup G_general
2480 * Possible values of the error code returned by many functions in wimlib.
2482 * See the documentation for each wimlib function to see specifically what error
2483 * codes can be returned by a given function, and what they mean.
2485 enum wimlib_error_code {
2486 WIMLIB_ERR_SUCCESS = 0,
2487 WIMLIB_ERR_ALREADY_LOCKED = 1,
2488 WIMLIB_ERR_DECOMPRESSION = 2,
2489 WIMLIB_ERR_FUSE = 6,
2490 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2491 WIMLIB_ERR_IMAGE_COUNT = 10,
2492 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2493 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2494 WIMLIB_ERR_INTEGRITY = 13,
2495 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2496 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2497 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2498 WIMLIB_ERR_INVALID_HEADER = 17,
2499 WIMLIB_ERR_INVALID_IMAGE = 18,
2500 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2501 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2502 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2503 WIMLIB_ERR_INVALID_OVERLAY = 23,
2504 WIMLIB_ERR_INVALID_PARAM = 24,
2505 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2506 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2507 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2508 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2509 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2510 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2511 WIMLIB_ERR_IS_DIRECTORY = 32,
2512 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2513 WIMLIB_ERR_LINK = 35,
2514 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2515 WIMLIB_ERR_MKDIR = 37,
2516 WIMLIB_ERR_MQUEUE = 38,
2517 WIMLIB_ERR_NOMEM = 39,
2518 WIMLIB_ERR_NOTDIR = 40,
2519 WIMLIB_ERR_NOTEMPTY = 41,
2520 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2521 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2522 WIMLIB_ERR_NOT_PIPABLE = 44,
2523 WIMLIB_ERR_NO_FILENAME = 45,
2524 WIMLIB_ERR_NTFS_3G = 46,
2525 WIMLIB_ERR_OPEN = 47,
2526 WIMLIB_ERR_OPENDIR = 48,
2527 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2528 WIMLIB_ERR_READ = 50,
2529 WIMLIB_ERR_READLINK = 51,
2530 WIMLIB_ERR_RENAME = 52,
2531 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2532 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2533 WIMLIB_ERR_RESOURCE_ORDER = 56,
2534 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2535 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2536 WIMLIB_ERR_SET_SECURITY = 59,
2537 WIMLIB_ERR_SET_SHORT_NAME = 60,
2538 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2539 WIMLIB_ERR_SPLIT_INVALID = 62,
2540 WIMLIB_ERR_STAT = 63,
2541 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2542 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2543 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2544 WIMLIB_ERR_UNSUPPORTED = 68,
2545 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2546 WIMLIB_ERR_WIM_IS_READONLY = 71,
2547 WIMLIB_ERR_WRITE = 72,
2548 WIMLIB_ERR_XML = 73,
2549 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2550 WIMLIB_ERR_WIMBOOT = 75,
2551 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2552 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2553 WIMLIB_ERR_MKNOD = 78,
2554 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2555 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2556 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2557 WIMLIB_ERR_FVE_LOCKED_VOLUME = 82,
2558 WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG = 83,
2559 WIMLIB_ERR_WIM_IS_INCOMPLETE = 84,
2560 WIMLIB_ERR_COMPACTION_NOT_POSSIBLE = 85,
2561 WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES = 86,
2562 WIMLIB_ERR_DUPLICATE_EXPORTED_IMAGE = 87,
2563 WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED = 88,
2564 WIMLIB_ERR_SNAPSHOT_FAILURE = 89,
2565 WIMLIB_ERR_INVALID_EXTENDED_ATTRIBUTE = 90,
2569 /** Used to indicate no image or an invalid image. */
2570 #define WIMLIB_NO_IMAGE 0
2572 /** Used to specify all images in the WIM. */
2573 #define WIMLIB_ALL_IMAGES (-1)
2578 * @ingroup G_modifying_wims
2580 * Append an empty image to a ::WIMStruct.
2582 * The new image will initially contain no files or directories, although if
2583 * written without further modifications, then a root directory will be created
2584 * automatically for it.
2586 * After calling this function, you can use wimlib_update_image() to add files
2587 * to the new image. This gives you more control over making the new image
2588 * compared to calling wimlib_add_image() or wimlib_add_image_multisource().
2591 * Pointer to the ::WIMStruct to which to add the image.
2593 * Name to give the new image. If @c NULL or empty, the new image is given
2594 * no name. If nonempty, it must specify a name that does not already
2596 * @param new_idx_ret
2597 * If non-<c>NULL</c>, the index of the newly added image is returned in
2600 * @return 0 on success; a ::wimlib_error_code value on failure.
2602 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2603 * The WIM already contains an image with the requested name.
2606 wimlib_add_empty_image(WIMStruct *wim,
2607 const wimlib_tchar *name,
2611 * @ingroup G_modifying_wims
2613 * Add an image to a ::WIMStruct from an on-disk directory tree or NTFS volume.
2615 * The directory tree or NTFS volume is scanned immediately to load the dentry
2616 * tree into memory, and file metadata is read. However, actual file data may
2617 * not be read until the ::WIMStruct is persisted to disk using wimlib_write()
2618 * or wimlib_overwrite().
2620 * See the documentation for the @b wimlib-imagex program for more information
2621 * about the "normal" capture mode versus the NTFS capture mode (entered by
2622 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2624 * Note that no changes are committed to disk until wimlib_write() or
2625 * wimlib_overwrite() is called.
2628 * Pointer to the ::WIMStruct to which to add the image.
2630 * A path to a directory or unmounted NTFS volume that will be captured as
2633 * Name to give the new image. If @c NULL or empty, the new image is given
2634 * no name. If nonempty, it must specify a name that does not already
2636 * @param config_file
2637 * Path to capture configuration file, or @c NULL. This file may specify,
2638 * among other things, which files to exclude from capture. See the
2639 * documentation for <b>wimcapture</b> (<b>--config</b> option) for details
2640 * of the file format. If @c NULL, the default capture configuration will
2641 * be used. Ordinarily, the default capture configuration will result in
2642 * no files being excluded from capture purely based on name; however, the
2643 * ::WIMLIB_ADD_FLAG_WINCONFIG and ::WIMLIB_ADD_FLAG_WIMBOOT flags modify
2646 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2648 * @return 0 on success; a ::wimlib_error_code value on failure.
2650 * This function is implemented by calling wimlib_add_empty_image(), then
2651 * calling wimlib_update_image() with a single "add" command, so any error code
2652 * returned by wimlib_add_empty_image() may be returned, as well as any error
2653 * codes returned by wimlib_update_image() other than ones documented as only
2654 * being returned specifically by an update involving delete or rename commands.
2656 * If a progress function is registered with @p wim, then it will receive the
2657 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2658 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2659 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2662 wimlib_add_image(WIMStruct *wim,
2663 const wimlib_tchar *source,
2664 const wimlib_tchar *name,
2665 const wimlib_tchar *config_file,
2669 * @ingroup G_modifying_wims
2671 * This function is equivalent to wimlib_add_image() except it allows for
2672 * multiple sources to be combined into a single WIM image. This is done by
2673 * specifying the @p sources and @p num_sources parameters instead of the @p
2674 * source parameter of wimlib_add_image(). The rest of the parameters are the
2675 * same as wimlib_add_image(). See the documentation for <b>wimcapture</b> for
2676 * full details on how this mode works.
2679 wimlib_add_image_multisource(WIMStruct *wim,
2680 const struct wimlib_capture_source *sources,
2682 const wimlib_tchar *name,
2683 const wimlib_tchar *config_file,
2687 * @ingroup G_modifying_wims
2689 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2690 * location @p wim_target_path within the specified @p image of the @p wim.
2692 * This just builds an appropriate ::wimlib_add_command and passes it to
2693 * wimlib_update_image().
2696 wimlib_add_tree(WIMStruct *wim, int image,
2697 const wimlib_tchar *fs_source_path,
2698 const wimlib_tchar *wim_target_path, int add_flags);
2701 * @ingroup G_creating_and_opening_wims
2703 * Create a ::WIMStruct which initially contains no images and is not backed by
2707 * The "output compression type" to assign to the ::WIMStruct. This is the
2708 * compression type that will be used if the ::WIMStruct is later persisted
2709 * to an on-disk file using wimlib_write().
2711 * This choice is not necessarily final. If desired, it can still be
2712 * changed at any time before wimlib_write() is called, using
2713 * wimlib_set_output_compression_type(). In addition, if you wish to use a
2714 * non-default compression chunk size, then you will need to call
2715 * wimlib_set_output_chunk_size().
2717 * On success, a pointer to the new ::WIMStruct is written to the memory
2718 * location pointed to by this parameter. This ::WIMStruct must be freed
2719 * using using wimlib_free() when finished with it.
2721 * @return 0 on success; a ::wimlib_error_code value on failure.
2723 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2724 * @p ctype was not a supported compression type.
2725 * @retval ::WIMLIB_ERR_NOMEM
2726 * Insufficient memory to allocate a new ::WIMStruct.
2729 wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret);
2732 * @ingroup G_modifying_wims
2734 * Delete an image, or all images, from a ::WIMStruct.
2736 * Note that no changes are committed to disk until wimlib_write() or
2737 * wimlib_overwrite() is called.
2740 * Pointer to the ::WIMStruct from which to delete the image.
2742 * The 1-based index of the image to delete, or ::WIMLIB_ALL_IMAGES to
2743 * delete all images.
2745 * @return 0 on success; a ::wimlib_error_code value on failure.
2747 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2748 * @p image does not exist in the WIM.
2750 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2751 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2752 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2753 * indicate failure (for different reasons) to read the metadata resource for an
2754 * image that needed to be deleted.
2756 * If this function fails when @p image was ::WIMLIB_ALL_IMAGES, then it's
2757 * possible that some but not all of the images were deleted.
2760 wimlib_delete_image(WIMStruct *wim, int image);
2763 * @ingroup G_modifying_wims
2765 * Delete the @p path from the specified @p image of the @p wim.
2767 * This just builds an appropriate ::wimlib_delete_command and passes it to
2768 * wimlib_update_image().
2771 wimlib_delete_path(WIMStruct *wim, int image,
2772 const wimlib_tchar *path, int delete_flags);
2775 * @ingroup G_modifying_wims
2777 * Export an image, or all images, from a ::WIMStruct into another ::WIMStruct.
2779 * Specifically, if the destination ::WIMStruct contains <tt>n</tt> images, then
2780 * the source image(s) will be appended, in order, starting at destination index
2781 * <tt>n + 1</tt>. By default, all image metadata will be exported verbatim,
2782 * but certain changes can be made by passing appropriate parameters.
2784 * wimlib_export_image() is only an in-memory operation; no changes are
2785 * committed to disk until wimlib_write() or wimlib_overwrite() is called.
2787 * A limitation of the current implementation of wimlib_export_image() is that
2788 * the directory tree of a source or destination image cannot be updated
2789 * following an export until one of the two images has been freed from memory.
2792 * The WIM from which to export the images, specified as a pointer to the
2793 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2794 * split WIM. In the case of a WIM file that is not standalone, this
2795 * ::WIMStruct must have had any needed external resources previously
2796 * referenced using wimlib_reference_resources() or
2797 * wimlib_reference_resource_files().
2799 * The 1-based index of the image from @p src_wim to export, or
2800 * ::WIMLIB_ALL_IMAGES.
2802 * The ::WIMStruct to which to export the images.
2804 * For single-image exports, the name to give the exported image in @p
2805 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2806 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2807 * that case, the names are all taken from @p src_wim. This parameter is
2808 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2809 * @param dest_description
2810 * For single-image exports, the description to give the exported image in
2811 * the new WIM file. If left @c NULL, the description from @p src_wim is
2812 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2813 * NULL; in that case, the description are all taken from @p src_wim. This
2814 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2815 * @param export_flags
2816 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2818 * @return 0 on success; a ::wimlib_error_code value on failure.
2820 * @retval ::WIMLIB_ERR_DUPLICATE_EXPORTED_IMAGE
2821 * One or more of the source images had already been exported into the
2823 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2824 * One or more of the names being given to an exported image was already in
2825 * use in the destination WIM.
2826 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2827 * @p src_image does not exist in @p src_wim.
2828 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2829 * At least one of @p src_wim and @p dest_wim does not contain image
2830 * metadata; for example, one of them represents a non-first part of a
2832 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2833 * A file data blob that needed to be exported could not be found in the
2834 * blob lookup table of @p src_wim. See @ref G_nonstandalone_wims.
2836 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2837 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2838 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2839 * indicate failure (for different reasons) to read the metadata resource for an
2840 * image in @p src_wim that needed to be exported.
2843 wimlib_export_image(WIMStruct *src_wim, int src_image,
2844 WIMStruct *dest_wim,
2845 const wimlib_tchar *dest_name,
2846 const wimlib_tchar *dest_description,
2850 * @ingroup G_extracting_wims
2852 * Extract an image, or all images, from a ::WIMStruct.
2854 * The exact behavior of how wimlib extracts files from a WIM image is
2855 * controllable by the @p extract_flags parameter, but there also are
2856 * differences depending on the platform (UNIX-like vs Windows). See the
2857 * documentation for <b>wimapply</b> for more information, including about the
2858 * NTFS-3G extraction mode.
2861 * The WIM from which to extract the image(s), specified as a pointer to the
2862 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2863 * split WIM. In the case of a WIM file that is not standalone, this
2864 * ::WIMStruct must have had any needed external resources previously
2865 * referenced using wimlib_reference_resources() or
2866 * wimlib_reference_resource_files().
2868 * The 1-based index of the image to extract, or ::WIMLIB_ALL_IMAGES to
2869 * extract all images. Note: ::WIMLIB_ALL_IMAGES is unsupported in NTFS-3G
2872 * A null-terminated string which names the location to which the image(s)
2873 * will be extracted. By default, this is interpreted as a path to a
2874 * directory. Alternatively, if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in
2875 * @p extract_flags, then this is interpreted as a path to an unmounted
2877 * @param extract_flags
2878 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2880 * @return 0 on success; a ::wimlib_error_code value on failure.
2882 * @retval ::WIMLIB_ERR_DECOMPRESSION
2883 * The WIM file contains invalid compressed data.
2884 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2885 * @p image does not exist in @p wim.
2886 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2887 * The metadata for an image to extract was invalid.
2888 * @retval ::WIMLIB_ERR_INVALID_PARAM
2889 * The extraction flags were invalid; more details may be found in the
2890 * documentation for the specific extraction flags that were specified. Or
2891 * @p target was @c NULL or an empty string, or @p wim was @c NULL.
2892 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2893 * The data of a file that needed to be extracted was corrupt.
2894 * @retval ::WIMLIB_ERR_LINK
2895 * Failed to create a symbolic link or a hard link.
2896 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2897 * @p wim does not contain image metadata; for example, it represents a
2898 * non-first part of a split WIM.
2899 * @retval ::WIMLIB_ERR_MKDIR
2900 * Failed create a directory.
2901 * @retval ::WIMLIB_ERR_NTFS_3G
2902 * libntfs-3g reported that a problem occurred while writing to the NTFS
2904 * @retval ::WIMLIB_ERR_OPEN
2905 * Could not create a file, or failed to open an already-extracted file.
2906 * @retval ::WIMLIB_ERR_READ
2907 * Failed to read data from the WIM.
2908 * @retval ::WIMLIB_ERR_READLINK
2909 * Failed to determine the target of a symbolic link in the WIM.
2910 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2911 * Failed to fix the target of an absolute symbolic link (e.g. if the
2912 * target would have exceeded the maximum allowed length). (Only if
2913 * reparse data was supported by the extraction mode and
2914 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2916 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2917 * A file data blob that needed to be extracted could not be found in the
2918 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
2919 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2920 * Failed to set attributes on a file.
2921 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2922 * Failed to set reparse data on a file (only if reparse data was supported
2923 * by the extraction mode).
2924 * @retval ::WIMLIB_ERR_SET_SECURITY
2925 * Failed to set security descriptor on a file.
2926 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2927 * Failed to set the short name of a file.
2928 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2929 * Failed to set timestamps on a file.
2930 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2931 * Unexpected end-of-file occurred when reading data from the WIM.
2932 * @retval ::WIMLIB_ERR_UNSUPPORTED
2933 * A requested extraction flag, or the data or metadata that must be
2934 * extracted to support it, is unsupported in the build and configuration
2935 * of wimlib, or on the current platform or extraction mode or target
2936 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2937 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2938 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2939 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2940 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2941 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2942 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2943 * image contains one or more files with short names, but extracting short
2944 * names is not supported --- on Windows, this occurs if the target volume
2945 * does not support short names, while on non-Windows, this occurs if
2946 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2947 * @retval ::WIMLIB_ERR_WIMBOOT
2948 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2949 * there was a problem creating WIMBoot pointer files or registering a
2950 * source WIM file with the Windows Overlay Filesystem (WOF) driver.
2951 * @retval ::WIMLIB_ERR_WRITE
2952 * Failed to write data to a file being extracted.
2954 * If a progress function is registered with @p wim, then as each image is
2955 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2956 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2957 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2958 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2959 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2962 wimlib_extract_image(WIMStruct *wim, int image,
2963 const wimlib_tchar *target, int extract_flags);
2966 * @ingroup G_extracting_wims
2968 * Extract one image from a pipe on which a pipable WIM is being sent.
2970 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2971 * subsec_pipable_wims, for more information about pipable WIMs.
2973 * This function operates in a special way to read the WIM fully sequentially.
2974 * As a result, there is no ::WIMStruct is made visible to library users, and
2975 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2976 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2977 * seekable file, not a pipe.)
2980 * File descriptor, which may be a pipe, opened for reading and positioned
2981 * at the start of the pipable WIM.
2982 * @param image_num_or_name
2983 * String that specifies the 1-based index or name of the image to extract.
2984 * It is translated to an image index using the same rules that
2985 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2986 * only a single image (not all images) can be specified. Alternatively,
2987 * specify @p NULL here to use the first image in the WIM if it contains
2988 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2990 * Same as the corresponding parameter to wimlib_extract_image().
2991 * @param extract_flags
2992 * Same as the corresponding parameter to wimlib_extract_image().
2994 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
2995 * error codes include those returned by wimlib_extract_image() and
2996 * wimlib_open_wim() as well as the following:
2998 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2999 * Data read from the pipable WIM was invalid.
3000 * @retval ::WIMLIB_ERR_NOT_PIPABLE
3001 * The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
3004 wimlib_extract_image_from_pipe(int pipe_fd,
3005 const wimlib_tchar *image_num_or_name,
3006 const wimlib_tchar *target, int extract_flags);
3009 * @ingroup G_extracting_wims
3011 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
3012 * function. The progress function will be used while extracting the image and
3013 * will receive the normal extraction progress messages, such as
3014 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
3015 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
3018 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
3019 const wimlib_tchar *image_num_or_name,
3020 const wimlib_tchar *target,
3022 wimlib_progress_func_t progfunc,
3026 * @ingroup G_extracting_wims
3028 * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
3029 * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
3030 * path_list_file which itself contains the list of paths to use, one per line.
3031 * Leading and trailing whitespace is ignored. Empty lines and lines beginning
3032 * with the ';' or '#' characters are ignored. No quotes are needed, as paths
3033 * are otherwise delimited by the newline character. However, quotes will be
3034 * stripped if present.
3036 * The error codes are the same as those returned by wimlib_extract_paths(),
3037 * except that wimlib_extract_pathlist() returns an appropriate error code if it
3038 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
3039 * ::WIMLIB_ERR_READ).
3042 wimlib_extract_pathlist(WIMStruct *wim, int image,
3043 const wimlib_tchar *target,
3044 const wimlib_tchar *path_list_file,
3048 * @ingroup G_extracting_wims
3050 * Extract zero or more paths (files or directory trees) from the specified WIM
3053 * By default, each path will be extracted to a corresponding subdirectory of
3054 * the target based on its location in the image. For example, if one of the
3055 * paths to extract is <c>/Windows/explorer.exe</c> and the target is
3056 * <c>outdir</c>, the file will be extracted to
3057 * <c>outdir/Windows/explorer.exe</c>. This behavior can be changed by
3058 * providing the flag ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which
3059 * will cause each file or directory tree to be placed directly in the target
3060 * directory --- so the same example would extract <c>/Windows/explorer.exe</c>
3061 * to <c>outdir/explorer.exe</c>.
3063 * With globbing turned off (the default), paths are always checked for
3064 * existence strictly; that is, if any path to extract does not exist in the
3065 * image, then nothing is extracted and the function fails with
3066 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST. But with globbing turned on
3067 * (::WIMLIB_EXTRACT_FLAG_GLOB_PATHS specified), globs are by default permitted
3068 * to match no files, and there is a flag (::WIMLIB_EXTRACT_FLAG_STRICT_GLOB) to
3069 * enable the strict behavior if desired.
3071 * Symbolic links are not dereferenced when paths in the image are interpreted.
3074 * WIM from which to extract the paths, specified as a pointer to the
3075 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
3076 * split WIM. In the case of a WIM file that is not standalone, this
3077 * ::WIMStruct must have had any needed external resources previously
3078 * referenced using wimlib_reference_resources() or
3079 * wimlib_reference_resource_files().
3081 * The 1-based index of the WIM image from which to extract the paths.
3083 * Array of paths to extract. Each element must be the absolute path to a
3084 * file or directory within the image. Path separators may be either
3085 * forwards or backwards slashes, and leading path separators are optional.
3086 * The paths will be interpreted either case-sensitively (UNIX default) or
3087 * case-insensitively (Windows default); however, the case sensitivity can
3088 * be configured explicitly at library initialization time by passing an
3089 * appropriate flag to wimlib_global_init().
3091 * By default, "globbing" is disabled, so the characters @c * and @c ? are
3092 * interpreted literally. This can be changed by specifying
3093 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p extract_flags.
3095 * Number of paths specified in @p paths.
3097 * Directory to which to extract the paths.
3098 * @param extract_flags
3099 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3101 * @return 0 on success; a ::wimlib_error_code value on failure. Most of the
3102 * error codes are the same as those returned by wimlib_extract_image(). Below,
3103 * some of the error codes returned in situations specific to path-mode
3104 * extraction are documented:
3106 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3107 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3108 * one of the paths to extract did not name a regular file.
3109 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3110 * One of the paths to extract does not exist in the image; see discussion
3111 * above about strict vs. non-strict behavior.
3113 * If a progress function is registered with @p wim, then it will receive
3114 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS.
3117 wimlib_extract_paths(WIMStruct *wim,
3119 const wimlib_tchar *target,
3120 const wimlib_tchar * const *paths,
3125 * @ingroup G_wim_information
3127 * Similar to wimlib_get_xml_data(), but the XML document will be written to the
3128 * specified standard C <c>FILE*</c> instead of retrieved in an in-memory
3131 * @return 0 on success; a ::wimlib_error_code value on failure. This may
3132 * return any error code which can be returned by wimlib_get_xml_data() as well
3133 * as the following error codes:
3135 * @retval ::WIMLIB_ERR_WRITE
3136 * Failed to write the data to the requested file.
3139 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3142 * @ingroup G_general
3144 * Release a reference to a ::WIMStruct. If the ::WIMStruct is still referenced
3145 * by other ::WIMStruct's (e.g. following calls to wimlib_export_image() or
3146 * wimlib_reference_resources()), then the library will free it later, when the
3147 * last reference is released; otherwise it is freed immediately and any
3148 * associated file descriptors are closed.
3151 * Pointer to the ::WIMStruct to release. If @c NULL, no action is taken.
3154 wimlib_free(WIMStruct *wim);
3157 * @ingroup G_general
3159 * Convert a ::wimlib_compression_type value into a string.
3162 * The compression type value to convert.
3165 * A statically allocated string naming the compression type, such as
3166 * "None", "LZX", or "XPRESS". If the value was unrecognized, then
3167 * the resulting string will be "Invalid".
3169 extern const wimlib_tchar *
3170 wimlib_get_compression_type_string(enum wimlib_compression_type ctype);
3173 * @ingroup G_general
3175 * Convert a wimlib error code into a string describing it.
3178 * An error code returned by one of wimlib's functions.
3181 * Pointer to a statically allocated string describing the error code. If
3182 * the value was unrecognized, then the resulting string will be "Unknown
3185 extern const wimlib_tchar *
3186 wimlib_get_error_string(enum wimlib_error_code code);
3189 * @ingroup G_wim_information
3191 * Get the description of the specified image. Equivalent to
3192 * <tt>wimlib_get_image_property(wim, image, "DESCRIPTION")</tt>.
3194 extern const wimlib_tchar *
3195 wimlib_get_image_description(const WIMStruct *wim, int image);
3198 * @ingroup G_wim_information
3200 * Get the name of the specified image. Equivalent to
3201 * <tt>wimlib_get_image_property(wim, image, "NAME")</tt>, except that
3202 * wimlib_get_image_name() will return an empty string if the image is unnamed
3203 * whereas wimlib_get_image_property() may return @c NULL in that case.
3205 extern const wimlib_tchar *
3206 wimlib_get_image_name(const WIMStruct *wim, int image);
3209 * @ingroup G_wim_information
3211 * Since wimlib v1.8.3: get a per-image property from the WIM's XML document.
3212 * This is an alternative to wimlib_get_image_name() and
3213 * wimlib_get_image_description() which allows getting any simple string
3217 * Pointer to the ::WIMStruct for the WIM.
3219 * The 1-based index of the image for which to get the property.
3220 * @param property_name
3221 * The name of the image property, for example "NAME", "DESCRIPTION", or
3222 * "TOTALBYTES". The name can contain forward slashes to indicate a nested
3223 * XML element; for example, "WINDOWS/VERSION/BUILD" indicates the BUILD
3224 * element nested within the VERSION element nested within the WINDOWS
3225 * element. Since wimlib v1.9.0, a bracketed number can be used to
3226 * indicate one of several identically-named elements; for example,
3227 * "WINDOWS/LANGUAGES/LANGUAGE[2]" indicates the second "LANGUAGE" element
3228 * nested within the "WINDOWS/LANGUAGES" element. Note that element names
3229 * are case sensitive.
3232 * The property's value as a ::wimlib_tchar string, or @c NULL if there is
3233 * no such property. The string may not remain valid after later library
3234 * calls, so the caller should duplicate it if needed.
3236 extern const wimlib_tchar *
3237 wimlib_get_image_property(const WIMStruct *wim, int image,
3238 const wimlib_tchar *property_name);
3241 * @ingroup G_general
3243 * Return the version of wimlib as a 32-bit number whose top 12 bits contain the
3244 * major version, the next 10 bits contain the minor version, and the low 10
3245 * bits contain the patch version.
3247 * In other words, the returned value is equal to <c>((WIMLIB_MAJOR_VERSION <<
3248 * 20) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</c> for the
3249 * corresponding header file.
3252 wimlib_get_version(void);
3255 * @ingroup G_wim_information
3257 * Get basic information about a WIM file.
3260 * Pointer to the ::WIMStruct to query. This need not represent a
3261 * standalone WIM (e.g. it could represent part of a split WIM).
3263 * A ::wimlib_wim_info structure that will be filled in with information
3264 * about the WIM file.
3269 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3272 * @ingroup G_wim_information
3274 * Read a WIM file's XML document into an in-memory buffer.
3276 * The XML document contains metadata about the WIM file and the images stored
3280 * Pointer to the ::WIMStruct to query. This need not represent a
3281 * standalone WIM (e.g. it could represent part of a split WIM).
3283 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3284 * XML document is written to this location.
3285 * @param bufsize_ret
3286 * The size of the XML document in bytes is written to this location.
3288 * @return 0 on success; a ::wimlib_error_code value on failure.
3290 * @retval ::WIMLIB_ERR_NO_FILENAME
3291 * @p wim is not backed by a file and therefore does not have an XML
3293 * @retval ::WIMLIB_ERR_READ
3294 * Failed to read the XML document from the WIM file.
3295 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3296 * Failed to read the XML document from the WIM file.
3299 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3302 * @ingroup G_general
3304 * Initialization function for wimlib. Call before using any other wimlib
3305 * function (except possibly wimlib_set_print_errors()). If not done manually,
3306 * this function will be called automatically with a flags argument of 0. This
3307 * function does nothing if called again after it has already successfully run.
3310 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3312 * @return 0 on success; a ::wimlib_error_code value on failure.
3314 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3315 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3316 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3317 * init_flags, but the corresponding privileges could not be acquired.
3320 wimlib_global_init(int init_flags);
3323 * @ingroup G_general
3325 * Cleanup function for wimlib. You are not required to call this function, but
3326 * it will release any global resources allocated by the library.
3329 wimlib_global_cleanup(void);
3332 * @ingroup G_wim_information
3334 * Determine if an image name is already used by some image in the WIM.
3337 * Pointer to the ::WIMStruct to query. This need not represent a
3338 * standalone WIM (e.g. it could represent part of a split WIM).
3340 * The name to check.
3343 * @c true if there is already an image in @p wim named @p name; @c false
3344 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3345 * the empty string, then @c false is returned.
3348 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3351 * @ingroup G_wim_information
3353 * Iterate through a file or directory tree in a WIM image. By specifying
3354 * appropriate flags and a callback function, you can get the attributes of a
3355 * file in the image, get a directory listing, or even get a listing of the
3359 * The ::WIMStruct containing the image(s) over which to iterate. This
3360 * ::WIMStruct must contain image metadata, so it cannot be the non-first
3361 * part of a split WIM (for example).
3363 * The 1-based index of the image that contains the files or directories to
3364 * iterate over, or ::WIMLIB_ALL_IMAGES to iterate over all images.
3366 * Path in the image at which to do the iteration.
3368 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3370 * A callback function that will receive each directory entry.
3372 * An extra parameter that will always be passed to the callback function
3375 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3376 * first nonzero value that was returned from @p cb. However, additional
3377 * ::wimlib_error_code values may be returned, including the following:
3379 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3380 * @p image does not exist in @p wim.
3381 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3382 * @p path does not exist in the image.
3383 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3384 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED was specified, but the
3385 * data for some files could not be found in the blob lookup table of @p
3388 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3389 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3390 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3391 * indicate failure (for different reasons) to read the metadata resource for an
3392 * image over which iteration needed to be done.
3395 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3397 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3400 * @ingroup G_wim_information
3402 * Iterate through the blob lookup table of a ::WIMStruct. This can be used to
3403 * directly get a listing of the unique "blobs" contained in a WIM file, which
3404 * are deduplicated over all images.
3406 * Specifically, each listed blob may be from any of the following sources:
3408 * - Metadata blobs, if the ::WIMStruct contains image metadata
3409 * - File blobs from the on-disk WIM file (if any) backing the ::WIMStruct
3410 * - File blobs from files that have been added to the in-memory ::WIMStruct,
3411 * e.g. by using wimlib_add_image()
3412 * - File blobs from external WIMs referenced by
3413 * wimlib_reference_resource_files() or wimlib_reference_resources()
3416 * Pointer to the ::WIMStruct for which to get the blob listing.
3418 * Reserved; set to 0.
3420 * A callback function that will receive each blob.
3422 * An extra parameter that will always be passed to the callback function
3425 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3426 * that was returned from @p cb.
3429 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3430 wimlib_iterate_lookup_table_callback_t cb,
3434 * @ingroup G_nonstandalone_wims
3436 * Join a split WIM into a stand-alone (one-part) WIM.
3439 * An array of strings that gives the filenames of all parts of the split
3440 * WIM. No specific order is required, but all parts must be included with
3443 * Number of filenames in @p swms.
3444 * @param swm_open_flags
3445 * Open flags for the split WIM parts (e.g.
3446 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3447 * @param wim_write_flags
3448 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3449 * be used to write the joined WIM.
3450 * @param output_path
3451 * The path to write the joined WIM file to.
3453 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3454 * may return most error codes that can be returned by wimlib_open_wim() and
3455 * wimlib_write(), as well as the following error codes:
3457 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3458 * The split WIMs do not form a valid WIM because they do not include all
3459 * the parts of the original WIM, there are duplicate parts, or not all the
3460 * parts have the same GUID and compression type.
3462 * Note: wimlib is generalized enough that this function is not actually needed
3463 * to join a split WIM; instead, you could open the first part of the split WIM,
3464 * then reference the other parts with wimlib_reference_resource_files(), then
3465 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3466 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3470 wimlib_join(const wimlib_tchar * const *swms,
3472 const wimlib_tchar *output_path,
3474 int wim_write_flags);
3477 * @ingroup G_nonstandalone_wims
3479 * Same as wimlib_join(), but allows specifying a progress function. The
3480 * progress function will receive the write progress messages, such as
3481 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3482 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3483 * swm_open_flags, the progress function will receive a series of
3484 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3488 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3490 const wimlib_tchar *output_path,
3492 int wim_write_flags,
3493 wimlib_progress_func_t progfunc,
3498 * @ingroup G_mounting_wim_images
3500 * Mount an image from a WIM file on a directory read-only or read-write.
3503 * Pointer to the ::WIMStruct containing the image to be mounted. This
3504 * ::WIMStruct must have a backing file.
3506 * The 1-based index of the image to mount. This image cannot have been
3507 * previously modified in memory.
3509 * The path to an existing empty directory on which to mount the image.
3510 * @param mount_flags
3511 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3512 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3514 * @param staging_dir
3515 * If non-NULL, the name of a directory in which a temporary directory for
3516 * storing modified or added files will be created. Ignored if
3517 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3518 * left @c NULL, the staging directory is created in the same directory as
3519 * the backing WIM file. The staging directory is automatically deleted
3520 * when the image is unmounted.
3522 * @return 0 on success; a ::wimlib_error_code value on failure.
3524 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3525 * Another process is currently modifying the WIM file.
3526 * @retval ::WIMLIB_ERR_FUSE
3527 * A non-zero status code was returned by @c fuse_main().
3528 * @retval ::WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES
3529 * There are currently multiple references to the image as a result of a
3530 * call to wimlib_export_image(). Free one before attempting the
3532 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3533 * @p image does not exist in @p wim.
3534 * @retval ::WIMLIB_ERR_INVALID_PARAM
3535 * @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3536 * unrecognized flag was specified in @p mount_flags; or the image has
3537 * already been modified in memory (e.g. by wimlib_update_image()).
3538 * @retval ::WIMLIB_ERR_MKDIR
3539 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3540 * staging directory could not be created.
3541 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3542 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3543 * WIM file is considered read-only because of any of the reasons mentioned
3544 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3545 * @retval ::WIMLIB_ERR_UNSUPPORTED
3546 * Mounting is not supported in this build of the library.
3548 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3549 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3550 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3551 * indicate failure (for different reasons) to read the metadata resource for
3552 * the image to mount.
3554 * The ability to mount WIM images is implemented using FUSE (Filesystem in
3555 * UserSpacE). Depending on how FUSE is set up on your system, this function
3556 * may work as normal users in addition to the root user.
3558 * Mounting WIM images is not supported if wimlib was configured
3559 * <c>--without-fuse</c>. This includes Windows builds of wimlib;
3560 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3562 * Calling this function daemonizes the process, unless
3563 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3565 * It is safe to mount multiple images from the same WIM file read-only at the
3566 * same time, but only if different ::WIMStruct's are used. It is @b not safe
3567 * to mount multiple images from the same WIM file read-write at the same time.
3569 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3570 * different process.
3573 wimlib_mount_image(WIMStruct *wim,
3575 const wimlib_tchar *dir,
3577 const wimlib_tchar *staging_dir);
3580 * @ingroup G_creating_and_opening_wims
3582 * Open a WIM file and create a ::WIMStruct for it.
3585 * The path to the WIM file to open.
3587 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3589 * On success, a pointer to a new ::WIMStruct backed by the specified
3590 * on-disk WIM file is written to the memory location pointed to by this
3591 * parameter. This ::WIMStruct must be freed using using wimlib_free()
3592 * when finished with it.
3594 * @return 0 on success; a ::wimlib_error_code value on failure.
3596 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3597 * The number of metadata resources found in the WIM did not match the
3598 * image count specified in the WIM header, or the number of <IMAGE>
3599 * elements in the XML data of the WIM did not match the image count
3600 * specified in the WIM header.
3601 * @retval ::WIMLIB_ERR_INTEGRITY
3602 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags, and
3603 * the WIM file failed the integrity check.
3604 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3605 * The library did not recognize the compression chunk size of the WIM as
3606 * valid for its compression type.
3607 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3608 * The library did not recognize the compression type of the WIM.
3609 * @retval ::WIMLIB_ERR_INVALID_HEADER
3610 * The header of the WIM was otherwise invalid.
3611 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3612 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3613 * the WIM contained an integrity table, but the integrity table was
3615 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3616 * The lookup table of the WIM was invalid.
3617 * @retval ::WIMLIB_ERR_INVALID_PARAM
3618 * @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3619 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3620 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3621 * specified in @p open_flags.
3622 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3623 * The file did not begin with the magic characters that identify a WIM
3625 * @retval ::WIMLIB_ERR_OPEN
3626 * Failed to open the WIM file for reading. Some possible reasons: the WIM
3627 * file does not exist, or the calling process does not have permission to
3629 * @retval ::WIMLIB_ERR_READ
3630 * Failed to read data from the WIM file.
3631 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3632 * Unexpected end-of-file while reading data from the WIM file.
3633 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3634 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3635 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3636 * The WIM cannot be opened because it contains encrypted segments. (It
3637 * may be a Windows 8 "ESD" file.)
3638 * @retval ::WIMLIB_ERR_WIM_IS_INCOMPLETE
3639 * The WIM file is not complete (e.g. the program which wrote it was
3640 * terminated before it finished)
3641 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3642 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3643 * considered read-only because of any of the reasons mentioned in the
3644 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3645 * @retval ::WIMLIB_ERR_XML
3646 * The XML data of the WIM was invalid.
3649 wimlib_open_wim(const wimlib_tchar *wim_file,
3651 WIMStruct **wim_ret);
3654 * @ingroup G_creating_and_opening_wims
3656 * Same as wimlib_open_wim(), but allows specifying a progress function and
3657 * progress context. If successful, the progress function will be registered in
3658 * the newly open ::WIMStruct, as if by an automatic call to
3659 * wimlib_register_progress_function(). In addition, if
3660 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, then the
3661 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3662 * messages while checking the WIM file's integrity.
3665 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3667 WIMStruct **wim_ret,
3668 wimlib_progress_func_t progfunc,
3672 * @ingroup G_writing_and_overwriting_wims
3674 * Commit a ::WIMStruct to disk, updating its backing file.
3676 * There are several alternative ways in which changes may be committed:
3678 * 1. Full rebuild: write the updated WIM to a temporary file, then rename the
3679 * temporary file to the original.
3680 * 2. Appending: append updates to the new original WIM file, then overwrite
3681 * its header such that those changes become visible to new readers.
3682 * 3. Compaction: normally should not be used; see
3683 * ::WIMLIB_WRITE_FLAG_UNSAFE_COMPACT for details.
3685 * Append mode is often much faster than a full rebuild, but it wastes some
3686 * amount of space due to leaving "holes" in the WIM file. Because of the
3687 * greater efficiency, wimlib_overwrite() normally defaults to append mode.
3688 * However, ::WIMLIB_WRITE_FLAG_REBUILD can be used to explicitly request a full
3689 * rebuild. In addition, if wimlib_delete_image() has been used on the
3690 * ::WIMStruct, then the default mode switches to rebuild mode, and
3691 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE can be used to explicitly request append
3694 * If this function completes successfully, then no more functions can be called
3695 * on the ::WIMStruct other than wimlib_free(). If you need to continue using
3696 * the WIM file, you must use wimlib_open_wim() to open a new ::WIMStruct for
3700 * Pointer to a ::WIMStruct to commit to its backing file.
3701 * @param write_flags
3702 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3703 * @param num_threads
3704 * The number of threads to use for compressing data, or 0 to have the
3705 * library automatically choose an appropriate number.
3707 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3708 * may return most error codes returned by wimlib_write() as well as the
3709 * following error codes:
3711 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3712 * Another process is currently modifying the WIM file.
3713 * @retval ::WIMLIB_ERR_NO_FILENAME
3714 * @p wim is not backed by an on-disk file. In other words, it is a
3715 * ::WIMStruct created by wimlib_create_new_wim() rather than
3716 * wimlib_open_wim().
3717 * @retval ::WIMLIB_ERR_RENAME
3718 * The temporary file to which the WIM was written could not be renamed to
3719 * the original file.
3720 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3721 * The WIM file is considered read-only because of any of the reasons
3722 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3725 * If a progress function is registered with @p wim, then it will receive the
3726 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3727 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3728 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3731 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3734 * @ingroup G_wim_information
3736 * (Deprecated) Print information about one image, or all images, contained in a
3740 * Pointer to the ::WIMStruct to query. This need not represent a
3741 * standalone WIM (e.g. it could represent part of a split WIM).
3743 * The 1-based index of the image for which to print information, or
3744 * ::WIMLIB_ALL_IMAGES to print information about all images.
3746 * @return This function has no return value. No error checking is done when
3747 * printing the information. If @p image is invalid, an error message is
3750 * This function is deprecated; use wimlib_get_xml_data() or
3751 * wimlib_get_image_property() to query image information instead.
3754 wimlib_print_available_images(const WIMStruct *wim, int image);
3757 * @ingroup G_wim_information
3759 * Print the header of the WIM file (intended for debugging only).
3762 wimlib_print_header(const WIMStruct *wim);
3765 * @ingroup G_nonstandalone_wims
3767 * Reference file data from other WIM files or split WIM parts. This function
3768 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3769 * to load additional file data before calling a function such as
3770 * wimlib_extract_image() that requires the file data to be present.
3773 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3774 * necessarily "standalone". In the case of split WIMs, this should be the
3775 * first part, since only the first part contains the metadata resources.
3776 * In the case of delta WIMs, this should be the delta WIM rather than the
3777 * WIM on which it is based.
3778 * @param resource_wimfiles_or_globs
3779 * Array of paths to WIM files and/or split WIM parts to reference.
3780 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3781 * ref_flags, these are treated as globs rather than literal paths. That
3782 * is, using this function you can specify zero or more globs, each of
3783 * which expands to one or more literal paths.
3785 * Number of entries in @p resource_wimfiles_or_globs.
3787 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3788 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3790 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3791 * pass to internal calls to wimlib_open_wim() on the reference files.
3793 * @return 0 on success; a ::wimlib_error_code value on failure.
3795 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3796 * One of the specified globs did not match any paths (only with both
3797 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3798 * specified in @p ref_flags).
3799 * @retval ::WIMLIB_ERR_READ
3800 * I/O or permissions error while processing a file glob.
3802 * This function can additionally return most values that can be returned by
3803 * wimlib_open_wim().
3806 wimlib_reference_resource_files(WIMStruct *wim,
3807 const wimlib_tchar * const *resource_wimfiles_or_globs,
3813 * @ingroup G_nonstandalone_wims
3815 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3816 * where the caller must open the ::WIMStruct for each referenced file itself.
3819 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3820 * necessarily "standalone". In the case of split WIMs, this should be the
3821 * first part, since only the first part contains the metadata resources.
3822 * @param resource_wims
3823 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3824 * split WIM parts to reference.
3825 * @param num_resource_wims
3826 * Number of entries in @p resource_wims.
3828 * Reserved; must be 0.
3830 * @return 0 on success; a ::wimlib_error_code value on failure.
3833 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3834 unsigned num_resource_wims, int ref_flags);
3837 * @ingroup G_modifying_wims
3839 * Declare that a newly added image is mostly the same as a prior image, but
3840 * captured at a later point in time, possibly with some modifications in the
3841 * intervening time. This is designed to be used in incremental backups of the
3842 * same filesystem or directory tree.
3844 * This function compares the metadata of the directory tree of the newly added
3845 * image against that of the old image. Any files that are present in both the
3846 * newly added image and the old image and have timestamps that indicate they
3847 * haven't been modified are deemed not to have been modified and have their
3848 * checksums copied from the old image. Because of this and because WIM uses
3849 * single-instance streams, such files need not be read from the filesystem when
3850 * the WIM is being written or overwritten. Note that these unchanged files
3851 * will still be "archived" and will be logically present in the new image; the
3852 * optimization is that they don't need to actually be read from the filesystem
3853 * because the WIM already contains them.
3855 * This function is provided to optimize incremental backups. The resulting WIM
3856 * file will still be the same regardless of whether this function is called.
3857 * (This is, however, assuming that timestamps have not been manipulated or
3858 * unmaintained as to trick this function into thinking a file has not been
3859 * modified when really it has. To partly guard against such cases, other
3860 * metadata such as file sizes will be checked as well.)
3862 * This function must be called after adding the new image (e.g. with
3863 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3864 * wimlib_overwrite()).
3867 * Pointer to the ::WIMStruct containing the newly added image.
3869 * The 1-based index in @p wim of the newly added image.
3870 * @param template_wim
3871 * Pointer to the ::WIMStruct containing the template image. This can be,
3872 * but does not have to be, the same ::WIMStruct as @p wim.
3873 * @param template_image
3874 * The 1-based index in @p template_wim of the template image.
3876 * Reserved; must be 0.
3878 * @return 0 on success; a ::wimlib_error_code value on failure.
3880 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3881 * @p new_image does not exist in @p wim or @p template_image does not
3882 * exist in @p template_wim.
3883 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3884 * At least one of @p wim and @p template_wim does not contain image
3885 * metadata; for example, one of them represents a non-first part of a
3887 * @retval ::WIMLIB_ERR_INVALID_PARAM
3888 * Identical values were provided for the template and new image; or @p
3889 * new_image specified an image that had not been modified since opening
3892 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3893 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3894 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3895 * indicate failure (for different reasons) to read the metadata resource for
3896 * the template image.
3899 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3900 WIMStruct *template_wim, int template_image,
3904 * @ingroup G_general
3906 * Register a progress function with a ::WIMStruct.
3909 * The ::WIMStruct for which to register the progress function.
3911 * Pointer to the progress function to register. If the WIM already has a
3912 * progress function registered, it will be replaced with this one. If @p
3913 * NULL, the current progress function (if any) will be unregistered.
3915 * The value which will be passed as the third argument to calls to @p
3919 wimlib_register_progress_function(WIMStruct *wim,
3920 wimlib_progress_func_t progfunc,
3924 * @ingroup G_modifying_wims
3926 * Rename the @p source_path to the @p dest_path in the specified @p image of
3929 * This just builds an appropriate ::wimlib_rename_command and passes it to
3930 * wimlib_update_image().
3933 wimlib_rename_path(WIMStruct *wim, int image,
3934 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3937 * @ingroup G_wim_information
3939 * Translate a string specifying the name or number of an image in the WIM into
3940 * the number of the image. The images are numbered starting at 1.
3943 * Pointer to the ::WIMStruct for a WIM.
3944 * @param image_name_or_num
3945 * A string specifying the name or number of an image in the WIM. If it
3946 * parses to a positive integer, this integer is taken to specify the
3947 * number of the image, indexed starting at 1. Otherwise, it is taken to
3948 * be the name of an image, as given in the XML data for the WIM file. It
3949 * also may be the keyword "all" or the string "*", both of which will
3950 * resolve to ::WIMLIB_ALL_IMAGES.
3952 * There is no way to search for an image actually named "all", "*", or an
3953 * integer number, or an image that has no name. However, you can use
3954 * wimlib_get_image_name() to get the name of any image.
3957 * If the string resolved to a single existing image, the number of that
3958 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3959 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3960 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3961 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3962 * images in @p wim has no name. (Since a WIM may have multiple unnamed
3963 * images, an unnamed image must be specified by index to eliminate the
3967 wimlib_resolve_image(WIMStruct *wim,
3968 const wimlib_tchar *image_name_or_num);
3971 * @ingroup G_general
3973 * Set the file to which the library will print error and warning messages.
3975 * This version of the function takes a C library <c>FILE*</c> opened for
3976 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3977 * file by name instead.
3979 * This also enables error messages, as if by a call to
3980 * wimlib_set_print_errors(true).
3982 * @return 0 on success; a ::wimlib_error_code value on failure.
3984 * @retval ::WIMLIB_ERR_UNSUPPORTED
3985 * wimlib was compiled using the <c>--without-error-messages</c> option.
3988 wimlib_set_error_file(FILE *fp);
3991 * @ingroup G_general
3993 * Set the path to the file to which the library will print error and warning
3994 * messages. The library will open this file for appending.
3996 * This also enables error messages, as if by a call to
3997 * wimlib_set_print_errors(true).
3999 * @return 0 on success; a ::wimlib_error_code value on failure.
4001 * @retval ::WIMLIB_ERR_OPEN
4002 * The file named by @p path could not be opened for appending.
4003 * @retval ::WIMLIB_ERR_UNSUPPORTED
4004 * wimlib was compiled using the <c>--without-error-messages</c> option.
4007 wimlib_set_error_file_by_name(const wimlib_tchar *path);
4010 * @ingroup G_modifying_wims
4012 * Change the description of a WIM image. Equivalent to
4013 * <tt>wimlib_set_image_property(wim, image, "DESCRIPTION", description)</tt>.
4015 * Note that "description" is misspelled in the name of this function.
4018 wimlib_set_image_descripton(WIMStruct *wim, int image,
4019 const wimlib_tchar *description);
4022 * @ingroup G_modifying_wims
4024 * Change what is stored in the \<FLAGS\> element in the WIM XML document
4025 * (usually something like "Core" or "Ultimate"). Equivalent to
4026 * <tt>wimlib_set_image_property(wim, image, "FLAGS", flags)</tt>.
4029 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
4032 * @ingroup G_modifying_wims
4034 * Change the name of a WIM image. Equivalent to
4035 * <tt>wimlib_set_image_property(wim, image, "NAME", name)</tt>.
4038 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
4041 * @ingroup G_modifying_wims
4043 * Since wimlib v1.8.3: add, modify, or remove a per-image property from the
4044 * WIM's XML document. This is an alternative to wimlib_set_image_name(),
4045 * wimlib_set_image_descripton(), and wimlib_set_image_flags() which allows
4046 * manipulating any simple string property.
4049 * Pointer to the ::WIMStruct for the WIM.
4051 * The 1-based index of the image for which to set the property.
4052 * @param property_name
4053 * The name of the image property in the same format documented for
4054 * wimlib_get_image_property().
4056 * Note: if creating a new element using a bracketed index such as
4057 * "WINDOWS/LANGUAGES/LANGUAGE[2]", the highest index that can be specified
4058 * is one greater than the number of existing elements with that same name,
4059 * excluding the index. That means that if you are adding a list of new
4060 * elements, they must be added sequentially from the first index (1) to
4061 * the last index (n).
4062 * @param property_value
4063 * If not NULL and not empty, the property is set to this value.
4064 * Otherwise, the property is removed from the XML document.
4066 * @return 0 on success; a ::wimlib_error_code value on failure.
4068 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
4069 * The user requested to set the image name (the <tt>NAME</tt> property),
4070 * but another image in the WIM already had the requested name.
4071 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4072 * @p image does not exist in @p wim.
4073 * @retval ::WIMLIB_ERR_INVALID_PARAM
4074 * @p property_name has an unsupported format, or @p property_name included
4075 * a bracketed index that was too high.
4078 wimlib_set_image_property(WIMStruct *wim, int image,
4079 const wimlib_tchar *property_name,
4080 const wimlib_tchar *property_value);
4083 * @ingroup G_general
4085 * Set the functions that wimlib uses to allocate and free memory.
4087 * These settings are global and not per-WIM.
4089 * The default is to use the default @c malloc(), @c free(), and @c realloc()
4090 * from the standard C library.
4092 * Note: some external functions, such as those in @c libntfs-3g, may use the
4093 * standard memory allocation functions regardless of this setting.
4095 * @param malloc_func
4096 * A function equivalent to @c malloc() that wimlib will use to allocate
4097 * memory. If @c NULL, the allocator function is set back to the default
4098 * @c malloc() from the C library.
4100 * A function equivalent to @c free() that wimlib will use to free memory.
4101 * If @c NULL, the free function is set back to the default @c free() from
4103 * @param realloc_func
4104 * A function equivalent to @c realloc() that wimlib will use to reallocate
4105 * memory. If @c NULL, the free function is set back to the default @c
4106 * realloc() from the C library.
4111 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
4112 void (*free_func)(void *),
4113 void *(*realloc_func)(void *, size_t));
4116 * @ingroup G_writing_and_overwriting_wims
4118 * Set a ::WIMStruct's output compression chunk size. This is the compression
4119 * chunk size that will be used for writing non-solid resources in subsequent
4120 * calls to wimlib_write() or wimlib_overwrite(). A larger compression chunk
4121 * size often results in a better compression ratio, but compression may be
4122 * slower and the speed of random access to data may be reduced. In addition,
4123 * some chunk sizes are not compatible with Microsoft software.
4126 * The ::WIMStruct for which to set the output chunk size.
4128 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
4129 * on the compression type. See the documentation for each
4130 * ::wimlib_compression_type constant for more information. As a special
4131 * case, if @p chunk_size is specified as 0, then the chunk size will be
4132 * reset to the default for the currently selected output compression type.
4134 * @return 0 on success; a ::wimlib_error_code value on failure.
4136 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
4137 * @p chunk_size was not 0 or a supported chunk size for the currently
4138 * selected output compression type.
4141 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4144 * @ingroup G_writing_and_overwriting_wims
4146 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4150 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4153 * @ingroup G_writing_and_overwriting_wims
4155 * Set a ::WIMStruct's output compression type. This is the compression type
4156 * that will be used for writing non-solid resources in subsequent calls to
4157 * wimlib_write() or wimlib_overwrite().
4160 * The ::WIMStruct for which to set the output compression type.
4162 * The compression type to set. If this compression type is incompatible
4163 * with the current output chunk size, then the output chunk size will be
4164 * reset to the default for the new compression type.
4166 * @return 0 on success; a ::wimlib_error_code value on failure.
4168 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4169 * @p ctype did not specify a valid compression type.
4172 wimlib_set_output_compression_type(WIMStruct *wim,
4173 enum wimlib_compression_type ctype);
4176 * @ingroup G_writing_and_overwriting_wims
4178 * Similar to wimlib_set_output_compression_type(), but set the compression type
4179 * for writing solid resources. This cannot be ::WIMLIB_COMPRESSION_TYPE_NONE.
4182 wimlib_set_output_pack_compression_type(WIMStruct *wim,
4183 enum wimlib_compression_type ctype);
4186 * @ingroup G_general
4188 * Set whether wimlib can print error and warning messages to the error file,
4189 * which defaults to standard error. Error and warning messages may provide
4190 * information that cannot be determined only from returned error codes.
4192 * By default, error messages are not printed.
4194 * This setting applies globally (it is not per-WIM).
4196 * This can be called before wimlib_global_init().
4198 * @param show_messages
4199 * @c true if messages are to be printed; @c false if messages are not to
4202 * @return 0 on success; a ::wimlib_error_code value on failure.
4204 * @retval ::WIMLIB_ERR_UNSUPPORTED
4205 * wimlib was compiled using the <c>--without-error-messages</c> option.
4208 wimlib_set_print_errors(bool show_messages);
4211 * @ingroup G_modifying_wims
4213 * Set basic information about a WIM.
4216 * Pointer to the ::WIMStruct for a WIM.
4218 * Pointer to a ::wimlib_wim_info structure that contains the information
4219 * to set. Only the information explicitly specified in the @p which flags
4222 * Flags that specify which information to set. This is a bitwise OR of
4223 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4224 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4226 * @return 0 on success; a ::wimlib_error_code value on failure.
4228 * @retval ::WIMLIB_ERR_IMAGE_COUNT
4229 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4230 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4234 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4238 * @ingroup G_nonstandalone_wims
4240 * Split a WIM into multiple parts.
4243 * The ::WIMStruct for the WIM to split.
4245 * Name of the split WIM (SWM) file to create. This will be the name of
4246 * the first part. The other parts will, by default, have the same name
4247 * with 2, 3, 4, ..., etc. appended before the suffix. However, the exact
4248 * names can be customized using the progress function.
4250 * The maximum size per part, in bytes. Unfortunately, it is not
4251 * guaranteed that this will really be the maximum size per part, because
4252 * some file resources in the WIM may be larger than this size, and the WIM
4253 * file format provides no way to split up file resources among multiple
4255 * @param write_flags
4256 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4257 * flags will be used to write each split WIM part. Specify 0 here to get
4258 * the default behavior.
4260 * @return 0 on success; a ::wimlib_error_code value on failure. This function
4261 * may return most error codes that can be returned by wimlib_write() as well as
4262 * the following error codes:
4264 * @retval ::WIMLIB_ERR_INVALID_PARAM
4265 * @p swm_name was not a nonempty string, or @p part_size was 0.
4266 * @retval ::WIMLIB_ERR_UNSUPPORTED
4267 * The WIM contains solid resources. Splitting a WIM containing solid
4268 * resources is not supported.
4270 * If a progress function is registered with @p wim, then for each split WIM
4271 * part that is written it will receive the messages
4272 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4273 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4276 wimlib_split(WIMStruct *wim,
4277 const wimlib_tchar *swm_name,
4282 * @ingroup G_general
4284 * Perform verification checks on a WIM file.
4286 * This function is intended for safety checking and/or debugging. If used on a
4287 * well-formed WIM file, it should always succeed.
4290 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4291 * verification, it is a good idea to have used
4292 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4294 * If verifying a split WIM, specify the first part of the split WIM here,
4295 * and reference the other parts using wimlib_reference_resource_files()
4296 * before calling this function.
4297 * @param verify_flags
4298 * Reserved; must be 0.
4300 * @return 0 if the WIM file was successfully verified; a ::wimlib_error_code
4301 * value if it failed verification or another error occurred.
4303 * @retval ::WIMLIB_ERR_DECOMPRESSION
4304 * The WIM file contains invalid compressed data.
4305 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4306 * The metadata resource for an image is invalid.
4307 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4308 * File data stored in the WIM file is corrupt.
4309 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4310 * The data for a file in an image could not be found. See @ref
4311 * G_nonstandalone_wims.
4313 * If a progress function is registered with @p wim, then it will receive the
4314 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4315 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4316 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4319 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4322 * @ingroup G_mounting_wim_images
4324 * Unmount a WIM image that was mounted using wimlib_mount_image().
4326 * When unmounting a read-write mounted image, the default behavior is to
4327 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4328 * image to be committed.
4331 * The directory on which the WIM image is mounted.
4332 * @param unmount_flags
4333 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4335 * @return 0 on success; a ::wimlib_error_code value on failure.
4337 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4338 * There is no WIM image mounted on the specified directory.
4339 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4340 * The read-write mounted image cannot be committed because there are file
4341 * descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4343 * @retval ::WIMLIB_ERR_MQUEUE
4344 * Could not create a POSIX message queue.
4345 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4346 * The image was mounted by a different user.
4347 * @retval ::WIMLIB_ERR_UNSUPPORTED
4348 * Mounting is not supported in this build of the library.
4350 * Note: you can also unmount the image by using the @c umount() system call, or
4351 * by using the @c umount or @c fusermount programs. However, you need to call
4352 * this function if you want changes to be committed.
4355 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4358 * @ingroup G_mounting_wim_images
4360 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4361 * The progress function will receive a ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN
4362 * message. In addition, if changes are committed from a read-write mount, the
4363 * progress function will receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4366 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4368 wimlib_progress_func_t progfunc,
4372 * @ingroup G_modifying_wims
4374 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4377 * Pointer to the ::WIMStruct containing the image to update.
4379 * The 1-based index of the image to update.
4381 * An array of ::wimlib_update_command's that specify the update operations
4384 * Number of commands in @p cmds.
4385 * @param update_flags
4386 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4388 * @return 0 on success; a ::wimlib_error_code value on failure. On failure,
4389 * all update commands will be rolled back, and no visible changes will have
4390 * been made to @p wim.
4392 * @retval ::WIMLIB_ERR_FVE_LOCKED_VOLUME
4393 * Windows-only: One of the "add" commands attempted to add files from an
4394 * encrypted BitLocker volume that hasn't yet been unlocked.
4395 * @retval ::WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES
4396 * There are currently multiple references to the image as a result of a
4397 * call to wimlib_export_image(). Free one before attempting the update.
4398 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4399 * The contents of a capture configuration file were invalid.
4400 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4401 * @p image did not exist in @p wim.
4402 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4403 * An add command with ::WIMLIB_ADD_FLAG_NO_REPLACE specified attempted to
4404 * replace an existing nondirectory file.
4405 * @retval ::WIMLIB_ERR_INVALID_PARAM
4406 * An unknown operation type was provided in the update commands; or
4407 * unknown or incompatible flags were provided in a flags parameter; or
4408 * there was another problem with the provided parameters.
4409 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4410 * While executing an add command, a reparse point had invalid data.
4411 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4412 * An add command attempted to replace a directory with a non-directory; or
4413 * a delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE attempted to
4414 * delete a directory; or a rename command attempted to rename a directory
4415 * to a non-directory.
4416 * @retval ::WIMLIB_ERR_NOTDIR
4417 * An add command attempted to replace a non-directory with a directory; or
4418 * an add command attempted to set the root of the image to a
4419 * non-directory; or a rename command attempted to rename a directory to a
4420 * non-directory; or a component of an image path that was used as a
4421 * directory was not, in fact, a directory.
4422 * @retval ::WIMLIB_ERR_NOTEMPTY
4423 * A rename command attempted to rename a directory to a non-empty
4424 * directory; or a rename command would have created a loop.
4425 * @retval ::WIMLIB_ERR_NTFS_3G
4426 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4427 * error occurred while reading data from the NTFS volume using libntfs-3g.
4428 * @retval ::WIMLIB_ERR_OPEN
4429 * Failed to open a file to be captured while executing an add command.
4430 * @retval ::WIMLIB_ERR_OPENDIR
4431 * Failed to open a directory to be captured while executing an add
4433 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4434 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4435 * WIM path that did not exist; or a rename command attempted to rename a
4436 * file that does not exist.
4437 * @retval ::WIMLIB_ERR_READ
4438 * While executing an add command, failed to read data from a file or
4439 * directory to be captured.
4440 * @retval ::WIMLIB_ERR_READLINK
4441 * While executing an add command, failed to read the target of a symbolic
4442 * link, junction, or other reparse point.
4443 * @retval ::WIMLIB_ERR_STAT
4444 * While executing an add command, failed to read metadata for a file or
4446 * @retval ::WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG
4447 * A capture configuration file could not be read.
4448 * @retval ::WIMLIB_ERR_UNSUPPORTED
4449 * A command had flags provided that are not supported on this platform or
4450 * in this build of the library.
4451 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4452 * An add command with ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified
4453 * discovered a file that was not of a supported type.
4455 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4456 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4457 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4458 * indicate failure (for different reasons) to read the metadata resource for an
4459 * image that needed to be updated.
4462 wimlib_update_image(WIMStruct *wim,
4464 const struct wimlib_update_command *cmds,
4469 * @ingroup G_writing_and_overwriting_wims
4471 * Persist a ::WIMStruct to a new on-disk WIM file.
4473 * This brings in file data from any external locations, such as directory trees
4474 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4475 * wimlib_export_image(), and incorporates it into a new on-disk WIM file.
4477 * By default, the new WIM file is written as stand-alone. Using the
4478 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4479 * instead. However, this function cannot directly write a "split" WIM; use
4480 * wimlib_split() for that.
4483 * Pointer to the ::WIMStruct being persisted.
4485 * The path to the on-disk file to write.
4487 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4488 * images are to be included in the new on-disk WIM file. If for some
4489 * reason you only want to include a single image, specify the 1-based
4490 * index of that image instead.
4491 * @param write_flags
4492 * Bitwise OR of flags prefixed with @c WIMLIB_WRITE_FLAG.
4493 * @param num_threads
4494 * The number of threads to use for compressing data, or 0 to have the
4495 * library automatically choose an appropriate number.
4497 * @return 0 on success; a ::wimlib_error_code value on failure.
4499 * @retval ::WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED
4500 * A file that had previously been scanned for inclusion in the WIM was
4501 * concurrently modified.
4502 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4503 * @p image did not exist in @p wim.
4504 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4505 * A file, stored in another WIM, which needed to be written was corrupt.
4506 * @retval ::WIMLIB_ERR_INVALID_PARAM
4507 * @p path was not a nonempty string, or invalid flags were passed.
4508 * @retval ::WIMLIB_ERR_OPEN
4509 * Failed to open the output WIM file for writing, or failed to open a file
4510 * whose data needed to be included in the WIM.
4511 * @retval ::WIMLIB_ERR_READ
4512 * Failed to read data that needed to be included in the WIM.
4513 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4514 * A file data blob that needed to be written could not be found in the
4515 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
4516 * @retval ::WIMLIB_ERR_WRITE
4517 * An error occurred when trying to write data to the new WIM file.
4519 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4520 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4521 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4522 * indicate failure (for different reasons) to read the data from a WIM file.
4524 * If a progress function is registered with @p wim, then it will receive the
4525 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4526 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4527 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4530 wimlib_write(WIMStruct *wim,
4531 const wimlib_tchar *path,
4534 unsigned num_threads);
4537 * @ingroup G_writing_and_overwriting_wims
4539 * Same as wimlib_write(), but write the WIM directly to a file descriptor,
4540 * which need not be seekable if the write is done in a special pipable WIM
4541 * format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p write_flags. This can,
4542 * for example, allow capturing a WIM image and streaming it over the network.
4543 * See @ref subsec_pipable_wims for more information about pipable WIMs.
4545 * The file descriptor @p fd will @b not be closed when the write is complete;
4546 * the calling code is responsible for this.
4548 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
4549 * error codes include those that can be returned by wimlib_write() as well as
4552 * @retval ::WIMLIB_ERR_INVALID_PARAM
4553 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4554 * specified in @p write_flags.
4557 wimlib_write_to_fd(WIMStruct *wim,
4561 unsigned num_threads);
4564 * @defgroup G_compression Compression and decompression functions
4566 * @brief Functions for XPRESS, LZX, and LZMS compression and decompression.
4568 * These functions are already used by wimlib internally when appropriate for
4569 * reading and writing WIM archives. But they are exported and documented so
4570 * that they can be used in other applications or libraries for general-purpose
4571 * lossless data compression. They are implemented in highly optimized C code,
4572 * using state-of-the-art compression techniques. The main limitation is the
4573 * lack of sliding window support; this has, however, allowed the algorithms to
4574 * be optimized for block-based compression.
4579 /** Opaque compressor handle. */
4580 struct wimlib_compressor;
4582 /** Opaque decompressor handle. */
4583 struct wimlib_decompressor;
4586 * Set the default compression level for the specified compression type. This
4587 * is the compression level that wimlib_create_compressor() assumes if it is
4588 * called with @p compression_level specified as 0.
4590 * wimlib's WIM writing code (e.g. wimlib_write()) will pass 0 to
4591 * wimlib_create_compressor() internally. Therefore, calling this function will
4592 * affect the compression level of any data later written to WIM files using the
4593 * specified compression type.
4595 * The initial state, before this function is called, is that all compression
4596 * types have a default compression level of 50.
4599 * Compression type for which to set the default compression level, as one
4600 * of the ::wimlib_compression_type constants. Or, if this is the special
4601 * value -1, the default compression levels for all compression types will
4603 * @param compression_level
4604 * The default compression level to set. If 0, the "default default" level
4605 * of 50 is restored. Otherwise, a higher value indicates higher
4606 * compression, whereas a lower value indicates lower compression. See
4607 * wimlib_create_compressor() for more information.
4609 * @return 0 on success; a ::wimlib_error_code value on failure.
4611 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4612 * @p ctype was neither a supported compression type nor -1.
4615 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
4618 * Return the approximate number of bytes needed to allocate a compressor with
4619 * wimlib_create_compressor() for the specified compression type, maximum block
4620 * size, and compression level. @p compression_level may be 0, in which case
4621 * the current default compression level for @p ctype is used. Returns 0 if the
4622 * compression type is invalid, or the @p max_block_size for that compression
4626 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4627 size_t max_block_size,
4628 unsigned int compression_level);
4630 #define WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE 0x80000000
4633 * Allocate a compressor for the specified compression type using the specified
4634 * parameters. This function is part of wimlib's compression API; it is not
4635 * necessary to call this to process a WIM file.
4638 * Compression type for which to create the compressor, as one of the
4639 * ::wimlib_compression_type constants.
4640 * @param max_block_size
4641 * The maximum compression block size to support. This specifies the
4642 * maximum allowed value for the @p uncompressed_size parameter of
4643 * wimlib_compress() when called using this compressor.
4645 * Usually, the amount of memory used by the compressor will scale in
4646 * proportion to the @p max_block_size parameter.
4647 * wimlib_get_compressor_needed_memory() can be used to query the specific
4648 * amount of memory that will be required.
4650 * This parameter must be at least 1 and must be less than or equal to a
4651 * compression-type-specific limit.
4653 * In general, the same value of @p max_block_size must be passed to
4654 * wimlib_create_decompressor() when the data is later decompressed.
4655 * However, some compression types have looser requirements regarding this.
4656 * @param compression_level
4657 * The compression level to use. If 0, the default compression level (50,
4658 * or another value as set through wimlib_set_default_compression_level())
4659 * is used. Otherwise, a higher value indicates higher compression. The
4660 * values are scaled so that 10 is low compression, 50 is medium
4661 * compression, and 100 is high compression. This is not a percentage;
4662 * values above 100 are also valid.
4664 * Using a higher-than-default compression level can result in a better
4665 * compression ratio, but can significantly reduce performance. Similarly,
4666 * using a lower-than-default compression level can result in better
4667 * performance, but can significantly worsen the compression ratio. The
4668 * exact results will depend heavily on the compression type and what
4669 * algorithms are implemented for it. If you are considering using a
4670 * non-default compression level, you should run benchmarks to see if it is
4671 * worthwhile for your application.
4673 * The compression level does not affect the format of the compressed data.
4674 * Therefore, it is a compressor-only parameter and does not need to be
4675 * passed to the decompressor.
4677 * Since wimlib v1.8.0, this parameter can be OR-ed with the flag
4678 * ::WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE. This creates the compressor in a
4679 * mode where it is allowed to modify the input buffer. Specifically, in
4680 * this mode, if compression succeeds, the input buffer may have been
4681 * modified, whereas if compression does not succeed the input buffer still
4682 * may have been written to but will have been restored exactly to its
4683 * original state. This mode is designed to save some memory when using
4684 * large buffer sizes.
4685 * @param compressor_ret
4686 * A location into which to return the pointer to the allocated compressor.
4687 * The allocated compressor can be used for any number of calls to
4688 * wimlib_compress() before being freed with wimlib_free_compressor().
4690 * @return 0 on success; a ::wimlib_error_code value on failure.
4692 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4693 * @p ctype was not a supported compression type.
4694 * @retval ::WIMLIB_ERR_INVALID_PARAM
4695 * @p max_block_size was invalid for the compression type, or @p
4696 * compressor_ret was @c NULL.
4697 * @retval ::WIMLIB_ERR_NOMEM
4698 * Insufficient memory to allocate the compressor.
4701 wimlib_create_compressor(enum wimlib_compression_type ctype,
4702 size_t max_block_size,
4703 unsigned int compression_level,
4704 struct wimlib_compressor **compressor_ret);
4707 * Compress a buffer of data.
4709 * @param uncompressed_data
4710 * Buffer containing the data to compress.
4711 * @param uncompressed_size
4712 * Size, in bytes, of the data to compress. This cannot be greater than
4713 * the @p max_block_size with which wimlib_create_compressor() was called.
4714 * (If it is, the data will not be compressed and 0 will be returned.)
4715 * @param compressed_data
4716 * Buffer into which to write the compressed data.
4717 * @param compressed_size_avail
4718 * Number of bytes available in @p compressed_data.
4720 * A compressor previously allocated with wimlib_create_compressor().
4723 * The size of the compressed data, in bytes, or 0 if the data could not be
4724 * compressed to @p compressed_size_avail or fewer bytes.
4727 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4728 void *compressed_data, size_t compressed_size_avail,
4729 struct wimlib_compressor *compressor);
4732 * Free a compressor previously allocated with wimlib_create_compressor().
4735 * The compressor to free. If @c NULL, no action is taken.
4738 wimlib_free_compressor(struct wimlib_compressor *compressor);
4741 * Allocate a decompressor for the specified compression type. This function is
4742 * part of wimlib's compression API; it is not necessary to call this to process
4746 * Compression type for which to create the decompressor, as one of the
4747 * ::wimlib_compression_type constants.
4748 * @param max_block_size
4749 * The maximum compression block size to support. This specifies the
4750 * maximum allowed value for the @p uncompressed_size parameter of
4751 * wimlib_decompress().
4753 * In general, this parameter must be the same as the @p max_block_size
4754 * that was passed to wimlib_create_compressor() when the data was
4755 * compressed. However, some compression types have looser requirements
4757 * @param decompressor_ret
4758 * A location into which to return the pointer to the allocated
4759 * decompressor. The allocated decompressor can be used for any number of
4760 * calls to wimlib_decompress() before being freed with
4761 * wimlib_free_decompressor().
4763 * @return 0 on success; a ::wimlib_error_code value on failure.
4765 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4766 * @p ctype was not a supported compression type.
4767 * @retval ::WIMLIB_ERR_INVALID_PARAM
4768 * @p max_block_size was invalid for the compression type, or @p
4769 * decompressor_ret was @c NULL.
4770 * @retval ::WIMLIB_ERR_NOMEM
4771 * Insufficient memory to allocate the decompressor.
4774 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4775 size_t max_block_size,
4776 struct wimlib_decompressor **decompressor_ret);
4779 * Decompress a buffer of data.
4781 * @param compressed_data
4782 * Buffer containing the data to decompress.
4783 * @param compressed_size
4784 * Size, in bytes, of the data to decompress.
4785 * @param uncompressed_data
4786 * Buffer into which to write the uncompressed data.
4787 * @param uncompressed_size
4788 * Size, in bytes, of the data when uncompressed. This cannot exceed the
4789 * @p max_block_size with which wimlib_create_decompressor() was called.
4790 * (If it does, the data will not be decompressed and a nonzero value will
4792 * @param decompressor
4793 * A decompressor previously allocated with wimlib_create_decompressor().
4795 * @return 0 on success; nonzero on failure.
4797 * No specific error codes are defined; any nonzero value indicates that the
4798 * decompression failed. This can only occur if the data is truly invalid;
4799 * there will never be transient errors like "out of memory", for example.
4801 * This function requires that the exact uncompressed size of the data be passed
4802 * as the @p uncompressed_size parameter. If this is not done correctly,
4803 * decompression may fail or the data may be decompressed incorrectly.
4806 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4807 void *uncompressed_data, size_t uncompressed_size,
4808 struct wimlib_decompressor *decompressor);
4811 * Free a decompressor previously allocated with wimlib_create_decompressor().
4813 * @param decompressor
4814 * The decompressor to free. If @c NULL, no action is taken.
4817 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4829 #endif /* _WIMLIB_H */