3 * @brief External header for wimlib.
5 * This file contains extensive comments for generating documentation with
6 * Doxygen. The built HTML documentation can be viewed at
7 * http://wimlib.sourceforge.net. Make sure to see the <a
8 * href="modules.html">Modules page</a> to make more sense of the declarations
13 * Copyright (C) 2012, 2013, 2014 Eric Biggers
15 * This file is part of wimlib, a library for working with WIM files.
17 * wimlib is free software; you can redistribute it and/or modify it under the
18 * terms of the GNU General Public License as published by the Free
19 * Software Foundation; either version 3 of the License, or (at your option)
22 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
23 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
24 * A PARTICULAR PURPOSE. See the GNU General Public License for more
27 * You should have received a copy of the GNU General Public License
28 * along with wimlib; if not, see http://www.gnu.org/licenses/.
34 * This is the documentation for the library interface of wimlib 1.7.1, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the manual pages and also the <a
39 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
42 * @section sec_installing Installing
46 * Download the source code from <a
47 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
48 * Install the library by running <c>configure && make && sudo make install</c>.
49 * See the README for information about configuration options. To use wimlib in
50 * your program after installing it, include wimlib.h and link your program with
55 * Download the Windows binary distribution with the appropriate architecture
56 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
57 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
58 * Link your program with the libwim-15.dll file. Make sure to also download
59 * the source code so you can get wimlib.h, as it is not included in the binary
60 * distribution. If you need to access the DLL from other programming
61 * languages, note that the calling convention is "cdecl".
63 * @section sec_examples Examples
65 * Several examples are located in the <a
66 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
67 * directory of the source distribution.
69 * There is also the <a
70 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
71 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
72 * capabilities of wimlib.
74 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
76 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
77 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
78 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
79 * which creates a new ::WIMStruct that initially contains no images and does
80 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
83 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
84 * Images can be extracted (or "applied") using wimlib_extract_image(), added
85 * (or "captured" or "appended") using wimlib_add_image(), deleted using
86 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
87 * modified using wimlib_update_image(). However, changes made to a WIM
88 * represented by a ::WIMStruct have no persistent effect until the WIM is
89 * actually written to an on-disk file. This can be done using wimlib_write(),
90 * but if the WIM was originally opened using wimlib_open_wim(), then
91 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
92 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
94 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
95 * files is a multi-step process. For example, to add, or "append" an image to
96 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
97 * append</b>, you must call the following functions:
99 * 1. wimlib_open_wim()
100 * 2. wimlib_add_image()
101 * 3. wimlib_overwrite()
103 * This design is very much on purpose as it makes the library more useful in
104 * general by allowing functions to be composed in different ways. For example,
105 * you can make multiple changes to a WIM and commit them all to the underlying
106 * file in only one overwrite operation, which is more efficient.
108 * Note: before calling any other function declared in wimlib.h,
109 * wimlib_global_init() can (and in some cases, must) be called. See its
110 * documentation for more details.
112 * @section sec_cleaning_up Cleaning up
114 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
115 * all resources associated with it. Also, when you are completely done with
116 * using wimlib in your program, you can call wimlib_global_cleanup() to free
117 * any other resources allocated by the library.
119 * @section sec_error_handling Error Handling
121 * Most functions in wimlib return 0 on success and a positive error code on
122 * failure. Use wimlib_get_error_string() to get a string that describes an
123 * error code. wimlib also can print error messages to standard error itself
124 * when an error happens, and these may be more informative than the error code;
125 * to enable this, call wimlib_set_print_errors(). Please note that this is for
126 * convenience only, and some errors can occur without a message being printed.
127 * Currently, error messages and strings (as well as all documentation, for that
128 * matter) are only available in English.
130 * @section sec_encodings Locales and character encodings
132 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
133 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
136 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
137 * and the encoding is UTF-16LE.
139 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
140 * and the encoding is the locale-dependent multibyte encoding. I recommend you
141 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
142 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
143 * call wimlib_global_init() after having set your desired locale.
145 * @section sec_advanced Additional information and features
148 * @subsection subsec_mounting_wim_images Mounting WIM images
150 * See @ref G_mounting_wim_images.
152 * @subsection subsec_progress_functions Progress Messages
154 * See @ref G_progress.
156 * @subsection subsec_non_standalone_wims Non-standalone WIMs
158 * See @ref G_nonstandalone_wims.
160 * @subsection subsec_pipable_wims Pipable WIMs
162 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
163 * compatible with Microsoft's software. To create a pipable WIM, call
164 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
165 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
166 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
167 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
168 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
169 * s using a seekable file descriptor using the regular function calls (e.g.
170 * wimlib_open_wim(), wimlib_extract_image()).
172 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
173 * capture</b> for more information about pipable WIMs.
175 * @subsection subsec_thread_safety Thread Safety
177 * wimlib is thread-safe, with the following exceptions:
178 * - Different threads cannot operate on the same ::WIMStruct at the same time;
179 * they must use different ::WIMStruct's.
180 * - You must call wimlib_global_init() in one thread before calling any other
182 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
183 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
184 * concurrently in the same process, will daemonize the entire process when it
185 * does so for the first time. This includes changing the working directory
186 * to the root directory.
188 * @subsection subsec_limitations Limitations
190 * This section documents some technical limitations of wimlib not already
191 * documented in the man page for @b wimlib-imagex.
193 * - The old WIM format from Vista pre-releases is not supported.
194 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
195 * functionality other than that already present in @b ImageX, that allows you
196 * to make certain Windows-specific modifications to a Windows PE image, such
197 * as adding a driver or Windows component. Such a tool could be implemented
200 * @subsection more_info More information
202 * You are advised to read the README as well as the manual pages for
203 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
204 * the API documentation.
207 /** @defgroup G_general General
209 * @brief Declarations and structures shared across the library.
212 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
214 * @brief Create new WIMs and open existing WIMs.
217 /** @defgroup G_wim_information Retrieving WIM information and directory listings
219 * @brief Retrieve information about a WIM or WIM image.
222 /** @defgroup G_modifying_wims Modifying WIMs
224 * @brief Make changes to a WIM.
226 * @section sec_adding_images Capturing and adding WIM images
228 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
229 * appending an image to an existing WIM is a multi-step process, but at its
230 * core is wimlib_add_image() or an equivalent function. Normally,
231 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
232 * ::WIMStruct as a new image. However, when supported by the build of the
233 * library, there is also a special NTFS volume capture mode (entered when
234 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
235 * from an unmounted NTFS volume.
237 * Another function, wimlib_add_image_multisource() is also provided. It
238 * generalizes wimlib_add_image() to allow combining multiple files or directory
239 * trees into a single WIM image in a configurable way.
241 * For maximum customization of WIM image creation, it is also possible to add a
242 * completely empty WIM image with wimlib_add_empty_image(), then update it with
243 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
244 * wimlib_add_image_multisource() do internally.)
246 * Note that some details of how image addition/capture works are documented
247 * more fully in the manual page for <b>wimlib-imagex capture</b>.
249 * @section sec_deleting_images Deleting WIM images
251 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
252 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
253 * be made persistent in an on-disk WIM file.
255 * @section sec_exporting_images Exporting WIM images
257 * wimlib_export_image() can copy, or "export", an image from one WIM to
260 * @section sec_other_modifications Other modifications
262 * wimlib_update_image() can add, delete, and rename files in a WIM image.
264 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
265 * wimlib_set_image_flags() can change other image metadata.
267 * wimlib_set_wim_info() can change information about the WIM file itself, such
271 /** @defgroup G_extracting_wims Extracting WIMs
273 * @brief Extract files, directories, and images from a WIM.
275 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
276 * represented by a ::WIMStruct. This normally extracts the image to a
277 * directory, but when supported by the build of the library there is also a
278 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
279 * is specified) that allows extracting a WIM image directly to an unmounted
280 * NTFS volume. Various other flags allow further customization of image
283 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
284 * of (possibly wildcard) paths from a WIM image.
286 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
287 * over a pipe; see @ref subsec_pipable_wims.
289 * Some details of how WIM extraction works are documented more fully in the
290 * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
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 <code>--without-fuse</code> flag, these
303 * functions 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 Write and overwrite on-disk WIM files.
337 * As described in @ref sec_basic_wim_handling_concepts, these functions are
338 * fundamental to the design of the library as they allow new or modified
339 * ::WIMStruct's to actually be written to on-disk files. Call wimlib_write()
340 * to write a new WIM file, or wimlib_overwrite() to persistently update an
344 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
346 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
348 * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it
349 * than that. Normally, WIM files are "standalone". However, WIM files can
350 * also be arranged in non-standalone ways, such as a set of on-disk files that
351 * together form a single "split WIM" or "delta WIM". Such arrangements are
352 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
353 * created from one of these on-disk files initially only partially represents
354 * the full WIM and needs to, in effect, be logically combined with other
355 * ::WIMStruct's before performing certain operations, such as extracting files
356 * with wimlib_extract_image() or wimlib_extract_paths(). This is done by
357 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
359 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
360 * specialized function (wimlib_split()) is needed to create a split WIM.
369 #include <inttypes.h>
373 # define _wimlib_deprecated __attribute__((deprecated))
375 # define _wimlib_deprecated
378 /** @addtogroup G_general
381 /** Major version of the library (for example, the 1 in 1.2.5). */
382 #define WIMLIB_MAJOR_VERSION 1
384 /** Minor version of the library (for example, the 2 in 1.2.5). */
385 #define WIMLIB_MINOR_VERSION 7
387 /** Patch version of the library (for example, the 5 in 1.2.5). */
388 #define WIMLIB_PATCH_VERSION 1
395 * Opaque structure that represents a WIM file. This is an in-memory structure
396 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
397 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
398 * continuing to exist so that data can be read from it as needed.
400 * Most functions in this library will work the same way regardless of whether a
401 * given ::WIMStruct was obtained through wimlib_open_wim() or
402 * wimlib_create_new_wim(). Exceptions are documented.
404 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
405 * file from a ::WIMStruct.
407 * See @ref sec_basic_wim_handling_concepts for more information.
409 #ifndef WIMLIB_WIMSTRUCT_DECLARED
410 typedef struct WIMStruct WIMStruct;
411 #define WIMLIB_WIMSTRUCT_DECLARED
415 typedef wchar_t wimlib_tchar;
417 /** See @ref sec_encodings */
418 typedef char wimlib_tchar;
422 /** Path separator for WIM paths passed back to progress callbacks.
423 * This is forward slash on UNIX and backslash on Windows. */
424 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
425 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
427 /** Path separator for WIM paths passed back to progress callbacks.
428 * This is forward slash on UNIX and backslash on Windows. */
429 # define WIMLIB_WIM_PATH_SEPARATOR '/'
430 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
433 /** Use this to specify the root directory of the WIM image. */
434 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
436 /** Use this to test if the specified path refers to the root directory of the
438 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
439 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
442 /** Length of a Globally Unique Identifier (GUID) */
443 #define WIMLIB_GUID_LEN 16
446 * Specifies a compression format. Pass one of these values to
447 * wimlib_create_new_wim(), wimlib_set_output_compression_type(),
448 * wimlib_create_compressor(), or wimlib_create_decompressor().
450 * A WIM file has one default compression type and chunk size. Normally, each
451 * resource in the WIM file is compressed with this compression type. However,
452 * resources may be stored as uncompressed; for example, wimlib will do so if a
453 * resource does not compress to less than its original size. In addition, a
454 * WIM with the new version number of 3584, or "ESD file", might contain solid
455 * blocks with different compression types.
457 enum wimlib_compression_type {
461 * This is a valid argument to wimlib_create_new_wim() and
462 * wimlib_set_output_compression_type(), but not to the functions in the
463 * compression API such as wimlib_create_compressor().
465 WIMLIB_COMPRESSION_TYPE_NONE = 0,
468 * The XPRESS compression format. This format combines Lempel-Ziv
469 * factorization with Huffman encoding. Compression and decompression
470 * are both fast. This format supports chunk sizes that are powers of 2
471 * between <c>2^12</c> and <c>2^16</c>, inclusively.
473 * wimlib's XPRESS compressor will, with the default settings, usually
474 * produce a better compression ratio, and work more quickly, than the
475 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
476 * Non-default compression levels are also supported. For example,
477 * level 80 will enable two-pass optimal parsing, which is significantly
478 * slower but usually improves compression by several percent over the
479 * default level of 50.
481 * If using wimlib_create_compressor() to create an XPRESS compressor
482 * directly, the @p max_block_size parameter may be any positive value
485 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
488 * The LZX compression format. This format combines Lempel-Ziv
489 * factorization with Huffman encoding, but with more features and
490 * complexity than XPRESS. Compression is slow to somewhat fast,
491 * depending on the settings. Decompression is fast but slower than
492 * XPRESS. This format supports chunk sizes that are powers of 2
493 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
494 * other than <c>2^15</c> are not compatible with the Microsoft
497 * wimlib's LZX compressor will, with the default settings, usually
498 * produce a better compression ratio, and work more quickly, than the
499 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
500 * Non-default compression levels are also supported. For example,
501 * level 20 will provide fast compression, almost as fast as XPRESS.
503 * If using wimlib_create_compressor() to create an LZX compressor
504 * directly, the @p max_block_size parameter may be any positive value
507 WIMLIB_COMPRESSION_TYPE_LZX = 2,
510 * The LZMS compression format. This format combines Lempel-Ziv
511 * factorization with adaptive Huffman encoding and range coding.
512 * Compression and decompression are both fairly slow. This format
513 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
514 * <c>2^30</c>, inclusively. This format is best used for large chunk
515 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
516 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
517 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
518 * with the Microsoft implementation.
520 * wimlib's LZMS compressor is currently faster but will usually not
521 * compress as much as the implementation in Microsoft's WIMGAPI
524 * If using wimlib_create_compressor() to create an LZMS compressor
525 * directly, the @p max_block_size parameter may be any positive value
526 * up to <c>2^31 - 2</c>.
528 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
532 /** @addtogroup G_progress
535 /** Possible values of the first parameter to the user-supplied
536 * ::wimlib_progress_func_t progress function */
537 enum wimlib_progress_msg {
539 /** A WIM image is about to be extracted. @p info will point to
540 * ::wimlib_progress_info.extract. This message is received once per
541 * image for calls to wimlib_extract_image() and
542 * wimlib_extract_image_from_pipe(). */
543 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
545 /** One or more file or directory trees within a WIM image is about to
546 * be extracted. @p info will point to ::wimlib_progress_info.extract.
547 * This message is received only once per wimlib_extract_paths() and
548 * wimlib_extract_pathlist(), since wimlib combines all paths into a
549 * single extraction operation for optimization purposes. */
550 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
552 /** This message may be sent periodically (not for every file) while
553 * files or directories are being created, prior to data stream
554 * extraction. @p info will point to ::wimlib_progress_info.extract.
555 * In particular, the @p current_file_count and @p end_file_count
556 * members may be used to track the progress of this phase of
558 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
560 /** File data is currently being extracted. @p info will point to
561 * ::wimlib_progress_info.extract. This is the main message to track
562 * the progress of an extraction operation. */
563 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
565 /** Starting to read a new part of a split pipable WIM over the pipe.
566 * @p info will point to ::wimlib_progress_info.extract. */
567 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
569 /** This message may be sent periodically (not for every file) while
570 * file and directory metadata is being applied, following data stream
571 * extraction. @p info will point to ::wimlib_progress_info.extract.
572 * In particular, the @p current_file_count and @p end_file_count
573 * members may be used to track the progress of this phase of
575 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
577 /** Confirms that the image has been successfully extracted. @p info
578 * will point to ::wimlib_progress_info.extract. This is paired with
579 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
580 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
582 /** Confirms that the files or directory trees have been successfully
583 * extracted. @p info will point to ::wimlib_progress_info.extract.
584 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
585 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
587 /** The directory or NTFS volume is about to be scanned for metadata.
588 * @p info will point to ::wimlib_progress_info.scan. This message is
589 * received once per call to wimlib_add_image(), or once per capture
590 * source passed to wimlib_add_image_multisource(), or once per add
591 * command passed to wimlib_update_image(). */
592 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
594 /** A directory or file has been scanned. @p info will point to
595 * ::wimlib_progress_info.scan, and its @p cur_path member will be
596 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
598 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
600 /** Confirms that the directory or NTFS volume has been successfully
601 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
602 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
603 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
605 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
607 /** File resources ("streams") are currently being written to the WIM.
608 * @p info will point to ::wimlib_progress_info.write_streams. This
609 * message may be received many times while the WIM file is being
610 * written or appended to with wimlib_write(), wimlib_overwrite(), or
611 * wimlib_write_to_fd(). */
612 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
614 /** Per-image metadata is about to be written to the WIM file. @p info
615 * will not be valid. */
616 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
618 /** Confirms that per-image metadata has been successfully been written
619 * to the WIM file. @p info will not be valid. This message is paired
620 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
622 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
624 /** wimlib_overwrite() has successfully renamed the temporary file to
625 * the original WIM file, thereby committing the update. @p info will
626 * point to ::wimlib_progress_info.rename. Note: this message is not
627 * received if wimlib_overwrite() chose to append to the WIM file
629 WIMLIB_PROGRESS_MSG_RENAME = 15,
631 /** The contents of the WIM file are being checked against the integrity
632 * table. @p info will point to ::wimlib_progress_info.integrity. This
633 * message is only received (and may be received many times) when
634 * wimlib_open_wim_with_progress() is called with the
635 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
636 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
638 /** An integrity table is being calculated for the WIM being written.
639 * @p info will point to ::wimlib_progress_info.integrity. This message
640 * is only received (and may be received many times) when a WIM file is
641 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
642 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
644 /** A wimlib_split() operation is in progress, and a new split part is
645 * about to be started. @p info will point to
646 * ::wimlib_progress_info.split. */
647 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
649 /** A wimlib_split() operation is in progress, and a split part has been
650 * finished. @p info will point to ::wimlib_progress_info.split. */
651 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
653 /** A WIM update command is just about to be executed. @p info will
654 * point to ::wimlib_progress_info.update. This message is received
655 * once per update command when wimlib_update_image() is called with the
656 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
657 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
659 /** A WIM update command has just been executed. @p info will point to
660 * ::wimlib_progress_info.update. This message is received once per
661 * update command when wimlib_update_image() is called with the flag
662 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
663 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
665 /** A file in the WIM image is being replaced as a result of a
666 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
667 * @p info will point to ::wimlib_progress_info.replace. This is only
668 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
670 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
672 /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
673 * a file is being extracted normally (not as a WIMBoot "pointer file")
674 * due to it matching a pattern in the [PrepopulateList] section of the
675 * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
676 * WIM image. @p info will point to
677 * ::wimlib_progress_info.wimboot_exclude.
679 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
681 /** Starting to unmount a WIM image. @p info will point to
682 * ::wimlib_progress_info.unmount. */
683 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
685 /** wimlib has used a file's data for the last time (including all data
686 * streams, if it has multiple). @p info will point to
687 * ::wimlib_progress_info.done_with_file. This message is only received
688 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
689 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
691 /** wimlib_verify_wim() is starting to verify the metadata for an image.
692 * @p info will point to ::wimlib_progress_info.verify_image. */
693 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
695 /** wimlib_verify_wim() has finished verifying the metadata for an
696 * image. @p info will point to ::wimlib_progress_info.verify_image.
698 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
700 /** wimlib_verify_wim() is verifying stream integrity. @p info will
701 * point to ::wimlib_progress_info.verify_streams. */
702 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
705 * The progress function is being asked whether a file should be
706 * excluded from capture or not. @p info will point to
707 * ::wimlib_progress_info.test_file_exclusion. This is a bidirectional
708 * message that allows the progress function to set a flag if the file
709 * should be excluded.
711 * This message is only received if the flag
712 * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used. This method for file
713 * exclusions is independent of the "capture configuration file"
716 WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
719 /** Valid return values from user-provided progress functions
720 * (::wimlib_progress_func_t).
722 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
725 enum wimlib_progress_status {
727 /** The operation should be continued. This is the normal return value.
729 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
731 /** The operation should be aborted. This will cause the current
732 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
733 WIMLIB_PROGRESS_STATUS_ABORT = 1,
737 * A pointer to this union is passed to the user-supplied
738 * ::wimlib_progress_func_t progress function. One (or none) of the structures
739 * contained in this union will be applicable for the operation
740 * (::wimlib_progress_msg) indicated in the first argument to the progress
742 union wimlib_progress_info {
744 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
745 * document them if they aren't given a name... */
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 {
751 /** Total number of uncompressed bytes of stream data being
752 * written. This can be thought of as the total uncompressed
753 * size of the files being archived, with some caveats. WIM
754 * files use single-instance streams, so the size provided here
755 * only counts distinct streams, except for the following
756 * exception: the size provided here may include the sizes of
757 * all newly added (e.g. with wimlib_add_image() streams,
758 * pending automatic de-duplication during the write operation
759 * itself. When each such stream de-duplication occurs, this
760 * number will be decreased by the size of the duplicate stream
761 * that need not be written.
763 * In the case of a wimlib_overwrite() that the library opted to
764 * perform in-place, both @p total_streams and @p total_bytes
765 * will only count the streams actually being written and not
766 * pre-existing streams in the WIM file. */
767 uint64_t total_bytes;
769 /** Total number of streams being written. This can be thought
770 * of as the total number of files being archived, with some
771 * caveats. In general, a single file or directory may contain
772 * multiple data streams, each of which will be represented
773 * separately in this number. Furthermore, WIM files use
774 * single-instance streams, so the stream count provided here
775 * only counts distinct streams, except for the following
776 * exception: the stream count provided here may include newly
777 * added (e.g. with wimlib_add_image() streams, pending
778 * automatic de-duplication during the write operation itself.
779 * When each such stream de-duplication occurs, this number will
780 * be decreased by 1 to account for the duplicate stream that
781 * need not be written. */
782 uint64_t total_streams;
784 /** Number of uncompressed bytes of stream data that have been
785 * written so far. This number be 0 initially, and will be
786 * equal to @p total_bytes at the end of the write operation.
787 * Note that @p total_bytes (but not @p completed_bytes) may
788 * decrease throughout the write operation due to the discovery
789 * of stream duplications. */
790 uint64_t completed_bytes;
792 /** Number of streams that have been written so far. This
793 * number will be 0 initially, and will be equal to @p
794 * total_streams at the end of the write operation. Note that
795 * @p total_streams (but not @p completed_streams) may decrease
796 * throughout the write operation due to the discovery of stream
799 * For applications that wish to calculate a simple "percent
800 * complete" for the write operation, it will likely be more
801 * accurate to calculate the percentage from @p completed_bytes
802 * and @p total_bytes rather than @p completed_streams and
803 * @p total_streams because the time for the operation to
804 * complete is mainly determined by the number of bytes that
805 * need to be read, compressed, and written, not just the number
806 * of files being archived. */
807 uint64_t completed_streams;
809 /** Number of threads that are being used to compress streams,
810 * or 1 if streams are being written uncompressed. */
811 uint32_t num_threads;
813 /** The compression type being used to write the streams, as one
814 * of the ::wimlib_compression_type constants. */
815 int32_t compression_type;
817 /** Number of split WIM parts from which streams are being
818 * written (may be 0 if irrelevant). */
819 uint32_t total_parts;
821 /** This is currently broken and will always be 0. */
822 uint32_t completed_parts;
825 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
826 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
827 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
828 struct wimlib_progress_info_scan {
829 /** Top-level directory being scanned; or, when capturing an NTFS
830 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
831 * to the file or block device that contains the NTFS volume
833 const wimlib_tchar *source;
835 /** Path to the file (or directory) that has been scanned, valid
836 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
837 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
838 * relative to the root of the NTFS volume. */
839 const wimlib_tchar *cur_path;
841 /** Dentry scan status, valid on
842 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
844 /** The file looks okay and will be captured. */
845 WIMLIB_SCAN_DENTRY_OK = 0,
847 /** File is being excluded from capture due to the
848 * capture configuration. */
849 WIMLIB_SCAN_DENTRY_EXCLUDED,
851 /** File is being excluded from capture due to being
852 * unsupported (e.g. an encrypted or device file). */
853 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
855 /** The file is an absolute symbolic link or junction
856 * that points into the capture directory, and
857 * reparse-point fixups are enabled, so its target is
858 * being adjusted. (Reparse point fixups can be
859 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
861 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
863 /** Reparse-point fixups are enabled, but the file is an
864 * absolute symbolic link or junction that does
865 * <b>not</b> point into the capture directory, so its
866 * target is <b>not</b> being adjusted. */
867 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
871 /** Target path in the WIM image. Only valid on
872 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
873 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
874 const wimlib_tchar *wim_target_path;
876 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
877 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
878 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
879 * target of the absolute symbolic link or junction. */
880 const wimlib_tchar *symlink_target;
883 /** Number of directories scanned so far, including the root
884 * directory but excluding any unsupported/excluded directories.
886 * Details: On Windows and in NTFS capture mode, a reparse point
887 * counts as a directory if and only if it has
888 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
889 * counts as a directory if and only if when fully dereferenced
890 * it points to an accessible directory. If a file has multiple
891 * names (hard links), it is only counted one time. */
892 uint64_t num_dirs_scanned;
894 /** Number of non-directories scanned so far, excluding any
895 * unsupported/excluded files.
897 * Details: On Windows and in NTFS capture mode, a reparse point
898 * counts as a non-directory if and only if it does not have
899 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
900 * counts as a non-directory if and only if when fully
901 * dereferenced it points to a non-directory or its target is
902 * inaccessible. If a file has multiple names (hard links), it
903 * is only counted one time. */
904 uint64_t num_nondirs_scanned;
906 /** Number of bytes of file data that have been detected so far.
908 * Details: This data may not actually have been read yet, and
909 * it will not actually be written to the WIM file until
910 * wimlib_write() or wimlib_overwrite() has been called. Data
911 * from excluded files is not counted. This number includes
912 * default file contents as well as named data streams and
913 * reparse point data. The size of reparse point data is
914 * tallied after any reparse-point fixups, and in the case of
915 * capturing a symbolic link on a UNIX-like system, the creation
916 * of the reparse point data itself. If a file has multiple
917 * names (hard links), its size(s) are only counted one time.
918 * On Windows, encrypted files have their encrypted size
919 * counted, not their unencrypted size; however, compressed
920 * files have their uncompressed size counted. */
921 uint64_t num_bytes_scanned;
924 /** Valid on messages
925 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
926 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
927 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
928 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
929 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
930 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
931 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
932 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
934 * Note: most of the time of an extraction operation will be spent
935 * extracting streams, and the application will receive
936 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
937 * completed_bytes and @p total_bytes, the application can calculate a
938 * percentage complete. However, note that this message does not, in
939 * general, actually provide information about which "file" is currently
940 * being extracted. This is because wimlib, by default, extracts the
941 * individual data streams in whichever order it determines to be the
944 struct wimlib_progress_info_extract {
945 /** Number of the image from which files are being extracted
949 /** Extraction flags being used. */
950 uint32_t extract_flags;
952 /** Full path to the WIM file from which files are being
953 * extracted, or @c NULL if the WIMStruct has no associated
955 const wimlib_tchar *wimfile_name;
957 /** Name of the image from which files are being extracted, or
958 * the empty string if the image is unnamed. */
959 const wimlib_tchar *image_name;
961 /** Path to the directory or NTFS volume to which the files are
962 * being extracted. */
963 const wimlib_tchar *target;
966 const wimlib_tchar *reserved;
968 /** Number of bytes of uncompressed data that will be extracted.
969 * If a file has multiple names (hard links), its size (or
970 * sizes, in the case of named data streams) is only counted one
971 * time. For "reparse points" and symbolic links, the size to
972 * be extracted is the size of the reparse data buffer.
974 * This number will stay constant throughout the extraction. */
975 uint64_t total_bytes;
977 /** Number of bytes of uncompressed data that have been
978 * extracted so far. This initially be 0 and will equal to @p
979 * total_bytes at the end of the extraction. */
980 uint64_t completed_bytes;
982 /** Number of (not necessarily unique) streams that will be
983 * extracted. This may be more or less than the number of
984 * "files" to be extracted due to hard links as well as
985 * potentially multiple streams per file (named data streams).
986 * A "stream" may be the default contents of a file, a named
987 * data stream, or a reparse data buffer. */
988 uint64_t total_streams;
990 /** Number of (not necessarily unique) streams that have been
991 * extracted so far. */
992 uint64_t completed_streams;
994 /** Currently only used for
995 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
996 uint32_t part_number;
998 /** Currently only used for
999 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
1000 uint32_t total_parts;
1002 /** Currently only used for
1003 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
1004 uint8_t guid[WIMLIB_GUID_LEN];
1006 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1007 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
1008 * number of files that have been processed so far. Once the
1009 * corresponding phase of extraction is complete, this value
1010 * will be equal to @c end_file_count. */
1011 uint64_t current_file_count;
1013 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1014 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
1015 * total number of files that will be processed.
1017 * This number is provided for informational purposes only.
1018 * This number will not necessarily be equal to the number of
1019 * files actually being extracted. This is because extraction
1020 * backends are free to implement an extraction algorithm that
1021 * might be more efficient than processing every file in the
1022 * "extract file structure" and "extract metadata" phases. For
1023 * example, the current implementation of the UNIX extraction
1024 * backend will create files on-demand during the stream
1025 * extraction phase. Therefore, when using that particular
1026 * extraction backend, @p end_file_count will only include
1027 * directories and empty files. */
1028 uint64_t end_file_count;
1031 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
1032 struct wimlib_progress_info_rename {
1033 /** Name of the temporary file that the WIM was written to. */
1034 const wimlib_tchar *from;
1036 /** Name of the original WIM file to which the temporary file is
1038 const wimlib_tchar *to;
1041 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1042 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
1043 struct wimlib_progress_info_update {
1044 /** Pointer to the update command that will be executed or has
1045 * just been executed. */
1046 const struct wimlib_update_command *command;
1048 /** Number of update commands that have been completed so far.
1050 size_t completed_commands;
1052 /** Number of update commands that are being executed as part of
1053 * this call to wimlib_update_image(). */
1054 size_t total_commands;
1057 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
1058 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
1059 struct wimlib_progress_info_integrity {
1060 /** Number of bytes from the end of the WIM header to the end of
1061 * the lookup table (the area that is covered by the SHA1
1062 * integrity checks.) */
1063 uint64_t total_bytes;
1065 /** Number of bytes that have been SHA1-summed so far. Will be
1066 * 0 initially, and equal @p total_bytes at the end. */
1067 uint64_t completed_bytes;
1069 /** Number of chunks that the checksummed region is divided
1071 uint32_t total_chunks;
1073 /** Number of chunks that have been SHA1-summed so far. Will
1074 * be 0 initially, and equal to @p total_chunks at the end. */
1075 uint32_t completed_chunks;
1077 /** Size of the chunks used for the integrity calculation. */
1078 uint32_t chunk_size;
1080 /** Filename of the WIM (only valid if the message is
1081 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
1082 const wimlib_tchar *filename;
1085 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1086 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1087 struct wimlib_progress_info_split {
1088 /** Total size of the original WIM's file and metadata resources
1090 uint64_t total_bytes;
1092 /** Number of bytes of file and metadata resources that have
1093 * been copied out of the original WIM so far. Will be 0
1094 * initially, and equal to @p total_bytes at the end. */
1095 uint64_t completed_bytes;
1097 /** Number of the split WIM part that is about to be started
1098 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1099 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1100 unsigned cur_part_number;
1102 /** Total number of split WIM parts that are being written. */
1103 unsigned total_parts;
1105 /** Name of the split WIM part that is about to be started
1106 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1107 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1108 * As of wimlib v1.7.0, the library user may change this when
1109 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1110 * cause the next split WIM part to be written to a different
1112 wimlib_tchar *part_name;
1115 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1116 struct wimlib_progress_info_replace {
1117 /** Path to the file in the WIM image that is being replaced */
1118 const wimlib_tchar *path_in_wim;
1121 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1122 struct wimlib_progress_info_wimboot_exclude {
1123 /** Path to the file in the WIM image */
1124 const wimlib_tchar *path_in_wim;
1126 /** Path to which the file is being extracted */
1127 const wimlib_tchar *extraction_path;
1130 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1131 struct wimlib_progress_info_unmount {
1132 /** Path to directory being unmounted */
1133 const wimlib_tchar *mountpoint;
1135 /** Path to WIM file being unmounted */
1136 const wimlib_tchar *mounted_wim;
1138 /** 1-based index of image being unmounted. */
1139 uint32_t mounted_image;
1141 /** Flags that were passed to wimlib_mount_image() when the
1142 * mountpoint was set up. */
1143 uint32_t mount_flags;
1145 /** Flags passed to wimlib_unmount_image(). */
1146 uint32_t unmount_flags;
1149 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1150 struct wimlib_progress_info_done_with_file {
1151 /* Path to the file whose data has been written to the WIM file,
1152 * or is currently being asynchronously compressed in memory,
1153 * and therefore is no longer needed by wimlib.
1155 * WARNING: The file data will not actually be accessible in the
1156 * WIM file until the WIM file has been completely written.
1157 * Ordinarily you should <b>not</b> treat this message as a
1158 * green light to go ahead and delete the specified file, since
1159 * that would result in data loss if the WIM file cannot be
1160 * successfully created for any reason.
1162 * If a file has multiple names (hard links),
1163 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1164 * for one name. Also, this message will not be received for
1165 * empty files or reparse points (or symbolic links), unless
1166 * they have nonempty named data streams.
1168 const wimlib_tchar *path_to_file;
1171 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1172 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1173 struct wimlib_progress_info_verify_image {
1174 const wimlib_tchar *wimfile;
1175 uint32_t total_images;
1176 uint32_t current_image;
1179 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1180 struct wimlib_progress_info_verify_streams {
1181 const wimlib_tchar *wimfile;
1182 uint64_t total_streams;
1183 uint64_t total_bytes;
1184 uint64_t completed_streams;
1185 uint64_t completed_bytes;
1188 /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION. */
1189 struct wimlib_progress_info_test_file_exclusion {
1192 * Path to the file for which exclusion is being tested.
1194 * UNIX capture mode: The path will be a standard relative or
1195 * absolute UNIX filesystem path.
1197 * NTFS-3g capture mode: The path will be given relative to the
1198 * root of the NTFS volume, with a leading slash.
1200 * Windows capture mode: The path will be a Win32 namespace
1203 const wimlib_tchar *path;
1206 * Indicates whether the file or directory will be excluded from
1207 * capture or not. This will be <tt>false</tt> by default. The
1208 * progress function can set this to <tt>true</tt> if it decides
1209 * that the file needs to be excluded.
1212 } test_file_exclusion;
1216 * A user-supplied function that will be called periodically during certain WIM
1219 * The first argument will be the type of operation that is being performed or
1220 * is about to be started or has been completed.
1222 * The second argument will be a pointer to one of a number of structures
1223 * depending on the first argument. It may be @c NULL for some message types.
1224 * Note that although this argument is not @c const, users should not modify it
1225 * except in explicitly documented cases.
1227 * The third argument will be a user-supplied value that was provided when
1228 * registering or specifying the progress function.
1230 * This function must return one of the ::wimlib_progress_status values. By
1231 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1233 typedef enum wimlib_progress_status
1234 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1235 union wimlib_progress_info *info,
1239 /** @addtogroup G_modifying_wims
1242 /** An array of these structures is passed to wimlib_add_image_multisource() to
1243 * specify the sources from which to create a WIM image. */
1244 struct wimlib_capture_source {
1245 /** Absolute or relative path to a file or directory on the external
1246 * filesystem to be included in the WIM image. */
1247 wimlib_tchar *fs_source_path;
1249 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1250 * specify the root directory of the WIM image. */
1251 wimlib_tchar *wim_target_path;
1253 /** Reserved; set to 0. */
1257 /** Set or unset the WIM header flag that marks it read-only
1258 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
1259 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
1260 * is distinct from basic file permissions; this flag can be set on a WIM file
1261 * that is physically writable. If this flag is set, all further operations to
1262 * modify the WIM will fail, except calling wimlib_overwrite() with
1263 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
1264 * allows you to set this flag persistently on the underlying WIM file.
1266 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1268 /** Set the GUID (globally unique identifier) of the WIM file to the value
1269 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1270 #define WIMLIB_CHANGE_GUID 0x00000002
1272 /** Change the bootable image of the WIM to the value specified in
1273 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1274 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1276 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1277 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
1278 * indicates whether an image in the WIM has been captured with reparse-point
1279 * fixups enabled. wimlib also treats this flag as specifying whether to do
1280 * reparse-point fixups by default when capturing or applying WIM images. */
1281 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1285 /** @addtogroup G_wim_information */
1289 /** General information about a WIM file. */
1290 struct wimlib_wim_info {
1292 /** Globally unique identifier for the WIM file. Note: all parts of a
1293 * split WIM should have an identical value in this field. */
1294 uint8_t guid[WIMLIB_GUID_LEN];
1296 /** Number of images in the WIM. */
1297 uint32_t image_count;
1299 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1301 uint32_t boot_index;
1303 /** Version of the WIM file. */
1304 uint32_t wim_version;
1306 /** Chunk size used for compression. */
1307 uint32_t chunk_size;
1309 /** For split WIMs, the 1-based index of this part within the split WIM;
1311 uint16_t part_number;
1313 /** For split WIMs, the total number of parts in the split WIM;
1315 uint16_t total_parts;
1317 /** One of the ::wimlib_compression_type values that specifies the
1318 * method used to compress resources in the WIM. */
1319 int32_t compression_type;
1321 /** Size of the WIM file in bytes, excluding the XML data and integrity
1323 uint64_t total_bytes;
1325 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1326 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1327 * this will always be 0, even if the ::WIMStruct was written to
1328 * somewhere by calling wimlib_write() with the
1329 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1330 uint32_t has_integrity_table : 1;
1332 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1333 * wimlib_create_new_wim(). */
1334 uint32_t opened_from_file : 1;
1336 /** 1 if the WIM is considered readonly for any reason. */
1337 uint32_t is_readonly : 1;
1339 /** 1 if reparse-point fixups are enabled for one or more images in the
1341 uint32_t has_rpfix : 1;
1343 /** 1 if the WIM is marked read-only. */
1344 uint32_t is_marked_readonly : 1;
1346 /** 1 if the WIM is part of a spanned set. */
1347 uint32_t spanned : 1;
1349 uint32_t write_in_progress : 1;
1350 uint32_t metadata_only : 1;
1351 uint32_t resource_only : 1;
1353 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1354 uint32_t pipable : 1;
1355 uint32_t reserved_flags : 22;
1356 uint32_t reserved[9];
1359 /** Information about a unique stream in the WIM file. (A stream is the same
1360 * thing as a "resource", except in the case of packed resources.) */
1361 struct wimlib_resource_entry {
1362 /** Uncompressed size of the stream in bytes. */
1363 uint64_t uncompressed_size;
1365 /** Compressed size of the stream in bytes. This will be the same as @p
1366 * uncompressed_size if the stream is uncompressed. Or, if @p packed is
1367 * 1, this will be 0. */
1368 uint64_t compressed_size;
1370 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1371 * if @p packed is 1, then this is actually the offset at which this
1372 * stream begins in the uncompressed contents of the packed resource.
1376 /** SHA1 message digest of the stream's uncompressed contents. */
1377 uint8_t sha1_hash[20];
1379 /** Which part of WIM this stream is in. */
1380 uint32_t part_number;
1382 /** Number of times this stream is referenced over all WIM images. */
1383 uint32_t reference_count;
1385 /** 1 if this stream is compressed. */
1386 uint32_t is_compressed : 1;
1388 /** 1 if this stream is a metadata resource rather than a file resource.
1390 uint32_t is_metadata : 1;
1392 uint32_t is_free : 1;
1393 uint32_t is_spanned : 1;
1395 /** 1 if this stream was not found in the lookup table of the
1396 * ::WIMStruct. This normally implies a missing call to
1397 * wimlib_reference_resource_files() or wimlib_reference_resources().
1399 uint32_t is_missing : 1;
1401 /** 1 if this stream is located in a packed resource which may contain
1402 * other streams (all compressed together) as well. */
1403 uint32_t packed : 1;
1405 uint32_t reserved_flags : 26;
1407 /** If @p packed is 1, then this will specify the offset of the packed
1408 * resource in the WIM. */
1409 uint64_t raw_resource_offset_in_wim;
1411 /** If @p packed is 1, then this will specify the compressed size of the
1412 * packed resource in the WIM. */
1413 uint64_t raw_resource_compressed_size;
1415 uint64_t reserved[2];
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 struct wimlib_stream_entry {
1426 /** Name of the stream, or NULL if the stream is unnamed. */
1427 const wimlib_tchar *stream_name;
1428 /** Location, size, and other information about the stream's data as
1429 * stored in the WIM file. */
1430 struct wimlib_resource_entry resource;
1431 uint64_t reserved[4];
1434 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1435 * Roughly, the information about a "file" in the WIM--- but really a directory
1436 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1437 * field can be used to distinguish actual file inodes. */
1438 struct wimlib_dir_entry {
1439 /** Name of the file, or NULL if this file is unnamed. Only the root
1440 * directory of an image will be unnamed. */
1441 const wimlib_tchar *filename;
1443 /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1444 * this file has no such name. */
1445 const wimlib_tchar *dos_name;
1447 /** Full path to this file within the WIM image. Path separators will
1448 * be ::WIMLIB_WIM_PATH_SEPARATOR. */
1449 const wimlib_tchar *full_path;
1451 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1452 * children, ..., etc. */
1455 /** Pointer to the security descriptor for this file, in Windows
1456 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1457 * security descriptor. */
1458 const char *security_descriptor;
1460 /** Length of the above security descriptor. */
1461 size_t security_descriptor_size;
1463 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1464 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1465 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1466 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1467 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1468 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1469 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1470 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1471 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1472 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1473 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1474 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1475 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1476 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1477 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1478 /** File attributes, such as whether the file is a directory or not.
1479 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1480 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1481 * on other platforms. */
1482 uint32_t attributes;
1484 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1485 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1486 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1487 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1488 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1489 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1490 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1491 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1492 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1493 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1494 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1495 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1496 /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1497 * the attributes), this will give the reparse tag. This tells you
1498 * whether the reparse point is a symbolic link, junction point, or some
1499 * other, more unusual kind of reparse point. */
1500 uint32_t reparse_tag;
1502 /** Number of links to this file's inode (hard links).
1504 * Currently, this will always be 1 for directories. However, it can be
1505 * greater than 1 for nondirectory files. */
1508 /** Number of named data streams this file has. Normally 0. */
1509 uint32_t num_named_streams;
1511 /** A unique identifier for this file's inode. However, as a special
1512 * case, if the inode only has a single link (@p num_links == 1), this
1515 * Note: if a WIM image is captured from a filesystem, this value is not
1516 * guaranteed to be the same as the original number of the inode on the
1518 uint64_t hard_link_group_id;
1520 /** Time this file was created. */
1521 struct timespec creation_time;
1523 /** Time this file was last written to. */
1524 struct timespec last_write_time;
1526 /** Time this file was last accessed. */
1527 struct timespec last_access_time;
1529 /** The UNIX user ID of this file. This is a wimlib extension.
1531 * This field is only valid if @p unix_mode != 0. */
1534 /** The UNIX group ID of this file. This is a wimlib extension.
1536 * This field is only valid if @p unix_mode != 0. */
1539 /** The UNIX mode of this file. This is a wimlib extension.
1541 * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1542 * @p unix_rdev are all unknown (fields are not present in the WIM
1546 /** The UNIX device ID (major and minor number) of this file. This is a
1549 * This field is only valid if @p unix_mode != 0. */
1552 uint64_t reserved[14];
1555 * Array of streams that make up this file.
1557 * The first entry will always exist and will correspond to the unnamed
1558 * data stream (default file contents), so it will have <c>stream_name
1559 * == NULL</c>. Alternatively, for reparse point files, the first entry
1560 * will corresponding to the reparse data stream.
1562 * Then, following the first entry, there be @p num_named_streams
1563 * additional entries that specify the named data streams, if any, each
1564 * of which will have <c>stream_name != NULL</c>.
1566 struct wimlib_stream_entry streams[];
1570 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1573 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1577 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1580 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1583 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1584 * just on the specified path. */
1585 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1587 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1588 * itself; only its children (in the case of a non-empty directory) */
1589 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1591 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1592 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1593 * table of the ::WIMStruct. The default behavior without this flag is to fill
1594 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1595 * wimlib_resource_entry::is_missing "is_missing" flag. */
1596 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1600 /** @addtogroup G_modifying_wims
1603 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1604 * generic directory. This requires that wimlib was compiled with support for
1607 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1608 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1610 * Do not use this flag on Windows, where wimlib already supports all
1611 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1612 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1614 /** Follow symbolic links when scanning the directory tree. Currently only
1615 * supported on UNIX-like systems. */
1616 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1618 /** Call the progress function with the message
1619 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1621 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1623 /** Mark the image being added as the bootable image of the WIM. This flag is
1624 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1626 * Note that you can also change the bootable image of a WIM using
1627 * wimlib_set_wim_info().
1629 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1630 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1631 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1633 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1634 * (major and minor number) of each file. Also allows capturing special files
1635 * such as device nodes and FIFOs. See the documentation for the
1636 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1638 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1640 /** Do not capture security descriptors. Only has an effect in NTFS capture
1641 * mode, or in Windows native builds. */
1642 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1644 /** Fail immediately if the full security descriptor of any file or directory
1645 * cannot be accessed. Only has an effect in Windows native builds. The
1646 * default behavior without this flag is to first try omitting the SACL from the
1647 * security descriptor, then to try omitting the security descriptor entirely.
1649 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1651 /** Call the progress function with the message
1652 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1653 * capture. This is a subset of the messages provided by
1654 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1655 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1657 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1658 * case of Windows) that point inside the directory being captured to instead be
1659 * absolute relative to the directory being captured.
1661 * Without this flag, the default is to do reparse-point fixups if
1662 * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image
1663 * being added. WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is
1664 * captured with reparse point fixups enabled and currently cannot be unset. */
1665 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1667 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1668 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1670 /** Do not automatically exclude unsupported files or directories from capture;
1671 * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1672 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1673 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1674 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1677 * Automatically select a capture configuration appropriate for capturing
1678 * filesystems containing Windows operating systems. For example,
1679 * "/pagefile.sys" and "System Volume Information" will be excluded.
1681 * When this flag is specified, the corresponding @p config parameter (for
1682 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1683 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1685 * Note that the default behavior--- that is, when neither
1686 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1687 * config is @c NULL--- is to use no capture configuration, meaning that no
1688 * files are excluded from capture.
1690 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1693 * Capture image as WIMBoot compatible. In addition, if no capture
1694 * configuration file is explicitly specified use the capture configuration file
1695 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1696 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1697 * configuration file is explicitly specified, use it and also place it at
1698 * /Windows/System32/WimBootCompress.ini in the WIM image.
1700 * Note: this will not by itself change the compression type. Before writing
1701 * the WIM file, it's recommended to also do:
1704 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1705 * wimlib_set_output_chunk_size(wim, 4096);
1708 * since that makes access to the data faster (at the cost of a worse
1709 * compression ratio compared to the 32768-byte LZX chunks usually used).
1711 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1712 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1714 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1717 * If the add command involves adding a non-directory file to a location at
1718 * which there already exists a nondirectory file in the WIM image, issue
1719 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1720 * effect when updating an existing image with wimlib_update_image().
1721 * This was the default behavior in wimlib v1.6.2 and earlier.
1723 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1726 * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1729 * Note: This method for file exclusions is independent from the capture
1730 * configuration file mechanism.
1732 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1734 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1735 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1736 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1737 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1738 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1739 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1740 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1741 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1742 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1743 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1744 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1745 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1746 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1747 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1751 /** @addtogroup G_modifying_wims
1754 /** Do not issue an error if the path to delete does not exist. */
1755 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1757 /** Delete the file or directory tree recursively; if not specified, an error is
1758 * issued if the path to delete is a directory. */
1759 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1762 /** @addtogroup G_modifying_wims
1766 * If a single image is being exported, mark it bootable in the destination WIM.
1767 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1768 * the image in the source WIM (if any) that is marked as bootable is also
1769 * marked as bootable in the destination WIM.
1771 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1773 /** Give the exported image(s) no names. Avoids problems with image name
1776 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1778 /** Give the exported image(s) no descriptions. */
1779 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1781 /** This advises the library that the program is finished with the source
1782 * WIMStruct and will not attempt to access it after the call to
1783 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1784 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1787 * Mark each exported image as WIMBoot-compatible.
1789 * Note: by itself, this does change the destination WIM's compression type, nor
1790 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1791 * image. Before writing the destination WIM, it's recommended to do something
1795 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1796 * wimlib_set_output_chunk_size(wim, 4096);
1797 * wimlib_add_tree(wim, image, L"myconfig.ini",
1798 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1801 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1804 /** @addtogroup G_extracting_wims
1807 /** Extract the image directly to an NTFS volume rather than a generic directory.
1808 * This mode is only available if wimlib was compiled with libntfs-3g support;
1809 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1810 * extraction target will be interpreted as the path to an NTFS volume image (as
1811 * a regular file or block device) rather than a directory. It will be opened
1812 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1813 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1814 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1815 * wimlib_extract_paths() when passed multiple paths. */
1816 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1818 /** UNIX-like systems only: Extract special UNIX data captured with
1819 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1820 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1821 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1823 /** Do not extract security descriptors. This flag cannot be combined with
1824 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1825 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1827 /** Fail immediately if the full security descriptor of any file or directory
1828 * cannot be set exactly as specified in the WIM file. On Windows, the default
1829 * behavior without this flag when wimlib does not have permission to set the
1830 * correct security descriptor is to fall back to setting the security
1831 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1832 * owner omitted, then not at all. This flag cannot be combined with
1833 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1834 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1836 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1837 * reparse-point fixups on, so absolute symbolic links or junction points will
1838 * be fixed to be absolute relative to the actual extraction root. Reparse-
1839 * point fixups are done by default for wimlib_extract_image() and
1840 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1841 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1842 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1844 /** Force reparse-point fixups on extraction off, regardless of the state of the
1845 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1846 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1847 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1849 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1850 * paths, each of which must name a regular file, to standard output. */
1851 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1853 /** Instead of ignoring files and directories with names that cannot be
1854 * represented on the current platform (note: Windows has more restrictions on
1855 * filenames than POSIX-compliant systems), try to replace characters or append
1856 * junk to the names so that they can be extracted in some form.
1858 * Note: this flag is unlikely to have any effect when extracting a WIM image
1859 * that was captured on Windows.
1861 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1863 /** On Windows, when there exist two or more files with the same case
1864 * insensitive name but different case sensitive names, try to extract them all
1865 * by appending junk to the end of them, rather than arbitrarily extracting only
1868 * Note: this flag is unlikely to have any effect when extracting a WIM image
1869 * that was captured on Windows.
1871 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1873 /** Do not ignore failure to set timestamps on extracted files. This flag
1874 * currently only has an effect when extracting to a directory on UNIX-like
1876 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1878 /** Do not ignore failure to set short names on extracted files. This flag
1879 * currently only has an effect on Windows. */
1880 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1882 /** Do not ignore failure to extract symbolic links and junctions due to
1883 * permissions problems. This flag currently only has an effect on Windows. By
1884 * default, such failures are ignored since the default configuration of Windows
1885 * only allows the Administrator to create symbolic links. */
1886 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1888 /** Reserved for future use. */
1889 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1891 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1892 * paths to extract as wildcard patterns ("globs") which may contain the
1893 * wildcard characters @c ? and @c *. The @c ? character matches any
1894 * non-path-separator character, whereas the @c * character matches zero or more
1895 * non-path-separator characters. Consequently, each glob may match zero or
1896 * more actual paths in the WIM image.
1898 * By default, if a glob does not match any files, a warning but not an error
1899 * will be issued. This is the case even if the glob did not actually contain
1900 * wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1903 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1905 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1906 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1907 * one of the provided globs did not match a file. */
1908 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1910 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1912 * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1914 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1916 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1917 * preserve the directory structure of the archive when extracting --- that is,
1918 * place each extracted file or directory tree directly in the target directory.
1920 * The target directory will still be created if it does not already exist. */
1921 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1923 /** Windows only: Extract files as "pointers" back to the WIM archive.
1925 * The effects of this option are fairly complex. See the documentation for the
1926 * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1928 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1931 /** @addtogroup G_mounting_wim_images
1934 /** Mount the WIM image read-write rather than the default of read-only. */
1935 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1937 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main(). */
1938 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1940 /** Do not allow accessing named data streams in the mounted WIM image. */
1941 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1943 /** Access named data streams in the mounted WIM image through extended file
1944 * attributes named "user.X", where X is the name of a data stream. This is the
1946 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1948 /** Access named data streams in the mounted WIM image by specifying the file
1949 * name, a colon, then the name of the data stream. */
1950 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1952 /** Use UNIX metadata if available in the WIM image. See
1953 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1954 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1956 /** Allow other users to see the mounted filesystem. This passes the @c
1957 * allow_other option to fuse_main(). */
1958 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1961 /** @addtogroup G_creating_and_opening_wims
1964 /** Verify the WIM contents against the WIM's integrity table, if present. This
1965 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1966 * checksummed and checked against the SHA1 message digests specified in the
1967 * integrity table. If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
1968 * issued. If the WIM file does not contain an integrity table, this flag has
1970 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1972 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
1973 * WIM. Software can provide this flag for convenience if it explicitly does
1974 * not want to support split WIMs. */
1975 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1977 /** Check if the WIM is writable and issue an error
1978 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
1979 * only if it is writable at the filesystem level, does not have the
1980 * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
1981 * set. It is not required to provide this flag before attempting to make
1982 * changes to the WIM, but with this flag you get an error sooner rather than
1984 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1987 /** @addtogroup G_mounting_wim_images
1990 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
1991 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1992 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1994 /** Commit changes to the read-write mounted WIM image.
1995 * If this flag is not specified, changes will be discarded. */
1996 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1998 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
1999 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2000 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
2002 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2003 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2004 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
2007 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2008 * image, forces all file descriptors to the open WIM image to be closed before
2011 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2012 * this flag has no effect.
2014 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
2016 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2017 * WIM image, causes the modified image to be committed to the WIM file as a
2018 * new, unnamed image appended to the archive. The original image in the WIM
2019 * file will be unmodified. */
2020 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
2023 /** @addtogroup G_modifying_wims
2026 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2027 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
2028 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
2031 /** @addtogroup G_writing_and_overwriting_wims
2035 * Include an integrity table in the resulting WIM file.
2037 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2038 * include an integrity table if and only if one was present before. For
2039 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2040 * to not include an integrity table.
2042 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
2045 * Do not include an integrity table in the resulting WIM file. This is the
2046 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2049 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
2052 * Write the WIM as "pipable". After writing a WIM with this flag specified,
2053 * images from it can be applied directly from a pipe using
2054 * wimlib_extract_image_from_pipe(). See the documentation for the
2055 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2056 * Beware: WIMs written with this flag will not be compatible with Microsoft's
2059 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2060 * write the WIM as pipable if and only if it was pipable before. For
2061 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2062 * to write the WIM as non-pipable.
2064 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
2067 * Do not write the WIM as "pipable". This is the default behavior, unless the
2068 * ::WIMStruct was created by opening a pipable WIM.
2070 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
2073 * When writing streams to the WIM file, recompress them, even if their data is
2074 * already available in the desired compressed form (for example, in a WIM file
2075 * from which an image has been exported using wimlib_export_image()).
2077 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2078 * compression ratio for the same compression type and chunk size. Simply using
2079 * the default compression settings may suffice for this, especially if the WIM
2080 * file was created using another program/library that may not use as
2081 * sophisticated compression algorithms. Or,
2082 * wimlib_set_default_compression_level() can be called beforehand to set an
2083 * even higher compression level than the default.
2085 * If the WIM contains solid blocks, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can be
2086 * used in combination with ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any
2087 * solid blocks from being re-used. Otherwise, solid blocks are re-used
2088 * somewhat more liberally than normal compressed blocks.
2090 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
2091 * that would not otherwise be written. For example, a call to
2092 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2093 * cause already-existing streams in the WIM file to be recompressed. To force
2094 * the WIM file to be fully rebuilt and recompressed, combine
2095 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2097 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
2100 * Immediately before closing the WIM file, sync its data to disk.
2102 * This flag forces the function to wait until the data is safely on disk before
2103 * returning success. Otherwise, modern operating systems tend to cache data
2104 * for some time (in some cases, 30+ seconds) before actually writing it to
2105 * disk, even after reporting to the application that the writes have succeeded.
2107 * wimlib_overwrite() will set this flag automatically if it decides to
2108 * overwrite the WIM file via a temporary file instead of in-place. This is
2109 * necessary on POSIX systems; it will, for example, avoid problems with delayed
2110 * allocation on ext4.
2112 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
2115 * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
2116 * could be updated in-place by appending to it.
2118 * When rebuilding the WIM file, stream reference counts will be recomputed, and
2119 * any streams with 0 reference count (e.g. from deleted files or images) will
2120 * not be included in the resulting WIM file. This can free up space that is
2121 * currently not being used.
2123 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2124 * data to be recompressed. Otherwise, compressed data is re-used if possible.
2126 * wimlib_write() ignores this flag.
2128 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
2131 * For wimlib_overwrite(), override the default behavior after one or more calls
2132 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
2133 * flag, only minimal changes to correctly remove the image from the WIM file
2134 * will be taken. In particular, all streams will be retained, even if they are
2135 * no longer referenced. This may not be what you want, because no space will
2136 * be saved by deleting an image in this way.
2138 * wimlib_write() ignores this flag.
2140 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
2143 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2144 * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header. This can be used
2145 * following a call to wimlib_set_wim_info() with the
2146 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2149 * wimlib_write() ignores this flag.
2151 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
2154 * Do not include streams already present in other WIMs. This flag can be used
2155 * to write a "delta" WIM after resources from the WIM on which the delta is to
2156 * be based were referenced with wimlib_reference_resource_files() or
2157 * wimlib_reference_resources().
2159 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
2162 * Advises the library that for writes of all WIM images, all streams needed for
2163 * the WIM are already present (not in external resource WIMs) and their
2164 * reference counts are correct, so the code does not need to recalculate which
2165 * streams are referenced. This is for optimization purposes only, since with
2166 * this flag specified, the metadata resources may not need to be decompressed
2169 * wimlib_overwrite() will set this flag automatically.
2171 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
2174 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2176 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2179 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
2182 * When writing streams in the resulting WIM file, pack multiple streams into a
2183 * single compressed resource instead of compressing them independently. This
2184 * is also known as creating a "solid archive". This tends to produce a better
2185 * compression ratio at the cost of much slower random access.
2187 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2188 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2189 * created with this flag use a different version number in their header (3584
2190 * instead of 68864) and are also called "ESD files".
2192 * If this flag is passed to wimlib_overwrite(), any new data streams will be
2193 * written in solid mode. Use both ::WIMLIB_WRITE_FLAG_REBUILD and
2194 * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
2195 * all streams recompressed in solid mode.
2197 * Currently, new solid blocks will, by default, be written using LZMS
2198 * compression with 32 MiB (33554432 byte) chunks. Use
2199 * wimlib_set_output_pack_compression_type() and/or
2200 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2201 * the WIM's main compression type and chunk size; you can have a WIM that
2202 * nominally uses LZX compression and 32768 byte chunks but actually contains
2203 * LZMS-compressed solid blocks, for example. However, if including solid
2204 * blocks, I suggest that you set the WIM's main compression type to LZMS as
2205 * well, either by creating the WIM with
2206 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2207 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2209 * This flag will be set by default when writing or overwriting a WIM file that
2210 * either already contains packed streams, or has had packed streams exported
2211 * into it and the WIM's main compression type is LZMS.
2213 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
2216 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2217 * file. This is only needed in the unusual case that the library user needs to
2218 * know exactly when wimlib has read each file for the last time.
2220 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2223 /** @addtogroup G_general
2226 /** Assume that strings are represented in UTF-8, even if this is not the
2227 * locale's character encoding. This flag is ignored on Windows, where wimlib
2228 * always uses UTF-16LE. */
2229 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2231 /** Windows-only: do not attempt to acquire additional privileges (currently
2232 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2233 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
2234 * for the case where the calling program manages these privileges itself.
2235 * Note: no error is issued if privileges cannot be acquired, although related
2236 * errors may be reported later, depending on if the operations performed
2237 * actually require additional privileges or not. */
2238 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2240 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2241 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2242 * to read all possible data and metadata for a capture operation could not be
2243 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2245 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2247 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2248 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2249 * to restore all possible data and metadata for an apply operation could not be
2250 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2252 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2254 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2256 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2258 /** Default to interpreting WIM paths case insensitively (default on Windows).
2259 * This does not apply to mounted images. */
2260 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2263 /** @addtogroup G_nonstandalone_wims
2266 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2267 * Ignored by wimlib_reference_resources(). */
2268 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2270 /** For wimlib_reference_resource_files(), issue an error
2271 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2272 * default behavior without this flag is to issue no error at that point, but
2273 * then attempt to open the glob as a literal path, which of course will fail
2274 * anyway if no file exists at that path. No effect if
2275 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2276 * wimlib_reference_resources(). */
2277 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2280 /** @addtogroup G_modifying_wims
2283 /** The specific type of update to perform. */
2284 enum wimlib_update_op {
2285 /** Add a new file or directory tree to the WIM image in a
2286 * certain location. */
2287 WIMLIB_UPDATE_OP_ADD = 0,
2289 /** Delete a file or directory tree from the WIM image. */
2290 WIMLIB_UPDATE_OP_DELETE,
2292 /** Rename a file or directory tree in the WIM image. */
2293 WIMLIB_UPDATE_OP_RENAME,
2296 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2297 struct wimlib_add_command {
2298 /** Filesystem path to the file or directory tree to add. */
2299 wimlib_tchar *fs_source_path;
2301 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2302 * specify the root directory of the WIM image. */
2303 wimlib_tchar *wim_target_path;
2305 /** Path to capture configuration file to use, or @c NULL for default.
2307 wimlib_tchar *config_file;
2309 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2313 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2314 struct wimlib_delete_command {
2316 /** Path, specified from the root of the WIM image, for the file or
2317 * directory tree within the WIM image to be deleted. */
2318 wimlib_tchar *wim_path;
2320 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2324 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2325 struct wimlib_rename_command {
2327 /** Path, specified from the root of the WIM image, for the source file
2328 * or directory tree within the WIM image. */
2329 wimlib_tchar *wim_source_path;
2331 /** Path, specified from the root of the WIM image, for the destination
2332 * file or directory tree within the WIM image. */
2333 wimlib_tchar *wim_target_path;
2335 /** Reserved; set to 0. */
2339 /** Specification of an update to perform on a WIM image. */
2340 struct wimlib_update_command {
2342 enum wimlib_update_op op;
2345 struct wimlib_add_command add;
2346 struct wimlib_delete_command delete_; /* Underscore is for C++
2348 struct wimlib_rename_command rename;
2353 /** @addtogroup G_general
2357 * Possible values of the error code returned by many functions in wimlib.
2359 * See the documentation for each wimlib function to see specifically what error
2360 * codes can be returned by a given function, and what they mean.
2362 enum wimlib_error_code {
2363 WIMLIB_ERR_SUCCESS = 0,
2364 WIMLIB_ERR_ALREADY_LOCKED = 1,
2365 WIMLIB_ERR_DECOMPRESSION = 2,
2366 WIMLIB_ERR_FUSE = 6,
2367 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2368 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2369 WIMLIB_ERR_IMAGE_COUNT = 10,
2370 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2371 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2372 WIMLIB_ERR_INTEGRITY = 13,
2373 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2374 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2375 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2376 WIMLIB_ERR_INVALID_HEADER = 17,
2377 WIMLIB_ERR_INVALID_IMAGE = 18,
2378 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2379 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2380 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2381 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2382 WIMLIB_ERR_INVALID_OVERLAY = 23,
2383 WIMLIB_ERR_INVALID_PARAM = 24,
2384 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2385 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2386 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2387 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2388 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2389 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2390 WIMLIB_ERR_IS_DIRECTORY = 32,
2391 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2392 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2393 WIMLIB_ERR_LINK = 35,
2394 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2395 WIMLIB_ERR_MKDIR = 37,
2396 WIMLIB_ERR_MQUEUE = 38,
2397 WIMLIB_ERR_NOMEM = 39,
2398 WIMLIB_ERR_NOTDIR = 40,
2399 WIMLIB_ERR_NOTEMPTY = 41,
2400 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2401 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2402 WIMLIB_ERR_NOT_PIPABLE = 44,
2403 WIMLIB_ERR_NO_FILENAME = 45,
2404 WIMLIB_ERR_NTFS_3G = 46,
2405 WIMLIB_ERR_OPEN = 47,
2406 WIMLIB_ERR_OPENDIR = 48,
2407 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2408 WIMLIB_ERR_READ = 50,
2409 WIMLIB_ERR_READLINK = 51,
2410 WIMLIB_ERR_RENAME = 52,
2411 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2412 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2413 WIMLIB_ERR_RESOURCE_ORDER = 56,
2414 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2415 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2416 WIMLIB_ERR_SET_SECURITY = 59,
2417 WIMLIB_ERR_SET_SHORT_NAME = 60,
2418 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2419 WIMLIB_ERR_SPLIT_INVALID = 62,
2420 WIMLIB_ERR_STAT = 63,
2421 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2422 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2423 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2424 WIMLIB_ERR_UNSUPPORTED = 68,
2425 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2426 WIMLIB_ERR_WIM_IS_READONLY = 71,
2427 WIMLIB_ERR_WRITE = 72,
2428 WIMLIB_ERR_XML = 73,
2429 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2430 WIMLIB_ERR_WIMBOOT = 75,
2431 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2432 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2433 WIMLIB_ERR_MKNOD = 78,
2434 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2435 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2436 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2437 WIMLIB_ERR_FVE_LOCKED_VOLUME = 82,
2441 /** Used to indicate no WIM image or an invalid WIM image. */
2442 #define WIMLIB_NO_IMAGE 0
2444 /** Used to specify all images in the WIM. */
2445 #define WIMLIB_ALL_IMAGES (-1)
2450 * @ingroup G_modifying_wims
2452 * Appends an empty image to a WIM file. This empty image will initially
2453 * contain no files or directories, although if written without further
2454 * modifications, a root directory will be created automatically for it. After
2455 * calling this function, you can use wimlib_update_image() to add files to the
2456 * new WIM image. This gives you slightly more control over making the new
2457 * image compared to calling wimlib_add_image() or
2458 * wimlib_add_image_multisource() directly.
2461 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
2464 * Name to give the new image. If @c NULL or empty, the new image is given
2465 * no name. If nonempty, it must specify a name that does not already
2467 * @param new_idx_ret
2468 * If non-<code>NULL</code>, the index of the newly added image is returned
2471 * @return 0 on success; nonzero on failure. The possible error codes are:
2473 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2474 * There is already an image in @p wim named @p name.
2475 * @retval ::WIMLIB_ERR_NOMEM
2476 * Failed to allocate the memory needed to add the new image.
2477 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2478 * The WIM file is considered read-only because of any of the reasons
2479 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2483 wimlib_add_empty_image(WIMStruct *wim,
2484 const wimlib_tchar *name,
2488 * @ingroup G_modifying_wims
2490 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2492 * The directory tree or NTFS volume is scanned immediately to load the dentry
2493 * tree into memory, and file attributes and symbolic links are read. However,
2494 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2497 * See the manual page for the @b wimlib-imagex program for more information
2498 * about the "normal" capture mode versus the NTFS capture mode (entered by
2499 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2501 * Note that @b no changes are committed to the underlying WIM file (if
2502 * any) until wimlib_write() or wimlib_overwrite() is called.
2505 * Pointer to the ::WIMStruct to which to add the image.
2507 * A path to a directory or unmounted NTFS volume that will be captured as
2510 * Name to give the new image. If @c NULL or empty, the new image is given
2511 * no name. If nonempty, it must specify a name that does not already
2513 * @param config_file
2514 * Path to capture configuration file, or @c NULL. This file may specify,
2515 * among other things, which files to exclude from capture. See the man
2516 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2517 * details of the file format. If @c NULL, the default capture
2518 * configuration shall be used. Ordinarily, the default capture
2519 * configuration will result in no files being excluded from capture purely
2520 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2521 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2523 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2525 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2526 * discarded so that it appears to be in the same state as when this function
2529 * This function is implemented by calling wimlib_add_empty_image(), then
2530 * calling wimlib_update_image() with a single "add" command, so any error code
2531 * returned by wimlib_add_empty_image() may be returned, as well as any error
2532 * codes returned by wimlib_update_image() other than ones documented as only
2533 * being returned specifically by an update involving delete or rename commands.
2535 * If a progress function is registered with @p wim, it will receive the
2536 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2537 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2538 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2541 wimlib_add_image(WIMStruct *wim,
2542 const wimlib_tchar *source,
2543 const wimlib_tchar *name,
2544 const wimlib_tchar *config_file,
2548 * @ingroup G_modifying_wims
2550 * This function is equivalent to wimlib_add_image() except it allows for
2551 * multiple sources to be combined into a single WIM image. This is done by
2552 * specifying the @p sources and @p num_sources parameters instead of the @p
2553 * source parameter of wimlib_add_image(). The rest of the parameters are the
2554 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2555 * capture</b> for full details on how this mode works.
2557 * In addition to the error codes that wimlib_add_image() can return,
2558 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2559 * when trying to overlay a non-directory on a directory or when otherwise
2560 * trying to overlay multiple conflicting files to the same location in the WIM
2561 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2562 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2563 * was not exactly one capture source with the target being the root directory.
2564 * (In this respect, there is no advantage to using
2565 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2568 wimlib_add_image_multisource(WIMStruct *wim,
2569 const struct wimlib_capture_source *sources,
2571 const wimlib_tchar *name,
2572 const wimlib_tchar *config_file,
2576 * @ingroup G_modifying_wims
2578 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2579 * location @p wim_target_path within the specified @p image of the @p wim.
2581 * This just builds an appropriate ::wimlib_add_command and passes it to
2582 * wimlib_update_image().
2585 wimlib_add_tree(WIMStruct *wim, int image,
2586 const wimlib_tchar *fs_source_path,
2587 const wimlib_tchar *wim_target_path, int add_flags);
2590 * @ingroup G_creating_and_opening_wims
2592 * Creates a ::WIMStruct for a new WIM file.
2594 * This only creates an in-memory structure for a WIM that initially contains no
2595 * images. No on-disk file is created until wimlib_write() is called.
2598 * The type of compression to be used in the new WIM file, as one of the
2599 * ::wimlib_compression_type constants.
2601 * This choice is not necessarily final; if desired, it can still be
2602 * changed at any time before the WIM is written to disk, using
2603 * wimlib_set_output_compression_type(). In addition, if you wish to use a
2604 * non-default chunk size, you will need to call
2605 * wimlib_set_output_chunk_size().
2607 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2608 * written to the memory location pointed to by this parameter. The
2609 * ::WIMStruct must be freed using using wimlib_free() when finished with
2611 * @return 0 on success; nonzero on error.
2612 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2613 * @p ctype was not a supported compression type.
2614 * @retval ::WIMLIB_ERR_NOMEM
2615 * Failed to allocate needed memory.
2618 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2621 * @ingroup G_modifying_wims
2623 * Deletes an image, or all images, from a WIM file.
2625 * Note: no changes are committed to the underlying WIM file (if any) until
2626 * wimlib_write() or wimlib_overwrite() is called.
2629 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2632 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2635 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2636 * to be left unmodified only if @p image specified a single image. If instead
2637 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2638 * possible for some but not all of the images to have been deleted when a
2639 * failure status is returned.
2641 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2642 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2643 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2644 * The WIM file is considered read-only because of any of the reasons
2645 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2648 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2649 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2650 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2651 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2652 * different reasons) to read the metadata resource for an image that needed to
2656 wimlib_delete_image(WIMStruct *wim, int image);
2659 * @ingroup G_modifying_wims
2661 * Delete the @p path from the specified @p image of the @p wim.
2663 * This just builds an appropriate ::wimlib_delete_command and passes it to
2664 * wimlib_update_image().
2667 wimlib_delete_path(WIMStruct *wim, int image,
2668 const wimlib_tchar *path, int delete_flags);
2671 * @ingroup G_modifying_wims
2673 * Exports an image, or all the images, from a WIM file, into another WIM file.
2675 * The destination image is made to share the same dentry tree and security data
2676 * structure as the source image. This places some restrictions on additional
2677 * functions that may be called. For example, you may not call wimlib_free() on
2678 * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2679 * because @p dest_wim will have references back to @p src_wim.
2681 * If this function fails, all changes to @p dest_wim are rolled back.
2683 * Please note that no changes are committed to the underlying WIM file of @p
2684 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2687 * The WIM from which to export the images, specified as a pointer to the
2688 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2689 * split WIM. In the case of a WIM file that is not standalone, this
2690 * ::WIMStruct must have had any needed external resources previously
2691 * referenced using wimlib_reference_resources() or
2692 * wimlib_reference_resource_files().
2694 * The image to export from @p src_wim, as either a 1-based image index to
2695 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2697 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2700 * For single-image exports, the name to give the exported image in @p
2701 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2702 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2703 * that case, the names are all taken from @p src_wim. This parameter is
2704 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2705 * @param dest_description
2706 * For single-image exports, the description to give the exported image in
2707 * the new WIM file. If left @c NULL, the description from @p src_wim is
2708 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2709 * NULL; in that case, the description are all taken from @p src_wim. This
2710 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2711 * @param export_flags
2712 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2714 * @return 0 on success; nonzero on error.
2715 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2716 * One or more of the names being given to an exported image was already in
2717 * use in the destination WIM.
2718 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2719 * @p src_image does not exist in @p src_wim and was not
2720 * ::WIMLIB_ALL_IMAGES.
2721 * @retval ::WIMLIB_ERR_INVALID_PARAM
2722 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2723 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2725 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2726 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2727 * example, one of them was a non-first part of a split WIM.
2728 * @retval ::WIMLIB_ERR_NOMEM
2729 * Failed to allocate needed memory.
2730 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2731 * A resource that needed to be exported could not be found in either the
2732 * source or destination WIMs. This error can occur if, for example, @p
2733 * src_wim is part of a split WIM but needed resources from the other split
2734 * WIM parts were not referenced with wimlib_reference_resources() or
2735 * wimlib_reference_resource_files() before the call to
2736 * wimlib_export_image().
2737 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2738 * @p dest_wim is considered read-only because of any of the reasons
2739 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2742 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2743 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2744 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2745 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2746 * different reasons) to read the metadata resource for an image in @p src_wim
2747 * that needed to be exported.
2750 wimlib_export_image(WIMStruct *src_wim, int src_image,
2751 WIMStruct *dest_wim,
2752 const wimlib_tchar *dest_name,
2753 const wimlib_tchar *dest_description,
2757 * @ingroup G_extracting_wims
2759 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2762 * The exact behavior of how wimlib extracts files from a WIM image is
2763 * controllable by the @p extract_flags parameter, but there also are
2764 * differences depending on the platform (UNIX-like vs Windows). See the manual
2765 * page for <b>wimlib-imagex apply</b> for more information, including about the
2766 * NTFS-3g extraction mode.
2769 * The WIM from which to extract the image(s), specified as a pointer to
2770 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2771 * of a split WIM. In the case of a WIM file that is not standalone, this
2772 * ::WIMStruct must have had any needed external resources previously
2773 * referenced using wimlib_reference_resources() or
2774 * wimlib_reference_resource_files().
2776 * The image to extract, specified as either the 1-based index of a single
2777 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2778 * to be extracted. However, ::WIMLIB_ALL_IMAGES cannot be used if
2779 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2781 * Directory to extract the WIM image(s) to; or, with
2782 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2783 * the unmounted NTFS volume to which to extract the image.
2784 * @param extract_flags
2785 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2787 * @return 0 on success; nonzero on error.
2788 * @retval ::WIMLIB_ERR_DECOMPRESSION
2789 * Failed to decompress data contained in the WIM.
2790 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2791 * The metadata for one of the images to extract was invalid.
2792 * @retval ::WIMLIB_ERR_INVALID_PARAM
2793 * The extraction flags were invalid; more details may be found in the
2794 * documentation for the specific extraction flags that were specified. Or
2795 * @p target was @c NULL or an empty string, or @p wim was @c NULL.
2796 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2797 * The SHA1 message digest of an extracted stream did not match the SHA1
2798 * message digest given in the WIM. In other words, the WIM file is
2799 * corrupted, so the data cannot be extracted in its original form.
2800 * @retval ::WIMLIB_ERR_LINK
2801 * Failed to create a symbolic link or a hard link.
2802 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2803 * The metadata resource for one of the images to extract was not found.
2804 * This can happen if @p wim represents a non-first part of a split WIM.
2805 * @retval ::WIMLIB_ERR_MKDIR
2806 * Failed create a directory.
2807 * @retval ::WIMLIB_ERR_NOMEM
2808 * Failed to allocate needed memory.
2809 * @retval ::WIMLIB_ERR_OPEN
2810 * Could not create a file, or failed to open an already-extracted file.
2811 * @retval ::WIMLIB_ERR_READ
2812 * Failed to read data from the WIM.
2813 * @retval ::WIMLIB_ERR_READLINK
2814 * Failed to determine the target of a symbolic link in the WIM.
2815 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2816 * Failed to fix the target of an absolute symbolic link (e.g. if the
2817 * target would have exceeded the maximum allowed length). (Only if
2818 * reparse data was supported by the extraction mode and
2819 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2821 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2822 * One of the files or directories that needed to be extracted referenced a
2823 * stream not present in the WIM's lookup table (or in any of the lookup
2824 * tables of the split WIM parts). This can happen if the WIM is not
2825 * standalone and the necessary resource WIMs, or split WIM parts, were not
2826 * referenced with wimlib_reference_resource_files().
2827 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2828 * Failed to set attributes on a file.
2829 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2830 * Failed to set reparse data on a file (only if reparse data was supported
2831 * by the extraction mode).
2832 * @retval ::WIMLIB_ERR_SET_SECURITY
2833 * Failed to set security descriptor on a file.
2834 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2835 * Failed to set the short name of a file.
2836 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2837 * Failed to set timestamps on a file.
2838 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2839 * Unexpected end-of-file occurred when reading data from the WIM.
2840 * @retval ::WIMLIB_ERR_UNSUPPORTED
2841 * A requested extraction flag, or the data or metadata that must be
2842 * extracted to support it, is unsupported in the build and configuration
2843 * of wimlib, or on the current platform or extraction mode or target
2844 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2845 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2846 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2847 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2848 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2849 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2850 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2851 * image contains one or more files with short names, but extracting short
2852 * names is not supported --- on Windows, this occurs if the target volume
2853 * does not support short names, while on non-Windows, this occurs if
2854 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2855 * @retval ::WIMLIB_ERR_WIMBOOT
2856 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2857 * there was a problem creating WIMBoot pointer files.
2858 * @retval ::WIMLIB_ERR_WRITE
2859 * Failed to write data to a file being extracted.
2861 * If a progress function is registered with @p wim, then as each image is
2862 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2863 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2864 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2865 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2866 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2869 wimlib_extract_image(WIMStruct *wim, int image,
2870 const wimlib_tchar *target, int extract_flags);
2873 * @ingroup G_extracting_wims
2875 * Extract one image from a pipe on which a pipable WIM is being sent.
2877 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2878 * subsec_pipable_wims, for more information about pipable WIMs.
2880 * This function operates in a special way to read the WIM fully sequentially.
2881 * As a result, there is no ::WIMStruct is made visible to library users, and
2882 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2883 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2884 * seekable file, not a pipe.)
2887 * File descriptor, which may be a pipe, opened for reading and positioned
2888 * at the start of the pipable WIM.
2889 * @param image_num_or_name
2890 * String that specifies the 1-based index or name of the image to extract.
2891 * It is translated to an image index using the same rules that
2892 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2893 * only a single image (not all images) can be specified. Alternatively,
2894 * specify @p NULL here to use the first image in the WIM if it contains
2895 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2897 * Same as the corresponding parameter to wimlib_extract_image().
2898 * @param extract_flags
2899 * Same as the corresponding parameter to wimlib_extract_image().
2901 * @return 0 on success; nonzero on error. The possible error codes include
2902 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2905 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2906 * Data read from the pipable WIM was invalid.
2907 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2908 * The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2911 wimlib_extract_image_from_pipe(int pipe_fd,
2912 const wimlib_tchar *image_num_or_name,
2913 const wimlib_tchar *target, int extract_flags);
2916 * @ingroup G_extracting_wims
2918 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2919 * function. The progress function will be used while extracting the WIM image
2920 * and will receive the normal extraction progress messages, such as
2921 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2922 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2925 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2926 const wimlib_tchar *image_num_or_name,
2927 const wimlib_tchar *target,
2929 wimlib_progress_func_t progfunc,
2933 * @ingroup G_extracting_wims
2935 * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2936 * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2937 * path_list_file which itself contains the list of paths to use, one per line.
2938 * Leading and trailing whitespace is ignored. Empty lines and lines beginning
2939 * with the ';' or '#' characters are ignored. No quotes are needed, as paths
2940 * are otherwise delimited by the newline character. However, quotes will be
2941 * stripped if present.
2943 * The error codes are the same as those returned by wimlib_extract_paths(),
2944 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2945 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2946 * ::WIMLIB_ERR_READ).
2949 wimlib_extract_pathlist(WIMStruct *wim, int image,
2950 const wimlib_tchar *target,
2951 const wimlib_tchar *path_list_file,
2955 * @ingroup G_extracting_wims
2957 * Extract zero or more paths (files or directory trees) from the specified WIM
2960 * By default, each path will be extracted to a corresponding subdirectory of
2961 * the target based on its location in the WIM image. For example, if one of
2962 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2963 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2964 * can be changed by providing the flag
2965 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2966 * or directory tree to be placed directly in the target directory --- so the
2967 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2969 * Symbolic links will not be dereferenced when paths in the WIM image are
2973 * WIM from which to extract the paths, specified as a pointer to the
2974 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2975 * split WIM. In the case of a WIM file that is not standalone, this
2976 * ::WIMStruct must have had any needed external resources previously
2977 * referenced using wimlib_reference_resources() or
2978 * wimlib_reference_resource_files().
2980 * 1-based index of the WIM image from which to extract the paths.
2982 * Array of paths to extract. Each element must be the absolute path to a
2983 * file or directory within the WIM image. Separators may be either
2984 * forwards or backwards slashes, and leading path separators are optional.
2985 * The paths will be interpreted either case-sensitively (UNIX default) or
2986 * case-insensitively (Windows default); however, the behavior can be
2987 * configured explicitly at library initialization time by passing an
2988 * appropriate flag to wimlib_global_init().
2990 * By default, the characters @c * and @c ? are interpreted literally.
2991 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2994 * By default, if any paths to extract do not exist, the error code
2995 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2996 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2998 * Number of paths specified in @p paths.
3000 * Directory to which to extract the paths; or with
3001 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
3002 * unmounted NTFS volume to which to extract the paths. Unlike the @p
3003 * paths being extracted, the @p target must be native path. On UNIX-like
3004 * systems it may not contain backslashes, for example.
3005 * @param extract_flags
3006 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3008 * @return 0 on success; nonzero on error. Most of the error codes are the same
3009 * as those returned by wimlib_extract_image(). Below, some of the error codes
3010 * returned in situations specific to path-mode extraction are documented:
3012 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3013 * One of the paths to extract did not exist in the WIM image. This error
3014 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
3015 * specified in @p extract_flags, or if both
3016 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
3017 * were specified in @p extract_flags.
3018 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3019 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3020 * one of the paths to extract did not name a regular file.
3022 * If a progress function is registered with @p wim, it will receive
3023 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. Note that because the extraction code
3024 * is stream-based and not file-based, there is no way to get information about
3025 * which path is currently being extracted, but based on byte count you can
3026 * still calculate an approximate percentage complete for the extraction overall
3027 * which may be all you really need anyway.
3030 wimlib_extract_paths(WIMStruct *wim,
3032 const wimlib_tchar *target,
3033 const wimlib_tchar * const *paths,
3038 * @ingroup G_wim_information
3040 * Extracts the XML data of a WIM file to a file stream. Every WIM file
3041 * includes a string of XML that describes the images contained in the WIM.
3043 * See wimlib_get_xml_data() to read the XML data into memory instead.
3046 * Pointer to the ::WIMStruct to query. This need not represent a
3047 * standalone WIM (e.g. it could represent part of a split WIM).
3049 * @c stdout, or a FILE* opened for writing, to extract the data to.
3051 * @return 0 on success; nonzero on error.
3052 * @retval ::WIMLIB_ERR_INVALID_PARAM
3053 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
3054 * @retval ::WIMLIB_ERR_NOMEM
3055 * Failed to allocate needed memory.
3056 * @retval ::WIMLIB_ERR_READ
3057 * Error reading the XML data from the WIM file.
3058 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3059 * Error reading the XML data from the WIM file.
3060 * @retval ::WIMLIB_ERR_WRITE
3061 * Failed to completely write the XML data to @p fp.
3064 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3067 * @ingroup G_general
3069 * Frees all memory allocated for a WIMStruct and closes all files associated
3073 * Pointer to the ::WIMStruct to free.
3075 * @return This function has no return value.
3078 wimlib_free(WIMStruct *wim);
3081 * @ingroup G_general
3083 * Converts a ::wimlib_compression_type value into a string.
3086 * The ::wimlib_compression_type value to convert.
3089 * A statically allocated string naming the compression algorithm,
3090 * such as "None", "LZX", "XPRESS", or "Invalid".
3092 extern const wimlib_tchar *
3093 wimlib_get_compression_type_string(int ctype);
3096 * @ingroup G_general
3098 * Converts an error code into a string describing it.
3101 * The error code returned by one of wimlib's functions.
3104 * Pointer to a statically allocated string describing the error code. If
3105 * the error code is for some reason not recognized by the library, the
3106 * string will be "Unknown error".
3108 extern const wimlib_tchar *
3109 wimlib_get_error_string(enum wimlib_error_code code);
3112 * @ingroup G_wim_information
3114 * Returns the description of the specified image.
3117 * Pointer to the ::WIMStruct to query. This need not represent a
3118 * standalone WIM (e.g. it could represent part of a split WIM).
3120 * The number of the image, numbered starting at 1.
3123 * The description of the image, or @c NULL if there is no such image, or
3124 * @c NULL if the specified image has no description. The description
3125 * string is in library-internal memory and may not be modified or freed;
3126 * in addition, the string will become invalid if the description of the
3127 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
3129 extern const wimlib_tchar *
3130 wimlib_get_image_description(const WIMStruct *wim, int image);
3133 * @ingroup G_wim_information
3135 * Returns the name of the specified image.
3138 * Pointer to the ::WIMStruct to query. This need not represent a
3139 * standalone WIM (e.g. it could represent part of a split WIM).
3141 * The number of the image, numbered starting at 1.
3144 * The name of the image, or @c NULL if there is no such image, or an empty
3145 * string if the image is unnamed. The name string is in
3146 * library-internal memory and may not be modified or freed; in addition,
3147 * the string will become invalid if the name of the image is changed, the
3148 * image is deleted, or the ::WIMStruct is destroyed.
3150 extern const wimlib_tchar *
3151 wimlib_get_image_name(const WIMStruct *wim, int image);
3154 * @ingroup G_general
3156 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
3157 * the major version, the next 10 bits contain the minor version, and the low 10
3158 * bits contain the patch version.
3160 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
3161 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
3162 * corresponding header file.
3165 wimlib_get_version(void);
3168 * @ingroup G_wim_information
3170 * Get basic information about a WIM file.
3173 * Pointer to the ::WIMStruct to query. This need not represent a
3174 * standalone WIM (e.g. it could represent part of a split WIM).
3176 * A ::wimlib_wim_info structure that will be filled in with information
3177 * about the WIM file.
3182 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3185 * @ingroup G_wim_information
3187 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
3188 * includes a string of XML that describes the images contained in the WIM.
3190 * See wimlib_extract_xml_data() to extract the XML data to a file stream
3194 * Pointer to the ::WIMStruct to query. This need not represent a
3195 * standalone WIM (e.g. it could represent part of a split WIM).
3197 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3198 * XML data is written to this location.
3199 * @param bufsize_ret
3200 * The size of the XML data in bytes is written to this location.
3202 * @return 0 on success; nonzero on error.
3203 * @retval ::WIMLIB_ERR_INVALID_PARAM
3204 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
3205 * @p buf_ret or @p bufsize_ret was @c NULL.
3206 * @retval ::WIMLIB_ERR_NOMEM
3207 * @retval ::WIMLIB_ERR_READ
3208 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3209 * Failed to read the XML data from the WIM.
3212 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3215 * @ingroup G_general
3217 * Initialization function for wimlib. Call before using any other wimlib
3218 * function except wimlib_set_print_errors(). If not done manually, this
3219 * function will be called automatically with @p init_flags set to
3220 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
3221 * after it has already successfully run.
3224 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3226 * @return 0 on success; nonzero on failure. Currently, only the following
3227 * error code is defined:
3229 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3230 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3231 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3232 * init_flags, but the corresponding privileges could not be acquired.
3235 wimlib_global_init(int init_flags);
3238 * @ingroup G_general
3240 * Cleanup function for wimlib. You are not required to call this function, but
3241 * it will release any global resources allocated by the library.
3244 wimlib_global_cleanup(void);
3247 * @ingroup G_wim_information
3249 * Determines if an image name is already used by some image in the WIM.
3252 * Pointer to the ::WIMStruct to query. This need not represent a
3253 * standalone WIM (e.g. it could represent part of a split WIM).
3255 * The name to check.
3258 * @c true if there is already an image in @p wim named @p name; @c false
3259 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3260 * the empty string, @c false is returned.
3263 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3266 * @ingroup G_wim_information
3268 * Iterate through a file or directory tree in the WIM image. By specifying
3269 * appropriate flags and a callback function, you can get the attributes of a
3270 * file in the WIM, get a directory listing, or even get a listing of the entire
3274 * The WIM containing the image(s) over which to iterate, specified as a
3275 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3276 * or part 1 of a split WIM. In the case of a WIM file that is not
3277 * standalone, this ::WIMStruct should have had any needed external
3278 * resources previously referenced using wimlib_reference_resources() or
3279 * wimlib_reference_resource_files(). If not, see
3280 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3281 * the behavior when resources are missing.
3284 * The 1-based number of the image in @p wim that contains the files or
3285 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3286 * iteration on all images in the WIM.
3289 * Path in the WIM image at which to do the iteration.
3292 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3295 * A callback function that will receive each directory entry.
3298 * An extra parameter that will always be passed to the callback function
3301 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3302 * first nonzero value that was returned from @p cb. However, additional error
3303 * codes may be returned, including the following:
3305 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3306 * @p path did not exist in the WIM image.
3307 * @retval ::WIMLIB_ERR_NOMEM
3308 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
3310 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3311 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3312 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3313 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3314 * different reasons) to read the metadata resource for an image over which
3315 * iteration needed to be done.
3318 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3320 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3323 * @ingroup G_wim_information
3325 * Iterate through the lookup table of a WIM file. This can be used to directly
3326 * get a listing of the unique resources contained in a WIM file over all
3327 * images. Both file resources and metadata resources are included. However,
3328 * only resources actually included in the file represented by @a wim, plus
3329 * explicitly referenced external resources (via wimlib_reference_resources() or
3330 * wimlib_reference_resource_files()) are included in the iteration. For
3331 * example, if @p wim represents just one part of a split WIM, then only
3332 * resources in that part will be included, unless other resources were
3333 * explicitly referenced.
3336 * Pointer to the ::WIMStruct to query. This need not represent a
3337 * standalone WIM (e.g. it could represent part of a split WIM).
3340 * Reserved; set to 0.
3343 * A callback function that will receive each resource.
3346 * An extra parameter that will always be passed to the callback function
3349 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3350 * that was returned from @p cb.
3353 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3354 wimlib_iterate_lookup_table_callback_t cb,
3358 * @ingroup G_nonstandalone_wims
3360 * Joins a split WIM into a stand-alone one-part WIM.
3363 * An array of strings that gives the filenames of all parts of the split
3364 * WIM. No specific order is required, but all parts must be included with
3367 * Number of filenames in @p swms.
3368 * @param swm_open_flags
3369 * Open flags for the split WIM parts (e.g.
3370 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3371 * @param wim_write_flags
3372 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3373 * be used to write the joined WIM.
3374 * @param output_path
3375 * The path to write the joined WIM file to.
3377 * @return 0 on success; nonzero on error. This function may return most error
3378 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3379 * as the following error code:
3381 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3382 * The split WIMs do not form a valid WIM because they do not include all
3383 * the parts of the original WIM, there are duplicate parts, or not all the
3384 * parts have the same GUID and compression type.
3386 * Note: wimlib is generalized enough that this function is not actually needed
3387 * to join a split WIM; instead, you could open the first part of the split WIM,
3388 * then reference the other parts with wimlib_reference_resource_files(), then
3389 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3390 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3394 wimlib_join(const wimlib_tchar * const *swms,
3396 const wimlib_tchar *output_path,
3398 int wim_write_flags);
3401 * @ingroup G_nonstandalone_wims
3403 * Same as wimlib_join(), but allows specifying a progress function. The
3404 * progress function will receive the write progress messages, such as
3405 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3406 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3407 * swm_open_flags, the progress function will receive a series of
3408 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3412 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3414 const wimlib_tchar *output_path,
3416 int wim_write_flags,
3417 wimlib_progress_func_t progfunc,
3422 * @ingroup G_mounting_wim_images
3424 * Mounts an image from a WIM file on a directory read-only or read-write.
3427 * Pointer to the ::WIMStruct containing the image to be mounted.
3429 * The 1-based index of the image to mount.
3431 * The path to an existing empty directory on which to mount the WIM image.
3432 * @param mount_flags
3433 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3434 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3436 * @param staging_dir
3437 * If non-NULL, the name of a directory in which a temporary directory for
3438 * storing modified or added files will be created. Ignored if
3439 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3440 * left @c NULL, the staging directory is created in the same directory as
3441 * the WIM file that @p wim was originally read from. The staging
3442 * directory is automatically deleted when the image is unmounted.
3444 * @return 0 on success; nonzero on error. The possible error codes include:
3446 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3447 * An image from the WIM file is already mounted read-write, or another
3448 * process is currently appending data to the WIM file.
3449 * @retval ::WIMLIB_ERR_FUSE
3450 * A non-zero status code was returned by @c fuse_main().
3451 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3452 * @p image does not specify an existing, single image in @p wim.
3453 * @retval ::WIMLIB_ERR_INVALID_PARAM
3454 * @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3455 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3456 * already been modified in memory (e.g. by wimlib_update_image()).
3457 * @retval ::WIMLIB_ERR_MKDIR
3458 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3459 * staging directory could not be created.
3460 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3461 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3462 * WIM file is considered read-only because of any of the reasons mentioned
3463 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3464 * @retval ::WIMLIB_ERR_UNSUPPORTED
3465 * Mounting is not supported in this build of the library.
3467 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3468 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3469 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3470 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3471 * different reasons) to read the metadata resource for the image to mount.
3473 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3474 * UserSpacE). Depending on how FUSE is set up on your system, this function
3475 * may work as normal users in addition to the root user.
3477 * Mounting WIM images is not supported if wimlib was configured
3478 * <code>--without-fuse</code>. This includes Windows builds of wimlib;
3479 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3481 * Calling this function daemonizes the process, unless
3482 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3484 * It is safe to mount multiple images from the same underlying WIM file
3485 * read-only at the same time, but only if different ::WIMStruct's are used. It
3486 * is @b not safe to mount multiple images from the same WIM file read-write at
3489 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3490 * different process.
3493 wimlib_mount_image(WIMStruct *wim,
3495 const wimlib_tchar *dir,
3497 const wimlib_tchar *staging_dir);
3500 * @ingroup G_creating_and_opening_wims
3502 * Opens a WIM file and creates a ::WIMStruct for it.
3505 * The path to the WIM file to open.
3508 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3511 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3512 * is written to the memory location pointed to by this parameter. The
3513 * ::WIMStruct must be freed using using wimlib_free() when finished with
3516 * @return 0 on success; nonzero on error.
3517 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3518 * The number of metadata resources found in the WIM did not match the
3519 * image count specified in the WIM header, or the number of <IMAGE>
3520 * elements in the XML data of the WIM did not match the image count
3521 * specified in the WIM header.
3522 * @retval ::WIMLIB_ERR_INTEGRITY
3523 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3524 * the WIM contained an integrity table, but the SHA1 message digest for a
3525 * chunk of the WIM did not match the corresponding value in the integrity
3527 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3528 * The library did not recognize the compression chunk size of the WIM as
3529 * valid for its compression type.
3530 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3531 * The library did not recognize the compression type of the WIM.
3532 * @retval ::WIMLIB_ERR_INVALID_HEADER
3533 * The header of the WIM was otherwise invalid.
3534 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3535 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3536 * the WIM contained an integrity table, but the integrity table was
3538 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3539 * The lookup table of the WIM was invalid.
3540 * @retval ::WIMLIB_ERR_INVALID_PARAM
3541 * @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3542 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3543 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3544 * specified in @p open_flags.
3545 * @retval ::WIMLIB_ERR_NOMEM
3546 * Failed to allocated needed memory.
3547 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3548 * The file did not begin with the magic characters that identify a WIM
3550 * @retval ::WIMLIB_ERR_OPEN
3551 * Failed to open the WIM file for reading. Some possible reasons: the WIM
3552 * file does not exist, or the calling process does not have permission to
3554 * @retval ::WIMLIB_ERR_READ
3555 * Failed to read data from the WIM file.
3556 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3557 * Unexpected end-of-file while reading data from the WIM file.
3558 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3559 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3560 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3561 * The WIM cannot be opened because it contains encrypted segments. (It
3562 * may be a Windows 8 "ESD" file.)
3563 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3564 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3565 * considered read-only because of any of the reasons mentioned in the
3566 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3567 * @retval ::WIMLIB_ERR_XML
3568 * The XML data of the WIM was invalid.
3571 wimlib_open_wim(const wimlib_tchar *wim_file,
3573 WIMStruct **wim_ret);
3576 * @ingroup G_creating_and_opening_wims
3578 * Same as wimlib_open_wim(), but allows specifying a progress function and
3579 * progress context. If successful, the progress function will be registered in
3580 * the newly open ::WIMStruct, as if by an automatic call to
3581 * wimlib_register_progress_function(). In addition, if
3582 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the
3583 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3584 * messages while checking the WIM file's integrity.
3587 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3589 WIMStruct **wim_ret,
3590 wimlib_progress_func_t progfunc,
3594 * @ingroup G_writing_and_overwriting_wims
3596 * Overwrites the file that the WIM was originally read from, with changes made.
3597 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3598 * rather than wimlib_create_new_wim().
3600 * There are two ways that a WIM may be overwritten. The first is to do a full
3601 * rebuild. In this mode, the new WIM is written to a temporary file and then
3602 * renamed to the original file after it is has been completely written. The
3603 * temporary file is made in the same directory as the original WIM file. A
3604 * full rebuild may take a while, but it will save space by producing a WIM with
3607 * The second way to overwrite a WIM is by appending to the end of it and
3608 * overwriting the header. This can be much faster than a full rebuild, but the
3609 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3610 * begins with writing any new file resources *after* everything in the old WIM,
3611 * even though this will leave a hole where the old lookup table, XML data, and
3612 * integrity were. This is done so that the WIM remains valid even if the
3613 * operation is aborted mid-write. The WIM header is only overwritten at the
3614 * very last moment, and up until that point the WIM will be seen as the old
3617 * By default, wimlib_overwrite() does the append-style overwrite described
3618 * above, unless resources in the WIM are arranged in an unusual way or if
3619 * images have been deleted from the WIM. Use the flag
3620 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3621 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3622 * images have been deleted from the WIM.
3624 * If this function completes successfully, no more functions should be called
3625 * on @p wim other than wimlib_free(). If you need to continue using the WIM,
3626 * you must use wimlib_open_wim() to read it anew.
3629 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3630 * been in-memory changes made to it, which are then reflected in the
3632 * @param write_flags
3633 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3634 * @param num_threads
3635 * Number of threads to use for compression, or 0 for the default. (See
3638 * @return 0 on success; nonzero on error. This function may return most error
3639 * codes returned by wimlib_write() as well as the following error codes:
3641 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3642 * The WIM was going to be modified in-place (with no temporary file), but
3643 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3644 * because another thread or process has mounted an image from the WIM
3645 * read-write or is currently modifying the WIM in-place.
3646 * @retval ::WIMLIB_ERR_NO_FILENAME
3647 * @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim()
3648 * rather than a WIM read with wimlib_open_wim().
3649 * @retval ::WIMLIB_ERR_RENAME
3650 * The temporary file that the WIM was written to could not be renamed to
3651 * the original filename of @p wim.
3652 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3653 * The WIM file is considered read-only because of any of the reasons
3654 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3657 * If a progress function is registered with @p wim, it will receive the
3658 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3659 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3660 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3663 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3666 * @ingroup G_wim_information
3668 * Prints information about one image, or all images, contained in a WIM.
3671 * Pointer to the ::WIMStruct to query. This need not represent a
3672 * standalone WIM (e.g. it could represent part of a split WIM).
3674 * The image about which to print information. Can be the number of an
3675 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3678 * @return This function has no return value. No error checking is done when
3679 * printing the information. If @p image is invalid, an error message is
3683 wimlib_print_available_images(const WIMStruct *wim, int image);
3686 * @ingroup G_wim_information
3688 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3689 * in a way that can be accessed programatically.
3692 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3695 * @ingroup G_nonstandalone_wims
3697 * Reference resources from other WIM files or split WIM parts. This function
3698 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3699 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3700 * from other files, before calling a function such as wimlib_extract_image()
3701 * that requires the resources to be present.
3704 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3705 * necessarily "standalone". In the case of split WIMs, this should be the
3706 * first part, since only the first part contains the metadata resources.
3707 * In the case of delta WIMs, this should be the delta WIM rather than the
3708 * WIM on which it is based.
3709 * @param resource_wimfiles_or_globs
3710 * Array of paths to WIM files and/or split WIM parts to reference.
3711 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3712 * ref_flags, these are treated as globs rather than literal paths. That
3713 * is, using this function you can specify zero or more globs, each of
3714 * which expands to one or more literal paths.
3716 * Number of entries in @p resource_wimfiles_or_globs.
3718 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3719 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3721 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3722 * pass to internal calls to wimlib_open_wim() on the reference files.
3724 * @return 0 on success; nonzero on error.
3726 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3727 * One of the specified globs did not match any paths (only with both
3728 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3729 * specified in @p ref_flags).
3730 * @retval ::WIMLIB_ERR_NOMEM
3731 * Failed to allocate memory.
3732 * @retval ::WIMLIB_ERR_READ
3733 * I/O or permissions error while processing a file glob.
3735 * This function can additionally return most values that can be returned by
3736 * wimlib_open_wim().
3739 wimlib_reference_resource_files(WIMStruct *wim,
3740 const wimlib_tchar * const *resource_wimfiles_or_globs,
3746 * @ingroup G_nonstandalone_wims
3748 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3749 * where the caller must open the ::WIMStruct for each referenced file itself.
3752 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3753 * necessarily "standalone". In the case of split WIMs, this should be the
3754 * first part, since only the first part contains the metadata resources.
3755 * @param resource_wims
3756 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3757 * split WIM parts to reference.
3758 * @param num_resource_wims
3759 * Number of entries in @p resource_wims.
3761 * Currently ignored (set to 0).
3763 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3764 * @p resource_wims are referenced internally by @p wim and must not be freed
3765 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3766 * been freed with wimlib_free(), or immediately before freeing @p wim with
3769 * @retval ::WIMLIB_ERR_INVALID_PARAM
3770 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3771 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3772 * @retval ::WIMLIB_ERR_NOMEM
3773 * Failed to allocate memory.
3776 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3777 unsigned num_resource_wims, int ref_flags);
3780 * @ingroup G_modifying_wims
3782 * Declares that a newly added image is mostly the same as a prior image, but
3783 * captured at a later point in time, possibly with some modifications in the
3784 * intervening time. This is designed to be used in incremental backups of the
3785 * same filesystem or directory tree.
3787 * This function compares the metadata of the directory tree of the newly added
3788 * image against that of the old image. Any files that are present in both the
3789 * newly added image and the old image and have timestamps that indicate they
3790 * haven't been modified are deemed not to have been modified and have their
3791 * SHA1 message digest copied from the old image. Because of this and because
3792 * WIM uses single-instance streams, such files need not be read from the
3793 * filesystem when the WIM is being written or overwritten. Note that these
3794 * unchanged files will still be "archived" and will be logically present in the
3795 * new image; the optimization is that they don't need to actually be read from
3796 * the filesystem because the WIM already contains them.
3798 * This function is provided to optimize incremental backups. The resulting WIM
3799 * file will still be the same regardless of whether this function is called.
3800 * (This is, however, assuming that timestamps have not been manipulated or
3801 * unmaintained as to trick this function into thinking a file has not been
3802 * modified when really it has. To partly guard against such cases, other
3803 * metadata such as file sizes will be checked as well.)
3805 * This function must be called after adding the new image (e.g. with
3806 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3807 * wimlib_overwrite()).
3810 * Pointer to the ::WIMStruct for a WIM.
3812 * 1-based index in the WIM of the newly added image. This image can have
3813 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3814 * wimlib_add_empty_image() followed by wimlib_update_image().
3815 * @param template_wim
3816 * The ::WIMStruct for the WIM containing the template image. This can be
3817 * the same as @p wim, or it can be a different ::WIMStruct.
3818 * @param template_image
3819 * 1-based index in the WIM of a template image that reflects a prior state
3820 * of the directory tree being captured.
3822 * Reserved; must be 0.
3824 * @return 0 on success; nonzero on error.
3826 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3827 * @p new_image and/or @p template_image were not a valid image indices in
3829 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3830 * The specified ::WIMStruct did not actually contain the metadata resource
3831 * for the new or template image; for example, it was a non-first part of a
3833 * @retval ::WIMLIB_ERR_NOMEM
3834 * Failed to allocate needed memory.
3835 * @retval ::WIMLIB_ERR_INVALID_PARAM
3836 * @p new_image was equal to @p template_image, or @p new_image specified
3837 * an image that had not been modified since opening the WIM.
3839 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3840 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3841 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3842 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3843 * different reasons) to read the metadata resource for the template image.
3846 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3847 WIMStruct *template_wim, int template_image,
3851 * @ingroup G_general
3853 * Registers a progress function with a ::WIMStruct.
3856 * The ::WIMStruct for which to register the progress function.
3858 * Pointer to the progress function to register. If the WIM already has a
3859 * progress function registered, it will be replaced with this one. If @p
3860 * NULL, the current progress function (if any) will be unregistered.
3862 * The value which will be passed as the third argument to calls to @p
3866 wimlib_register_progress_function(WIMStruct *wim,
3867 wimlib_progress_func_t progfunc,
3871 * @ingroup G_modifying_wims
3873 * Rename the @p source_path to the @p dest_path in the specified @p image of
3876 * This just builds an appropriate ::wimlib_rename_command and passes it to
3877 * wimlib_update_image().
3880 wimlib_rename_path(WIMStruct *wim, int image,
3881 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3884 * @ingroup G_wim_information
3886 * Translates a string specifying the name or number of an image in the WIM into
3887 * the number of the image. The images are numbered starting at 1.
3890 * Pointer to the ::WIMStruct for a WIM.
3891 * @param image_name_or_num
3892 * A string specifying the name or number of an image in the WIM. If it
3893 * parses to a positive integer, this integer is taken to specify the
3894 * number of the image, indexed starting at 1. Otherwise, it is taken to
3895 * be the name of an image, as given in the XML data for the WIM file. It
3896 * also may be the keyword "all" or the string "*", both of which will
3897 * resolve to ::WIMLIB_ALL_IMAGES.
3899 * There is no way to search for an image actually named "all", "*", or an
3900 * integer number, or an image that has no name. However, you can use
3901 * wimlib_get_image_name() to get the name of any image.
3904 * If the string resolved to a single existing image, the number of that
3905 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3906 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3907 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3908 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3909 * images in @p wim has no name.
3912 wimlib_resolve_image(WIMStruct *wim,
3913 const wimlib_tchar *image_name_or_num);
3916 * @ingroup G_general
3918 * Sets the file to which the library will print error and warning messages.
3920 * This version of the function takes a C library <c>FILE *</c> opened for
3921 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3922 * file by name instead.
3924 * This also enables error messages, as if by a call to
3925 * wimlib_set_print_errors(true).
3927 * @return 0 on success; nonzero on error.
3928 * @retval ::WIMLIB_ERR_UNSUPPORTED
3929 * wimlib was compiled using the <c>--without-error-messages</c> option.
3932 wimlib_set_error_file(FILE *fp);
3935 * @ingroup G_general
3937 * Sets the path to the file to which the library will print error and warning
3938 * messages. The library will open this file for appending.
3940 * This also enables error messages, as if by a call to
3941 * wimlib_set_print_errors(true).
3943 * @return 0 on success; nonzero on error.
3944 * @retval ::WIMLIB_ERR_OPEN
3945 * The file named by @p path could not be opened for appending.
3946 * @retval ::WIMLIB_ERR_UNSUPPORTED
3947 * wimlib was compiled using the <c>--without-error-messages</c> option.
3950 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3953 * @ingroup G_modifying_wims
3955 * Changes the description of an image in the WIM.
3958 * Pointer to the ::WIMStruct for a WIM.
3960 * The number of the image for which to change the description.
3961 * @param description
3962 * The new description to give the image. It may be @c NULL, which
3963 * indicates that the image is to be given no description.
3965 * @return 0 on success; nonzero on error.
3966 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3967 * @p image does not specify a single existing image in @p wim.
3968 * @retval ::WIMLIB_ERR_NOMEM
3969 * Failed to allocate the memory needed to duplicate the @p description
3971 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3972 * @p wim is considered read-only because of any of the reasons mentioned
3973 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3976 wimlib_set_image_descripton(WIMStruct *wim, int image,
3977 const wimlib_tchar *description);
3980 * @ingroup G_writing_and_overwriting_wims
3982 * Set the compression chunk size of a WIM to use in subsequent calls to
3983 * wimlib_write() or wimlib_overwrite().
3985 * A larger compression chunk size will likely result in a better compression
3986 * ratio, but the speed of random access to the WIM will be reduced.
3987 * Furthermore, the effect of a larger compression chunk size is limited by the
3988 * size of each stream ("file") being compressed.
3991 * ::WIMStruct for a WIM.
3993 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3994 * on the compression format. See the documentation for each
3995 * ::wimlib_compression_type constant for more information. As a special
3996 * case, if @p chunk_size is specified as 0, the chunk size is set to the
3997 * default for the currently selected output compression type.
3999 * @return 0 on success; nonzero on error.
4001 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
4002 * @p chunk_size is not a supported chunk size for the currently selected
4003 * output compression type.
4006 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4009 * @ingroup G_writing_and_overwriting_wims
4011 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4012 * packed streams (solid blocks).
4015 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4018 * @ingroup G_writing_and_overwriting_wims
4020 * Set the compression type of a WIM to use in subsequent calls to
4021 * wimlib_write() or wimlib_overwrite().
4024 * ::WIMStruct for a WIM.
4026 * The compression type to set (one of ::wimlib_compression_type). If this
4027 * compression type is incompatible with the current output chunk size
4028 * (either the default or as set with wimlib_set_output_chunk_size()), the
4029 * output chunk size is reset to the default for that compression type.
4031 * @return 0 on success; nonzero on error.
4033 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4034 * @p ctype did not specify a valid compression type.
4037 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
4040 * @ingroup G_writing_and_overwriting_wims
4042 * Similar to wimlib_set_output_compression_type(), but set the compression type
4043 * for writing packed streams (solid blocks).
4046 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
4049 * @ingroup G_modifying_wims
4051 * Set basic information about a WIM.
4054 * Pointer to the ::WIMStruct for a WIM.
4056 * A struct ::wimlib_wim_info that contains the information to set. Only
4057 * the information explicitly specified in the @p which flags need be
4060 * Flags that specify which information to set. This is a bitwise OR of
4061 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4062 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4064 * @return 0 on success; nonzero on failure.
4065 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4066 * The WIM file is considered read-only because of any of the reasons
4067 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
4068 * flag. However, as a special case, if you are using
4069 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
4070 * function will not fail due to the readonly flag being previously set.
4071 * @retval ::WIMLIB_ERR_IMAGE_COUNT
4072 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4073 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4077 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4081 * @ingroup G_modifying_wims
4083 * Changes what is written in the \<FLAGS\> element in the WIM XML data
4084 * (something like "Core" or "Ultimate")
4087 * Pointer to the ::WIMStruct for a WIM.
4089 * The number of the image for which to change the description.
4091 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
4092 * indicates that the image is to be given no \<FLAGS\> element.
4094 * @return 0 on success; nonzero on error.
4095 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4096 * @p image does not specify a single existing image in @p wim.
4097 * @retval ::WIMLIB_ERR_NOMEM
4098 * Failed to allocate the memory needed to duplicate the @p flags string.
4099 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4100 * @p wim is considered read-only because of any of the reasons mentioned
4101 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
4104 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
4107 * @ingroup G_modifying_wims
4109 * Changes the name of an image in the WIM.
4112 * Pointer to the ::WIMStruct for a WIM.
4114 * The number of the image for which to change the name.
4116 * New name to give the new image. If @c NULL or empty, the new image is
4117 * given no name. If nonempty, it must specify a name that does not
4118 * already exist in @p wim.
4120 * @return 0 on success; nonzero on error.
4121 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
4122 * There is already an image named @p name in @p wim.
4123 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4124 * @p image does not specify a single existing image in @p wim.
4125 * @retval ::WIMLIB_ERR_NOMEM
4126 * Failed to allocate the memory needed to duplicate the @p name string.
4127 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4128 * @p wim is considered read-only because of any of the reasons mentioned
4129 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
4132 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
4135 * @ingroup G_general
4137 * Set the functions that wimlib uses to allocate and free memory.
4139 * These settings are global and not per-WIM.
4141 * The default is to use the default @c malloc() and @c free() from the C
4144 * Please note that some external functions, such as those in @c libntfs-3g, may
4145 * use the standard memory allocation functions regardless of this setting.
4147 * @param malloc_func
4148 * A function equivalent to @c malloc() that wimlib will use to allocate
4149 * memory. If @c NULL, the allocator function is set back to the default
4150 * @c malloc() from the C library.
4152 * A function equivalent to @c free() that wimlib will use to free memory.
4153 * If @c NULL, the free function is set back to the default @c free() from
4155 * @param realloc_func
4156 * A function equivalent to @c realloc() that wimlib will use to reallocate
4157 * memory. If @c NULL, the free function is set back to the default @c
4158 * realloc() from the C library.
4162 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
4163 void (*free_func)(void *),
4164 void *(*realloc_func)(void *, size_t));
4167 * @ingroup G_general
4169 * Sets whether wimlib is to print error messages to @c stderr when a function
4170 * fails. These error messages may provide information that cannot be
4171 * determined only from the error code that is returned. Not every error will
4172 * result in an error message being printed.
4174 * This setting is global and not per-WIM.
4176 * By default, error messages are not printed.
4178 * This can be called before wimlib_global_init().
4180 * @param show_messages
4181 * @c true if error messages are to be printed; @c false if error messages
4182 * are not to be printed.
4184 * @return 0 on success; nonzero on error.
4185 * @retval ::WIMLIB_ERR_UNSUPPORTED
4186 * @p show_messages was @c true, but wimlib was compiled with the @c
4187 * --without-error-messages option. Therefore, error messages cannot be
4191 wimlib_set_print_errors(bool show_messages);
4194 * @ingroup G_nonstandalone_wims
4196 * Splits a WIM into multiple parts.
4199 * The ::WIMStruct for the WIM to split.
4201 * Name of the SWM file to create. This will be the name of the first
4202 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
4203 * appended before the suffix.
4205 * The maximum size per part, in bytes. Unfortunately, it is not
4206 * guaranteed that this will really be the maximum size per part, because
4207 * some file resources in the WIM may be larger than this size, and the WIM
4208 * file format provides no way to split up file resources among multiple
4210 * @param write_flags
4211 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4212 * flags will be used to write each split WIM part. Specify 0 here to get
4213 * the default behavior.
4215 * @return 0 on success; nonzero on error. This function may return most error
4216 * codes that can be returned by wimlib_write() as well as the following error
4219 * @retval ::WIMLIB_ERR_INVALID_PARAM
4220 * @p swm_name was not a nonempty string, or @p part_size was 0.
4222 * If a progress function is registered with @p wim, for each split WIM part
4223 * that is written it will receive the messages
4224 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4225 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4228 wimlib_split(WIMStruct *wim,
4229 const wimlib_tchar *swm_name,
4234 * @ingroup G_general
4236 * Perform verification checks on a WIM file.
4239 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4240 * verification, it is a good idea to have used
4241 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4243 * If verifying a split WIM, specify the first part of the split WIM here,
4244 * and reference the other parts using wimlib_reference_resource_files()
4245 * before calling this function.
4247 * @param verify_flags
4248 * Reserved; must be 0.
4250 * @retval 0 if the WIM file was successfully verified; nonzero if it failed
4251 * verification or another error occurred. Some of the possible error codes
4254 * @retval ::WIMLIB_ERR_DECOMPRESSION
4255 * A compressed resource could not be decompressed.
4256 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4257 * The metadata resource for an image is invalid.
4258 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4259 * One of the files did not decompress to its original data, as given by a
4260 * cryptographic checksum.
4261 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4262 * One of the files referenced by an image could not be located.
4264 * If a progress function is registered with @p wim, it will receive the
4265 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4266 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4267 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4270 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4273 * @ingroup G_mounting_wim_images
4275 * Unmounts a WIM image that was mounted using wimlib_mount_image().
4277 * When unmounting a read-write mounted image, the default behavior is to
4278 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4279 * WIM image to be committed.
4282 * The directory the WIM image was mounted on.
4283 * @param unmount_flags
4284 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4286 * @return 0 on success; nonzero on error. The possible error codes include:
4288 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4289 * There is no WIM image mounted on the specified directory.
4290 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4291 * The read-write mounted WIM image cannot be committed because there are
4292 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4294 * @retval ::WIMLIB_ERR_MQUEUE
4295 * Could not create a POSIX message queue.
4296 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4297 * The WIM image was mounted by a different user.
4298 * @retval ::WIMLIB_ERR_UNSUPPORTED
4299 * Mounting is not supported in this build of the library.
4301 * Note: you can also unmount the image by using the @c umount() system call, or
4302 * by using the @c umount or @c fusermount programs. However, you need to call
4303 * this function if you want changes to be committed.
4306 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4309 * @ingroup G_mounting_wim_images
4311 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4312 * If changes are committed from a read-write mount, the progress function will
4313 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4316 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4318 wimlib_progress_func_t progfunc,
4322 * @ingroup G_modifying_wims
4324 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4327 * Pointer to the ::WIMStruct for the WIM file to update.
4329 * The 1-based index of the image in the WIM to update. It cannot be
4330 * ::WIMLIB_ALL_IMAGES.
4332 * An array of ::wimlib_update_command's that specify the update operations
4335 * Number of commands in @p cmds.
4336 * @param update_flags
4337 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4339 * @return 0 on success; nonzero on error. On failure, all update commands will
4340 * be rolled back, and no visible changes shall have been made to @p wim.
4341 * Possible error codes include:
4343 * @retval ::WIMLIB_ERR_FVE_LOCKED_VOLUME
4344 * Windows-only: One of the "add" commands attempted to add files from an
4345 * encrypted BitLocker volume that hasn't yet been unlocked.
4346 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4347 * The capture configuration structure specified for an add command was
4349 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4350 * @p image did not specify a single, existing image in @p wim.
4351 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4352 * Attempted to perform an add command that conflicted with previously
4353 * existing files in the WIM when an overlay was attempted.
4354 * @retval ::WIMLIB_ERR_INVALID_PARAM
4355 * An unknown operation type was specified in the update commands; or,
4356 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
4357 * in the @p add_flags, but the same image had previously already been
4358 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
4359 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
4360 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
4361 * specified in the @p add_flags for an add command in which @p
4362 * wim_target_path was not the root directory of the WIM image.
4363 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4364 * (Windows only): While executing an add command, tried to capture a
4365 * reparse point with invalid data.
4366 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4367 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4368 * for a WIM path that corresponded to a directory; or, a rename command
4369 * attempted to rename a directory to a non-directory.
4370 * @retval ::WIMLIB_ERR_NOMEM
4371 * Failed to allocate needed memory.
4372 * @retval ::WIMLIB_ERR_NOTDIR
4373 * A rename command attempted to rename a directory to a non-directory; or,
4374 * an add command was executed that attempted to set the root of the WIM
4375 * image as a non-directory; or, a path component used as a directory in a
4376 * rename command was not, in fact, a directory.
4377 * @retval ::WIMLIB_ERR_NOTEMPTY
4378 * A rename command attempted to rename a directory to a non-empty
4380 * @retval ::WIMLIB_ERR_NTFS_3G
4381 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4382 * error occurred while reading data from the NTFS volume using libntfs-3g.
4383 * @retval ::WIMLIB_ERR_OPEN
4384 * Failed to open a file to be captured while executing an add command.
4385 * @retval ::WIMLIB_ERR_OPENDIR
4386 * Failed to open a directory to be captured while executing an add command.
4387 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4388 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4389 * WIM path that did not exist; or, a rename command attempted to rename a
4390 * file that does not exist.
4391 * @retval ::WIMLIB_ERR_READ
4392 * While executing an add command, failed to read data from a file or
4393 * directory to be captured.
4394 * @retval ::WIMLIB_ERR_READLINK
4395 * While executing an add command, failed to read the target of a symbolic
4396 * link or junction point.
4397 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
4398 * (Windows only) Failed to perform a reparse point fixup because of
4399 * problems with the data of a reparse point.
4400 * @retval ::WIMLIB_ERR_STAT
4401 * While executing an add command, failed to get attributes for a file or
4403 * @retval ::WIMLIB_ERR_UNSUPPORTED
4404 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4405 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4406 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4407 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4408 * add_flags for an update command.
4409 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4410 * While executing an add command, attempted to capture a file that was not
4411 * a supported file type (e.g. a device file). Only if
4412 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4413 * for an update command.
4414 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4415 * The WIM file is considered read-only because of any of the reasons
4416 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
4419 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4420 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4421 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4422 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4423 * different reasons) to read the metadata resource for an image that needed to
4427 wimlib_update_image(WIMStruct *wim,
4429 const struct wimlib_update_command *cmds,
4434 * @ingroup G_writing_and_overwriting_wims
4436 * Writes a WIM to a file.
4438 * This brings in resources from any external locations, such as directory trees
4439 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4440 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
4442 * By default, the new WIM file is written as stand-alone. Using the
4443 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4444 * instead. However, this function cannot directly write a "split" WIM; use
4445 * wimlib_split() for that.
4448 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
4449 * changes made to it, which are then reflected in the output file.
4451 * The path to the file to write the WIM to.
4453 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4454 * images are to be included in the new on-disk WIM file. If for some
4455 * reason you only want to include a single image, specify the index of
4456 * that image instead.
4457 * @param write_flags
4458 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
4459 * @param num_threads
4460 * Number of threads to use for compressing data. If 0, the number of
4461 * threads will be set by the library automatically. This chosen value
4462 * will generally be the number of online processors, but the
4463 * implementation may take into account other information (e.g. available
4464 * memory and overall system activity).
4466 * @return 0 on success; nonzero on error.
4468 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4469 * @p image does not specify a single existing image in @p wim, and is not
4470 * ::WIMLIB_ALL_IMAGES.
4471 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4472 * A file resource failed a SHA-1 message digest check. This can happen if
4473 * a file that had previously been scanned for inclusion in the WIM by was
4474 * concurrently modified.
4475 * @retval ::WIMLIB_ERR_INVALID_PARAM
4476 * @p path was not a nonempty string, or invalid flags were passed.
4477 * @retval ::WIMLIB_ERR_NOMEM
4478 * Failed to allocate needed memory.
4479 * @retval ::WIMLIB_ERR_OPEN
4480 * Failed to open @p path for writing, or some file resources in @p wim
4481 * refer to files in the outside filesystem, and one of these files could
4482 * not be opened for reading.
4483 * @retval ::WIMLIB_ERR_READ
4484 * An error occurred when trying to read data from the WIM file associated
4485 * with @p wim, or some file resources in @p wim refer to files in the
4486 * outside filesystem, and a read error occurred when reading one of these
4488 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4489 * A stream that needed to be written could not be found in the stream
4490 * lookup table of @p wim. This error can occur if, for example, @p wim is
4491 * part of a split WIM but needed resources from the other split WIM parts
4492 * were not referenced with wimlib_reference_resources() or
4493 * wimlib_reference_resource_files() before the call to wimlib_write().
4494 * @retval ::WIMLIB_ERR_WRITE
4495 * An error occurred when trying to write data to the new WIM file.
4497 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4498 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4499 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4500 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4501 * different reasons) to read the data from a WIM archive.
4503 * If a progress function is registered with @p wim, it will receive the
4504 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4505 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4506 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4509 wimlib_write(WIMStruct *wim,
4510 const wimlib_tchar *path,
4513 unsigned num_threads);
4516 * @ingroup G_writing_and_overwriting_wims
4518 * Same as wimlib_write(), but write the WIM directly to a file descriptor,
4519 * which need not be seekable if the write is done in a special pipable WIM
4520 * format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p write_flags. This can,
4521 * for example, allow capturing a WIM image and streaming it over the network.
4522 * See @ref subsec_pipable_wims for more information about pipable WIMs.
4524 * The file descriptor @p fd will @b not be closed when the write is complete;
4525 * the calling code is responsible for this.
4527 * Returns 0 on success; nonzero on failure. The possible error codes include
4528 * those that can be returned by wimlib_write() as well as the following:
4530 * @retval ::WIMLIB_ERR_INVALID_PARAM
4531 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4532 * specified in @p write_flags.
4535 wimlib_write_to_fd(WIMStruct *wim,
4539 unsigned num_threads);
4542 * @defgroup G_compression Compression and decompression functions
4544 * @brief Functions for XPRESS, LZX, and LZMS compression and decompression.
4546 * These functions are already used by wimlib internally when appropriate for
4547 * reading and writing WIM archives. But they are exported and documented so
4548 * that they can be used in other applications or libraries for general-purpose
4549 * lossless data compression. They are implemented in highly optimized C code,
4550 * using state-of-the-art compression techniques. The main limitation is the
4551 * lack of sliding window support; this has, however, allowed the algorithms to
4552 * be optimized for block-based compression.
4557 /** Opaque compressor handle. */
4558 struct wimlib_compressor;
4560 /** Opaque decompressor handle. */
4561 struct wimlib_decompressor;
4564 * Set the default compression level for the specified compression type. This
4565 * is the compression level that wimlib_create_compressor() assumes if it is
4566 * called with @p compression_level specified as 0.
4568 * wimlib's WIM writing code (e.g. wimlib_write()) will pass 0 to
4569 * wimlib_create_compressor() internally. Therefore, calling this function will
4570 * affect the compression level of any data later written to WIM files using the
4571 * specified compression type.
4573 * The initial state, before this function is called, is that all compression
4574 * types have a default compression level of 50.
4577 * Compression type for which to set the default compression level, as one
4578 * of the ::wimlib_compression_type constants. Or, if this is the special
4579 * value -1, the default compression levels for all compression types will
4581 * @param compression_level
4582 * The default compression level to set. If 0, the "default default" level
4583 * of 50 is restored. Otherwise, a higher value indicates higher
4584 * compression, whereas a lower value indicates lower compression. See
4585 * wimlib_create_compressor() for more information.
4587 * @return 0 on success; nonzero on error.
4589 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4590 * @p ctype was neither a supported compression type nor -1.
4593 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
4596 * Returns the approximate number of bytes needed to allocate a compressor with
4597 * wimlib_create_compressor() for the specified compression type, maximum block
4598 * size, and compression level. @p compression_level may be 0, in which case
4599 * the current default compression level for @p ctype is used. Returns 0 if the
4600 * compression type is invalid, or the @p max_block_size for that compression
4604 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4605 size_t max_block_size,
4606 unsigned int compression_level);
4609 * Allocate a compressor for the specified compression type using the specified
4610 * parameters. This function is part of wimlib's compression API; it is not
4611 * necessary to call this to process a WIM file.
4614 * Compression type for which to create the compressor, as one of the
4615 * ::wimlib_compression_type constants.
4616 * @param max_block_size
4617 * The maximum compression block size to support. This specifies the
4618 * maximum allowed value for the @p uncompressed_size parameter of
4619 * wimlib_compress() when called using this compressor.
4621 * Usually, the amount of memory used by the compressor will scale in
4622 * proportion to the @p max_block_size parameter.
4623 * wimlib_get_compressor_needed_memory() can be used to query the specific
4624 * amount of memory that will be required.
4626 * This parameter must be at least 1 and must be less than or equal to a
4627 * compression-type-specific limit.
4629 * In general, the same value of @p max_block_size must be passed to
4630 * wimlib_create_decompressor() when the data is later decompressed.
4631 * However, some compression types have looser requirements regarding this.
4632 * @param compression_level
4633 * The compression level to use. If 0, the default compression level (50,
4634 * or another value as set through wimlib_set_default_compression_level())
4635 * is used. Otherwise, a higher value indicates higher compression. The
4636 * values are scaled so that 10 is low compression, 50 is medium
4637 * compression, and 100 is high compression. This is not a percentage;
4638 * values above 100 are also valid.
4640 * Using a higher-than-default compression level can result in a better
4641 * compression ratio, but can significantly reduce performance. Similarly,
4642 * using a lower-than-default compression level can result in better
4643 * performance, but can significantly worsen the compression ratio. The
4644 * exact results will depend heavily on the compression type and what
4645 * algorithms are implemented for it. If you are considering using a
4646 * non-default compression level, you should run benchmarks to see if it is
4647 * worthwhile for your application.
4649 * The compression level does not affect the format of the compressed data.
4650 * Therefore, it is a compressor-only parameter and does not need to be
4651 * passed to the decompressor.
4652 * @param compressor_ret
4653 * A location into which to return the pointer to the allocated compressor.
4654 * The allocated compressor can be used for any number of calls to
4655 * wimlib_compress() before being freed with wimlib_free_compressor().
4657 * @return 0 on success; nonzero on error.
4659 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4660 * @p ctype was not a supported compression type.
4661 * @retval ::WIMLIB_ERR_INVALID_PARAM
4662 * @p max_block_size was invalid for the compression type, or @p
4663 * compressor_ret was @c NULL.
4664 * @retval ::WIMLIB_ERR_NOMEM
4665 * Insufficient memory to allocate the compressor.
4668 wimlib_create_compressor(enum wimlib_compression_type ctype,
4669 size_t max_block_size,
4670 unsigned int compression_level,
4671 struct wimlib_compressor **compressor_ret);
4674 * Compress a buffer of data.
4676 * @param uncompressed_data
4677 * Buffer containing the data to compress.
4678 * @param uncompressed_size
4679 * Size, in bytes, of the data to compress. This cannot be greater than
4680 * the @p max_block_size with which wimlib_create_compressor() was called.
4681 * (If it is, the data will not be compressed and 0 will be returned.)
4682 * @param compressed_data
4683 * Buffer into which to write the compressed data.
4684 * @param compressed_size_avail
4685 * Number of bytes available in @p compressed_data.
4687 * A compressor previously allocated with wimlib_create_compressor().
4690 * The size of the compressed data, in bytes, or 0 if the data could not be
4691 * compressed to @p compressed_size_avail or fewer bytes.
4694 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4695 void *compressed_data, size_t compressed_size_avail,
4696 struct wimlib_compressor *compressor);
4699 * Free a compressor previously allocated with wimlib_create_compressor().
4702 * The compressor to free. If @c NULL, no action is taken.
4705 wimlib_free_compressor(struct wimlib_compressor *compressor);
4708 * Allocate a decompressor for the specified compression type. This function is
4709 * part of wimlib's compression API; it is not necessary to call this to process
4713 * Compression type for which to create the decompressor, as one of the
4714 * ::wimlib_compression_type constants.
4715 * @param max_block_size
4716 * The maximum compression block size to support. This specifies the
4717 * maximum allowed value for the @p uncompressed_size parameter of
4718 * wimlib_decompress().
4720 * In general, this parameter must be the same as the @p max_block_size
4721 * that was passed to wimlib_create_compressor() when the data was
4722 * compressed. However, some compression types have looser requirements
4724 * @param decompressor_ret
4725 * A location into which to return the pointer to the allocated
4726 * decompressor. The allocated decompressor can be used for any number of
4727 * calls to wimlib_decompress() before being freed with
4728 * wimlib_free_decompressor().
4730 * @return 0 on success; nonzero on error.
4732 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4733 * @p ctype was not a supported compression type.
4734 * @retval ::WIMLIB_ERR_INVALID_PARAM
4735 * @p max_block_size was invalid for the compression type, or @p
4736 * decompressor_ret was @c NULL.
4737 * @retval ::WIMLIB_ERR_NOMEM
4738 * Insufficient memory to allocate the decompressor.
4741 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4742 size_t max_block_size,
4743 struct wimlib_decompressor **decompressor_ret);
4746 * Decompress a buffer of data.
4748 * @param compressed_data
4749 * Buffer containing the data to decompress.
4750 * @param compressed_size
4751 * Size, in bytes, of the data to decompress.
4752 * @param uncompressed_data
4753 * Buffer into which to write the uncompressed data.
4754 * @param uncompressed_size
4755 * Size, in bytes, of the data when uncompressed. This cannot exceed the
4756 * @p max_block_size with which wimlib_create_decompressor() was called.
4757 * (If it does, the data will not be decompressed and a nonzero value will
4759 * @param decompressor
4760 * A decompressor previously allocated with wimlib_create_decompressor().
4762 * @return 0 on success; nonzero on error.
4764 * No specific error codes are defined; any nonzero value indicates that the
4765 * decompression failed. This can only occur if the data is truly invalid;
4766 * there will never be transient errors like "out of memory", for example.
4768 * This function requires that the exact uncompressed size of the data be passed
4769 * as the @p uncompressed_size parameter. If this is not done correctly,
4770 * decompression may fail or the data may be decompressed incorrectly.
4773 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4774 void *uncompressed_data, size_t uncompressed_size,
4775 struct wimlib_decompressor *decompressor);
4778 * Free a decompressor previously allocated with wimlib_create_decompressor().
4780 * @param decompressor
4781 * The decompressor to free. If @c NULL, no action is taken.
4784 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4796 #endif /* _WIMLIB_H */