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.9.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/gitlist/wimlib/blob/master/README">README
22 * @section sec_installing Installing
26 * Download the source code from https://wimlib.net. Install the library by
27 * running <c>configure && make && sudo make install</c>. See the README for
28 * information about configuration options. To use wimlib in your program after
29 * installing it, include wimlib.h and link your program with <c>-lwim</c>.
33 * Download the Windows binary distribution with the appropriate architecture
34 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from
35 * https://wimlib.net. Link your program with the libwim-15.dll file. Make
36 * sure to also download the source code so you can get wimlib.h, as it is not
37 * included in the binary distribution. If you need to access the DLL from
38 * other programming languages, note that the calling convention is "cdecl".
40 * @section sec_examples Examples
42 * Several examples are located in the "examples" directory of the source
45 * There is also the <a
46 * href="https://wimlib.net/gitlist/wimlib/blob/master/programs/imagex.c">
47 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
48 * capabilities of wimlib.
50 * @section backwards_compatibility Backwards Compatibility
52 * New releases of wimlib are intended to be API/ABI compatible with old
53 * releases, except when the libtool "age" is reset. This most recently
54 * occurred for the v1.4.0 (libwim7), v1.5.0 (libwim9), and v1.7.0 (libwim15)
55 * releases. However, the library is becoming increasingly stable, and the goal
56 * is to maintain the current API/ABI for as long as possible unless there is a
57 * strong reason not to. Even for the v1.7.0 release (libwim15), the changes
58 * were fairly limited.
60 * As with any other library, applications should not rely on internal
61 * implementation details that may be subject to change.
63 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
65 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
66 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
67 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
68 * which creates a new ::WIMStruct that initially contains no images and does
69 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
72 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
73 * Images can be extracted (or "applied") using wimlib_extract_image(), added
74 * (or "captured" or "appended") using wimlib_add_image(), deleted using
75 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
76 * modified using wimlib_update_image(). However, changes made to a WIM
77 * represented by a ::WIMStruct have no persistent effect until the WIM is
78 * actually written to an on-disk file. This can be done using wimlib_write(),
79 * but if the WIM was originally opened using wimlib_open_wim(), then
80 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
81 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
83 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
84 * files is a multi-step process. For example, to add, or "append" an image to
85 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
86 * append</b>, you must call the following functions:
88 * 1. wimlib_open_wim()
89 * 2. wimlib_add_image()
90 * 3. wimlib_overwrite()
92 * This design is very much on purpose as it makes the library more useful in
93 * general by allowing functions to be composed in different ways. For example,
94 * you can make multiple changes to a WIM and commit them all to the backing
95 * file in only one overwrite operation, which is more efficient.
97 * Note: before calling any other function declared in wimlib.h,
98 * wimlib_global_init() can (and in some cases, must) be called. See its
99 * documentation for more details.
101 * @section sec_cleaning_up Cleaning up
103 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
104 * all resources associated with it. Also, when you are completely done with
105 * using wimlib in your program, you can call wimlib_global_cleanup() to free
106 * any other resources allocated by the library.
108 * @section sec_error_handling Error Handling
110 * Most functions in wimlib return 0 on success and a positive
111 * ::wimlib_error_code value on failure. Use wimlib_get_error_string() to get a
112 * string that describes an error code. wimlib also can print error messages to
113 * standard error itself when an error happens, and these may be more
114 * informative than the error code; to enable this, call
115 * wimlib_set_print_errors(). Please note that this is for convenience only,
116 * and some errors can occur without a message being printed. Currently, error
117 * messages and strings (as well as all documentation, for that matter) are only
118 * available in English.
120 * @section sec_encodings Locales and character encodings
122 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
123 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
126 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
127 * and the encoding is UTF-16LE.
129 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
130 * and the encoding is the locale-dependent multibyte encoding. I recommend you
131 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
132 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
133 * call wimlib_global_init() after having set your desired locale.
135 * @section sec_advanced Additional information and features
138 * @subsection subsec_mounting_wim_images Mounting WIM images
140 * See @ref G_mounting_wim_images.
142 * @subsection subsec_progress_functions Progress Messages
144 * See @ref G_progress.
146 * @subsection subsec_non_standalone_wims Non-standalone WIMs
148 * See @ref G_nonstandalone_wims.
150 * @subsection subsec_pipable_wims Pipable WIMs
152 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
153 * compatible with Microsoft's software. To create a pipable WIM, call
154 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
155 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
156 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
157 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
158 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
159 * s using a seekable file descriptor using the regular function calls (e.g.
160 * wimlib_open_wim(), wimlib_extract_image()).
162 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
163 * capture</b> for more information about pipable WIMs.
165 * @subsection subsec_thread_safety Thread Safety
167 * A ::WIMStruct is not thread-safe and cannot be accessed by multiple threads
168 * concurrently, even for "read-only" operations such as extraction. However,
169 * users are free to use <i>different</i> ::WIMStruct's from different threads
170 * concurrently. It is even allowed for multiple ::WIMStruct's to be backed by
171 * the same on-disk WIM file, although "overwrites" should never be done in such
174 * In addition, several functions change global state and should only be called
175 * when a single thread is active in the library. These functions are:
177 * - wimlib_global_init()
178 * - wimlib_global_cleanup()
179 * - wimlib_set_memory_allocator()
180 * - wimlib_set_print_errors()
181 * - wimlib_set_error_file()
182 * - wimlib_set_error_file_by_name()
184 * @subsection subsec_limitations Limitations
186 * This section documents some technical limitations of wimlib not already
187 * described in the documentation for @b wimlib-imagex.
189 * - The old WIM format from Vista pre-releases is not supported.
190 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
191 * functionality other than that already present in @b ImageX, that allows you
192 * to make certain Windows-specific modifications to a Windows PE image, such
193 * as adding a driver or Windows component. Such a tool could be implemented
196 * @subsection more_info More information
198 * You are advised to read the README as well as the documentation for
199 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
200 * the API documentation.
203 /** @defgroup G_general General
205 * @brief Declarations and structures shared across the library.
208 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
210 * @brief Open an existing WIM file as a ::WIMStruct, or create a new
211 * ::WIMStruct which can be used to create a new WIM file.
214 /** @defgroup G_wim_information Retrieving WIM information and directory listings
216 * @brief Retrieve information about a WIM or WIM image.
219 /** @defgroup G_modifying_wims Modifying WIMs
221 * @brief Make changes to a ::WIMStruct, in preparation of persisting the
222 * ::WIMStruct to an on-disk file.
224 * @section sec_adding_images Capturing and adding WIM images
226 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
227 * appending an image to an existing WIM is a multi-step process, but at its
228 * core is wimlib_add_image() or an equivalent function. Normally,
229 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
230 * ::WIMStruct as a new image. However, when supported by the build of the
231 * library, there is also a special NTFS volume capture mode (entered when
232 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
233 * from an unmounted NTFS volume.
235 * Another function, wimlib_add_image_multisource() is also provided. It
236 * generalizes wimlib_add_image() to allow combining multiple files or directory
237 * trees into a single WIM image in a configurable way.
239 * For maximum customization of WIM image creation, it is also possible to add a
240 * completely empty WIM image with wimlib_add_empty_image(), then update it with
241 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
242 * wimlib_add_image_multisource() do internally.)
244 * Note that some details of how image addition/capture works are documented
245 * more fully in the documentation for <b>wimlib-imagex capture</b>.
247 * @section sec_deleting_images Deleting WIM images
249 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
250 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
251 * be made persistent in an on-disk WIM file.
253 * @section sec_exporting_images Exporting WIM images
255 * wimlib_export_image() can copy, or "export", an image from one WIM to
258 * @section sec_other_modifications Other modifications
260 * wimlib_update_image() can add, delete, and rename files in a WIM image.
262 * wimlib_set_image_name(), wimlib_set_image_descripton(),
263 * wimlib_set_image_flags(), and wimlib_set_image_property() can change other
266 * wimlib_set_wim_info() can change information about the WIM file itself, such
270 /** @defgroup G_extracting_wims Extracting WIMs
272 * @brief Extract files, directories, and images from a WIM.
274 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
275 * represented by a ::WIMStruct. This normally extracts the image to a
276 * directory, but when supported by the build of the library there is also a
277 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
278 * is specified) that allows extracting a WIM image directly to an unmounted
279 * NTFS volume. Various other flags allow further customization of image
282 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
283 * of (possibly wildcard) paths from a WIM image.
285 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
286 * over a pipe; see @ref subsec_pipable_wims.
288 * Some details of how WIM extraction works are described more fully in the
289 * documentation for <b>wimlib-imagex apply</b> and <b>wimlib-imagex
293 /** @defgroup G_mounting_wim_images Mounting WIM images
295 * @brief Mount and unmount WIM images.
297 * On Linux, wimlib supports mounting images from WIM files either read-only or
298 * read-write. To mount an image, call wimlib_mount_image(). To unmount an
299 * image, call wimlib_unmount_image(). Mounting can be done without root
300 * privileges because it is implemented using FUSE (Filesystem in Userspace).
302 * If wimlib is compiled using the <c>--without-fuse</c> flag, these functions
303 * will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
305 * Note: if mounting is unsupported, wimlib still provides another way to modify
306 * a WIM image (wimlib_update_image()).
310 * @defgroup G_progress Progress Messages
312 * @brief Track the progress of long WIM operations.
314 * Library users can provide a progress function which will be called
315 * periodically during operations such as extracting a WIM image or writing a
316 * WIM image. A ::WIMStruct can have a progress function of type
317 * ::wimlib_progress_func_t associated with it by calling
318 * wimlib_register_progress_function() or by opening the ::WIMStruct using
319 * wimlib_open_wim_with_progress(). Once this is done, the progress function
320 * will be called automatically during many operations, such as
321 * wimlib_extract_image() and wimlib_write().
323 * Some functions that do not operate directly on a user-provided ::WIMStruct,
324 * such as wimlib_join(), also take the progress function directly using an
325 * extended version of the function, such as wimlib_join_with_progress().
327 * In wimlib v1.7.0 and later, progress functions are no longer just
328 * unidirectional. You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
329 * the current operation to be aborted. wimlib v1.7.0 also added the third
330 * argument to ::wimlib_progress_func_t, which is a user-supplied context.
333 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
335 * @brief Create or update an on-disk WIM file.
337 * wimlib_write() creates a new on-disk WIM file, whereas wimlib_overwrite()
338 * updates an existing WIM file. See @ref sec_basic_wim_handling_concepts for
339 * more information about the API design.
342 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
344 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
346 * A ::WIMStruct backed by an on-disk file normally represents a fully
347 * standalone WIM archive. However, WIM archives can also be arranged in
348 * non-standalone ways, such as a set of on-disk files that together form a
349 * single "split WIM" or "delta WIM". Such arrangements are fully supported by
350 * wimlib. However, as a result, in such cases a ::WIMStruct created from one
351 * of these on-disk files initially only partially represents the full WIM and
352 * needs to, in effect, be logically combined with other ::WIMStruct's before
353 * performing certain operations, such as extracting files with
354 * wimlib_extract_image() or wimlib_extract_paths(). This is done by calling
355 * wimlib_reference_resource_files() or wimlib_reference_resources(). Note: if
356 * you fail to do so, you may see the error code
357 * ::WIMLIB_ERR_RESOURCE_NOT_FOUND; this just indicates that data is not
358 * available because the appropriate WIM files have not yet been referenced.
360 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
361 * specialized function (wimlib_split()) is needed to create a split WIM.
370 #include <inttypes.h>
373 /** @addtogroup G_general
376 /** Major version of the library (for example, the 1 in 1.2.5). */
377 #define WIMLIB_MAJOR_VERSION 1
379 /** Minor version of the library (for example, the 2 in 1.2.5). */
380 #define WIMLIB_MINOR_VERSION 9
382 /** Patch version of the library (for example, the 5 in 1.2.5). */
383 #define WIMLIB_PATCH_VERSION 0
390 * Opaque structure that represents a WIM, possibly backed by an on-disk file.
391 * See @ref sec_basic_wim_handling_concepts for more information.
393 #ifndef WIMLIB_WIMSTRUCT_DECLARED
394 typedef struct WIMStruct WIMStruct;
395 #define WIMLIB_WIMSTRUCT_DECLARED
399 typedef wchar_t wimlib_tchar;
401 /** See @ref sec_encodings */
402 typedef char wimlib_tchar;
406 /** Path separator for WIM paths passed back to progress callbacks.
407 * This is forward slash on UNIX and backslash on Windows. */
408 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
409 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
411 /** Path separator for WIM paths passed back to progress callbacks.
412 * This is forward slash on UNIX and backslash on Windows. */
413 # define WIMLIB_WIM_PATH_SEPARATOR '/'
414 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
417 /** Use this to specify the root directory of the WIM image. */
418 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
420 /** Use this to test if the specified path refers to the root directory of the
422 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
423 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
426 /** Length of a Globally Unique Identifier (GUID), in bytes. */
427 #define WIMLIB_GUID_LEN 16
430 * Specifies a compression type.
432 * A WIM file has a default compression type, indicated by its file header.
433 * Normally, each resource in the WIM file is compressed with this compression
434 * type. However, resources may be stored as uncompressed; for example, wimlib
435 * may do so if a resource does not compress to less than its original size. In
436 * addition, a WIM with the new version number of 3584, or "ESD file", might
437 * contain solid resources with different compression types.
439 enum wimlib_compression_type {
443 * This is a valid argument to wimlib_create_new_wim() and
444 * wimlib_set_output_compression_type(), but not to the functions in the
445 * compression API such as wimlib_create_compressor().
447 WIMLIB_COMPRESSION_TYPE_NONE = 0,
450 * The XPRESS compression format. This format combines Lempel-Ziv
451 * factorization with Huffman encoding. Compression and decompression
452 * are both fast. This format supports chunk sizes that are powers of 2
453 * between <c>2^12</c> and <c>2^16</c>, inclusively.
455 * wimlib's XPRESS compressor will, with the default settings, usually
456 * produce a better compression ratio, and work more quickly, than the
457 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
458 * Non-default compression levels are also supported. For example,
459 * level 80 will enable two-pass optimal parsing, which is significantly
460 * slower but usually improves compression by several percent over the
461 * default level of 50.
463 * If using wimlib_create_compressor() to create an XPRESS compressor
464 * directly, the @p max_block_size parameter may be any positive value
465 * up to and including <c>2^16</c>.
467 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
470 * The LZX compression format. This format combines Lempel-Ziv
471 * factorization with Huffman encoding, but with more features and
472 * complexity than XPRESS. Compression is slow to somewhat fast,
473 * depending on the settings. Decompression is fast but slower than
474 * XPRESS. This format supports chunk sizes that are powers of 2
475 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
476 * other than <c>2^15</c> are not compatible with the Microsoft
479 * wimlib's LZX compressor will, with the default settings, usually
480 * produce a better compression ratio, and work more quickly, than the
481 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
482 * Non-default compression levels are also supported. For example,
483 * level 20 will provide fast compression, almost as fast as XPRESS.
485 * If using wimlib_create_compressor() to create an LZX compressor
486 * directly, the @p max_block_size parameter may be any positive value
487 * up to and including <c>2^21</c>.
489 WIMLIB_COMPRESSION_TYPE_LZX = 2,
492 * The LZMS compression format. This format combines Lempel-Ziv
493 * factorization with adaptive Huffman encoding and range coding.
494 * Compression and decompression are both fairly slow. This format
495 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
496 * <c>2^30</c>, inclusively. This format is best used for large chunk
497 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
498 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
499 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
500 * with the Microsoft implementation.
502 * wimlib's LZMS compressor will, with the default settings, usually
503 * produce a better compression ratio, and work more quickly, than the
504 * implementation in Microsoft's WIMGAPI (as of Windows 8.1). There is
505 * limited support for non-default compression levels, but compression
506 * will be noticeably faster if you choose a level < 35.
508 * If using wimlib_create_compressor() to create an LZMS compressor
509 * directly, the @p max_block_size parameter may be any positive value
510 * up to and including <c>2^30</c>.
512 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
516 /** @addtogroup G_progress
519 /** Possible values of the first parameter to the user-supplied
520 * ::wimlib_progress_func_t progress function */
521 enum wimlib_progress_msg {
523 /** A WIM image is about to be extracted. @p info will point to
524 * ::wimlib_progress_info.extract. This message is received once per
525 * image for calls to wimlib_extract_image() and
526 * wimlib_extract_image_from_pipe(). */
527 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
529 /** One or more file or directory trees within a WIM image is about to
530 * be extracted. @p info will point to ::wimlib_progress_info.extract.
531 * This message is received only once per wimlib_extract_paths() and
532 * wimlib_extract_pathlist(), since wimlib combines all paths into a
533 * single extraction operation for optimization purposes. */
534 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
536 /** This message may be sent periodically (not for every file) while
537 * files and directories are being created, prior to file data
538 * extraction. @p info will point to ::wimlib_progress_info.extract.
539 * In particular, the @p current_file_count and @p end_file_count
540 * members may be used to track the progress of this phase of
542 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
544 /** File data is currently being extracted. @p info will point to
545 * ::wimlib_progress_info.extract. This is the main message to track
546 * the progress of an extraction operation. */
547 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
549 /** Starting to read a new part of a split pipable WIM over the pipe.
550 * @p info will point to ::wimlib_progress_info.extract. */
551 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
553 /** This message may be sent periodically (not necessarily for every
554 * file) while file and directory metadata is being extracted, following
555 * file data extraction. @p info will point to
556 * ::wimlib_progress_info.extract. The @p current_file_count and @p
557 * end_file_count members may be used to track the progress of this
558 * phase of extraction. */
559 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
561 /** The image has been successfully extracted. @p info will point to
562 * ::wimlib_progress_info.extract. This is paired with
563 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
564 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
566 /** The files or directory trees have been successfully extracted. @p
567 * info will point to ::wimlib_progress_info.extract. This is paired
568 * with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
569 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
571 /** The directory or NTFS volume is about to be scanned for metadata.
572 * @p info will point to ::wimlib_progress_info.scan. This message is
573 * received once per call to wimlib_add_image(), or once per capture
574 * source passed to wimlib_add_image_multisource(), or once per add
575 * command passed to wimlib_update_image(). */
576 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
578 /** A directory or file has been scanned. @p info will point to
579 * ::wimlib_progress_info.scan, and its @p cur_path member will be
580 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
582 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
584 /** The directory or NTFS volume has been successfully scanned. @p info
585 * will point to ::wimlib_progress_info.scan. This is paired with a
586 * previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message, possibly with many
587 * intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY messages. */
588 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
590 /** File data is currently being written to the WIM. @p info will point
591 * to ::wimlib_progress_info.write_streams. This message may be
592 * received many times while the WIM file is being written or appended
593 * to with wimlib_write(), wimlib_overwrite(), or wimlib_write_to_fd().
595 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
597 /** Per-image metadata is about to be written to the WIM file. @p info
598 * will not be valid. */
599 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
601 /** The per-image metadata has been written to the WIM file. @p info
602 * will not be valid. This message is paired with a preceding
603 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message. */
604 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
606 /** wimlib_overwrite() has successfully renamed the temporary file to
607 * the original WIM file, thereby committing the changes to the WIM
608 * file. @p info will point to ::wimlib_progress_info.rename. Note:
609 * this message is not received if wimlib_overwrite() chose to append to
610 * the WIM file in-place. */
611 WIMLIB_PROGRESS_MSG_RENAME = 15,
613 /** The contents of the WIM file are being checked against the integrity
614 * table. @p info will point to ::wimlib_progress_info.integrity. This
615 * message is only received (and may be received many times) when
616 * wimlib_open_wim_with_progress() is called with the
617 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
618 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
620 /** An integrity table is being calculated for the WIM being written.
621 * @p info will point to ::wimlib_progress_info.integrity. This message
622 * is only received (and may be received many times) when a WIM file is
623 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
624 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
626 /** A wimlib_split() operation is in progress, and a new split part is
627 * about to be started. @p info will point to
628 * ::wimlib_progress_info.split. */
629 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
631 /** A wimlib_split() operation is in progress, and a split part has been
632 * finished. @p info will point to ::wimlib_progress_info.split. */
633 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
635 /** A WIM update command is about to be executed. @p info will point to
636 * ::wimlib_progress_info.update. This message is received once per
637 * update command when wimlib_update_image() is called with the flag
638 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
639 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
641 /** A WIM update command has been executed. @p info will point to
642 * ::wimlib_progress_info.update. This message is received once per
643 * update command when wimlib_update_image() is called with the flag
644 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
645 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
647 /** A file in the WIM image is being replaced as a result of a
648 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
649 * @p info will point to ::wimlib_progress_info.replace. This is only
650 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
652 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
654 /** A WIM image is being extracted with ::WIMLIB_EXTRACT_FLAG_WIMBOOT,
655 * and a file is being extracted normally (not as a "WIMBoot pointer
656 * file") due to it matching a pattern in the <c>[PrepopulateList]</c>
657 * section of the configuration file
658 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image. @p
659 * info will point to ::wimlib_progress_info.wimboot_exclude. */
660 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
662 /** Starting to unmount a WIM image. @p info will point to
663 * ::wimlib_progress_info.unmount. */
664 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
666 /** wimlib has used a file's data for the last time (including all data
667 * streams, if it has multiple). @p info will point to
668 * ::wimlib_progress_info.done_with_file. This message is only received
669 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
670 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
672 /** wimlib_verify_wim() is starting to verify the metadata for an image.
673 * @p info will point to ::wimlib_progress_info.verify_image. */
674 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
676 /** wimlib_verify_wim() has finished verifying the metadata for an
677 * image. @p info will point to ::wimlib_progress_info.verify_image.
679 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
681 /** wimlib_verify_wim() is verifying file data integrity. @p info will
682 * point to ::wimlib_progress_info.verify_streams. */
683 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
686 * The progress function is being asked whether a file should be
687 * excluded from capture or not. @p info will point to
688 * ::wimlib_progress_info.test_file_exclusion. This is a bidirectional
689 * message that allows the progress function to set a flag if the file
690 * should be excluded.
692 * This message is only received if the flag
693 * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used. This method for file
694 * exclusions is independent of the "capture configuration file"
697 WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
700 * An error has occurred and the progress function is being asked
701 * whether to ignore the error or not. @p info will point to
702 * ::wimlib_progress_info.handle_error. This is a bidirectional
705 * This message provides a limited capability for applications to
706 * recover from "unexpected" errors (i.e. those with no in-library
707 * handling policy) arising from the underlying operating system.
708 * Normally, any such error will cause the library to abort the current
709 * operation. By implementing a handler for this message, the
710 * application can instead choose to ignore a given error.
712 * Currently, only the following types of errors will result in this
713 * progress message being sent:
715 * - Directory tree scan errors, e.g. from wimlib_add_image()
716 * - Most extraction errors; currently restricted to the Windows
717 * build of the library only.
719 WIMLIB_PROGRESS_MSG_HANDLE_ERROR = 31,
722 /** Valid return values from user-provided progress functions
723 * (::wimlib_progress_func_t).
725 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
728 enum wimlib_progress_status {
730 /** The operation should be continued. This is the normal return value.
732 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
734 /** The operation should be aborted. This will cause the current
735 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
736 WIMLIB_PROGRESS_STATUS_ABORT = 1,
740 * A pointer to this union is passed to the user-supplied
741 * ::wimlib_progress_func_t progress function. One (or none) of the structures
742 * contained in this union will be applicable for the operation
743 * (::wimlib_progress_msg) indicated in the first argument to the progress
745 union wimlib_progress_info {
747 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
748 * the primary message for tracking the progress of writing a WIM file.
750 struct wimlib_progress_info_write_streams {
752 /** An upper bound on the number of bytes of file data that will
753 * be written. This number is the uncompressed size; the actual
754 * size may be lower due to compression. In addition, this
755 * number may decrease over time as duplicated file data is
757 uint64_t total_bytes;
759 /** An upper bound on the number of distinct file data "blobs"
760 * that will be written. This will often be similar to the
761 * "number of files", but for several reasons (hard links, named
762 * data streams, empty files, etc.) it can be different. In
763 * addition, this number may decrease over time as duplicated
764 * file data is discovered. */
765 uint64_t total_streams;
767 /** The number of bytes of file data that have been written so
768 * far. This starts at 0 and ends at @p total_bytes. This
769 * number is the uncompressed size; the actual size may be lower
770 * due to compression. */
771 uint64_t completed_bytes;
773 /** The number of distinct file data "blobs" that have been
774 * written so far. This starts at 0 and ends at @p
776 uint64_t completed_streams;
778 /** The number of threads being used for data compression; or,
779 * if no compression is being performed, this will be 1. */
780 uint32_t num_threads;
782 /** The compression type being used, as one of the
783 * ::wimlib_compression_type constants. */
784 int32_t compression_type;
786 /** The number of on-disk WIM files from which file data is
787 * being exported into the output WIM file. This can be 0, 1,
788 * or more than 1, depending on the situation. */
789 uint32_t total_parts;
791 /** This is currently broken and will always be 0. */
792 uint32_t completed_parts;
795 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
796 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
797 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
798 struct wimlib_progress_info_scan {
800 /** Top-level directory being scanned; or, when capturing an NTFS
801 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
802 * to the file or block device that contains the NTFS volume
804 const wimlib_tchar *source;
806 /** Path to the file (or directory) that has been scanned, valid
807 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
808 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
809 * relative to the root of the NTFS volume. */
810 const wimlib_tchar *cur_path;
812 /** Dentry scan status, valid on
813 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
815 /** File looks okay and will be captured. */
816 WIMLIB_SCAN_DENTRY_OK = 0,
818 /** File is being excluded from capture due to the
819 * capture configuration. */
820 WIMLIB_SCAN_DENTRY_EXCLUDED,
822 /** File is being excluded from capture due to being of
823 * an unsupported type. */
824 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
826 /** The file is an absolute symbolic link or junction
827 * that points into the capture directory, and
828 * reparse-point fixups are enabled, so its target is
829 * being adjusted. (Reparse point fixups can be
830 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
832 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
834 /** Reparse-point fixups are enabled, but the file is an
835 * absolute symbolic link or junction that does
836 * <b>not</b> point into the capture directory, so its
837 * target is <b>not</b> being adjusted. */
838 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
842 /** Target path in the WIM image. Only valid on
843 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
844 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
845 const wimlib_tchar *wim_target_path;
847 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
848 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
849 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
850 * target of the absolute symbolic link or junction. */
851 const wimlib_tchar *symlink_target;
854 /** The number of directories scanned so far, not counting
855 * excluded/unsupported files. */
856 uint64_t num_dirs_scanned;
858 /** The number of non-directories scanned so far, not counting
859 * excluded/unsupported files. */
860 uint64_t num_nondirs_scanned;
862 /** The number of bytes of file data detected so far, not
863 * counting excluded/unsupported files. */
864 uint64_t num_bytes_scanned;
867 /** Valid on messages
868 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
869 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
870 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
871 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
872 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
873 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
874 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
875 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
877 * Note: most of the time of an extraction operation will be spent
878 * extracting file data, and the application will receive
879 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
880 * completed_bytes and @p total_bytes, the application can calculate a
881 * percentage complete. However, there is no way for applications to
882 * know which file is currently being extracted. This is by design
883 * because the best way to complete the extraction operation is not
884 * necessarily file-by-file.
886 struct wimlib_progress_info_extract {
888 /** The 1-based index of the image from which files are being
892 /** Extraction flags being used. */
893 uint32_t extract_flags;
895 /** If the ::WIMStruct from which the extraction being performed
896 * has a backing file, then this is an absolute path to that
897 * backing file. Otherwise, this is @c NULL. */
898 const wimlib_tchar *wimfile_name;
900 /** Name of the image from which files are being extracted, or
901 * the empty string if the image is unnamed. */
902 const wimlib_tchar *image_name;
904 /** Path to the directory or NTFS volume to which the files are
905 * being extracted. */
906 const wimlib_tchar *target;
909 const wimlib_tchar *reserved;
911 /** The number of bytes of file data that will be extracted. */
912 uint64_t total_bytes;
914 /** The number of bytes of file data that have been extracted so
915 * far. This starts at 0 and ends at @p total_bytes. */
916 uint64_t completed_bytes;
918 /** The number of file streams that will be extracted. This
919 * will often be similar to the "number of files", but for
920 * several reasons (hard links, named data streams, empty files,
921 * etc.) it can be different. */
922 uint64_t total_streams;
924 /** The number of file streams that have been extracted so far.
925 * This starts at 0 and ends at @p total_streams. */
926 uint64_t completed_streams;
928 /** Currently only used for
929 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
930 uint32_t part_number;
932 /** Currently only used for
933 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
934 uint32_t total_parts;
936 /** Currently only used for
937 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
938 uint8_t guid[WIMLIB_GUID_LEN];
940 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
941 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
942 * number of files that have been processed so far. Once the
943 * corresponding phase of extraction is complete, this value
944 * will be equal to @c end_file_count. */
945 uint64_t current_file_count;
947 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
948 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
949 * total number of files that will be processed.
951 * This number is provided for informational purposes only, e.g.
952 * for a progress bar. This number will not necessarily be
953 * equal to the number of files actually being extracted. This
954 * is because extraction backends are free to implement an
955 * extraction algorithm that might be more efficient than
956 * processing every file in the "extract file structure" and
957 * "extract file metadata" phases. For example, the current
958 * implementation of the UNIX extraction backend will create
959 * files on-demand during the "extract file data" phase.
960 * Therefore, when using that particular extraction backend, @p
961 * end_file_count will only include directories and empty files.
963 uint64_t end_file_count;
966 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
967 struct wimlib_progress_info_rename {
968 /** Name of the temporary file that the WIM was written to. */
969 const wimlib_tchar *from;
971 /** Name of the original WIM file to which the temporary file is
973 const wimlib_tchar *to;
976 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
977 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
978 struct wimlib_progress_info_update {
979 /** Pointer to the update command that will be executed or has
980 * just been executed. */
981 const struct wimlib_update_command *command;
983 /** Number of update commands that have been completed so far.
985 size_t completed_commands;
987 /** Number of update commands that are being executed as part of
988 * this call to wimlib_update_image(). */
989 size_t total_commands;
992 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
993 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
994 struct wimlib_progress_info_integrity {
996 /** The number of bytes in the WIM file that are covered by
997 * integrity checks. */
998 uint64_t total_bytes;
1000 /** The number of bytes that have been checksummed so far. This
1001 * starts at 0 and ends at @p total_bytes. */
1002 uint64_t completed_bytes;
1004 /** The number of individually checksummed "chunks" the
1005 * integrity-checked region is divided into. */
1006 uint32_t total_chunks;
1008 /** The number of chunks that have been checksummed so far.
1009 * This starts at 0 and ends at @p total_chunks. */
1010 uint32_t completed_chunks;
1012 /** The size of each individually checksummed "chunk" in the
1013 * integrity-checked region. */
1014 uint32_t chunk_size;
1016 /** For ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages, this is
1017 * the path to the WIM file being checked. */
1018 const wimlib_tchar *filename;
1021 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1022 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1023 struct wimlib_progress_info_split {
1024 /** Total size of the original WIM's file and metadata resources
1026 uint64_t total_bytes;
1028 /** Number of bytes of file and metadata resources that have
1029 * been copied out of the original WIM so far. Will be 0
1030 * initially, and equal to @p total_bytes at the end. */
1031 uint64_t completed_bytes;
1033 /** Number of the split WIM part that is about to be started
1034 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1035 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1036 unsigned cur_part_number;
1038 /** Total number of split WIM parts that are being written. */
1039 unsigned total_parts;
1041 /** Name of the split WIM part that is about to be started
1042 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1043 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1044 * As of wimlib v1.7.0, the library user may change this when
1045 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1046 * cause the next split WIM part to be written to a different
1048 wimlib_tchar *part_name;
1051 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1052 struct wimlib_progress_info_replace {
1053 /** Path to the file in the WIM image that is being replaced */
1054 const wimlib_tchar *path_in_wim;
1057 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1058 struct wimlib_progress_info_wimboot_exclude {
1059 /** Path to the file in the WIM image */
1060 const wimlib_tchar *path_in_wim;
1062 /** Path to which the file is being extracted */
1063 const wimlib_tchar *extraction_path;
1066 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1067 struct wimlib_progress_info_unmount {
1068 /** Path to directory being unmounted */
1069 const wimlib_tchar *mountpoint;
1071 /** Path to WIM file being unmounted */
1072 const wimlib_tchar *mounted_wim;
1074 /** 1-based index of image being unmounted. */
1075 uint32_t mounted_image;
1077 /** Flags that were passed to wimlib_mount_image() when the
1078 * mountpoint was set up. */
1079 uint32_t mount_flags;
1081 /** Flags passed to wimlib_unmount_image(). */
1082 uint32_t unmount_flags;
1085 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1086 struct wimlib_progress_info_done_with_file {
1088 * Path to the file whose data has been written to the WIM file,
1089 * or is currently being asynchronously compressed in memory,
1090 * and therefore is no longer needed by wimlib.
1092 * WARNING: The file data will not actually be accessible in the
1093 * WIM file until the WIM file has been completely written.
1094 * Ordinarily you should <b>not</b> treat this message as a
1095 * green light to go ahead and delete the specified file, since
1096 * that would result in data loss if the WIM file cannot be
1097 * successfully created for any reason.
1099 * If a file has multiple names (hard links),
1100 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1101 * for one name. Also, this message will not be received for
1102 * empty files or reparse points (or symbolic links), unless
1103 * they have nonempty named data streams.
1105 const wimlib_tchar *path_to_file;
1108 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1109 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1110 struct wimlib_progress_info_verify_image {
1111 const wimlib_tchar *wimfile;
1112 uint32_t total_images;
1113 uint32_t current_image;
1116 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1117 struct wimlib_progress_info_verify_streams {
1118 const wimlib_tchar *wimfile;
1119 uint64_t total_streams;
1120 uint64_t total_bytes;
1121 uint64_t completed_streams;
1122 uint64_t completed_bytes;
1125 /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION. */
1126 struct wimlib_progress_info_test_file_exclusion {
1129 * Path to the file for which exclusion is being tested.
1131 * UNIX capture mode: The path will be a standard relative or
1132 * absolute UNIX filesystem path.
1134 * NTFS-3g capture mode: The path will be given relative to the
1135 * root of the NTFS volume, with a leading slash.
1137 * Windows capture mode: The path will be a Win32 namespace
1140 const wimlib_tchar *path;
1143 * Indicates whether the file or directory will be excluded from
1144 * capture or not. This will be <c>false</c> by default. The
1145 * progress function can set this to <c>true</c> if it decides
1146 * that the file needs to be excluded.
1149 } test_file_exclusion;
1151 /** Valid on messages ::WIMLIB_PROGRESS_MSG_HANDLE_ERROR. */
1152 struct wimlib_progress_info_handle_error {
1154 /** Path to the file for which the error occurred, or NULL if
1156 const wimlib_tchar *path;
1158 /** The wimlib error code associated with the error. */
1162 * Indicates whether the error will be ignored or not. This
1163 * will be <c>false</c> by default; the progress function may
1164 * set it to <c>true</c>.
1171 * A user-supplied function that will be called periodically during certain WIM
1174 * The first argument will be the type of operation that is being performed or
1175 * is about to be started or has been completed.
1177 * The second argument will be a pointer to one of a number of structures
1178 * depending on the first argument. It may be @c NULL for some message types.
1179 * Note that although this argument is not @c const, users should not modify it
1180 * except in explicitly documented cases.
1182 * The third argument will be a user-supplied value that was provided when
1183 * registering or specifying the progress function.
1185 * This function must return one of the ::wimlib_progress_status values. By
1186 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1188 typedef enum wimlib_progress_status
1189 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1190 union wimlib_progress_info *info,
1194 /** @addtogroup G_modifying_wims
1197 /** An array of these structures is passed to wimlib_add_image_multisource() to
1198 * specify the sources from which to create a WIM image. */
1199 struct wimlib_capture_source {
1200 /** Absolute or relative path to a file or directory on the external
1201 * filesystem to be included in the WIM image. */
1202 wimlib_tchar *fs_source_path;
1204 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1205 * specify the root directory of the WIM image. */
1206 wimlib_tchar *wim_target_path;
1208 /** Reserved; set to 0. */
1212 /** Set or unset the "readonly" WIM header flag (<c>WIM_HDR_FLAG_READONLY</c> in
1213 * Microsoft's documentation), based on the ::wimlib_wim_info.is_marked_readonly
1214 * member of the @p info parameter. This is distinct from basic file
1215 * permissions; this flag can be set on a WIM file that is physically writable.
1217 * wimlib disallows modifying on-disk WIM files with the readonly flag set.
1218 * However, wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG
1219 * will override this --- and in fact, this is necessary to set the readonly
1220 * flag persistently on an existing WIM file.
1222 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1224 /** Set the GUID (globally unique identifier) of the WIM file to the value
1225 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1226 #define WIMLIB_CHANGE_GUID 0x00000002
1228 /** Change the bootable image of the WIM to the value specified in
1229 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1230 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1232 /** Change the <c>WIM_HDR_FLAG_RP_FIX</c> flag of the WIM file to the value
1233 * specified in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag
1234 * generally indicates whether an image in the WIM has been captured with
1235 * reparse-point fixups enabled. wimlib also treats this flag as specifying
1236 * whether to do reparse-point fixups by default when capturing or applying WIM
1238 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1242 /** @addtogroup G_wim_information */
1247 * General information about a WIM file.
1249 * This info can also be requested for a ::WIMStruct that does not have a
1250 * backing file. In this case, fields that only make sense given a backing file
1251 * are set to default values.
1253 struct wimlib_wim_info {
1255 /** The globally unique identifier for this WIM. (Note: all parts of a
1256 * split WIM normally have identical GUIDs.) */
1257 uint8_t guid[WIMLIB_GUID_LEN];
1259 /** The number of images in this WIM file. */
1260 uint32_t image_count;
1262 /** The 1-based index of the bootable image in this WIM file, or 0 if no
1263 * image is bootable. */
1264 uint32_t boot_index;
1266 /** The version of the WIM file format used in this WIM file. */
1267 uint32_t wim_version;
1269 /** The default compression chunk size of resources in this WIM file.
1271 uint32_t chunk_size;
1273 /** For split WIMs, the 1-based index of this part within the split WIM;
1275 uint16_t part_number;
1277 /** For split WIMs, the total number of parts in the split WIM;
1279 uint16_t total_parts;
1281 /** The default compression type of resources in this WIM file, as one
1282 * of the ::wimlib_compression_type constants. */
1283 int32_t compression_type;
1285 /** The size of this WIM file in bytes, excluding the XML data and
1286 * integrity table. */
1287 uint64_t total_bytes;
1289 /** 1 iff this WIM file has an integrity table. */
1290 uint32_t has_integrity_table : 1;
1292 /** 1 iff this info struct is for a ::WIMStruct that has a backing file.
1294 uint32_t opened_from_file : 1;
1296 /** 1 iff this WIM file is considered readonly for any reason (e.g. the
1297 * "readonly" header flag is set, or this is part of a split WIM, or
1298 * filesystem permissions deny writing) */
1299 uint32_t is_readonly : 1;
1301 /** 1 iff the "reparse point fix" flag is set in this WIM's header */
1302 uint32_t has_rpfix : 1;
1304 /** 1 iff the "readonly" flag is set in this WIM's header */
1305 uint32_t is_marked_readonly : 1;
1307 /** 1 iff the "spanned" flag is set in this WIM's header */
1308 uint32_t spanned : 1;
1310 /** 1 iff the "write in progress" flag is set in this WIM's header */
1311 uint32_t write_in_progress : 1;
1313 /** 1 iff the "metadata only" flag is set in this WIM's header */
1314 uint32_t metadata_only : 1;
1316 /** 1 iff the "resource only" flag is set in this WIM's header */
1317 uint32_t resource_only : 1;
1319 /** 1 iff this WIM file is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1320 uint32_t pipable : 1;
1321 uint32_t reserved_flags : 22;
1322 uint32_t reserved[9];
1326 * Information about a "blob", which is a fixed length sequence of binary data.
1327 * Each nonempty stream of each file in a WIM image is associated with a blob.
1328 * Blobs are deduplicated within a WIM file.
1330 * TODO: this struct needs to be renamed, and perhaps made into a union since
1331 * there are several cases. I'll try to list them below:
1333 * 1. The blob is "missing", meaning that it is referenced by hash but not
1334 * actually present in the WIM file. In this case we only know the
1335 * sha1_hash. This case can only occur with wimlib_iterate_dir_tree(), never
1336 * wimlib_iterate_lookup_table().
1338 * 2. Otherwise we know the sha1_hash, the uncompressed_size, the
1339 * reference_count, and the is_metadata flag. In addition:
1341 * A. If the blob is located in a non-solid WIM resource, then we also know
1342 * the compressed_size and offset.
1344 * B. If the blob is located in a solid WIM resource, then we also know the
1345 * offset, raw_resource_offset_in_wim, raw_resource_compressed_size, and
1346 * raw_resource_uncompressed_size. But the "offset" is actually the
1347 * offset in the uncompressed solid resource rather than the offset from
1348 * the beginning of the WIM file.
1350 * C. If the blob is *not* located in any type of WIM resource, then we don't
1351 * know any additional information.
1353 * Unknown or irrelevant fields are left zeroed.
1355 struct wimlib_resource_entry {
1357 /** If this blob is not missing, then this is the uncompressed size of
1358 * this blob in bytes. */
1359 uint64_t uncompressed_size;
1361 /** If this blob is located in a non-solid WIM resource, then this is
1362 * the compressed size of that resource. */
1363 uint64_t compressed_size;
1365 /** If this blob is located in a non-solid WIM resource, then this is
1366 * the offset of that resource within the WIM file containing it. If
1367 * this blob is located in a solid WIM resource, then this is the offset
1368 * of this blob within that solid resource when uncompressed. */
1371 /** The SHA-1 message digest of the blob's uncompressed contents. */
1372 uint8_t sha1_hash[20];
1374 /** If this blob is located in a WIM resource, then this is the part
1375 * number of the WIM file containing it. */
1376 uint32_t part_number;
1378 /** If this blob is not missing, then this is the number of times this
1379 * blob is referenced over all images in the WIM. This number is not
1380 * guaranteed to be correct. */
1381 uint32_t reference_count;
1383 /** 1 iff this blob is located in a non-solid compressed WIM resource.
1385 uint32_t is_compressed : 1;
1387 /** 1 iff this blob contains the metadata for an image. */
1388 uint32_t is_metadata : 1;
1390 uint32_t is_free : 1;
1391 uint32_t is_spanned : 1;
1393 /** 1 iff a blob with this hash was not found in the blob lookup table
1394 * of the ::WIMStruct. This normally implies a missing call to
1395 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1396 uint32_t is_missing : 1;
1398 /** 1 iff this blob is located in a solid resource. */
1399 uint32_t packed : 1;
1401 uint32_t reserved_flags : 26;
1403 /** If this blob is located in a solid WIM resource, then this is the
1404 * offset of that solid resource within the WIM file containing it. */
1405 uint64_t raw_resource_offset_in_wim;
1407 /** If this blob is located in a solid WIM resource, then this is the
1408 * compressed size of that solid resource. */
1409 uint64_t raw_resource_compressed_size;
1411 /** If this blob is located in a solid WIM resource, then this is the
1412 * uncompressed size of that solid resource. */
1413 uint64_t raw_resource_uncompressed_size;
1415 uint64_t reserved[1];
1419 * Information about a stream of a particular file in the WIM.
1421 * Normally, only WIM images captured from NTFS filesystems will have multiple
1422 * streams per file. In practice, this is a rarely used feature of the
1425 * TODO: the library now explicitly tracks stream types, which allows it to have
1426 * multiple unnamed streams (e.g. both a reparse point stream and unnamed data
1427 * stream). However, this isn't yet exposed by wimlib_iterate_dir_tree().
1429 struct wimlib_stream_entry {
1431 /** Name of the stream, or NULL if the stream is unnamed. */
1432 const wimlib_tchar *stream_name;
1434 /** Info about this stream's data, such as its hash and size if known.*/
1435 struct wimlib_resource_entry resource;
1437 uint64_t reserved[4];
1441 * An object ID, which is an extra piece of metadata that may be associated with
1442 * a file on NTFS filesystems. See:
1443 * https://msdn.microsoft.com/en-us/library/windows/desktop/aa363997(v=vs.85).aspx
1445 struct wimlib_object_id {
1446 uint8_t object_id[WIMLIB_GUID_LEN];
1447 uint8_t birth_volume_id[WIMLIB_GUID_LEN];
1448 uint8_t birth_object_id[WIMLIB_GUID_LEN];
1449 uint8_t domain_id[WIMLIB_GUID_LEN];
1452 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1453 * Roughly, the information about a "file" in the WIM--- but really a directory
1454 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1455 * field can be used to distinguish actual file inodes. */
1456 struct wimlib_dir_entry {
1457 /** Name of the file, or NULL if this file is unnamed. Only the root
1458 * directory of an image will be unnamed. */
1459 const wimlib_tchar *filename;
1461 /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1462 * this file has no such name. */
1463 const wimlib_tchar *dos_name;
1465 /** Full path to this file within the WIM image. Path separators will
1466 * be ::WIMLIB_WIM_PATH_SEPARATOR. */
1467 const wimlib_tchar *full_path;
1469 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1470 * children, ..., etc. */
1473 /** Pointer to the security descriptor for this file, in Windows
1474 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1475 * security descriptor. */
1476 const char *security_descriptor;
1478 /** Length of the above security descriptor. */
1479 size_t security_descriptor_size;
1481 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1482 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1483 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1484 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1485 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1486 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1487 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1488 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1489 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1490 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1491 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1492 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1493 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1494 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1495 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1496 /** File attributes, such as whether the file is a directory or not.
1497 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1498 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1499 * on other platforms. */
1500 uint32_t attributes;
1502 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1503 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1504 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1505 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1506 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1507 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1508 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1509 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1510 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1511 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1512 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1513 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1514 /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1515 * the attributes), this will give the reparse tag. This tells you
1516 * whether the reparse point is a symbolic link, junction point, or some
1517 * other, more unusual kind of reparse point. */
1518 uint32_t reparse_tag;
1520 /** Number of links to this file's inode (hard links).
1522 * Currently, this will always be 1 for directories. However, it can be
1523 * greater than 1 for nondirectory files. */
1526 /** Number of named data streams this file has. Normally 0. */
1527 uint32_t num_named_streams;
1529 /** A unique identifier for this file's inode. However, as a special
1530 * case, if the inode only has a single link (@p num_links == 1), this
1533 * Note: if a WIM image is captured from a filesystem, this value is not
1534 * guaranteed to be the same as the original number of the inode on the
1536 uint64_t hard_link_group_id;
1538 /** Time this file was created. */
1539 struct timespec creation_time;
1541 /** Time this file was last written to. */
1542 struct timespec last_write_time;
1544 /** Time this file was last accessed. */
1545 struct timespec last_access_time;
1547 /** The UNIX user ID of this file. This is a wimlib extension.
1549 * This field is only valid if @p unix_mode != 0. */
1552 /** The UNIX group ID of this file. This is a wimlib extension.
1554 * This field is only valid if @p unix_mode != 0. */
1557 /** The UNIX mode of this file. This is a wimlib extension.
1559 * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1560 * @p unix_rdev are all unknown (fields are not present in the WIM
1564 /** The UNIX device ID (major and minor number) of this file. This is a
1567 * This field is only valid if @p unix_mode != 0. */
1570 /* The object ID of this file, if any. Only valid if
1571 * object_id.object_id is not all zeroes. */
1572 struct wimlib_object_id object_id;
1574 uint64_t reserved[6];
1577 * Array of streams that make up this file.
1579 * The first entry will always exist and will correspond to the unnamed
1580 * data stream (default file contents), so it will have <c>stream_name
1581 * == NULL</c>. Alternatively, for reparse point files, the first entry
1582 * will correspond to the reparse data stream. Alternatively, for
1583 * encrypted files, the first entry will correspond to the encrypted
1586 * Then, following the first entry, there be @p num_named_streams
1587 * additional entries that specify the named data streams, if any, each
1588 * of which will have <c>stream_name != NULL</c>.
1590 struct wimlib_stream_entry streams[];
1594 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1597 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1601 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1604 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1607 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1608 * just on the specified path. */
1609 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1611 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1612 * itself; only its children (in the case of a non-empty directory) */
1613 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1615 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any file data blobs needed to fill
1616 * in the ::wimlib_resource_entry's for the iteration cannot be found in the
1617 * blob lookup table of the ::WIMStruct. The default behavior without this flag
1618 * is to fill in the @ref wimlib_resource_entry::sha1_hash "sha1_hash" and set
1619 * the @ref wimlib_resource_entry::is_missing "is_missing" flag. */
1620 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1624 /** @addtogroup G_modifying_wims
1627 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1628 * generic directory. This requires that wimlib was compiled with support for
1631 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1632 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1634 * Do not use this flag on Windows, where wimlib already supports all
1635 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1636 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1638 /** Follow symbolic links when scanning the directory tree. Currently only
1639 * supported on UNIX-like systems. */
1640 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1642 /** Call the progress function with the message
1643 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1645 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1647 /** Mark the image being added as the bootable image of the WIM. This flag is
1648 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1650 * Note that you can also change the bootable image of a WIM using
1651 * wimlib_set_wim_info().
1653 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1654 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1655 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1657 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1658 * (major and minor number) of each file. In addition, capture special files
1659 * such as device nodes and FIFOs. See the documentation for the
1660 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1662 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1664 /** Do not capture security descriptors. Only has an effect in NTFS capture
1665 * mode, or in Windows native builds. */
1666 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1668 /** Fail immediately if the full security descriptor of any file or directory
1669 * cannot be accessed. Only has an effect in Windows native builds. The
1670 * default behavior without this flag is to first try omitting the SACL from the
1671 * security descriptor, then to try omitting the security descriptor entirely.
1673 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1675 /** Call the progress function with the message
1676 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1677 * capture. This is a subset of the messages provided by
1678 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1679 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1681 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1682 * case of Windows) that point inside the directory being captured to instead be
1683 * absolute relative to the directory being captured.
1685 * Without this flag, the default is to do reparse-point fixups if
1686 * <c>WIM_HDR_FLAG_RP_FIX</c> is set in the WIM header or if this is the first
1687 * image being added. */
1688 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1690 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1691 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1693 /** Do not automatically exclude unsupported files or directories from capture,
1694 * such as encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1695 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1696 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1697 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1700 * Automatically select a capture configuration appropriate for capturing
1701 * filesystems containing Windows operating systems. For example,
1702 * <c>/pagefile.sys</c> and <c>"/System Volume Information"</c> will be
1705 * When this flag is specified, the corresponding @p config parameter (for
1706 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1707 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1709 * Note that the default behavior--- that is, when neither
1710 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1711 * config is @c NULL--- is to use no capture configuration, meaning that no
1712 * files are excluded from capture.
1714 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1717 * Capture image as "WIMBoot compatible". In addition, if no capture
1718 * configuration file is explicitly specified use the capture configuration file
1719 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1720 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1721 * configuration file is explicitly specified, use it and also place it at
1722 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image.
1724 * This flag does not, by itself, change the compression type or chunk size.
1725 * Before writing the WIM file, you may wish to set the compression format to
1726 * be the same as that used by WIMGAPI and DISM:
1729 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1730 * wimlib_set_output_chunk_size(wim, 4096);
1733 * However, "WIMBoot" also works with other XPRESS chunk sizes as well as LZX
1734 * with 32768 byte chunks.
1736 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1737 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1739 * Since wimlib v1.8.3, ::WIMLIB_ADD_FLAG_WIMBOOT also causes offline WIM-backed
1740 * files to be added as the "real" files rather than as their reparse points,
1741 * provided that their data is already present in the WIM. This feature can be
1742 * useful when updating a backing WIM file in an "offline" state.
1744 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1747 * If the add command involves adding a non-directory file to a location at
1748 * which there already exists a nondirectory file in the WIM image, issue
1749 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1750 * effect when updating an existing image with wimlib_update_image().
1751 * This was the default behavior in wimlib v1.6.2 and earlier.
1753 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1756 * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1759 * Note: This method for file exclusions is independent from the capture
1760 * configuration file mechanism.
1762 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1765 * Since wimlib v1.9.0: create a temporary filesystem snapshot of the source
1766 * directory and add the files from it. Currently, this option is only
1767 * supported on Windows, where it uses the Volume Shadow Copy Service (VSS).
1768 * Using this option, you can create a consistent backup of the system volume of
1769 * a running Windows system without running into problems with locked files.
1770 * For the VSS snapshot to be successfully created, your application must be run
1771 * as an Administrator, and it cannot be run in WoW64 mode (i.e. if Windows is
1772 * 64-bit, then your application must be 64-bit as well).
1774 #define WIMLIB_ADD_FLAG_SNAPSHOT 0x00008000
1777 * Since wimlib v1.9.0: permit the library to discard file paths after the
1778 * initial scan. If the application won't use
1779 * WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES while writing the WIM archive,
1780 * this flag can be used to allow the library to enable optimizations such as
1781 * opening files by inode number rather than by path. Currently this only makes
1782 * a difference on Windows.
1784 #define WIMLIB_ADD_FLAG_FILE_PATHS_UNNEEDED 0x00010000
1787 /** @addtogroup G_modifying_wims
1790 /** Do not issue an error if the path to delete does not exist. */
1791 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1793 /** Delete the file or directory tree recursively; if not specified, an error is
1794 * issued if the path to delete is a directory. */
1795 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1798 /** @addtogroup G_modifying_wims
1802 * If a single image is being exported, mark it bootable in the destination WIM.
1803 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1804 * the image in the source WIM (if any) that is marked as bootable is also
1805 * marked as bootable in the destination WIM.
1807 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1809 /** Give the exported image(s) no names. Avoids problems with image name
1812 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1814 /** Give the exported image(s) no descriptions. */
1815 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1817 /** This advises the library that the program is finished with the source
1818 * WIMStruct and will not attempt to access it after the call to
1819 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1820 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1823 * Mark each exported image as WIMBoot-compatible.
1825 * Note: by itself, this does change the destination WIM's compression type, nor
1826 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1827 * image. Before writing the destination WIM, it's recommended to do something
1831 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1832 * wimlib_set_output_chunk_size(wim, 4096);
1833 * wimlib_add_tree(wim, image, L"myconfig.ini",
1834 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1837 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1840 /** @addtogroup G_extracting_wims
1843 /** Extract the image directly to an NTFS volume rather than a generic directory.
1844 * This mode is only available if wimlib was compiled with libntfs-3g support;
1845 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1846 * extraction target will be interpreted as the path to an NTFS volume image (as
1847 * a regular file or block device) rather than a directory. It will be opened
1848 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1849 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1850 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1851 * wimlib_extract_paths() when passed multiple paths. */
1852 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1854 /** UNIX-like systems only: Extract special UNIX data captured with
1855 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1856 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1857 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1859 /** Do not extract security descriptors. This flag cannot be combined with
1860 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1861 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1863 /** Fail immediately if the full security descriptor of any file or directory
1864 * cannot be set exactly as specified in the WIM file. On Windows, the default
1865 * behavior without this flag when wimlib does not have permission to set the
1866 * correct security descriptor is to fall back to setting the security
1867 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1868 * owner omitted, then not at all. This flag cannot be combined with
1869 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1870 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1872 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1873 * reparse-point fixups on, so absolute symbolic links or junction points will
1874 * be fixed to be absolute relative to the actual extraction root. Reparse-
1875 * point fixups are done by default for wimlib_extract_image() and
1876 * wimlib_extract_image_from_pipe() if <c>WIM_HDR_FLAG_RP_FIX</c> is set in the
1877 * WIM header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.
1879 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1881 /** Force reparse-point fixups on extraction off, regardless of the state of the
1882 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1883 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1884 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1886 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1887 * paths, each of which must name a regular file, to standard output. */
1888 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1890 /** Instead of ignoring files and directories with names that cannot be
1891 * represented on the current platform (note: Windows has more restrictions on
1892 * filenames than POSIX-compliant systems), try to replace characters or append
1893 * junk to the names so that they can be extracted in some form.
1895 * Note: this flag is unlikely to have any effect when extracting a WIM image
1896 * that was captured on Windows.
1898 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1900 /** On Windows, when there exist two or more files with the same case
1901 * insensitive name but different case sensitive names, try to extract them all
1902 * by appending junk to the end of them, rather than arbitrarily extracting only
1905 * Note: this flag is unlikely to have any effect when extracting a WIM image
1906 * that was captured on Windows.
1908 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1910 /** Do not ignore failure to set timestamps on extracted files. This flag
1911 * currently only has an effect when extracting to a directory on UNIX-like
1913 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1915 /** Do not ignore failure to set short names on extracted files. This flag
1916 * currently only has an effect on Windows. */
1917 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1919 /** Do not ignore failure to extract symbolic links and junctions due to
1920 * permissions problems. This flag currently only has an effect on Windows. By
1921 * default, such failures are ignored since the default configuration of Windows
1922 * only allows the Administrator to create symbolic links. */
1923 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1925 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1926 * paths to extract as wildcard patterns ("globs") which may contain the
1927 * wildcard characters @c ? and @c *. The @c ? character matches any
1928 * non-path-separator character, whereas the @c * character matches zero or more
1929 * non-path-separator characters. Consequently, each glob may match zero or
1930 * more actual paths in the WIM image.
1932 * By default, if a glob does not match any files, a warning but not an error
1933 * will be issued. This is the case even if the glob did not actually contain
1934 * wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1937 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1939 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1940 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1941 * one of the provided globs did not match a file. */
1942 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1944 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1946 * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1948 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1950 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1951 * preserve the directory structure of the archive when extracting --- that is,
1952 * place each extracted file or directory tree directly in the target directory.
1954 * The target directory will still be created if it does not already exist. */
1955 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1957 /** Windows only: Extract files as "pointers" back to the WIM archive.
1959 * The effects of this option are fairly complex. See the documentation for the
1960 * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1962 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1965 * Since wimlib v1.8.2 and Windows-only: compress the extracted files using
1966 * System Compression, when possible. This only works on either Windows 10 or
1967 * later, or on an older Windows to which Microsoft's wofadk.sys driver has been
1968 * added. Several different compression formats may be used with System
1969 * Compression; this particular flag selects the XPRESS compression format with
1972 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K 0x01000000
1974 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
1975 * 8192 byte chunks. */
1976 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K 0x02000000
1978 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
1979 * 16384 byte chunks. */
1980 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K 0x04000000
1982 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use LZX compression with
1983 * 32768 byte chunks. */
1984 #define WIMLIB_EXTRACT_FLAG_COMPACT_LZX 0x08000000
1987 /** @addtogroup G_mounting_wim_images
1990 /** Mount the WIM image read-write rather than the default of read-only. */
1991 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1993 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main(). */
1994 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1996 /** Do not allow accessing named data streams in the mounted WIM image. */
1997 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1999 /** Access named data streams in the mounted WIM image through extended file
2000 * attributes named "user.X", where X is the name of a data stream. This is the
2002 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
2004 /** Access named data streams in the mounted WIM image by specifying the file
2005 * name, a colon, then the name of the data stream. */
2006 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
2008 /** Use UNIX metadata if available in the WIM image. See
2009 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
2010 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
2012 /** Allow other users to see the mounted filesystem. This passes the @c
2013 * allow_other option to fuse_main(). */
2014 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
2017 /** @addtogroup G_creating_and_opening_wims
2020 /** Verify the WIM contents against the WIM's integrity table, if present. The
2021 * integrity table stores checksums for the raw data of the WIM file, divided
2022 * into fixed size chunks. Verification will compute checksums and compare them
2023 * with the stored values. If there are any mismatches, then
2024 * ::WIMLIB_ERR_INTEGRITY will be issued. If the WIM file does not contain an
2025 * integrity table, then this flag has no effect. */
2026 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
2028 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
2029 * WIM. Software can provide this flag for convenience if it explicitly does
2030 * not want to support split WIMs. */
2031 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
2033 /** Check if the WIM is writable and issue an error
2034 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
2035 * only if it is writable at the filesystem level, does not have the
2036 * <c>WIM_HDR_FLAG_READONLY</c> flag set in its header, and is not part of a
2037 * spanned set. It is not required to provide this flag before attempting to
2038 * make changes to the WIM, but with this flag you get an error immediately
2039 * rather than potentially much later, when wimlib_overwrite() is finally
2041 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
2044 /** @addtogroup G_mounting_wim_images
2047 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
2048 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2049 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
2051 /** Commit changes to the read-write mounted WIM image.
2052 * If this flag is not specified, changes will be discarded. */
2053 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
2055 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
2056 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2057 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
2059 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2060 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2061 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
2064 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2065 * image, forces all file descriptors to the open WIM image to be closed before
2068 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2069 * this flag has no effect.
2071 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
2073 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2074 * WIM image, causes the modified image to be committed to the WIM file as a
2075 * new, unnamed image appended to the archive. The original image in the WIM
2076 * file will be unmodified. */
2077 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
2080 /** @addtogroup G_modifying_wims
2083 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2084 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
2085 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
2088 /** @addtogroup G_writing_and_overwriting_wims
2092 * Include an integrity table in the resulting WIM file.
2094 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2095 * include an integrity table if and only if one was present before. For
2096 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2097 * to not include an integrity table.
2099 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
2102 * Do not include an integrity table in the resulting WIM file. This is the
2103 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2106 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
2109 * Write the WIM as "pipable". After writing a WIM with this flag specified,
2110 * images from it can be applied directly from a pipe using
2111 * wimlib_extract_image_from_pipe(). See the documentation for the
2112 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2113 * Beware: WIMs written with this flag will not be compatible with Microsoft's
2116 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2117 * write the WIM as pipable if and only if it was pipable before. For
2118 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2119 * to write the WIM as non-pipable.
2121 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
2124 * Do not write the WIM as "pipable". This is the default behavior, unless the
2125 * ::WIMStruct was created by opening a pipable WIM.
2127 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
2130 * When writing data to the WIM file, recompress it, even if the data is already
2131 * available in the desired compressed form (for example, in a WIM file from
2132 * which an image has been exported using wimlib_export_image()).
2134 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2135 * compression ratio for the same compression type and chunk size. Simply using
2136 * the default compression settings may suffice for this, especially if the WIM
2137 * file was created using another program/library that may not use as
2138 * sophisticated compression algorithms. Or,
2139 * wimlib_set_default_compression_level() can be called beforehand to set an
2140 * even higher compression level than the default.
2142 * If the WIM contains solid resources, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can
2143 * be used in combination with ::WIMLIB_WRITE_FLAG_SOLID to prevent any solid
2144 * resources from being re-used. Otherwise, solid resources are re-used
2145 * somewhat more liberally than normal compressed resources.
2147 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of data
2148 * that would not otherwise be written. For example, a call to
2149 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2150 * cause already-existing data in the WIM file to be recompressed. To force the
2151 * WIM file to be fully rebuilt and recompressed, combine
2152 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2154 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
2157 * Immediately before closing the WIM file, sync its data to disk.
2159 * This flag forces the function to wait until the data is safely on disk before
2160 * returning success. Otherwise, modern operating systems tend to cache data
2161 * for some time (in some cases, 30+ seconds) before actually writing it to
2162 * disk, even after reporting to the application that the writes have succeeded.
2164 * wimlib_overwrite() will set this flag automatically if it decides to
2165 * overwrite the WIM file via a temporary file instead of in-place. This is
2166 * necessary on POSIX systems; it will, for example, avoid problems with delayed
2167 * allocation on ext4.
2169 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
2172 * For wimlib_overwrite(): rebuild the entire WIM file, even if it otherwise
2173 * could be updated in-place by appending to it. Any data that existed in the
2174 * original WIM file but is not actually needed by any of the remaining images
2175 * will not be included. This can free up space left over after previous
2176 * in-place modifications to the WIM file.
2178 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2179 * data to be recompressed. Otherwise, compressed data is re-used if possible.
2181 * wimlib_write() ignores this flag.
2183 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
2186 * For wimlib_overwrite(): override the default behavior after one or more calls
2187 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
2188 * flag, only minimal changes to correctly remove the image from the WIM file
2189 * will be taken. This can be much faster, but it will result in the WIM file
2190 * getting larger rather than smaller.
2192 * wimlib_write() ignores this flag.
2194 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
2197 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2198 * flag (<c>WIM_HDR_FLAG_READONLY</c>) is set in the WIM header. This can be
2199 * used following a call to wimlib_set_wim_info() with the
2200 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2203 * wimlib_write() ignores this flag.
2205 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
2208 * Do not include file data already present in other WIMs. This flag can be
2209 * used to write a "delta" WIM after the WIM files on which the delta is to be
2210 * based were referenced with wimlib_reference_resource_files() or
2211 * wimlib_reference_resources().
2213 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
2215 /** Deprecated; this flag should not be used outside of the library itself. */
2216 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
2219 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2221 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2224 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
2227 * Concatenate files and compress them together, rather than compress each file
2228 * independently. This is also known as creating a "solid archive". This tends
2229 * to produce a better compression ratio at the cost of much slower random
2232 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2233 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2234 * created with this flag use a different version number in their header (3584
2235 * instead of 68864) and are also called "ESD files".
2237 * Note that providing this flag does not affect the "append by default"
2238 * behavior of wimlib_overwrite(). In other words, wimlib_overwrite() with just
2239 * ::WIMLIB_WRITE_FLAG_SOLID can be used to append solid-compressed data to a
2240 * WIM file that originally did not contain any solid-compressed data. But if
2241 * you instead want to rebuild and recompress an entire WIM file in solid mode,
2242 * then also provide ::WIMLIB_WRITE_FLAG_REBUILD and
2243 * ::WIMLIB_WRITE_FLAG_RECOMPRESS.
2245 * Currently, new solid resources will, by default, be written using LZMS
2246 * compression with 64 MiB (67108864 byte) chunks. Use
2247 * wimlib_set_output_pack_compression_type() and/or
2248 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2249 * the WIM's main compression type and chunk size; you can have a WIM that
2250 * nominally uses LZX compression and 32768 byte chunks but actually contains
2251 * LZMS-compressed solid resources, for example. However, if including solid
2252 * resources, I suggest that you set the WIM's main compression type to LZMS as
2253 * well, either by creating the WIM with
2254 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2255 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2257 * This flag will be set by default when writing or overwriting a WIM file that
2258 * either already contains solid resources, or has had solid resources exported
2259 * into it and the WIM's main compression type is LZMS.
2261 #define WIMLIB_WRITE_FLAG_SOLID 0x00001000
2264 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2265 * file. This is only needed in the unusual case that the library user needs to
2266 * know exactly when wimlib has read each file for the last time.
2268 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2271 * Do not consider content similarity when arranging file data for solid
2272 * compression. Providing this flag will typically worsen the compression
2273 * ratio, so only provide this flag if you know what you are doing.
2275 #define WIMLIB_WRITE_FLAG_NO_SOLID_SORT 0x00004000
2278 * Since wimlib v1.8.3 and for wimlib_overwrite() only: <b>unsafely</b> compact
2279 * the WIM file in-place, without appending. Existing resources are shifted
2280 * down to fill holes and new resources are appended as needed. The WIM file is
2281 * truncated to its final size, which may shrink the on-disk file. <b>This
2282 * operation cannot be safely interrupted. If the operation is interrupted,
2283 * then the WIM file will be corrupted, and it may be impossible (or at least
2284 * very difficult) to recover any data from it. Users of this flag are expected
2285 * to know what they are doing and assume responsibility for any data corruption
2286 * that may result.</b>
2288 * If the WIM file cannot be compacted in-place because of its structure, its
2289 * layout, or other requested write parameters, then wimlib_overwrite() fails
2290 * with ::WIMLIB_ERR_COMPACTION_NOT_POSSIBLE, and the caller may wish to retry
2291 * the operation without this flag.
2293 #define WIMLIB_WRITE_FLAG_UNSAFE_COMPACT 0x00008000
2296 /** @addtogroup G_general
2299 /** Assume that strings are represented in UTF-8, even if this is not the
2300 * locale's character encoding. This flag is ignored on Windows, where wimlib
2301 * always uses UTF-16LE. */
2302 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2304 /** Windows-only: do not attempt to acquire additional privileges (currently
2305 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege,
2306 * SeTakeOwnershipPrivilege, and SeManageVolumePrivilege) when initializing the
2307 * library. This flag is intended for the case where the calling program
2308 * manages these privileges itself. Note: by default, no error is issued if
2309 * privileges cannot be acquired, although related errors may be reported later,
2310 * depending on if the operations performed actually require additional
2311 * privileges or not. */
2312 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2314 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2315 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2316 * to read all possible data and metadata for a capture operation could not be
2317 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2319 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2321 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2322 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2323 * to restore all possible data and metadata for an apply operation could not be
2324 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2326 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2328 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2330 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2332 /** Default to interpreting WIM paths case insensitively (default on Windows).
2333 * This does not apply to mounted images. */
2334 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2337 /** @addtogroup G_nonstandalone_wims
2340 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2341 * Ignored by wimlib_reference_resources(). */
2342 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2344 /** For wimlib_reference_resource_files(), issue an error
2345 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2346 * default behavior without this flag is to issue no error at that point, but
2347 * then attempt to open the glob as a literal path, which of course will fail
2348 * anyway if no file exists at that path. No effect if
2349 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2350 * wimlib_reference_resources(). */
2351 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2354 /** @addtogroup G_modifying_wims
2357 /** The specific type of update to perform. */
2358 enum wimlib_update_op {
2359 /** Add a new file or directory tree to the WIM image in a
2360 * certain location. */
2361 WIMLIB_UPDATE_OP_ADD = 0,
2363 /** Delete a file or directory tree from the WIM image. */
2364 WIMLIB_UPDATE_OP_DELETE,
2366 /** Rename a file or directory tree in the WIM image. */
2367 WIMLIB_UPDATE_OP_RENAME,
2370 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2371 struct wimlib_add_command {
2372 /** Filesystem path to the file or directory tree to add. */
2373 wimlib_tchar *fs_source_path;
2375 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2376 * specify the root directory of the WIM image. */
2377 wimlib_tchar *wim_target_path;
2379 /** Path to capture configuration file to use, or @c NULL for default.
2381 wimlib_tchar *config_file;
2383 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2387 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2388 struct wimlib_delete_command {
2390 /** Path, specified from the root of the WIM image, for the file or
2391 * directory tree within the WIM image to be deleted. */
2392 wimlib_tchar *wim_path;
2394 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2398 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2399 struct wimlib_rename_command {
2401 /** Path, specified from the root of the WIM image, for the source file
2402 * or directory tree within the WIM image. */
2403 wimlib_tchar *wim_source_path;
2405 /** Path, specified from the root of the WIM image, for the destination
2406 * file or directory tree within the WIM image. */
2407 wimlib_tchar *wim_target_path;
2409 /** Reserved; set to 0. */
2413 /** Specification of an update to perform on a WIM image. */
2414 struct wimlib_update_command {
2416 enum wimlib_update_op op;
2419 struct wimlib_add_command add;
2420 struct wimlib_delete_command delete_; /* Underscore is for C++
2422 struct wimlib_rename_command rename;
2427 /** @addtogroup G_general
2431 * Possible values of the error code returned by many functions in wimlib.
2433 * See the documentation for each wimlib function to see specifically what error
2434 * codes can be returned by a given function, and what they mean.
2436 enum wimlib_error_code {
2437 WIMLIB_ERR_SUCCESS = 0,
2438 WIMLIB_ERR_ALREADY_LOCKED = 1,
2439 WIMLIB_ERR_DECOMPRESSION = 2,
2440 WIMLIB_ERR_FUSE = 6,
2441 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2442 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2443 WIMLIB_ERR_IMAGE_COUNT = 10,
2444 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2445 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2446 WIMLIB_ERR_INTEGRITY = 13,
2447 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2448 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2449 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2450 WIMLIB_ERR_INVALID_HEADER = 17,
2451 WIMLIB_ERR_INVALID_IMAGE = 18,
2452 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2453 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2454 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2455 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2456 WIMLIB_ERR_INVALID_OVERLAY = 23,
2457 WIMLIB_ERR_INVALID_PARAM = 24,
2458 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2459 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2460 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2461 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2462 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2463 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2464 WIMLIB_ERR_IS_DIRECTORY = 32,
2465 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2466 WIMLIB_ERR_LINK = 35,
2467 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2468 WIMLIB_ERR_MKDIR = 37,
2469 WIMLIB_ERR_MQUEUE = 38,
2470 WIMLIB_ERR_NOMEM = 39,
2471 WIMLIB_ERR_NOTDIR = 40,
2472 WIMLIB_ERR_NOTEMPTY = 41,
2473 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2474 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2475 WIMLIB_ERR_NOT_PIPABLE = 44,
2476 WIMLIB_ERR_NO_FILENAME = 45,
2477 WIMLIB_ERR_NTFS_3G = 46,
2478 WIMLIB_ERR_OPEN = 47,
2479 WIMLIB_ERR_OPENDIR = 48,
2480 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2481 WIMLIB_ERR_READ = 50,
2482 WIMLIB_ERR_READLINK = 51,
2483 WIMLIB_ERR_RENAME = 52,
2484 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2485 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2486 WIMLIB_ERR_RESOURCE_ORDER = 56,
2487 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2488 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2489 WIMLIB_ERR_SET_SECURITY = 59,
2490 WIMLIB_ERR_SET_SHORT_NAME = 60,
2491 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2492 WIMLIB_ERR_SPLIT_INVALID = 62,
2493 WIMLIB_ERR_STAT = 63,
2494 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2495 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2496 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2497 WIMLIB_ERR_UNSUPPORTED = 68,
2498 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2499 WIMLIB_ERR_WIM_IS_READONLY = 71,
2500 WIMLIB_ERR_WRITE = 72,
2501 WIMLIB_ERR_XML = 73,
2502 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2503 WIMLIB_ERR_WIMBOOT = 75,
2504 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2505 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2506 WIMLIB_ERR_MKNOD = 78,
2507 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2508 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2509 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2510 WIMLIB_ERR_FVE_LOCKED_VOLUME = 82,
2511 WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG = 83,
2512 WIMLIB_ERR_WIM_IS_INCOMPLETE = 84,
2513 WIMLIB_ERR_COMPACTION_NOT_POSSIBLE = 85,
2514 WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES = 86,
2515 WIMLIB_ERR_DUPLICATE_EXPORTED_IMAGE = 87,
2516 WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED = 88,
2517 WIMLIB_ERR_SNAPSHOT_FAILURE = 89,
2521 /** Used to indicate no WIM image or an invalid WIM image. */
2522 #define WIMLIB_NO_IMAGE 0
2524 /** Used to specify all images in the WIM. */
2525 #define WIMLIB_ALL_IMAGES (-1)
2530 * @ingroup G_modifying_wims
2532 * Append an empty image to a ::WIMStruct.
2534 * The new image will initially contain no files or directories, although if
2535 * written without further modifications, then a root directory will be created
2536 * automatically for it.
2538 * After calling this function, you can use wimlib_update_image() to add files
2539 * to the new WIM image. This gives you more control over making the new image
2540 * compared to calling wimlib_add_image() or wimlib_add_image_multisource().
2543 * Pointer to the ::WIMStruct to which to add the image.
2545 * Name to give the new image. If @c NULL or empty, the new image is given
2546 * no name. If nonempty, it must specify a name that does not already
2548 * @param new_idx_ret
2549 * If non-<c>NULL</c>, the index of the newly added image is returned in
2552 * @return 0 on success; a ::wimlib_error_code value on failure.
2554 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2555 * The WIM already contains an image with the requested name.
2558 wimlib_add_empty_image(WIMStruct *wim,
2559 const wimlib_tchar *name,
2563 * @ingroup G_modifying_wims
2565 * Add an image to a ::WIMStruct from an on-disk directory tree or NTFS volume.
2567 * The directory tree or NTFS volume is scanned immediately to load the dentry
2568 * tree into memory, and file metadata is read. However, actual file data may
2569 * not be read until the ::WIMStruct is persisted to disk using wimlib_write()
2570 * or wimlib_overwrite().
2572 * See the documentation for the @b wimlib-imagex program for more information
2573 * about the "normal" capture mode versus the NTFS capture mode (entered by
2574 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2576 * Note that no changes are committed to disk until wimlib_write() or
2577 * wimlib_overwrite() is called.
2580 * Pointer to the ::WIMStruct to which to add the image.
2582 * A path to a directory or unmounted NTFS volume that will be captured as
2585 * Name to give the new image. If @c NULL or empty, the new image is given
2586 * no name. If nonempty, it must specify a name that does not already
2588 * @param config_file
2589 * Path to capture configuration file, or @c NULL. This file may specify,
2590 * among other things, which files to exclude from capture. See the
2591 * documentation for <b>wimlib-imagex capture</b> (<b>--config</b> option)
2592 * for details of the file format. If @c NULL, the default capture
2593 * configuration will be used. Ordinarily, the default capture
2594 * configuration will result in no files being excluded from capture purely
2595 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2596 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2598 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2600 * @return 0 on success; a ::wimlib_error_code value on failure.
2602 * This function is implemented by calling wimlib_add_empty_image(), then
2603 * calling wimlib_update_image() with a single "add" command, so any error code
2604 * returned by wimlib_add_empty_image() may be returned, as well as any error
2605 * codes returned by wimlib_update_image() other than ones documented as only
2606 * being returned specifically by an update involving delete or rename commands.
2608 * If a progress function is registered with @p wim, then it will receive the
2609 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2610 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2611 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2614 wimlib_add_image(WIMStruct *wim,
2615 const wimlib_tchar *source,
2616 const wimlib_tchar *name,
2617 const wimlib_tchar *config_file,
2621 * @ingroup G_modifying_wims
2623 * This function is equivalent to wimlib_add_image() except it allows for
2624 * multiple sources to be combined into a single WIM image. This is done by
2625 * specifying the @p sources and @p num_sources parameters instead of the @p
2626 * source parameter of wimlib_add_image(). The rest of the parameters are the
2627 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2628 * capture</b> for full details on how this mode works.
2630 * In addition to the error codes that wimlib_add_image() can return,
2631 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY when
2632 * trying to overlay a non-directory on a directory or when otherwise trying to
2633 * overlay multiple conflicting files to the same location in the WIM image.
2636 wimlib_add_image_multisource(WIMStruct *wim,
2637 const struct wimlib_capture_source *sources,
2639 const wimlib_tchar *name,
2640 const wimlib_tchar *config_file,
2644 * @ingroup G_modifying_wims
2646 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2647 * location @p wim_target_path within the specified @p image of the @p wim.
2649 * This just builds an appropriate ::wimlib_add_command and passes it to
2650 * wimlib_update_image().
2653 wimlib_add_tree(WIMStruct *wim, int image,
2654 const wimlib_tchar *fs_source_path,
2655 const wimlib_tchar *wim_target_path, int add_flags);
2658 * @ingroup G_creating_and_opening_wims
2660 * Create a ::WIMStruct which initially contains no images and is not backed by
2664 * The "output compression type" to assign to the ::WIMStruct. This is the
2665 * compression type that will be used if the ::WIMStruct is later persisted
2666 * to an on-disk file using wimlib_write().
2668 * This choice is not necessarily final. If desired, it can still be
2669 * changed at any time before wimlib_write() is called, using
2670 * wimlib_set_output_compression_type(). In addition, if you wish to use a
2671 * non-default compression chunk size, then you will need to call
2672 * wimlib_set_output_chunk_size().
2674 * On success, a pointer to the new ::WIMStruct is written to the memory
2675 * location pointed to by this parameter. This ::WIMStruct must be freed
2676 * using using wimlib_free() when finished with it.
2678 * @return 0 on success; a ::wimlib_error_code value on failure.
2680 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2681 * @p ctype was not a supported compression type.
2682 * @retval ::WIMLIB_ERR_NOMEM
2683 * Insufficient memory to allocate a new ::WIMStruct.
2686 wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret);
2689 * @ingroup G_modifying_wims
2691 * Delete an image, or all images, from a ::WIMStruct.
2693 * Note that no changes are committed to disk until wimlib_write() or
2694 * wimlib_overwrite() is called.
2697 * Pointer to the ::WIMStruct from which to delete the image.
2699 * The 1-based index of the image to delete, or ::WIMLIB_ALL_IMAGES to
2700 * delete all images.
2702 * @return 0 on success; a ::wimlib_error_code value on failure.
2704 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2705 * @p image does not exist in the WIM.
2707 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2708 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2709 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2710 * indicate failure (for different reasons) to read the metadata resource for an
2711 * image that needed to be deleted.
2713 * If this function fails when @p image was ::WIMLIB_ALL_IMAGES, then it's
2714 * possible that some but not all of the images were deleted.
2717 wimlib_delete_image(WIMStruct *wim, int image);
2720 * @ingroup G_modifying_wims
2722 * Delete the @p path from the specified @p image of the @p wim.
2724 * This just builds an appropriate ::wimlib_delete_command and passes it to
2725 * wimlib_update_image().
2728 wimlib_delete_path(WIMStruct *wim, int image,
2729 const wimlib_tchar *path, int delete_flags);
2732 * @ingroup G_modifying_wims
2734 * Export an image, or all images, from a ::WIMStruct into another ::WIMStruct.
2736 * Specifically, if the destination ::WIMStruct contains <tt>n</tt> images, then
2737 * the source image(s) will be appended, in order, starting at destination index
2738 * <tt>n + 1</tt>. By default, all image metadata will be exported verbatim,
2739 * but certain changes can be made by passing appropriate parameters.
2741 * wimlib_export_image() is only an in-memory operation; no changes are
2742 * committed to disk until wimlib_write() or wimlib_overwrite() is called.
2744 * A limitation of the current implementation of wimlib_export_image() is that
2745 * the directory tree of a source or destination image cannot be updated
2746 * following an export until one of the two images has been freed from memory.
2749 * The WIM from which to export the images, specified as a pointer to the
2750 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2751 * split WIM. In the case of a WIM file that is not standalone, this
2752 * ::WIMStruct must have had any needed external resources previously
2753 * referenced using wimlib_reference_resources() or
2754 * wimlib_reference_resource_files().
2756 * The 1-based index of the image from @p src_wim to export, or
2757 * ::WIMLIB_ALL_IMAGES.
2759 * The ::WIMStruct to which to export the images.
2761 * For single-image exports, the name to give the exported image in @p
2762 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2763 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2764 * that case, the names are all taken from @p src_wim. This parameter is
2765 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2766 * @param dest_description
2767 * For single-image exports, the description to give the exported image in
2768 * the new WIM file. If left @c NULL, the description from @p src_wim is
2769 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2770 * NULL; in that case, the description are all taken from @p src_wim. This
2771 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2772 * @param export_flags
2773 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2775 * @return 0 on success; a ::wimlib_error_code value on failure.
2777 * @retval ::WIMLIB_ERR_DUPLICATE_EXPORTED_IMAGE
2778 * One or more of the source images had already been exported into the
2780 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2781 * One or more of the names being given to an exported image was already in
2782 * use in the destination WIM.
2783 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2784 * @p src_image does not exist in @p src_wim.
2785 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2786 * At least one of @p src_wim and @p dest_wim do not contain image
2787 * metadata. For example, one of them was a non-first part of a split WIM.
2788 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2789 * A file data blob that needed to be exported could not be found in the
2790 * blob lookup table of @p src_wim. See @ref G_nonstandalone_wims.
2792 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2793 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2794 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2795 * indicate failure (for different reasons) to read the metadata resource for an
2796 * image in @p src_wim that needed to be exported.
2799 wimlib_export_image(WIMStruct *src_wim, int src_image,
2800 WIMStruct *dest_wim,
2801 const wimlib_tchar *dest_name,
2802 const wimlib_tchar *dest_description,
2806 * @ingroup G_extracting_wims
2808 * Extract an image, or all images, from a ::WIMStruct.
2810 * The exact behavior of how wimlib extracts files from a WIM image is
2811 * controllable by the @p extract_flags parameter, but there also are
2812 * differences depending on the platform (UNIX-like vs Windows). See the
2813 * documentation for <b>wimlib-imagex apply</b> for more information, including
2814 * about the NTFS-3g extraction mode.
2817 * The WIM from which to extract the image(s), specified as a pointer to the
2818 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2819 * split WIM. In the case of a WIM file that is not standalone, this
2820 * ::WIMStruct must have had any needed external resources previously
2821 * referenced using wimlib_reference_resources() or
2822 * wimlib_reference_resource_files().
2824 * The 1-based index of the image to extract, or ::WIMLIB_ALL_IMAGES to
2825 * extract all images. Note: ::WIMLIB_ALL_IMAGES is unsupported in NTFS-3g
2828 * A null-terminated string which names the location to which the image(s)
2829 * will be extracted. By default, this is interpreted as a path to a
2830 * directory. Alternatively, if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in
2831 * @p extract_flags, then this is interpreted as a path to an unmounted
2833 * @param extract_flags
2834 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2836 * @return 0 on success; a ::wimlib_error_code value on failure.
2838 * @retval ::WIMLIB_ERR_DECOMPRESSION
2839 * Failed to decompress data contained in the WIM.
2840 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2841 * The metadata for one of the images to extract was invalid.
2842 * @retval ::WIMLIB_ERR_INVALID_PARAM
2843 * The extraction flags were invalid; more details may be found in the
2844 * documentation for the specific extraction flags that were specified. Or
2845 * @p target was @c NULL or an empty string, or @p wim was @c NULL.
2846 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2847 * The data of a file that needed to be extracted was corrupt.
2848 * @retval ::WIMLIB_ERR_LINK
2849 * Failed to create a symbolic link or a hard link.
2850 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2851 * The metadata resource for one of the images to extract was not found.
2852 * This can happen if @p wim represents a non-first part of a split WIM.
2853 * @retval ::WIMLIB_ERR_MKDIR
2854 * Failed create a directory.
2855 * @retval ::WIMLIB_ERR_OPEN
2856 * Could not create a file, or failed to open an already-extracted file.
2857 * @retval ::WIMLIB_ERR_READ
2858 * Failed to read data from the WIM.
2859 * @retval ::WIMLIB_ERR_READLINK
2860 * Failed to determine the target of a symbolic link in the WIM.
2861 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2862 * Failed to fix the target of an absolute symbolic link (e.g. if the
2863 * target would have exceeded the maximum allowed length). (Only if
2864 * reparse data was supported by the extraction mode and
2865 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2867 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2868 * A file data blob that needed to be extracted could not be found in the
2869 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
2870 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2871 * Failed to set attributes on a file.
2872 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2873 * Failed to set reparse data on a file (only if reparse data was supported
2874 * by the extraction mode).
2875 * @retval ::WIMLIB_ERR_SET_SECURITY
2876 * Failed to set security descriptor on a file.
2877 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2878 * Failed to set the short name of a file.
2879 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2880 * Failed to set timestamps on a file.
2881 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2882 * Unexpected end-of-file occurred when reading data from the WIM.
2883 * @retval ::WIMLIB_ERR_UNSUPPORTED
2884 * A requested extraction flag, or the data or metadata that must be
2885 * extracted to support it, is unsupported in the build and configuration
2886 * of wimlib, or on the current platform or extraction mode or target
2887 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2888 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2889 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2890 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2891 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2892 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2893 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2894 * image contains one or more files with short names, but extracting short
2895 * names is not supported --- on Windows, this occurs if the target volume
2896 * does not support short names, while on non-Windows, this occurs if
2897 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2898 * @retval ::WIMLIB_ERR_WIMBOOT
2899 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2900 * there was a problem creating WIMBoot pointer files or registering a
2901 * source WIM file with the Windows Overlay Filesystem (WOF) driver.
2902 * @retval ::WIMLIB_ERR_WRITE
2903 * Failed to write data to a file being extracted.
2905 * If a progress function is registered with @p wim, then as each image is
2906 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2907 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2908 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2909 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2910 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2913 wimlib_extract_image(WIMStruct *wim, int image,
2914 const wimlib_tchar *target, int extract_flags);
2917 * @ingroup G_extracting_wims
2919 * Extract one image from a pipe on which a pipable WIM is being sent.
2921 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2922 * subsec_pipable_wims, for more information about pipable WIMs.
2924 * This function operates in a special way to read the WIM fully sequentially.
2925 * As a result, there is no ::WIMStruct is made visible to library users, and
2926 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2927 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2928 * seekable file, not a pipe.)
2931 * File descriptor, which may be a pipe, opened for reading and positioned
2932 * at the start of the pipable WIM.
2933 * @param image_num_or_name
2934 * String that specifies the 1-based index or name of the image to extract.
2935 * It is translated to an image index using the same rules that
2936 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2937 * only a single image (not all images) can be specified. Alternatively,
2938 * specify @p NULL here to use the first image in the WIM if it contains
2939 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2941 * Same as the corresponding parameter to wimlib_extract_image().
2942 * @param extract_flags
2943 * Same as the corresponding parameter to wimlib_extract_image().
2945 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
2946 * error codes include those returned by wimlib_extract_image() and
2947 * wimlib_open_wim() as well as the following:
2949 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2950 * Data read from the pipable WIM was invalid.
2951 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2952 * The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2955 wimlib_extract_image_from_pipe(int pipe_fd,
2956 const wimlib_tchar *image_num_or_name,
2957 const wimlib_tchar *target, int extract_flags);
2960 * @ingroup G_extracting_wims
2962 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2963 * function. The progress function will be used while extracting the WIM image
2964 * and will receive the normal extraction progress messages, such as
2965 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2966 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2969 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2970 const wimlib_tchar *image_num_or_name,
2971 const wimlib_tchar *target,
2973 wimlib_progress_func_t progfunc,
2977 * @ingroup G_extracting_wims
2979 * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2980 * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2981 * path_list_file which itself contains the list of paths to use, one per line.
2982 * Leading and trailing whitespace is ignored. Empty lines and lines beginning
2983 * with the ';' or '#' characters are ignored. No quotes are needed, as paths
2984 * are otherwise delimited by the newline character. However, quotes will be
2985 * stripped if present.
2987 * The error codes are the same as those returned by wimlib_extract_paths(),
2988 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2989 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2990 * ::WIMLIB_ERR_READ).
2993 wimlib_extract_pathlist(WIMStruct *wim, int image,
2994 const wimlib_tchar *target,
2995 const wimlib_tchar *path_list_file,
2999 * @ingroup G_extracting_wims
3001 * Extract zero or more paths (files or directory trees) from the specified WIM
3004 * By default, each path will be extracted to a corresponding subdirectory of
3005 * the target based on its location in the WIM image. For example, if one of
3006 * the paths to extract is <c>/Windows/explorer.exe</c> and the target is
3007 * <c>outdir</c>, the file will be extracted to
3008 * <c>outdir/Windows/explorer.exe</c>. This behavior can be changed by
3009 * providing the flag ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which
3010 * will cause each file or directory tree to be placed directly in the target
3011 * directory --- so the same example would extract <c>/Windows/explorer.exe</c>
3012 * to <c>outdir/explorer.exe</c>.
3014 * Symbolic links will not be dereferenced when paths in the WIM image are
3018 * WIM from which to extract the paths, specified as a pointer to the
3019 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
3020 * split WIM. In the case of a WIM file that is not standalone, this
3021 * ::WIMStruct must have had any needed external resources previously
3022 * referenced using wimlib_reference_resources() or
3023 * wimlib_reference_resource_files().
3025 * The 1-based index of the WIM image from which to extract the paths.
3027 * Array of paths to extract. Each element must be the absolute path to a
3028 * file or directory within the WIM image. Path separators may be either
3029 * forwards or backwards slashes, and leading path separators are optional.
3030 * The paths will be interpreted either case-sensitively (UNIX default) or
3031 * case-insensitively (Windows default); however, the behavior can be
3032 * configured explicitly at library initialization time by passing an
3033 * appropriate flag to wimlib_global_init().
3035 * By default, the characters @c * and @c ? are interpreted literally.
3036 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
3039 * By default, if any paths to extract do not exist, the error code
3040 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
3041 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
3043 * Number of paths specified in @p paths.
3045 * Directory to which to extract the paths; or with
3046 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
3047 * unmounted NTFS volume to which to extract the paths. Unlike the @p
3048 * paths being extracted, the @p target must be native path. On UNIX-like
3049 * systems it may not contain backslashes, for example.
3050 * @param extract_flags
3051 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3053 * @return 0 on success; a ::wimlib_error_code value on failure. Most of the
3054 * error codes are the same as those returned by wimlib_extract_image(). Below,
3055 * some of the error codes returned in situations specific to path-mode
3056 * extraction are documented:
3058 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3059 * One of the paths to extract does not exist in the WIM image. This error
3060 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
3061 * specified in @p extract_flags, or if both
3062 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
3063 * were specified in @p extract_flags.
3064 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3065 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3066 * one of the paths to extract did not name a regular file.
3068 * If a progress function is registered with @p wim, then it will receive
3069 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS.
3072 wimlib_extract_paths(WIMStruct *wim,
3074 const wimlib_tchar *target,
3075 const wimlib_tchar * const *paths,
3080 * @ingroup G_wim_information
3082 * Similar to wimlib_get_xml_data(), but the XML document will be written to the
3083 * specified standard C <c>FILE*</c> instead of retrieved in an in-memory
3086 * @return 0 on success; a ::wimlib_error_code value on failure. This may
3087 * return any error code which can be returned by wimlib_get_xml_data() as well
3088 * as the following error codes:
3090 * @retval ::WIMLIB_ERR_WRITE
3091 * Failed to write the data to the requested file.
3094 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3097 * @ingroup G_general
3099 * Release a reference to a ::WIMStruct. If the ::WIMStruct is still referenced
3100 * by other ::WIMStruct's (e.g. following calls to wimlib_export_image() or
3101 * wimlib_reference_resources()), then the library will free it later, when the
3102 * last reference is released; otherwise it is freed immediately and any
3103 * associated file descriptors are closed.
3106 * Pointer to the ::WIMStruct to release. If @c NULL, no action is taken.
3109 wimlib_free(WIMStruct *wim);
3112 * @ingroup G_general
3114 * Convert a ::wimlib_compression_type value into a string.
3117 * The compression type value to convert.
3120 * A statically allocated string naming the compression type, such as
3121 * "None", "LZX", or "XPRESS". If the value was unrecognized, then
3122 * the resulting string will be "Invalid".
3124 extern const wimlib_tchar *
3125 wimlib_get_compression_type_string(enum wimlib_compression_type ctype);
3128 * @ingroup G_general
3130 * Convert a wimlib error code into a string describing it.
3133 * An error code returned by one of wimlib's functions.
3136 * Pointer to a statically allocated string describing the error code. If
3137 * the value was unrecognized, then the resulting string will be "Unknown
3140 extern const wimlib_tchar *
3141 wimlib_get_error_string(enum wimlib_error_code code);
3144 * @ingroup G_wim_information
3146 * Get the description of the specified image. Equivalent to
3147 * <tt>wimlib_get_image_property(wim, image, "DESCRIPTION")</tt>.
3149 extern const wimlib_tchar *
3150 wimlib_get_image_description(const WIMStruct *wim, int image);
3153 * @ingroup G_wim_information
3155 * Get the name of the specified image. Equivalent to
3156 * <tt>wimlib_get_image_property(wim, image, "NAME")</tt>, except that
3157 * wimlib_get_image_name() will return an empty string if the image is unnamed
3158 * whereas wimlib_get_image_property() may return @c NULL in that case.
3160 extern const wimlib_tchar *
3161 wimlib_get_image_name(const WIMStruct *wim, int image);
3164 * @ingroup G_wim_information
3166 * Since wimlib v1.8.3: get a per-image property from the WIM's XML document.
3167 * This is an alternative to wimlib_get_image_name() and
3168 * wimlib_get_image_description() which allows getting any simple string
3172 * Pointer to the ::WIMStruct for the WIM.
3174 * The 1-based index of the image for which to get the property.
3175 * @param property_name
3176 * The name of the image property, for example "NAME", "DESCRIPTION", or
3177 * "TOTALBYTES". The name can contain forward slashes to indicate a nested
3178 * XML element; for example, "WINDOWS/VERSION/BUILD" indicates the BUILD
3179 * element nested within the VERSION element nested within the WINDOWS
3180 * element. Since wimlib v1.9.0, a bracketed number can be used to
3181 * indicate one of several identically-named elements; for example,
3182 * "WINDOWS/LANGUAGES/LANGUAGE[2]" indicates the second "LANGUAGE" element
3183 * nested within the "WINDOWS/LANGUAGES" element. Note that element names
3184 * are case sensitive.
3187 * The property's value as a ::wimlib_tchar string, or @c NULL if there is
3188 * no such property. The string may not remain valid after later library
3189 * calls, so the caller should duplicate it if needed.
3191 extern const wimlib_tchar *
3192 wimlib_get_image_property(const WIMStruct *wim, int image,
3193 const wimlib_tchar *property_name);
3196 * @ingroup G_general
3198 * Return the version of wimlib as a 32-bit number whose top 12 bits contain the
3199 * major version, the next 10 bits contain the minor version, and the low 10
3200 * bits contain the patch version.
3202 * In other words, the returned value is equal to <c>((WIMLIB_MAJOR_VERSION <<
3203 * 20) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</c> for the
3204 * corresponding header file.
3207 wimlib_get_version(void);
3210 * @ingroup G_wim_information
3212 * Get basic information about a WIM file.
3215 * Pointer to the ::WIMStruct to query. This need not represent a
3216 * standalone WIM (e.g. it could represent part of a split WIM).
3218 * A ::wimlib_wim_info structure that will be filled in with information
3219 * about the WIM file.
3224 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3227 * @ingroup G_wim_information
3229 * Read a WIM file's XML document into an in-memory buffer.
3231 * The XML document contains metadata about the WIM file and the images stored
3235 * Pointer to the ::WIMStruct to query. This need not represent a
3236 * standalone WIM (e.g. it could represent part of a split WIM).
3238 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3239 * XML document is written to this location.
3240 * @param bufsize_ret
3241 * The size of the XML document in bytes is written to this location.
3243 * @return 0 on success; a ::wimlib_error_code value on failure.
3245 * @retval ::WIMLIB_ERR_NO_FILENAME
3246 * @p wim is not backed by a file and therefore does not have an XML
3248 * @retval ::WIMLIB_ERR_READ
3249 * Failed to read the XML document from the WIM file.
3250 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3251 * Failed to read the XML document from the WIM file.
3254 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3257 * @ingroup G_general
3259 * Initialization function for wimlib. Call before using any other wimlib
3260 * function (except possibly wimlib_set_print_errors()). If not done manually,
3261 * this function will be called automatically with @p init_flags set to
3262 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
3263 * after it has already successfully run.
3266 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3268 * @return 0 on success; a ::wimlib_error_code value on failure.
3270 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3271 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3272 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3273 * init_flags, but the corresponding privileges could not be acquired.
3276 wimlib_global_init(int init_flags);
3279 * @ingroup G_general
3281 * Cleanup function for wimlib. You are not required to call this function, but
3282 * it will release any global resources allocated by the library.
3285 wimlib_global_cleanup(void);
3288 * @ingroup G_wim_information
3290 * Determine if an image name is already used by some image in the WIM.
3293 * Pointer to the ::WIMStruct to query. This need not represent a
3294 * standalone WIM (e.g. it could represent part of a split WIM).
3296 * The name to check.
3299 * @c true if there is already an image in @p wim named @p name; @c false
3300 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3301 * the empty string, then @c false is returned.
3304 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3307 * @ingroup G_wim_information
3309 * Iterate through a file or directory tree in the WIM image. By specifying
3310 * appropriate flags and a callback function, you can get the attributes of a
3311 * file in the WIM image, get a directory listing, or even get a listing of the
3315 * The ::WIMStruct containing the image(s) over which to iterate. This
3316 * ::WIMStruct must contain image metadata, so it cannot be the non-first
3317 * part of a split WIM (for example).
3319 * The 1-based index of the image that contains the files or directories to
3320 * iterate over, or ::WIMLIB_ALL_IMAGES to iterate over all images.
3322 * Path in the WIM image at which to do the iteration.
3324 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3326 * A callback function that will receive each directory entry.
3328 * An extra parameter that will always be passed to the callback function
3331 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3332 * first nonzero value that was returned from @p cb. However, additional
3333 * ::wimlib_error_code values may be returned, including the following:
3335 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3336 * @p path does not exist in the WIM image.
3337 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3338 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED was specified, but the
3339 * data for some files could not be found in the blob lookup table of @p
3342 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3343 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3344 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3345 * indicate failure (for different reasons) to read the metadata resource for an
3346 * image over which iteration needed to be done.
3349 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3351 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3354 * @ingroup G_wim_information
3356 * Iterate through the blob lookup table of a ::WIMStruct. This can be used to
3357 * directly get a listing of the unique "blobs" contained in a WIM file, which
3358 * are deduplicated over all images.
3360 * Specifically, each listed blob may be from any of the following sources:
3362 * - Metadata blobs, if the ::WIMStruct contains image metadata
3363 * - File blobs from the on-disk WIM file (if any) backing the ::WIMStruct
3364 * - File blobs from files that have been added to the in-memory ::WIMStruct,
3365 * e.g. by using wimlib_add_image()
3366 * - File blobs from external WIMs referenced by
3367 * wimlib_reference_resource_files() or wimlib_reference_resources()
3370 * Pointer to the ::WIMStruct for which to get the blob listing.
3372 * Reserved; set to 0.
3374 * A callback function that will receive each blob.
3376 * An extra parameter that will always be passed to the callback function
3379 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3380 * that was returned from @p cb.
3383 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3384 wimlib_iterate_lookup_table_callback_t cb,
3388 * @ingroup G_nonstandalone_wims
3390 * Join a split WIM into a stand-alone (one-part) WIM.
3393 * An array of strings that gives the filenames of all parts of the split
3394 * WIM. No specific order is required, but all parts must be included with
3397 * Number of filenames in @p swms.
3398 * @param swm_open_flags
3399 * Open flags for the split WIM parts (e.g.
3400 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3401 * @param wim_write_flags
3402 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3403 * be used to write the joined WIM.
3404 * @param output_path
3405 * The path to write the joined WIM file to.
3407 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3408 * may return most error codes that can be returned by wimlib_open_wim() and
3409 * wimlib_write(), as well as the following error codes:
3411 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3412 * The split WIMs do not form a valid WIM because they do not include all
3413 * the parts of the original WIM, there are duplicate parts, or not all the
3414 * parts have the same GUID and compression type.
3416 * Note: wimlib is generalized enough that this function is not actually needed
3417 * to join a split WIM; instead, you could open the first part of the split WIM,
3418 * then reference the other parts with wimlib_reference_resource_files(), then
3419 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3420 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3424 wimlib_join(const wimlib_tchar * const *swms,
3426 const wimlib_tchar *output_path,
3428 int wim_write_flags);
3431 * @ingroup G_nonstandalone_wims
3433 * Same as wimlib_join(), but allows specifying a progress function. The
3434 * progress function will receive the write progress messages, such as
3435 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3436 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3437 * swm_open_flags, the progress function will receive a series of
3438 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3442 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3444 const wimlib_tchar *output_path,
3446 int wim_write_flags,
3447 wimlib_progress_func_t progfunc,
3452 * @ingroup G_mounting_wim_images
3454 * Mount an image from a WIM file on a directory read-only or read-write.
3457 * Pointer to the ::WIMStruct containing the image to be mounted. This
3458 * ::WIMStruct must have a backing file.
3460 * The 1-based index of the image to mount. This image cannot have been
3461 * previously modified in memory.
3463 * The path to an existing empty directory on which to mount the WIM image.
3464 * @param mount_flags
3465 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3466 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3468 * @param staging_dir
3469 * If non-NULL, the name of a directory in which a temporary directory for
3470 * storing modified or added files will be created. Ignored if
3471 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3472 * left @c NULL, the staging directory is created in the same directory as
3473 * the backing WIM file. The staging directory is automatically deleted
3474 * when the image is unmounted.
3476 * @return 0 on success; a ::wimlib_error_code value on failure.
3478 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3479 * Another process is currently modifying the WIM file.
3480 * @retval ::WIMLIB_ERR_FUSE
3481 * A non-zero status code was returned by @c fuse_main().
3482 * @retval ::WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES
3483 * There are currently multiple references to the WIM image as a result of
3484 * a call to wimlib_export_image(). Free one before attempting the
3486 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3487 * @p image does not exist in @p wim.
3488 * @retval ::WIMLIB_ERR_INVALID_PARAM
3489 * @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3490 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3491 * already been modified in memory (e.g. by wimlib_update_image()).
3492 * @retval ::WIMLIB_ERR_MKDIR
3493 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3494 * staging directory could not be created.
3495 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3496 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3497 * WIM file is considered read-only because of any of the reasons mentioned
3498 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3499 * @retval ::WIMLIB_ERR_UNSUPPORTED
3500 * Mounting is not supported in this build of the library.
3502 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3503 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3504 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3505 * indicate failure (for different reasons) to read the metadata resource for
3506 * the image to mount.
3508 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3509 * UserSpacE). Depending on how FUSE is set up on your system, this function
3510 * may work as normal users in addition to the root user.
3512 * Mounting WIM images is not supported if wimlib was configured
3513 * <c>--without-fuse</c>. This includes Windows builds of wimlib;
3514 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3516 * Calling this function daemonizes the process, unless
3517 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3519 * It is safe to mount multiple images from the same WIM file read-only at the
3520 * same time, but only if different ::WIMStruct's are used. It is @b not safe
3521 * to mount multiple images from the same WIM file read-write at the same time.
3523 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3524 * different process.
3527 wimlib_mount_image(WIMStruct *wim,
3529 const wimlib_tchar *dir,
3531 const wimlib_tchar *staging_dir);
3534 * @ingroup G_creating_and_opening_wims
3536 * Open a WIM file and create a ::WIMStruct for it.
3539 * The path to the WIM file to open.
3541 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3543 * On success, a pointer to a new ::WIMStruct backed by the specified
3544 * on-disk WIM file is written to the memory location pointed to by this
3545 * parameter. This ::WIMStruct must be freed using using wimlib_free()
3546 * when finished with it.
3548 * @return 0 on success; a ::wimlib_error_code value on failure.
3550 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3551 * The number of metadata resources found in the WIM did not match the
3552 * image count specified in the WIM header, or the number of <IMAGE>
3553 * elements in the XML data of the WIM did not match the image count
3554 * specified in the WIM header.
3555 * @retval ::WIMLIB_ERR_INTEGRITY
3556 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags, and
3557 * the WIM file failed the integrity check.
3558 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3559 * The library did not recognize the compression chunk size of the WIM as
3560 * valid for its compression type.
3561 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3562 * The library did not recognize the compression type of the WIM.
3563 * @retval ::WIMLIB_ERR_INVALID_HEADER
3564 * The header of the WIM was otherwise invalid.
3565 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3566 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3567 * the WIM contained an integrity table, but the integrity table was
3569 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3570 * The lookup table of the WIM was invalid.
3571 * @retval ::WIMLIB_ERR_INVALID_PARAM
3572 * @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3573 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3574 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3575 * specified in @p open_flags.
3576 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3577 * The file did not begin with the magic characters that identify a WIM
3579 * @retval ::WIMLIB_ERR_OPEN
3580 * Failed to open the WIM file for reading. Some possible reasons: the WIM
3581 * file does not exist, or the calling process does not have permission to
3583 * @retval ::WIMLIB_ERR_READ
3584 * Failed to read data from the WIM file.
3585 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3586 * Unexpected end-of-file while reading data from the WIM file.
3587 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3588 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3589 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3590 * The WIM cannot be opened because it contains encrypted segments. (It
3591 * may be a Windows 8 "ESD" file.)
3592 * @retval ::WIMLIB_ERR_WIM_IS_INCOMPLETE
3593 * The WIM file is not complete (e.g. the program which wrote it was
3594 * terminated before it finished)
3595 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3596 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3597 * considered read-only because of any of the reasons mentioned in the
3598 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3599 * @retval ::WIMLIB_ERR_XML
3600 * The XML data of the WIM was invalid.
3603 wimlib_open_wim(const wimlib_tchar *wim_file,
3605 WIMStruct **wim_ret);
3608 * @ingroup G_creating_and_opening_wims
3610 * Same as wimlib_open_wim(), but allows specifying a progress function and
3611 * progress context. If successful, the progress function will be registered in
3612 * the newly open ::WIMStruct, as if by an automatic call to
3613 * wimlib_register_progress_function(). In addition, if
3614 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, then the
3615 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3616 * messages while checking the WIM file's integrity.
3619 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3621 WIMStruct **wim_ret,
3622 wimlib_progress_func_t progfunc,
3626 * @ingroup G_writing_and_overwriting_wims
3628 * Commit a ::WIMStruct to disk, updating its backing file.
3630 * There are several alternative ways in which changes may be committed:
3632 * 1. Full rebuild: write the updated WIM to a temporary file, then rename the
3633 * temporary file to the original.
3634 * 2. Appending: append updates to the new original WIM file, then overwrite
3635 * its header such that those changes become visible to new readers.
3636 * 3. Compaction: normally should not be used; see
3637 * ::WIMLIB_WRITE_FLAG_UNSAFE_COMPACT for details.
3639 * Append mode is often much faster than a full rebuild, but it wastes some
3640 * amount of space due to leaving "holes" in the WIM file. Because of the
3641 * greater efficiency, wimlib_overwrite() normally defaults to append mode.
3642 * However, ::WIMLIB_WRITE_FLAG_REBUILD can be used to explicitly request a full
3643 * rebuild. In addition, if wimlib_delete_image() has been used on the
3644 * ::WIMStruct, then the default mode switches to rebuild mode, and
3645 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE can be used to explicitly request append
3648 * If this function completes successfully, then no more functions can be called
3649 * on the ::WIMStruct other than wimlib_free(). If you need to continue using
3650 * the WIM file, you must use wimlib_open_wim() to open a new ::WIMStruct for
3654 * Pointer to a ::WIMStruct to commit to its backing file.
3655 * @param write_flags
3656 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3657 * @param num_threads
3658 * The number of threads to use for compressing data, or 0 to have the
3659 * library automatically choose an appropriate number.
3661 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3662 * may return most error codes returned by wimlib_write() as well as the
3663 * following error codes:
3665 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3666 * Another process is currently modifying the WIM file.
3667 * @retval ::WIMLIB_ERR_NO_FILENAME
3668 * @p wim is not backed by an on-disk file. In other words, it is a
3669 * ::WIMStruct created by wimlib_create_new_wim() rather than
3670 * wimlib_open_wim().
3671 * @retval ::WIMLIB_ERR_RENAME
3672 * The temporary file to which the WIM was written could not be renamed to
3673 * the original file.
3674 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3675 * The WIM file is considered read-only because of any of the reasons
3676 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3679 * If a progress function is registered with @p wim, then it will receive the
3680 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3681 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3682 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3685 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3688 * @ingroup G_wim_information
3690 * Print information about one image, or all images, contained in a WIM.
3693 * Pointer to the ::WIMStruct to query. This need not represent a
3694 * standalone WIM (e.g. it could represent part of a split WIM).
3696 * The 1-based index of the image for which to print information, or
3697 * ::WIMLIB_ALL_IMAGES to print information about all images.
3699 * @return This function has no return value. No error checking is done when
3700 * printing the information. If @p image is invalid, an error message is
3704 wimlib_print_available_images(const WIMStruct *wim, int image);
3707 * @ingroup G_wim_information
3709 * Print the header of the WIM file (intended for debugging only).
3712 wimlib_print_header(const WIMStruct *wim);
3715 * @ingroup G_nonstandalone_wims
3717 * Reference file data from other WIM files or split WIM parts. This function
3718 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3719 * to load additional file data before calling a function such as
3720 * wimlib_extract_image() that requires the file data to be present.
3723 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3724 * necessarily "standalone". In the case of split WIMs, this should be the
3725 * first part, since only the first part contains the metadata resources.
3726 * In the case of delta WIMs, this should be the delta WIM rather than the
3727 * WIM on which it is based.
3728 * @param resource_wimfiles_or_globs
3729 * Array of paths to WIM files and/or split WIM parts to reference.
3730 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3731 * ref_flags, these are treated as globs rather than literal paths. That
3732 * is, using this function you can specify zero or more globs, each of
3733 * which expands to one or more literal paths.
3735 * Number of entries in @p resource_wimfiles_or_globs.
3737 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3738 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3740 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3741 * pass to internal calls to wimlib_open_wim() on the reference files.
3743 * @return 0 on success; a ::wimlib_error_code value on failure.
3745 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3746 * One of the specified globs did not match any paths (only with both
3747 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3748 * specified in @p ref_flags).
3749 * @retval ::WIMLIB_ERR_READ
3750 * I/O or permissions error while processing a file glob.
3752 * This function can additionally return most values that can be returned by
3753 * wimlib_open_wim().
3756 wimlib_reference_resource_files(WIMStruct *wim,
3757 const wimlib_tchar * const *resource_wimfiles_or_globs,
3763 * @ingroup G_nonstandalone_wims
3765 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3766 * where the caller must open the ::WIMStruct for each referenced file itself.
3769 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3770 * necessarily "standalone". In the case of split WIMs, this should be the
3771 * first part, since only the first part contains the metadata resources.
3772 * @param resource_wims
3773 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3774 * split WIM parts to reference.
3775 * @param num_resource_wims
3776 * Number of entries in @p resource_wims.
3778 * Reserved; must be 0.
3780 * @return 0 on success; a ::wimlib_error_code value on failure.
3783 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3784 unsigned num_resource_wims, int ref_flags);
3787 * @ingroup G_modifying_wims
3789 * Declare that a newly added image is mostly the same as a prior image, but
3790 * captured at a later point in time, possibly with some modifications in the
3791 * intervening time. This is designed to be used in incremental backups of the
3792 * same filesystem or directory tree.
3794 * This function compares the metadata of the directory tree of the newly added
3795 * image against that of the old image. Any files that are present in both the
3796 * newly added image and the old image and have timestamps that indicate they
3797 * haven't been modified are deemed not to have been modified and have their
3798 * checksums copied from the old image. Because of this and because WIM uses
3799 * single-instance streams, such files need not be read from the filesystem when
3800 * the WIM is being written or overwritten. Note that these unchanged files
3801 * will still be "archived" and will be logically present in the new image; the
3802 * optimization is that they don't need to actually be read from the filesystem
3803 * because the WIM already contains them.
3805 * This function is provided to optimize incremental backups. The resulting WIM
3806 * file will still be the same regardless of whether this function is called.
3807 * (This is, however, assuming that timestamps have not been manipulated or
3808 * unmaintained as to trick this function into thinking a file has not been
3809 * modified when really it has. To partly guard against such cases, other
3810 * metadata such as file sizes will be checked as well.)
3812 * This function must be called after adding the new image (e.g. with
3813 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3814 * wimlib_overwrite()).
3817 * Pointer to the ::WIMStruct containing the newly added image.
3819 * The 1-based index in @p wim of the newly added image.
3820 * @param template_wim
3821 * Pointer to the ::WIMStruct containing the template image. This can be,
3822 * but does not have to be, the same ::WIMStruct as @p wim.
3823 * @param template_image
3824 * The 1-based index in @p template_wim of the template image.
3826 * Reserved; must be 0.
3828 * @return 0 on success; a ::wimlib_error_code value on failure.
3830 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3831 * @p new_image does not exist in @p wim or @p template_image does not
3832 * exist in @p template_wim.
3833 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3834 * The specified ::WIMStruct did not actually contain the metadata resource
3835 * for the new or template image; for example, it was a non-first part of a
3837 * @retval ::WIMLIB_ERR_INVALID_PARAM
3838 * @p new_image was equal to @p template_image, or @p new_image specified
3839 * an image that had not been modified since opening the WIM.
3841 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3842 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3843 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3844 * indicate failure (for different reasons) to read the metadata resource for
3845 * the template image.
3848 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3849 WIMStruct *template_wim, int template_image,
3853 * @ingroup G_general
3855 * Register a progress function with a ::WIMStruct.
3858 * The ::WIMStruct for which to register the progress function.
3860 * Pointer to the progress function to register. If the WIM already has a
3861 * progress function registered, it will be replaced with this one. If @p
3862 * NULL, the current progress function (if any) will be unregistered.
3864 * The value which will be passed as the third argument to calls to @p
3868 wimlib_register_progress_function(WIMStruct *wim,
3869 wimlib_progress_func_t progfunc,
3873 * @ingroup G_modifying_wims
3875 * Rename the @p source_path to the @p dest_path in the specified @p image of
3878 * This just builds an appropriate ::wimlib_rename_command and passes it to
3879 * wimlib_update_image().
3882 wimlib_rename_path(WIMStruct *wim, int image,
3883 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3886 * @ingroup G_wim_information
3888 * Translate a string specifying the name or number of an image in the WIM into
3889 * the number of the image. The images are numbered starting at 1.
3892 * Pointer to the ::WIMStruct for a WIM.
3893 * @param image_name_or_num
3894 * A string specifying the name or number of an image in the WIM. If it
3895 * parses to a positive integer, this integer is taken to specify the
3896 * number of the image, indexed starting at 1. Otherwise, it is taken to
3897 * be the name of an image, as given in the XML data for the WIM file. It
3898 * also may be the keyword "all" or the string "*", both of which will
3899 * resolve to ::WIMLIB_ALL_IMAGES.
3901 * There is no way to search for an image actually named "all", "*", or an
3902 * integer number, or an image that has no name. However, you can use
3903 * wimlib_get_image_name() to get the name of any image.
3906 * If the string resolved to a single existing image, the number of that
3907 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3908 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3909 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3910 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3911 * images in @p wim has no name. (Since a WIM may have multiple unnamed
3912 * images, an unnamed image must be specified by index to eliminate the
3916 wimlib_resolve_image(WIMStruct *wim,
3917 const wimlib_tchar *image_name_or_num);
3920 * @ingroup G_general
3922 * Set the file to which the library will print error and warning messages.
3924 * This version of the function takes a C library <c>FILE*</c> opened for
3925 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3926 * file by name instead.
3928 * This also enables error messages, as if by a call to
3929 * wimlib_set_print_errors(true).
3931 * @return 0 on success; a ::wimlib_error_code value on failure.
3933 * @retval ::WIMLIB_ERR_UNSUPPORTED
3934 * wimlib was compiled using the <c>--without-error-messages</c> option.
3937 wimlib_set_error_file(FILE *fp);
3940 * @ingroup G_general
3942 * Set the path to the file to which the library will print error and warning
3943 * messages. The library will open this file for appending.
3945 * This also enables error messages, as if by a call to
3946 * wimlib_set_print_errors(true).
3948 * @return 0 on success; a ::wimlib_error_code value on failure.
3950 * @retval ::WIMLIB_ERR_OPEN
3951 * The file named by @p path could not be opened for appending.
3952 * @retval ::WIMLIB_ERR_UNSUPPORTED
3953 * wimlib was compiled using the <c>--without-error-messages</c> option.
3956 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3959 * @ingroup G_modifying_wims
3961 * Change the description of a WIM image. Equivalent to
3962 * <tt>wimlib_set_image_property(wim, image, "DESCRIPTION", description)</tt>.
3965 wimlib_set_image_descripton(WIMStruct *wim, int image,
3966 const wimlib_tchar *description);
3969 * @ingroup G_modifying_wims
3971 * Change what is stored in the \<FLAGS\> element in the WIM XML document
3972 * (usually something like "Core" or "Ultimate"). Equivalent to
3973 * <tt>wimlib_set_image_property(wim, image, "FLAGS", flags)</tt>.
3976 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3979 * @ingroup G_modifying_wims
3981 * Change the name of a WIM image. Equivalent to
3982 * <tt>wimlib_set_image_property(wim, image, "NAME", name)</tt>.
3985 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3988 * @ingroup G_modifying_wims
3990 * Since wimlib v1.8.3: add, modify, or remove a per-image property from the
3991 * WIM's XML document. This is an alternative to wimlib_set_image_name(),
3992 * wimlib_set_image_descripton(), and wimlib_set_image_flags() which allows
3993 * manipulating any simple string property.
3996 * Pointer to the ::WIMStruct for the WIM.
3998 * The 1-based index of the image for which to set the property.
3999 * @param property_name
4000 * The name of the image property in the same format documented for
4001 * wimlib_get_image_property().
4003 * Note: if creating a new element using a bracketed index such as
4004 * "WINDOWS/LANGUAGES/LANGUAGE[2]", the highest index that can be specified
4005 * is one greater than the number of existing elements with that same name,
4006 * excluding the index. That means that if you are adding a list of new
4007 * elements, they must be added sequentially from the first index (1) to
4008 * the last index (n).
4009 * @param property_value
4010 * If not NULL and not empty, the property is set to this value.
4011 * Otherwise, the property is removed from the XML document.
4013 * @return 0 on success; a ::wimlib_error_code value on failure.
4015 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
4016 * The user requested to set the image name (the <tt>NAME</tt> property),
4017 * but another image in the WIM already had the requested name.
4018 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4019 * @p image does not exist in @p wim.
4020 * @retval ::WIMLIB_ERR_INVALID_PARAM
4021 * @p property_name has an unsupported format, or @p property_name included
4022 * a bracketed index that was too high.
4025 wimlib_set_image_property(WIMStruct *wim, int image,
4026 const wimlib_tchar *property_name,
4027 const wimlib_tchar *property_value);
4030 * @ingroup G_general
4032 * Set the functions that wimlib uses to allocate and free memory.
4034 * These settings are global and not per-WIM.
4036 * The default is to use the default @c malloc(), @c free(), and @c realloc()
4037 * from the standard C library.
4039 * Note: some external functions, such as those in @c libntfs-3g, may use the
4040 * standard memory allocation functions regardless of this setting.
4042 * @param malloc_func
4043 * A function equivalent to @c malloc() that wimlib will use to allocate
4044 * memory. If @c NULL, the allocator function is set back to the default
4045 * @c malloc() from the C library.
4047 * A function equivalent to @c free() that wimlib will use to free memory.
4048 * If @c NULL, the free function is set back to the default @c free() from
4050 * @param realloc_func
4051 * A function equivalent to @c realloc() that wimlib will use to reallocate
4052 * memory. If @c NULL, the free function is set back to the default @c
4053 * realloc() from the C library.
4058 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
4059 void (*free_func)(void *),
4060 void *(*realloc_func)(void *, size_t));
4063 * @ingroup G_writing_and_overwriting_wims
4065 * Set a ::WIMStruct's output compression chunk size. This is the compression
4066 * chunk size that will be used for writing non-solid resources in subsequent
4067 * calls to wimlib_write() or wimlib_overwrite(). A larger compression chunk
4068 * size often results in a better compression ratio, but compression may be
4069 * slower and the speed of random access to data may be reduced. In addition,
4070 * some chunk sizes are not compatible with Microsoft software.
4073 * The ::WIMStruct for which to set the output chunk size.
4075 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
4076 * on the compression type. See the documentation for each
4077 * ::wimlib_compression_type constant for more information. As a special
4078 * case, if @p chunk_size is specified as 0, then the chunk size will be
4079 * reset to the default for the currently selected output compression type.
4081 * @return 0 on success; a ::wimlib_error_code value on failure.
4083 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
4084 * @p chunk_size was not 0 or a supported chunk size for the currently
4085 * selected output compression type.
4088 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4091 * @ingroup G_writing_and_overwriting_wims
4093 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4097 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4100 * @ingroup G_writing_and_overwriting_wims
4102 * Set a ::WIMStruct's output compression type. This is the compression type
4103 * that will be used for writing non-solid resources in subsequent calls to
4104 * wimlib_write() or wimlib_overwrite().
4107 * The ::WIMStruct for which to set the output compression type.
4109 * The compression type to set. If this compression type is incompatible
4110 * with the current output chunk size, then the output chunk size will be
4111 * reset to the default for the new compression type.
4113 * @return 0 on success; a ::wimlib_error_code value on failure.
4115 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4116 * @p ctype did not specify a valid compression type.
4119 wimlib_set_output_compression_type(WIMStruct *wim,
4120 enum wimlib_compression_type ctype);
4123 * @ingroup G_writing_and_overwriting_wims
4125 * Similar to wimlib_set_output_compression_type(), but set the compression type
4126 * for writing solid resources. This cannot be ::WIMLIB_COMPRESSION_TYPE_NONE.
4129 wimlib_set_output_pack_compression_type(WIMStruct *wim,
4130 enum wimlib_compression_type ctype);
4133 * @ingroup G_general
4135 * Set whether wimlib can print error and warning messages to the error file,
4136 * which defaults to standard error. Error and warning messages may provide
4137 * information that cannot be determined only from returned error codes.
4139 * By default, error messages are not printed.
4141 * This setting applies globally (it is not per-WIM).
4143 * This can be called before wimlib_global_init().
4145 * @param show_messages
4146 * @c true if messages are to be printed; @c false if messages are not to
4149 * @return 0 on success; a ::wimlib_error_code value on failure.
4151 * @retval ::WIMLIB_ERR_UNSUPPORTED
4152 * wimlib was compiled using the <c>--without-error-messages</c> option.
4155 wimlib_set_print_errors(bool show_messages);
4158 * @ingroup G_modifying_wims
4160 * Set basic information about a WIM.
4163 * Pointer to the ::WIMStruct for a WIM.
4165 * Pointer to a ::wimlib_wim_info structure that contains the information
4166 * to set. Only the information explicitly specified in the @p which flags
4169 * Flags that specify which information to set. This is a bitwise OR of
4170 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4171 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4173 * @return 0 on success; a ::wimlib_error_code value on failure.
4175 * @retval ::WIMLIB_ERR_IMAGE_COUNT
4176 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4177 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4181 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4185 * @ingroup G_nonstandalone_wims
4187 * Split a WIM into multiple parts.
4190 * The ::WIMStruct for the WIM to split.
4192 * Name of the split WIM (SWM) file to create. This will be the name of
4193 * the first part. The other parts will, by default, have the same name
4194 * with 2, 3, 4, ..., etc. appended before the suffix. However, the exact
4195 * names can be customized using the progress function.
4197 * The maximum size per part, in bytes. Unfortunately, it is not
4198 * guaranteed that this will really be the maximum size per part, because
4199 * some file resources in the WIM may be larger than this size, and the WIM
4200 * file format provides no way to split up file resources among multiple
4202 * @param write_flags
4203 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4204 * flags will be used to write each split WIM part. Specify 0 here to get
4205 * the default behavior.
4207 * @return 0 on success; a ::wimlib_error_code value on failure. This function
4208 * may return most error codes that can be returned by wimlib_write() as well as
4209 * the following error codes:
4211 * @retval ::WIMLIB_ERR_INVALID_PARAM
4212 * @p swm_name was not a nonempty string, or @p part_size was 0.
4213 * @retval ::WIMLIB_ERR_UNSUPPORTED
4214 * The WIM contains solid resources. Splitting a WIM containing solid
4215 * resources is not supported.
4217 * If a progress function is registered with @p wim, then for each split WIM
4218 * part that is written it will receive the messages
4219 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4220 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4223 wimlib_split(WIMStruct *wim,
4224 const wimlib_tchar *swm_name,
4229 * @ingroup G_general
4231 * Perform verification checks on a WIM file.
4233 * This function is intended for safety checking and/or debugging. If used on a
4234 * well-formed WIM file, it should always succeed.
4237 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4238 * verification, it is a good idea to have used
4239 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4241 * If verifying a split WIM, specify the first part of the split WIM here,
4242 * and reference the other parts using wimlib_reference_resource_files()
4243 * before calling this function.
4244 * @param verify_flags
4245 * Reserved; must be 0.
4247 * @return 0 if the WIM file was successfully verified; a ::wimlib_error_code
4248 * value if it failed verification or another error occurred.
4250 * @retval ::WIMLIB_ERR_DECOMPRESSION
4251 * A compressed resource could not be decompressed.
4252 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4253 * The metadata resource for an image is invalid.
4254 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4255 * File data stored in the WIM file is corrupt.
4256 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4257 * The data for a file in an image could not be found. See @ref
4258 * G_nonstandalone_wims.
4260 * If a progress function is registered with @p wim, then it will receive the
4261 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4262 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4263 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4266 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4269 * @ingroup G_mounting_wim_images
4271 * Unmount a WIM image that was mounted using wimlib_mount_image().
4273 * When unmounting a read-write mounted image, the default behavior is to
4274 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4275 * WIM image to be committed.
4278 * The directory the WIM image was mounted on.
4279 * @param unmount_flags
4280 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4282 * @return 0 on success; a ::wimlib_error_code value on failure.
4284 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4285 * There is no WIM image mounted on the specified directory.
4286 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4287 * The read-write mounted WIM image cannot be committed because there are
4288 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4290 * @retval ::WIMLIB_ERR_MQUEUE
4291 * Could not create a POSIX message queue.
4292 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4293 * The WIM image was mounted by a different user.
4294 * @retval ::WIMLIB_ERR_UNSUPPORTED
4295 * Mounting is not supported in this build of the library.
4297 * Note: you can also unmount the image by using the @c umount() system call, or
4298 * by using the @c umount or @c fusermount programs. However, you need to call
4299 * this function if you want changes to be committed.
4302 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4305 * @ingroup G_mounting_wim_images
4307 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4308 * If changes are committed from a read-write mount, the progress function will
4309 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4312 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4314 wimlib_progress_func_t progfunc,
4318 * @ingroup G_modifying_wims
4320 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4323 * Pointer to the ::WIMStruct containing the image to update.
4325 * The 1-based index of the image to update.
4327 * An array of ::wimlib_update_command's that specify the update operations
4330 * Number of commands in @p cmds.
4331 * @param update_flags
4332 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4334 * @return 0 on success; a ::wimlib_error_code value on failure. On failure,
4335 * all update commands will be rolled back, and no visible changes will have
4336 * been made to @p wim.
4338 * @retval ::WIMLIB_ERR_FVE_LOCKED_VOLUME
4339 * Windows-only: One of the "add" commands attempted to add files from an
4340 * encrypted BitLocker volume that hasn't yet been unlocked.
4341 * @retval ::WIMLIB_ERR_IMAGE_HAS_MULTIPLE_REFERENCES
4342 * There are currently multiple references to the WIM image as a result of
4343 * a call to wimlib_export_image(). Free one before attempting the update.
4344 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4345 * The contents of a capture configuration file were invalid.
4346 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4347 * @p image did not exist in @p wim.
4348 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4349 * Attempted to perform an add command that conflicted with previously
4350 * existing files in the WIM when an overlay was attempted.
4351 * @retval ::WIMLIB_ERR_INVALID_PARAM
4352 * An unknown operation type was specified in the update commands; or, both
4353 * ::WIMLIB_ADD_FLAG_RPFIX and ::WIMLIB_ADD_FLAG_NORPFIX were specified in
4354 * the @p add_flags for one add command; or ::WIMLIB_ADD_FLAG_RPFIX were
4355 * specified in the @p add_flags for an add command in which @p
4356 * wim_target_path was not the root directory of the WIM image.
4357 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4358 * (Windows only): While executing an add command, tried to capture a
4359 * reparse point with invalid data.
4360 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4361 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4362 * for a WIM path that corresponded to a directory; or, a rename command
4363 * attempted to rename a directory to a non-directory.
4364 * @retval ::WIMLIB_ERR_NOTDIR
4365 * A rename command attempted to rename a directory to a non-directory; or,
4366 * an add command was executed that attempted to set the root of the WIM
4367 * image as a non-directory; or, a path component used as a directory in a
4368 * rename command was not, in fact, a directory.
4369 * @retval ::WIMLIB_ERR_NOTEMPTY
4370 * A rename command attempted to rename a directory to a non-empty
4372 * @retval ::WIMLIB_ERR_NTFS_3G
4373 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4374 * error occurred while reading data from the NTFS volume using libntfs-3g.
4375 * @retval ::WIMLIB_ERR_OPEN
4376 * Failed to open a file to be captured while executing an add command.
4377 * @retval ::WIMLIB_ERR_OPENDIR
4378 * Failed to open a directory to be captured while executing an add command.
4379 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4380 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4381 * WIM path that did not exist; or, a rename command attempted to rename a
4382 * file that does not exist.
4383 * @retval ::WIMLIB_ERR_READ
4384 * While executing an add command, failed to read data from a file or
4385 * directory to be captured.
4386 * @retval ::WIMLIB_ERR_READLINK
4387 * While executing an add command, failed to read the target of a symbolic
4388 * link or junction point.
4389 * @retval ::WIMLIB_ERR_STAT
4390 * While executing an add command, failed to get attributes for a file or
4392 * @retval ::WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG
4393 * A capture configuration file could not be read.
4394 * @retval ::WIMLIB_ERR_UNSUPPORTED
4395 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4396 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4397 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4398 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4399 * add_flags for an update command.
4400 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4401 * While executing an add command, attempted to capture a file that was not
4402 * a supported file type (e.g. a device file). Only if
4403 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4404 * for an update command.
4406 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4407 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4408 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4409 * indicate failure (for different reasons) to read the metadata resource for an
4410 * image that needed to be updated.
4413 wimlib_update_image(WIMStruct *wim,
4415 const struct wimlib_update_command *cmds,
4420 * @ingroup G_writing_and_overwriting_wims
4422 * Persist a ::WIMStruct to a new on-disk WIM file.
4424 * This brings in file data from any external locations, such as directory trees
4425 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4426 * wimlib_export_image(), and incorporates it into a new on-disk WIM file.
4428 * By default, the new WIM file is written as stand-alone. Using the
4429 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4430 * instead. However, this function cannot directly write a "split" WIM; use
4431 * wimlib_split() for that.
4434 * Pointer to the ::WIMStruct being persisted.
4436 * The path to the on-disk file to write.
4438 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4439 * images are to be included in the new on-disk WIM file. If for some
4440 * reason you only want to include a single image, specify the 1-based
4441 * index of that image instead.
4442 * @param write_flags
4443 * Bitwise OR of flags prefixed with @c WIMLIB_WRITE_FLAG.
4444 * @param num_threads
4445 * The number of threads to use for compressing data, or 0 to have the
4446 * library automatically choose an appropriate number.
4448 * @return 0 on success; a ::wimlib_error_code value on failure.
4450 * @retval ::WIMLIB_ERR_CONCURRENT_MODIFICATION_DETECTED
4451 * A file that had previously been scanned for inclusion in the WIM was
4452 * concurrently modified.
4453 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4454 * @p image did not exist in @p wim.
4455 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4456 * A file, stored in another WIM, which needed to be written was corrupt.
4457 * @retval ::WIMLIB_ERR_INVALID_PARAM
4458 * @p path was not a nonempty string, or invalid flags were passed.
4459 * @retval ::WIMLIB_ERR_OPEN
4460 * Failed to open the output WIM file for writing, or failed to open a file
4461 * whose data needed to be included in the WIM.
4462 * @retval ::WIMLIB_ERR_READ
4463 * Failed to read data that needed to be included in the WIM.
4464 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4465 * A file data blob that needed to be written could not be found in the
4466 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
4467 * @retval ::WIMLIB_ERR_WRITE
4468 * An error occurred when trying to write data to the new WIM file.
4470 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4471 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4472 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4473 * indicate failure (for different reasons) to read the data from a WIM file.
4475 * If a progress function is registered with @p wim, then it will receive the
4476 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4477 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4478 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4481 wimlib_write(WIMStruct *wim,
4482 const wimlib_tchar *path,
4485 unsigned num_threads);
4488 * @ingroup G_writing_and_overwriting_wims
4490 * Same as wimlib_write(), but write the WIM directly to a file descriptor,
4491 * which need not be seekable if the write is done in a special pipable WIM
4492 * format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p write_flags. This can,
4493 * for example, allow capturing a WIM image and streaming it over the network.
4494 * See @ref subsec_pipable_wims for more information about pipable WIMs.
4496 * The file descriptor @p fd will @b not be closed when the write is complete;
4497 * the calling code is responsible for this.
4499 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
4500 * error codes include those that can be returned by wimlib_write() as well as
4503 * @retval ::WIMLIB_ERR_INVALID_PARAM
4504 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4505 * specified in @p write_flags.
4508 wimlib_write_to_fd(WIMStruct *wim,
4512 unsigned num_threads);
4515 * @defgroup G_compression Compression and decompression functions
4517 * @brief Functions for XPRESS, LZX, and LZMS compression and decompression.
4519 * These functions are already used by wimlib internally when appropriate for
4520 * reading and writing WIM archives. But they are exported and documented so
4521 * that they can be used in other applications or libraries for general-purpose
4522 * lossless data compression. They are implemented in highly optimized C code,
4523 * using state-of-the-art compression techniques. The main limitation is the
4524 * lack of sliding window support; this has, however, allowed the algorithms to
4525 * be optimized for block-based compression.
4530 /** Opaque compressor handle. */
4531 struct wimlib_compressor;
4533 /** Opaque decompressor handle. */
4534 struct wimlib_decompressor;
4537 * Set the default compression level for the specified compression type. This
4538 * is the compression level that wimlib_create_compressor() assumes if it is
4539 * called with @p compression_level specified as 0.
4541 * wimlib's WIM writing code (e.g. wimlib_write()) will pass 0 to
4542 * wimlib_create_compressor() internally. Therefore, calling this function will
4543 * affect the compression level of any data later written to WIM files using the
4544 * specified compression type.
4546 * The initial state, before this function is called, is that all compression
4547 * types have a default compression level of 50.
4550 * Compression type for which to set the default compression level, as one
4551 * of the ::wimlib_compression_type constants. Or, if this is the special
4552 * value -1, the default compression levels for all compression types will
4554 * @param compression_level
4555 * The default compression level to set. If 0, the "default default" level
4556 * of 50 is restored. Otherwise, a higher value indicates higher
4557 * compression, whereas a lower value indicates lower compression. See
4558 * wimlib_create_compressor() for more information.
4560 * @return 0 on success; a ::wimlib_error_code value on failure.
4562 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4563 * @p ctype was neither a supported compression type nor -1.
4566 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
4569 * Return the approximate number of bytes needed to allocate a compressor with
4570 * wimlib_create_compressor() for the specified compression type, maximum block
4571 * size, and compression level. @p compression_level may be 0, in which case
4572 * the current default compression level for @p ctype is used. Returns 0 if the
4573 * compression type is invalid, or the @p max_block_size for that compression
4577 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4578 size_t max_block_size,
4579 unsigned int compression_level);
4581 #define WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE 0x80000000
4584 * Allocate a compressor for the specified compression type using the specified
4585 * parameters. This function is part of wimlib's compression API; it is not
4586 * necessary to call this to process a WIM file.
4589 * Compression type for which to create the compressor, as one of the
4590 * ::wimlib_compression_type constants.
4591 * @param max_block_size
4592 * The maximum compression block size to support. This specifies the
4593 * maximum allowed value for the @p uncompressed_size parameter of
4594 * wimlib_compress() when called using this compressor.
4596 * Usually, the amount of memory used by the compressor will scale in
4597 * proportion to the @p max_block_size parameter.
4598 * wimlib_get_compressor_needed_memory() can be used to query the specific
4599 * amount of memory that will be required.
4601 * This parameter must be at least 1 and must be less than or equal to a
4602 * compression-type-specific limit.
4604 * In general, the same value of @p max_block_size must be passed to
4605 * wimlib_create_decompressor() when the data is later decompressed.
4606 * However, some compression types have looser requirements regarding this.
4607 * @param compression_level
4608 * The compression level to use. If 0, the default compression level (50,
4609 * or another value as set through wimlib_set_default_compression_level())
4610 * is used. Otherwise, a higher value indicates higher compression. The
4611 * values are scaled so that 10 is low compression, 50 is medium
4612 * compression, and 100 is high compression. This is not a percentage;
4613 * values above 100 are also valid.
4615 * Using a higher-than-default compression level can result in a better
4616 * compression ratio, but can significantly reduce performance. Similarly,
4617 * using a lower-than-default compression level can result in better
4618 * performance, but can significantly worsen the compression ratio. The
4619 * exact results will depend heavily on the compression type and what
4620 * algorithms are implemented for it. If you are considering using a
4621 * non-default compression level, you should run benchmarks to see if it is
4622 * worthwhile for your application.
4624 * The compression level does not affect the format of the compressed data.
4625 * Therefore, it is a compressor-only parameter and does not need to be
4626 * passed to the decompressor.
4628 * Since wimlib v1.8.0, this parameter can be OR-ed with the flag
4629 * ::WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE. This creates the compressor in a
4630 * mode where it is allowed to modify the input buffer. Specifically, in
4631 * this mode, if compression succeeds, the input buffer may have been
4632 * modified, whereas if compression does not succeed the input buffer still
4633 * may have been written to but will have been restored exactly to its
4634 * original state. This mode is designed to save some memory when using
4635 * large buffer sizes.
4636 * @param compressor_ret
4637 * A location into which to return the pointer to the allocated compressor.
4638 * The allocated compressor can be used for any number of calls to
4639 * wimlib_compress() before being freed with wimlib_free_compressor().
4641 * @return 0 on success; a ::wimlib_error_code value on failure.
4643 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4644 * @p ctype was not a supported compression type.
4645 * @retval ::WIMLIB_ERR_INVALID_PARAM
4646 * @p max_block_size was invalid for the compression type, or @p
4647 * compressor_ret was @c NULL.
4648 * @retval ::WIMLIB_ERR_NOMEM
4649 * Insufficient memory to allocate the compressor.
4652 wimlib_create_compressor(enum wimlib_compression_type ctype,
4653 size_t max_block_size,
4654 unsigned int compression_level,
4655 struct wimlib_compressor **compressor_ret);
4658 * Compress a buffer of data.
4660 * @param uncompressed_data
4661 * Buffer containing the data to compress.
4662 * @param uncompressed_size
4663 * Size, in bytes, of the data to compress. This cannot be greater than
4664 * the @p max_block_size with which wimlib_create_compressor() was called.
4665 * (If it is, the data will not be compressed and 0 will be returned.)
4666 * @param compressed_data
4667 * Buffer into which to write the compressed data.
4668 * @param compressed_size_avail
4669 * Number of bytes available in @p compressed_data.
4671 * A compressor previously allocated with wimlib_create_compressor().
4674 * The size of the compressed data, in bytes, or 0 if the data could not be
4675 * compressed to @p compressed_size_avail or fewer bytes.
4678 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4679 void *compressed_data, size_t compressed_size_avail,
4680 struct wimlib_compressor *compressor);
4683 * Free a compressor previously allocated with wimlib_create_compressor().
4686 * The compressor to free. If @c NULL, no action is taken.
4689 wimlib_free_compressor(struct wimlib_compressor *compressor);
4692 * Allocate a decompressor for the specified compression type. This function is
4693 * part of wimlib's compression API; it is not necessary to call this to process
4697 * Compression type for which to create the decompressor, as one of the
4698 * ::wimlib_compression_type constants.
4699 * @param max_block_size
4700 * The maximum compression block size to support. This specifies the
4701 * maximum allowed value for the @p uncompressed_size parameter of
4702 * wimlib_decompress().
4704 * In general, this parameter must be the same as the @p max_block_size
4705 * that was passed to wimlib_create_compressor() when the data was
4706 * compressed. However, some compression types have looser requirements
4708 * @param decompressor_ret
4709 * A location into which to return the pointer to the allocated
4710 * decompressor. The allocated decompressor can be used for any number of
4711 * calls to wimlib_decompress() before being freed with
4712 * wimlib_free_decompressor().
4714 * @return 0 on success; a ::wimlib_error_code value on failure.
4716 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4717 * @p ctype was not a supported compression type.
4718 * @retval ::WIMLIB_ERR_INVALID_PARAM
4719 * @p max_block_size was invalid for the compression type, or @p
4720 * decompressor_ret was @c NULL.
4721 * @retval ::WIMLIB_ERR_NOMEM
4722 * Insufficient memory to allocate the decompressor.
4725 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4726 size_t max_block_size,
4727 struct wimlib_decompressor **decompressor_ret);
4730 * Decompress a buffer of data.
4732 * @param compressed_data
4733 * Buffer containing the data to decompress.
4734 * @param compressed_size
4735 * Size, in bytes, of the data to decompress.
4736 * @param uncompressed_data
4737 * Buffer into which to write the uncompressed data.
4738 * @param uncompressed_size
4739 * Size, in bytes, of the data when uncompressed. This cannot exceed the
4740 * @p max_block_size with which wimlib_create_decompressor() was called.
4741 * (If it does, the data will not be decompressed and a nonzero value will
4743 * @param decompressor
4744 * A decompressor previously allocated with wimlib_create_decompressor().
4746 * @return 0 on success; nonzero on failure.
4748 * No specific error codes are defined; any nonzero value indicates that the
4749 * decompression failed. This can only occur if the data is truly invalid;
4750 * there will never be transient errors like "out of memory", for example.
4752 * This function requires that the exact uncompressed size of the data be passed
4753 * as the @p uncompressed_size parameter. If this is not done correctly,
4754 * decompression may fail or the data may be decompressed incorrectly.
4757 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4758 void *uncompressed_data, size_t uncompressed_size,
4759 struct wimlib_decompressor *decompressor);
4762 * Free a decompressor previously allocated with wimlib_create_decompressor().
4764 * @param decompressor
4765 * The decompressor to free. If @c NULL, no action is taken.
4768 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4780 #endif /* _WIMLIB_H */