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
15 * This is the documentation for the library interface of wimlib 1.7.4, a C
16 * library for creating, modifying, extracting, and mounting files in the
17 * Windows Imaging Format. This documentation is intended for developers only.
18 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
19 * program, please see the manual pages and also the <a
20 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
23 * @section sec_installing Installing
27 * Download the source code from <a
28 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
29 * Install the library by running <c>configure && make && sudo make install</c>.
30 * See the README for information about configuration options. To use wimlib in
31 * your program after installing it, include wimlib.h and link your program with
36 * Download the Windows binary distribution with the appropriate architecture
37 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
38 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
39 * Link your program with the libwim-15.dll file. Make sure to also download
40 * the source code so you can get wimlib.h, as it is not included in the binary
41 * distribution. If you need to access the DLL from other programming
42 * languages, note that the calling convention is "cdecl".
44 * @section sec_examples Examples
46 * Several examples are located in the <a
47 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
48 * directory of the source distribution.
50 * There is also the <a
51 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
52 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
53 * capabilities of wimlib.
55 * @section backwards_compatibility Backwards Compatibility
57 * New releases of wimlib are intended to be API/ABI compatible with old
58 * releases, except when the libtool "age" is reset. This most recently
59 * occurred for the v1.4.0 (libwim7), v1.5.0 (libwim9), and v1.7.0 (libwim15)
60 * releases. However, the library is becoming increasingly stable, and the goal
61 * is to maintain the current API/ABI for as long as possible unless there is a
62 * strong reason not to. Even for the v1.7.0 release (libwim15), the changes
63 * were fairly limited.
65 * As with any other library, applications should not rely on internal
66 * implementation details that may be subject to change.
68 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
70 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
71 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
72 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
73 * which creates a new ::WIMStruct that initially contains no images and does
74 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
77 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
78 * Images can be extracted (or "applied") using wimlib_extract_image(), added
79 * (or "captured" or "appended") using wimlib_add_image(), deleted using
80 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
81 * modified using wimlib_update_image(). However, changes made to a WIM
82 * represented by a ::WIMStruct have no persistent effect until the WIM is
83 * actually written to an on-disk file. This can be done using wimlib_write(),
84 * but if the WIM was originally opened using wimlib_open_wim(), then
85 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
86 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
88 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
89 * files is a multi-step process. For example, to add, or "append" an image to
90 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
91 * append</b>, you must call the following functions:
93 * 1. wimlib_open_wim()
94 * 2. wimlib_add_image()
95 * 3. wimlib_overwrite()
97 * This design is very much on purpose as it makes the library more useful in
98 * general by allowing functions to be composed in different ways. For example,
99 * you can make multiple changes to a WIM and commit them all to the underlying
100 * file in only one overwrite operation, which is more efficient.
102 * Note: before calling any other function declared in wimlib.h,
103 * wimlib_global_init() can (and in some cases, must) be called. See its
104 * documentation for more details.
106 * @section sec_cleaning_up Cleaning up
108 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
109 * all resources associated with it. Also, when you are completely done with
110 * using wimlib in your program, you can call wimlib_global_cleanup() to free
111 * any other resources allocated by the library.
113 * @section sec_error_handling Error Handling
115 * Most functions in wimlib return 0 on success and a positive error code on
116 * failure. Use wimlib_get_error_string() to get a string that describes an
117 * error code. wimlib also can print error messages to standard error itself
118 * when an error happens, and these may be more informative than the error code;
119 * to enable this, call wimlib_set_print_errors(). Please note that this is for
120 * convenience only, and some errors can occur without a message being printed.
121 * Currently, error messages and strings (as well as all documentation, for that
122 * matter) are only available in English.
124 * @section sec_encodings Locales and character encodings
126 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
127 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
130 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
131 * and the encoding is UTF-16LE.
133 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
134 * and the encoding is the locale-dependent multibyte encoding. I recommend you
135 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
136 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
137 * call wimlib_global_init() after having set your desired locale.
139 * @section sec_advanced Additional information and features
142 * @subsection subsec_mounting_wim_images Mounting WIM images
144 * See @ref G_mounting_wim_images.
146 * @subsection subsec_progress_functions Progress Messages
148 * See @ref G_progress.
150 * @subsection subsec_non_standalone_wims Non-standalone WIMs
152 * See @ref G_nonstandalone_wims.
154 * @subsection subsec_pipable_wims Pipable WIMs
156 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
157 * compatible with Microsoft's software. To create a pipable WIM, call
158 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
159 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
160 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
161 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
162 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
163 * s using a seekable file descriptor using the regular function calls (e.g.
164 * wimlib_open_wim(), wimlib_extract_image()).
166 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
167 * capture</b> for more information about pipable WIMs.
169 * @subsection subsec_thread_safety Thread Safety
171 * wimlib is thread-safe, with the following exceptions:
172 * - Different threads cannot operate on the same ::WIMStruct at the same time;
173 * they must use different ::WIMStruct's.
174 * - You must call wimlib_global_init() in one thread before calling any other
176 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
177 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
178 * concurrently in the same process, will daemonize the entire process when it
179 * does so for the first time. This includes changing the working directory
180 * to the root directory.
182 * @subsection subsec_limitations Limitations
184 * This section documents some technical limitations of wimlib not already
185 * documented in the man page for @b wimlib-imagex.
187 * - The old WIM format from Vista pre-releases is not supported.
188 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
189 * functionality other than that already present in @b ImageX, that allows you
190 * to make certain Windows-specific modifications to a Windows PE image, such
191 * as adding a driver or Windows component. Such a tool could be implemented
194 * @subsection more_info More information
196 * You are advised to read the README as well as the manual pages for
197 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
198 * the API documentation.
201 /** @defgroup G_general General
203 * @brief Declarations and structures shared across the library.
206 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
208 * @brief Create new WIMs and open existing WIMs.
211 /** @defgroup G_wim_information Retrieving WIM information and directory listings
213 * @brief Retrieve information about a WIM or WIM image.
216 /** @defgroup G_modifying_wims Modifying WIMs
218 * @brief Make changes to a WIM.
220 * @section sec_adding_images Capturing and adding WIM images
222 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
223 * appending an image to an existing WIM is a multi-step process, but at its
224 * core is wimlib_add_image() or an equivalent function. Normally,
225 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
226 * ::WIMStruct as a new image. However, when supported by the build of the
227 * library, there is also a special NTFS volume capture mode (entered when
228 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
229 * from an unmounted NTFS volume.
231 * Another function, wimlib_add_image_multisource() is also provided. It
232 * generalizes wimlib_add_image() to allow combining multiple files or directory
233 * trees into a single WIM image in a configurable way.
235 * For maximum customization of WIM image creation, it is also possible to add a
236 * completely empty WIM image with wimlib_add_empty_image(), then update it with
237 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
238 * wimlib_add_image_multisource() do internally.)
240 * Note that some details of how image addition/capture works are documented
241 * more fully in the manual page for <b>wimlib-imagex capture</b>.
243 * @section sec_deleting_images Deleting WIM images
245 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
246 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
247 * be made persistent in an on-disk WIM file.
249 * @section sec_exporting_images Exporting WIM images
251 * wimlib_export_image() can copy, or "export", an image from one WIM to
254 * @section sec_other_modifications Other modifications
256 * wimlib_update_image() can add, delete, and rename files in a WIM image.
258 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
259 * wimlib_set_image_flags() can change other image metadata.
261 * wimlib_set_wim_info() can change information about the WIM file itself, such
265 /** @defgroup G_extracting_wims Extracting WIMs
267 * @brief Extract files, directories, and images from a WIM.
269 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
270 * represented by a ::WIMStruct. This normally extracts the image to a
271 * directory, but when supported by the build of the library there is also a
272 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
273 * is specified) that allows extracting a WIM image directly to an unmounted
274 * NTFS volume. Various other flags allow further customization of image
277 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
278 * of (possibly wildcard) paths from a WIM image.
280 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
281 * over a pipe; see @ref subsec_pipable_wims.
283 * Some details of how WIM extraction works are documented more fully in the
284 * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
287 /** @defgroup G_mounting_wim_images Mounting WIM images
289 * @brief Mount and unmount WIM images.
291 * On Linux, wimlib supports mounting images from WIM files either read-only or
292 * read-write. To mount an image, call wimlib_mount_image(). To unmount an
293 * image, call wimlib_unmount_image(). Mounting can be done without root
294 * privileges because it is implemented using FUSE (Filesystem in Userspace).
296 * If wimlib is compiled using the <code>--without-fuse</code> flag, these
297 * functions will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
299 * Note: if mounting is unsupported, wimlib still provides another way to modify
300 * a WIM image (wimlib_update_image()).
304 * @defgroup G_progress Progress Messages
306 * @brief Track the progress of long WIM operations.
308 * Library users can provide a progress function which will be called
309 * periodically during operations such as extracting a WIM image or writing a
310 * WIM image. A ::WIMStruct can have a progress function of type
311 * ::wimlib_progress_func_t associated with it by calling
312 * wimlib_register_progress_function() or by opening the ::WIMStruct using
313 * wimlib_open_wim_with_progress(). Once this is done, the progress function
314 * will be called automatically during many operations, such as
315 * wimlib_extract_image() and wimlib_write().
317 * Some functions that do not operate directly on a user-provided ::WIMStruct,
318 * such as wimlib_join(), also take the progress function directly using an
319 * extended version of the function, such as wimlib_join_with_progress().
321 * In wimlib v1.7.0 and later, progress functions are no longer just
322 * unidirectional. You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
323 * the current operation to be aborted. wimlib v1.7.0 also added the third
324 * argument to ::wimlib_progress_func_t, which is a user-supplied context.
327 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
329 * @brief Write and overwrite on-disk WIM files.
331 * As described in @ref sec_basic_wim_handling_concepts, these functions are
332 * fundamental to the design of the library as they allow new or modified
333 * ::WIMStruct's to actually be written to on-disk files. Call wimlib_write()
334 * to write a new WIM file, or wimlib_overwrite() to persistently update an
338 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
340 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
342 * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it
343 * than that. Normally, WIM files are "standalone". However, WIM files can
344 * also be arranged in non-standalone ways, such as a set of on-disk files that
345 * together form a single "split WIM" or "delta WIM". Such arrangements are
346 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
347 * created from one of these on-disk files initially only partially represents
348 * the full WIM and needs to, in effect, be logically combined with other
349 * ::WIMStruct's before performing certain operations, such as extracting files
350 * with wimlib_extract_image() or wimlib_extract_paths(). This is done by
351 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
353 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
354 * specialized function (wimlib_split()) is needed to create a split WIM.
363 #include <inttypes.h>
367 # define _wimlib_deprecated __attribute__((deprecated))
369 # define _wimlib_deprecated
372 /** @addtogroup G_general
375 /** Major version of the library (for example, the 1 in 1.2.5). */
376 #define WIMLIB_MAJOR_VERSION 1
378 /** Minor version of the library (for example, the 2 in 1.2.5). */
379 #define WIMLIB_MINOR_VERSION 7
381 /** Patch version of the library (for example, the 5 in 1.2.5). */
382 #define WIMLIB_PATCH_VERSION 4
389 * Opaque structure that represents a WIM file. This is an in-memory structure
390 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
391 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
392 * continuing to exist so that data can be read from it as needed.
394 * Most functions in this library will work the same way regardless of whether a
395 * given ::WIMStruct was obtained through wimlib_open_wim() or
396 * wimlib_create_new_wim(). Exceptions are documented.
398 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
399 * file from a ::WIMStruct.
401 * See @ref sec_basic_wim_handling_concepts for more information.
403 #ifndef WIMLIB_WIMSTRUCT_DECLARED
404 typedef struct WIMStruct WIMStruct;
405 #define WIMLIB_WIMSTRUCT_DECLARED
409 typedef wchar_t wimlib_tchar;
411 /** See @ref sec_encodings */
412 typedef char wimlib_tchar;
416 /** Path separator for WIM paths passed back to progress callbacks.
417 * This is forward slash on UNIX and backslash on Windows. */
418 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
419 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
421 /** Path separator for WIM paths passed back to progress callbacks.
422 * This is forward slash on UNIX and backslash on Windows. */
423 # define WIMLIB_WIM_PATH_SEPARATOR '/'
424 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
427 /** Use this to specify the root directory of the WIM image. */
428 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
430 /** Use this to test if the specified path refers to the root directory of the
432 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
433 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
436 /** Length of a Globally Unique Identifier (GUID) */
437 #define WIMLIB_GUID_LEN 16
440 * Specifies a compression format. Pass one of these values to
441 * wimlib_create_new_wim(), wimlib_set_output_compression_type(),
442 * wimlib_create_compressor(), or wimlib_create_decompressor().
444 * A WIM file has one default compression type and chunk size. Normally, each
445 * resource in the WIM file is compressed with this compression type. However,
446 * resources may be stored as uncompressed; for example, wimlib will do so if a
447 * resource does not compress to less than its original size. In addition, a
448 * WIM with the new version number of 3584, or "ESD file", might contain solid
449 * blocks with different compression types.
451 enum wimlib_compression_type {
455 * This is a valid argument to wimlib_create_new_wim() and
456 * wimlib_set_output_compression_type(), but not to the functions in the
457 * compression API such as wimlib_create_compressor().
459 WIMLIB_COMPRESSION_TYPE_NONE = 0,
462 * The XPRESS compression format. This format combines Lempel-Ziv
463 * factorization with Huffman encoding. Compression and decompression
464 * are both fast. This format supports chunk sizes that are powers of 2
465 * between <c>2^12</c> and <c>2^16</c>, inclusively.
467 * wimlib's XPRESS compressor will, with the default settings, usually
468 * produce a better compression ratio, and work more quickly, than the
469 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
470 * Non-default compression levels are also supported. For example,
471 * level 80 will enable two-pass optimal parsing, which is significantly
472 * slower but usually improves compression by several percent over the
473 * default level of 50.
475 * If using wimlib_create_compressor() to create an XPRESS compressor
476 * directly, the @p max_block_size parameter may be any positive value
477 * up to and including <c>2^16</c>.
479 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
482 * The LZX compression format. This format combines Lempel-Ziv
483 * factorization with Huffman encoding, but with more features and
484 * complexity than XPRESS. Compression is slow to somewhat fast,
485 * depending on the settings. Decompression is fast but slower than
486 * XPRESS. This format supports chunk sizes that are powers of 2
487 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
488 * other than <c>2^15</c> are not compatible with the Microsoft
491 * wimlib's LZX compressor will, with the default settings, usually
492 * produce a better compression ratio, and work more quickly, than the
493 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
494 * Non-default compression levels are also supported. For example,
495 * level 20 will provide fast compression, almost as fast as XPRESS.
497 * If using wimlib_create_compressor() to create an LZX compressor
498 * directly, the @p max_block_size parameter may be any positive value
499 * up to and including <c>2^21</c>.
501 WIMLIB_COMPRESSION_TYPE_LZX = 2,
504 * The LZMS compression format. This format combines Lempel-Ziv
505 * factorization with adaptive Huffman encoding and range coding.
506 * Compression and decompression are both fairly slow. This format
507 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
508 * <c>2^30</c>, inclusively. This format is best used for large chunk
509 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
510 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
511 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
512 * with the Microsoft implementation.
514 * wimlib's LZMS compressor is currently faster but will usually not
515 * compress as much as the implementation in Microsoft's WIMGAPI
518 * If using wimlib_create_compressor() to create an LZMS compressor
519 * directly, the @p max_block_size parameter may be any positive value
520 * up to and including <c>1180427429</c>.
522 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
526 /** @addtogroup G_progress
529 /** Possible values of the first parameter to the user-supplied
530 * ::wimlib_progress_func_t progress function */
531 enum wimlib_progress_msg {
533 /** A WIM image is about to be extracted. @p info will point to
534 * ::wimlib_progress_info.extract. This message is received once per
535 * image for calls to wimlib_extract_image() and
536 * wimlib_extract_image_from_pipe(). */
537 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
539 /** One or more file or directory trees within a WIM image is about to
540 * be extracted. @p info will point to ::wimlib_progress_info.extract.
541 * This message is received only once per wimlib_extract_paths() and
542 * wimlib_extract_pathlist(), since wimlib combines all paths into a
543 * single extraction operation for optimization purposes. */
544 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
546 /** This message may be sent periodically (not for every file) while
547 * files or directories are being created, prior to data stream
548 * extraction. @p info will point to ::wimlib_progress_info.extract.
549 * In particular, the @p current_file_count and @p end_file_count
550 * members may be used to track the progress of this phase of
552 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
554 /** File data is currently being extracted. @p info will point to
555 * ::wimlib_progress_info.extract. This is the main message to track
556 * the progress of an extraction operation. */
557 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
559 /** Starting to read a new part of a split pipable WIM over the pipe.
560 * @p info will point to ::wimlib_progress_info.extract. */
561 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
563 /** This message may be sent periodically (not for every file) while
564 * file and directory metadata is being applied, following data stream
565 * extraction. @p info will point to ::wimlib_progress_info.extract.
566 * In particular, the @p current_file_count and @p end_file_count
567 * members may be used to track the progress of this phase of
569 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
571 /** Confirms that the image has been successfully extracted. @p info
572 * will point to ::wimlib_progress_info.extract. This is paired with
573 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
574 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
576 /** Confirms that the files or directory trees have been successfully
577 * extracted. @p info will point to ::wimlib_progress_info.extract.
578 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
579 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
581 /** The directory or NTFS volume is about to be scanned for metadata.
582 * @p info will point to ::wimlib_progress_info.scan. This message is
583 * received once per call to wimlib_add_image(), or once per capture
584 * source passed to wimlib_add_image_multisource(), or once per add
585 * command passed to wimlib_update_image(). */
586 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
588 /** A directory or file has been scanned. @p info will point to
589 * ::wimlib_progress_info.scan, and its @p cur_path member will be
590 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
592 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
594 /** Confirms that the directory or NTFS volume has been successfully
595 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
596 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
597 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
599 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
601 /** File resources ("streams") are currently being written to the WIM.
602 * @p info will point to ::wimlib_progress_info.write_streams. This
603 * message may be received many times while the WIM file is being
604 * written or appended to with wimlib_write(), wimlib_overwrite(), or
605 * wimlib_write_to_fd(). */
606 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
608 /** Per-image metadata is about to be written to the WIM file. @p info
609 * will not be valid. */
610 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
612 /** Confirms that per-image metadata has been successfully been written
613 * to the WIM file. @p info will not be valid. This message is paired
614 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
616 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
618 /** wimlib_overwrite() has successfully renamed the temporary file to
619 * the original WIM file, thereby committing the update. @p info will
620 * point to ::wimlib_progress_info.rename. Note: this message is not
621 * received if wimlib_overwrite() chose to append to the WIM file
623 WIMLIB_PROGRESS_MSG_RENAME = 15,
625 /** The contents of the WIM file are being checked against the integrity
626 * table. @p info will point to ::wimlib_progress_info.integrity. This
627 * message is only received (and may be received many times) when
628 * wimlib_open_wim_with_progress() is called with the
629 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
630 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
632 /** An integrity table is being calculated for the WIM being written.
633 * @p info will point to ::wimlib_progress_info.integrity. This message
634 * is only received (and may be received many times) when a WIM file is
635 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
636 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
638 /** A wimlib_split() operation is in progress, and a new split part is
639 * about to be started. @p info will point to
640 * ::wimlib_progress_info.split. */
641 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
643 /** A wimlib_split() operation is in progress, and a split part has been
644 * finished. @p info will point to ::wimlib_progress_info.split. */
645 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
647 /** A WIM update command is just about to be executed. @p info will
648 * point to ::wimlib_progress_info.update. This message is received
649 * once per update command when wimlib_update_image() is called with the
650 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
651 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
653 /** A WIM update command has just been executed. @p info will point to
654 * ::wimlib_progress_info.update. This message is received once per
655 * update command when wimlib_update_image() is called with the flag
656 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
657 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
659 /** A file in the WIM image is being replaced as a result of a
660 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
661 * @p info will point to ::wimlib_progress_info.replace. This is only
662 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
664 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
666 /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
667 * a file is being extracted normally (not as a WIMBoot "pointer file")
668 * due to it matching a pattern in the [PrepopulateList] section of the
669 * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
670 * WIM image. @p info will point to
671 * ::wimlib_progress_info.wimboot_exclude.
673 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
675 /** Starting to unmount a WIM image. @p info will point to
676 * ::wimlib_progress_info.unmount. */
677 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
679 /** wimlib has used a file's data for the last time (including all data
680 * streams, if it has multiple). @p info will point to
681 * ::wimlib_progress_info.done_with_file. This message is only received
682 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
683 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
685 /** wimlib_verify_wim() is starting to verify the metadata for an image.
686 * @p info will point to ::wimlib_progress_info.verify_image. */
687 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
689 /** wimlib_verify_wim() has finished verifying the metadata for an
690 * image. @p info will point to ::wimlib_progress_info.verify_image.
692 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
694 /** wimlib_verify_wim() is verifying stream integrity. @p info will
695 * point to ::wimlib_progress_info.verify_streams. */
696 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
699 * The progress function is being asked whether a file should be
700 * excluded from capture or not. @p info will point to
701 * ::wimlib_progress_info.test_file_exclusion. This is a bidirectional
702 * message that allows the progress function to set a flag if the file
703 * should be excluded.
705 * This message is only received if the flag
706 * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used. This method for file
707 * exclusions is independent of the "capture configuration file"
710 WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
713 * An error has occurred and the progress function is being asked
714 * whether to ignore the error or not. @p info will point to
715 * ::wimlib_progress_info.handle_error. This is a bidirectional
718 * This message provides a limited capability for applications to
719 * recover from "unexpected" errors (i.e. those with no in-library
720 * handling policy) arising from the underlying operating system.
721 * Normally, any such error will cause the library to abort the current
722 * operation. By implementing a handler for this message, the
723 * application can instead choose to ignore a given error.
725 * Currently, only the following types of errors will result in this
726 * progress message being sent:
728 * - Directory tree scan errors, e.g. from wimlib_add_image()
729 * - Most extraction errors; currently restricted to the Windows
730 * build of the library only.
732 WIMLIB_PROGRESS_MSG_HANDLE_ERROR = 31,
735 /** Valid return values from user-provided progress functions
736 * (::wimlib_progress_func_t).
738 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
741 enum wimlib_progress_status {
743 /** The operation should be continued. This is the normal return value.
745 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
747 /** The operation should be aborted. This will cause the current
748 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
749 WIMLIB_PROGRESS_STATUS_ABORT = 1,
753 * A pointer to this union is passed to the user-supplied
754 * ::wimlib_progress_func_t progress function. One (or none) of the structures
755 * contained in this union will be applicable for the operation
756 * (::wimlib_progress_msg) indicated in the first argument to the progress
758 union wimlib_progress_info {
760 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
761 * document them if they aren't given a name... */
763 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
764 * the primary message for tracking the progress of writing a WIM file.
766 struct wimlib_progress_info_write_streams {
767 /** Total number of uncompressed bytes of stream data being
768 * written. This can be thought of as the total uncompressed
769 * size of the files being archived, with some caveats. WIM
770 * files use single-instance streams, so the size provided here
771 * only counts distinct streams, except for the following
772 * exception: the size provided here may include the sizes of
773 * all newly added (e.g. with wimlib_add_image() streams,
774 * pending automatic de-duplication during the write operation
775 * itself. When each such stream de-duplication occurs, this
776 * number will be decreased by the size of the duplicate stream
777 * that need not be written.
779 * In the case of a wimlib_overwrite() that the library opted to
780 * perform in-place, both @p total_streams and @p total_bytes
781 * will only count the streams actually being written and not
782 * pre-existing streams in the WIM file. */
783 uint64_t total_bytes;
785 /** Total number of streams being written. This can be thought
786 * of as the total number of files being archived, with some
787 * caveats. In general, a single file or directory may contain
788 * multiple data streams, each of which will be represented
789 * separately in this number. Furthermore, WIM files use
790 * single-instance streams, so the stream count provided here
791 * only counts distinct streams, except for the following
792 * exception: the stream count provided here may include newly
793 * added (e.g. with wimlib_add_image() streams, pending
794 * automatic de-duplication during the write operation itself.
795 * When each such stream de-duplication occurs, this number will
796 * be decreased by 1 to account for the duplicate stream that
797 * need not be written. */
798 uint64_t total_streams;
800 /** Number of uncompressed bytes of stream data that have been
801 * written so far. This number be 0 initially, and will be
802 * equal to @p total_bytes at the end of the write operation.
803 * Note that @p total_bytes (but not @p completed_bytes) may
804 * decrease throughout the write operation due to the discovery
805 * of stream duplications. */
806 uint64_t completed_bytes;
808 /** Number of streams that have been written so far. This
809 * number will be 0 initially, and will be equal to @p
810 * total_streams at the end of the write operation. Note that
811 * @p total_streams (but not @p completed_streams) may decrease
812 * throughout the write operation due to the discovery of stream
815 * For applications that wish to calculate a simple "percent
816 * complete" for the write operation, it will likely be more
817 * accurate to calculate the percentage from @p completed_bytes
818 * and @p total_bytes rather than @p completed_streams and
819 * @p total_streams because the time for the operation to
820 * complete is mainly determined by the number of bytes that
821 * need to be read, compressed, and written, not just the number
822 * of files being archived. */
823 uint64_t completed_streams;
825 /** Number of threads that are being used to compress streams,
826 * or 1 if streams are being written uncompressed. */
827 uint32_t num_threads;
829 /** The compression type being used to write the streams, as one
830 * of the ::wimlib_compression_type constants. */
831 int32_t compression_type;
833 /** Number of split WIM parts from which streams are being
834 * written (may be 0 if irrelevant). */
835 uint32_t total_parts;
837 /** This is currently broken and will always be 0. */
838 uint32_t completed_parts;
841 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
842 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
843 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
844 struct wimlib_progress_info_scan {
845 /** Top-level directory being scanned; or, when capturing an NTFS
846 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
847 * to the file or block device that contains the NTFS volume
849 const wimlib_tchar *source;
851 /** Path to the file (or directory) that has been scanned, valid
852 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
853 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
854 * relative to the root of the NTFS volume. */
855 const wimlib_tchar *cur_path;
857 /** Dentry scan status, valid on
858 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
860 /** The file looks okay and will be captured. */
861 WIMLIB_SCAN_DENTRY_OK = 0,
863 /** File is being excluded from capture due to the
864 * capture configuration. */
865 WIMLIB_SCAN_DENTRY_EXCLUDED,
867 /** File is being excluded from capture due to being
868 * unsupported (e.g. an encrypted or device file). */
869 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
871 /** The file is an absolute symbolic link or junction
872 * that points into the capture directory, and
873 * reparse-point fixups are enabled, so its target is
874 * being adjusted. (Reparse point fixups can be
875 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
877 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
879 /** Reparse-point fixups are enabled, but the file is an
880 * absolute symbolic link or junction that does
881 * <b>not</b> point into the capture directory, so its
882 * target is <b>not</b> being adjusted. */
883 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
887 /** Target path in the WIM image. Only valid on
888 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
889 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
890 const wimlib_tchar *wim_target_path;
892 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
893 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
894 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
895 * target of the absolute symbolic link or junction. */
896 const wimlib_tchar *symlink_target;
899 /** Number of directories scanned so far, including the root
900 * directory but excluding any unsupported/excluded directories.
902 * Details: On Windows and in NTFS capture mode, a reparse point
903 * counts as a directory if and only if it has
904 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
905 * counts as a directory if and only if when fully dereferenced
906 * it points to an accessible directory. If a file has multiple
907 * names (hard links), it is only counted one time. */
908 uint64_t num_dirs_scanned;
910 /** Number of non-directories scanned so far, excluding any
911 * unsupported/excluded files.
913 * Details: On Windows and in NTFS capture mode, a reparse point
914 * counts as a non-directory if and only if it does not have
915 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
916 * counts as a non-directory if and only if when fully
917 * dereferenced it points to a non-directory or its target is
918 * inaccessible. If a file has multiple names (hard links), it
919 * is only counted one time. */
920 uint64_t num_nondirs_scanned;
922 /** Number of bytes of file data that have been detected so far.
924 * Details: This data may not actually have been read yet, and
925 * it will not actually be written to the WIM file until
926 * wimlib_write() or wimlib_overwrite() has been called. Data
927 * from excluded files is not counted. This number includes
928 * default file contents as well as named data streams and
929 * reparse point data. The size of reparse point data is
930 * tallied after any reparse-point fixups, and in the case of
931 * capturing a symbolic link on a UNIX-like system, the creation
932 * of the reparse point data itself. If a file has multiple
933 * names (hard links), its size(s) are only counted one time.
934 * On Windows, encrypted files have their encrypted size
935 * counted, not their unencrypted size; however, compressed
936 * files have their uncompressed size counted. */
937 uint64_t num_bytes_scanned;
940 /** Valid on messages
941 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
942 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
943 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
944 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
945 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
946 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
947 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
948 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
950 * Note: most of the time of an extraction operation will be spent
951 * extracting streams, and the application will receive
952 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
953 * completed_bytes and @p total_bytes, the application can calculate a
954 * percentage complete. However, note that this message does not, in
955 * general, actually provide information about which "file" is currently
956 * being extracted. This is because wimlib, by default, extracts the
957 * individual data streams in whichever order it determines to be the
960 struct wimlib_progress_info_extract {
961 /** Number of the image from which files are being extracted
965 /** Extraction flags being used. */
966 uint32_t extract_flags;
968 /** Full path to the WIM file from which files are being
969 * extracted, or @c NULL if the WIMStruct has no associated
971 const wimlib_tchar *wimfile_name;
973 /** Name of the image from which files are being extracted, or
974 * the empty string if the image is unnamed. */
975 const wimlib_tchar *image_name;
977 /** Path to the directory or NTFS volume to which the files are
978 * being extracted. */
979 const wimlib_tchar *target;
982 const wimlib_tchar *reserved;
984 /** Number of bytes of uncompressed data that will be extracted.
985 * If a file has multiple names (hard links), its size (or
986 * sizes, in the case of named data streams) is only counted one
987 * time. For "reparse points" and symbolic links, the size to
988 * be extracted is the size of the reparse data buffer.
990 * This number will stay constant throughout the extraction. */
991 uint64_t total_bytes;
993 /** Number of bytes of uncompressed data that have been
994 * extracted so far. This initially be 0 and will equal to @p
995 * total_bytes at the end of the extraction. */
996 uint64_t completed_bytes;
998 /** Number of (not necessarily unique) streams that will be
999 * extracted. This may be more or less than the number of
1000 * "files" to be extracted due to hard links as well as
1001 * potentially multiple streams per file (named data streams).
1002 * A "stream" may be the default contents of a file, a named
1003 * data stream, or a reparse data buffer. */
1004 uint64_t total_streams;
1006 /** Number of (not necessarily unique) streams that have been
1007 * extracted so far. */
1008 uint64_t completed_streams;
1010 /** Currently only used for
1011 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
1012 uint32_t part_number;
1014 /** Currently only used for
1015 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
1016 uint32_t total_parts;
1018 /** Currently only used for
1019 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
1020 uint8_t guid[WIMLIB_GUID_LEN];
1022 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1023 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
1024 * number of files that have been processed so far. Once the
1025 * corresponding phase of extraction is complete, this value
1026 * will be equal to @c end_file_count. */
1027 uint64_t current_file_count;
1029 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1030 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
1031 * total number of files that will be processed.
1033 * This number is provided for informational purposes only.
1034 * This number will not necessarily be equal to the number of
1035 * files actually being extracted. This is because extraction
1036 * backends are free to implement an extraction algorithm that
1037 * might be more efficient than processing every file in the
1038 * "extract file structure" and "extract metadata" phases. For
1039 * example, the current implementation of the UNIX extraction
1040 * backend will create files on-demand during the stream
1041 * extraction phase. Therefore, when using that particular
1042 * extraction backend, @p end_file_count will only include
1043 * directories and empty files. */
1044 uint64_t end_file_count;
1047 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
1048 struct wimlib_progress_info_rename {
1049 /** Name of the temporary file that the WIM was written to. */
1050 const wimlib_tchar *from;
1052 /** Name of the original WIM file to which the temporary file is
1054 const wimlib_tchar *to;
1057 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1058 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
1059 struct wimlib_progress_info_update {
1060 /** Pointer to the update command that will be executed or has
1061 * just been executed. */
1062 const struct wimlib_update_command *command;
1064 /** Number of update commands that have been completed so far.
1066 size_t completed_commands;
1068 /** Number of update commands that are being executed as part of
1069 * this call to wimlib_update_image(). */
1070 size_t total_commands;
1073 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
1074 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
1075 struct wimlib_progress_info_integrity {
1076 /** Number of bytes from the end of the WIM header to the end of
1077 * the lookup table (the area that is covered by the SHA1
1078 * integrity checks.) */
1079 uint64_t total_bytes;
1081 /** Number of bytes that have been SHA1-summed so far. Will be
1082 * 0 initially, and equal @p total_bytes at the end. */
1083 uint64_t completed_bytes;
1085 /** Number of chunks that the checksummed region is divided
1087 uint32_t total_chunks;
1089 /** Number of chunks that have been SHA1-summed so far. Will
1090 * be 0 initially, and equal to @p total_chunks at the end. */
1091 uint32_t completed_chunks;
1093 /** Size of the chunks used for the integrity calculation. */
1094 uint32_t chunk_size;
1096 /** Filename of the WIM (only valid if the message is
1097 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
1098 const wimlib_tchar *filename;
1101 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1102 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1103 struct wimlib_progress_info_split {
1104 /** Total size of the original WIM's file and metadata resources
1106 uint64_t total_bytes;
1108 /** Number of bytes of file and metadata resources that have
1109 * been copied out of the original WIM so far. Will be 0
1110 * initially, and equal to @p total_bytes at the end. */
1111 uint64_t completed_bytes;
1113 /** Number of the split WIM part that is about to be started
1114 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1115 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1116 unsigned cur_part_number;
1118 /** Total number of split WIM parts that are being written. */
1119 unsigned total_parts;
1121 /** Name of the split WIM part that is about to be started
1122 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1123 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1124 * As of wimlib v1.7.0, the library user may change this when
1125 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1126 * cause the next split WIM part to be written to a different
1128 wimlib_tchar *part_name;
1131 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1132 struct wimlib_progress_info_replace {
1133 /** Path to the file in the WIM image that is being replaced */
1134 const wimlib_tchar *path_in_wim;
1137 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1138 struct wimlib_progress_info_wimboot_exclude {
1139 /** Path to the file in the WIM image */
1140 const wimlib_tchar *path_in_wim;
1142 /** Path to which the file is being extracted */
1143 const wimlib_tchar *extraction_path;
1146 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1147 struct wimlib_progress_info_unmount {
1148 /** Path to directory being unmounted */
1149 const wimlib_tchar *mountpoint;
1151 /** Path to WIM file being unmounted */
1152 const wimlib_tchar *mounted_wim;
1154 /** 1-based index of image being unmounted. */
1155 uint32_t mounted_image;
1157 /** Flags that were passed to wimlib_mount_image() when the
1158 * mountpoint was set up. */
1159 uint32_t mount_flags;
1161 /** Flags passed to wimlib_unmount_image(). */
1162 uint32_t unmount_flags;
1165 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1166 struct wimlib_progress_info_done_with_file {
1167 /* Path to the file whose data has been written to the WIM file,
1168 * or is currently being asynchronously compressed in memory,
1169 * and therefore is no longer needed by wimlib.
1171 * WARNING: The file data will not actually be accessible in the
1172 * WIM file until the WIM file has been completely written.
1173 * Ordinarily you should <b>not</b> treat this message as a
1174 * green light to go ahead and delete the specified file, since
1175 * that would result in data loss if the WIM file cannot be
1176 * successfully created for any reason.
1178 * If a file has multiple names (hard links),
1179 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1180 * for one name. Also, this message will not be received for
1181 * empty files or reparse points (or symbolic links), unless
1182 * they have nonempty named data streams.
1184 const wimlib_tchar *path_to_file;
1187 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1188 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1189 struct wimlib_progress_info_verify_image {
1190 const wimlib_tchar *wimfile;
1191 uint32_t total_images;
1192 uint32_t current_image;
1195 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1196 struct wimlib_progress_info_verify_streams {
1197 const wimlib_tchar *wimfile;
1198 uint64_t total_streams;
1199 uint64_t total_bytes;
1200 uint64_t completed_streams;
1201 uint64_t completed_bytes;
1204 /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION. */
1205 struct wimlib_progress_info_test_file_exclusion {
1208 * Path to the file for which exclusion is being tested.
1210 * UNIX capture mode: The path will be a standard relative or
1211 * absolute UNIX filesystem path.
1213 * NTFS-3g capture mode: The path will be given relative to the
1214 * root of the NTFS volume, with a leading slash.
1216 * Windows capture mode: The path will be a Win32 namespace
1219 const wimlib_tchar *path;
1222 * Indicates whether the file or directory will be excluded from
1223 * capture or not. This will be <tt>false</tt> by default. The
1224 * progress function can set this to <tt>true</tt> if it decides
1225 * that the file needs to be excluded.
1228 } test_file_exclusion;
1230 /** Valid on messages ::WIMLIB_PROGRESS_MSG_HANDLE_ERROR. */
1231 struct wimlib_progress_info_handle_error {
1233 /** Path to the file for which the error occurred, or NULL if
1235 const wimlib_tchar *path;
1237 /** The wimlib error code associated with the error. */
1241 * Indicates whether the error will be ignored or not. This
1242 * will be <tt>false</tt> by default; the progress function may
1243 * set it to <tt>true</tt>.
1250 * A user-supplied function that will be called periodically during certain WIM
1253 * The first argument will be the type of operation that is being performed or
1254 * is about to be started or has been completed.
1256 * The second argument will be a pointer to one of a number of structures
1257 * depending on the first argument. It may be @c NULL for some message types.
1258 * Note that although this argument is not @c const, users should not modify it
1259 * except in explicitly documented cases.
1261 * The third argument will be a user-supplied value that was provided when
1262 * registering or specifying the progress function.
1264 * This function must return one of the ::wimlib_progress_status values. By
1265 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1267 typedef enum wimlib_progress_status
1268 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1269 union wimlib_progress_info *info,
1273 /** @addtogroup G_modifying_wims
1276 /** An array of these structures is passed to wimlib_add_image_multisource() to
1277 * specify the sources from which to create a WIM image. */
1278 struct wimlib_capture_source {
1279 /** Absolute or relative path to a file or directory on the external
1280 * filesystem to be included in the WIM image. */
1281 wimlib_tchar *fs_source_path;
1283 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1284 * specify the root directory of the WIM image. */
1285 wimlib_tchar *wim_target_path;
1287 /** Reserved; set to 0. */
1291 /** Set or unset the "readonly" WIM header flag (WIM_HDR_FLAG_READONLY in
1292 * Microsoft's documentation), based on the ::wimlib_wim_info.is_marked_readonly
1293 * member of the @p info parameter. This is distinct from basic file
1294 * permissions; this flag can be set on a WIM file that is physically writable.
1296 * wimlib disallows modifying on-disk WIM files with the readonly flag set.
1297 * However, wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG
1298 * will override this --- and in fact, this is necessary to set the readonly
1299 * flag persistently on an existing WIM file.
1301 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1303 /** Set the GUID (globally unique identifier) of the WIM file to the value
1304 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1305 #define WIMLIB_CHANGE_GUID 0x00000002
1307 /** Change the bootable image of the WIM to the value specified in
1308 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1309 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1311 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1312 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
1313 * indicates whether an image in the WIM has been captured with reparse-point
1314 * fixups enabled. wimlib also treats this flag as specifying whether to do
1315 * reparse-point fixups by default when capturing or applying WIM images. */
1316 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1320 /** @addtogroup G_wim_information */
1324 /** General information about a WIM file. */
1325 struct wimlib_wim_info {
1327 /** Globally unique identifier for the WIM file. Note: all parts of a
1328 * split WIM should have an identical value in this field. */
1329 uint8_t guid[WIMLIB_GUID_LEN];
1331 /** Number of images in the WIM. */
1332 uint32_t image_count;
1334 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1336 uint32_t boot_index;
1338 /** Version of the WIM file. */
1339 uint32_t wim_version;
1341 /** Chunk size used for compression. */
1342 uint32_t chunk_size;
1344 /** For split WIMs, the 1-based index of this part within the split WIM;
1346 uint16_t part_number;
1348 /** For split WIMs, the total number of parts in the split WIM;
1350 uint16_t total_parts;
1352 /** One of the ::wimlib_compression_type values that specifies the
1353 * method used to compress resources in the WIM. */
1354 int32_t compression_type;
1356 /** Size of the WIM file in bytes, excluding the XML data and integrity
1358 uint64_t total_bytes;
1360 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1361 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1362 * this will always be 0, even if the ::WIMStruct was written to
1363 * somewhere by calling wimlib_write() with the
1364 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1365 uint32_t has_integrity_table : 1;
1367 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1368 * wimlib_create_new_wim(). */
1369 uint32_t opened_from_file : 1;
1371 /** 1 if the WIM is considered readonly for any reason. */
1372 uint32_t is_readonly : 1;
1374 /** 1 if reparse-point fixups are enabled for one or more images in the
1376 uint32_t has_rpfix : 1;
1378 /** 1 if the WIM is marked read-only. */
1379 uint32_t is_marked_readonly : 1;
1381 /** 1 if the WIM is part of a spanned set. */
1382 uint32_t spanned : 1;
1384 uint32_t write_in_progress : 1;
1385 uint32_t metadata_only : 1;
1386 uint32_t resource_only : 1;
1388 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1389 uint32_t pipable : 1;
1390 uint32_t reserved_flags : 22;
1391 uint32_t reserved[9];
1394 /** Information about a unique stream in the WIM file. (A stream is the same
1395 * thing as a "resource", except in the case of solid resources.) */
1396 struct wimlib_resource_entry {
1397 /** Uncompressed size of the stream in bytes. */
1398 uint64_t uncompressed_size;
1400 /** Compressed size of the stream in bytes. This will be the same as @p
1401 * uncompressed_size if the stream is uncompressed. Or, if @p packed is
1402 * 1, this will be 0. */
1403 uint64_t compressed_size;
1405 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1406 * if @p packed is 1, then this is actually the offset at which this
1407 * stream begins in the uncompressed contents of the solid resource.
1411 /** SHA1 message digest of the stream's uncompressed contents. */
1412 uint8_t sha1_hash[20];
1414 /** Which part of WIM this stream is in. */
1415 uint32_t part_number;
1417 /** Number of times this stream is referenced over all WIM images. */
1418 uint32_t reference_count;
1420 /** 1 if this stream is compressed. */
1421 uint32_t is_compressed : 1;
1423 /** 1 if this stream is a metadata resource rather than a file resource.
1425 uint32_t is_metadata : 1;
1427 uint32_t is_free : 1;
1428 uint32_t is_spanned : 1;
1430 /** 1 if this stream was not found in the lookup table of the
1431 * ::WIMStruct. This normally implies a missing call to
1432 * wimlib_reference_resource_files() or wimlib_reference_resources().
1434 uint32_t is_missing : 1;
1436 /** 1 if this stream is located in a solid resource which may contain
1437 * other streams (all compressed together) as well. */
1438 uint32_t packed : 1;
1440 uint32_t reserved_flags : 26;
1442 /** If @p packed is 1, then this will specify the offset of the solid
1443 * resource in the WIM. */
1444 uint64_t raw_resource_offset_in_wim;
1446 /** If @p packed is 1, then this will specify the compressed size of the
1447 * solid resource in the WIM. */
1448 uint64_t raw_resource_compressed_size;
1450 uint64_t reserved[2];
1454 * Information about a stream of a particular file in the WIM.
1456 * Normally, only WIM images captured from NTFS filesystems will have multiple
1457 * streams per file. In practice, this is a rarely used feature of the
1460 struct wimlib_stream_entry {
1461 /** Name of the stream, or NULL if the stream is unnamed. */
1462 const wimlib_tchar *stream_name;
1463 /** Location, size, and other information about the stream's data as
1464 * stored in the WIM file. */
1465 struct wimlib_resource_entry resource;
1466 uint64_t reserved[4];
1469 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1470 * Roughly, the information about a "file" in the WIM--- but really a directory
1471 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1472 * field can be used to distinguish actual file inodes. */
1473 struct wimlib_dir_entry {
1474 /** Name of the file, or NULL if this file is unnamed. Only the root
1475 * directory of an image will be unnamed. */
1476 const wimlib_tchar *filename;
1478 /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1479 * this file has no such name. */
1480 const wimlib_tchar *dos_name;
1482 /** Full path to this file within the WIM image. Path separators will
1483 * be ::WIMLIB_WIM_PATH_SEPARATOR. */
1484 const wimlib_tchar *full_path;
1486 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1487 * children, ..., etc. */
1490 /** Pointer to the security descriptor for this file, in Windows
1491 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1492 * security descriptor. */
1493 const char *security_descriptor;
1495 /** Length of the above security descriptor. */
1496 size_t security_descriptor_size;
1498 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1499 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1500 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1501 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1502 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1503 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1504 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1505 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1506 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1507 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1508 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1509 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1510 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1511 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1512 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1513 /** File attributes, such as whether the file is a directory or not.
1514 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1515 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1516 * on other platforms. */
1517 uint32_t attributes;
1519 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1520 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1521 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1522 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1523 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1524 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1525 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1526 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1527 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1528 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1529 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1530 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1531 /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1532 * the attributes), this will give the reparse tag. This tells you
1533 * whether the reparse point is a symbolic link, junction point, or some
1534 * other, more unusual kind of reparse point. */
1535 uint32_t reparse_tag;
1537 /** Number of links to this file's inode (hard links).
1539 * Currently, this will always be 1 for directories. However, it can be
1540 * greater than 1 for nondirectory files. */
1543 /** Number of named data streams this file has. Normally 0. */
1544 uint32_t num_named_streams;
1546 /** A unique identifier for this file's inode. However, as a special
1547 * case, if the inode only has a single link (@p num_links == 1), this
1550 * Note: if a WIM image is captured from a filesystem, this value is not
1551 * guaranteed to be the same as the original number of the inode on the
1553 uint64_t hard_link_group_id;
1555 /** Time this file was created. */
1556 struct timespec creation_time;
1558 /** Time this file was last written to. */
1559 struct timespec last_write_time;
1561 /** Time this file was last accessed. */
1562 struct timespec last_access_time;
1564 /** The UNIX user ID of this file. This is a wimlib extension.
1566 * This field is only valid if @p unix_mode != 0. */
1569 /** The UNIX group ID of this file. This is a wimlib extension.
1571 * This field is only valid if @p unix_mode != 0. */
1574 /** The UNIX mode of this file. This is a wimlib extension.
1576 * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1577 * @p unix_rdev are all unknown (fields are not present in the WIM
1581 /** The UNIX device ID (major and minor number) of this file. This is a
1584 * This field is only valid if @p unix_mode != 0. */
1587 uint64_t reserved[14];
1590 * Array of streams that make up this file.
1592 * The first entry will always exist and will correspond to the unnamed
1593 * data stream (default file contents), so it will have <c>stream_name
1594 * == NULL</c>. Alternatively, for reparse point files, the first entry
1595 * will corresponding to the reparse data stream.
1597 * Then, following the first entry, there be @p num_named_streams
1598 * additional entries that specify the named data streams, if any, each
1599 * of which will have <c>stream_name != NULL</c>.
1601 struct wimlib_stream_entry streams[];
1605 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1608 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1612 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1615 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1618 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1619 * just on the specified path. */
1620 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1622 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1623 * itself; only its children (in the case of a non-empty directory) */
1624 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1626 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1627 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1628 * table of the ::WIMStruct. The default behavior without this flag is to fill
1629 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1630 * wimlib_resource_entry::is_missing "is_missing" flag. */
1631 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1635 /** @addtogroup G_modifying_wims
1638 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1639 * generic directory. This requires that wimlib was compiled with support for
1642 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1643 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1645 * Do not use this flag on Windows, where wimlib already supports all
1646 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1647 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1649 /** Follow symbolic links when scanning the directory tree. Currently only
1650 * supported on UNIX-like systems. */
1651 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1653 /** Call the progress function with the message
1654 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1656 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1658 /** Mark the image being added as the bootable image of the WIM. This flag is
1659 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1661 * Note that you can also change the bootable image of a WIM using
1662 * wimlib_set_wim_info().
1664 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1665 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1666 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1668 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1669 * (major and minor number) of each file. Also allows capturing special files
1670 * such as device nodes and FIFOs. See the documentation for the
1671 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1673 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1675 /** Do not capture security descriptors. Only has an effect in NTFS capture
1676 * mode, or in Windows native builds. */
1677 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1679 /** Fail immediately if the full security descriptor of any file or directory
1680 * cannot be accessed. Only has an effect in Windows native builds. The
1681 * default behavior without this flag is to first try omitting the SACL from the
1682 * security descriptor, then to try omitting the security descriptor entirely.
1684 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1686 /** Call the progress function with the message
1687 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1688 * capture. This is a subset of the messages provided by
1689 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1690 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1692 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1693 * case of Windows) that point inside the directory being captured to instead be
1694 * absolute relative to the directory being captured.
1696 * Without this flag, the default is to do reparse-point fixups if
1697 * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image
1698 * being added. WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is
1699 * captured with reparse point fixups enabled and currently cannot be unset. */
1700 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1702 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1703 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1705 /** Do not automatically exclude unsupported files or directories from capture;
1706 * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1707 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1708 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1709 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1712 * Automatically select a capture configuration appropriate for capturing
1713 * filesystems containing Windows operating systems. For example,
1714 * "/pagefile.sys" and "System Volume Information" will be excluded.
1716 * When this flag is specified, the corresponding @p config parameter (for
1717 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1718 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1720 * Note that the default behavior--- that is, when neither
1721 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1722 * config is @c NULL--- is to use no capture configuration, meaning that no
1723 * files are excluded from capture.
1725 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1728 * Capture image as WIMBoot compatible. In addition, if no capture
1729 * configuration file is explicitly specified use the capture configuration file
1730 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1731 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1732 * configuration file is explicitly specified, use it and also place it at
1733 * /Windows/System32/WimBootCompress.ini in the WIM image.
1735 * Note: this will not by itself change the compression type. Before writing
1736 * the WIM file, it's recommended to also do:
1739 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1740 * wimlib_set_output_chunk_size(wim, 4096);
1743 * since that makes access to the data faster (at the cost of a worse
1744 * compression ratio compared to the 32768-byte LZX chunks usually used).
1746 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1747 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1749 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1752 * If the add command involves adding a non-directory file to a location at
1753 * which there already exists a nondirectory file in the WIM image, issue
1754 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1755 * effect when updating an existing image with wimlib_update_image().
1756 * This was the default behavior in wimlib v1.6.2 and earlier.
1758 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1761 * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1764 * Note: This method for file exclusions is independent from the capture
1765 * configuration file mechanism.
1767 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1769 /* Note: the WIMLIB_ADD_IMAGE_FLAG names are retained for source compatibility.
1770 * Use the WIMLIB_ADD_FLAG names in new code. */
1771 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1772 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1773 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1774 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1775 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1776 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1777 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1778 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1779 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1780 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1781 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1782 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1783 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1784 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1788 /** @addtogroup G_modifying_wims
1791 /** Do not issue an error if the path to delete does not exist. */
1792 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1794 /** Delete the file or directory tree recursively; if not specified, an error is
1795 * issued if the path to delete is a directory. */
1796 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1799 /** @addtogroup G_modifying_wims
1803 * If a single image is being exported, mark it bootable in the destination WIM.
1804 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1805 * the image in the source WIM (if any) that is marked as bootable is also
1806 * marked as bootable in the destination WIM.
1808 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1810 /** Give the exported image(s) no names. Avoids problems with image name
1813 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1815 /** Give the exported image(s) no descriptions. */
1816 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1818 /** This advises the library that the program is finished with the source
1819 * WIMStruct and will not attempt to access it after the call to
1820 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1821 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1824 * Mark each exported image as WIMBoot-compatible.
1826 * Note: by itself, this does change the destination WIM's compression type, nor
1827 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1828 * image. Before writing the destination WIM, it's recommended to do something
1832 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1833 * wimlib_set_output_chunk_size(wim, 4096);
1834 * wimlib_add_tree(wim, image, L"myconfig.ini",
1835 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1838 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1841 /** @addtogroup G_extracting_wims
1844 /** Extract the image directly to an NTFS volume rather than a generic directory.
1845 * This mode is only available if wimlib was compiled with libntfs-3g support;
1846 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1847 * extraction target will be interpreted as the path to an NTFS volume image (as
1848 * a regular file or block device) rather than a directory. It will be opened
1849 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1850 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1851 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1852 * wimlib_extract_paths() when passed multiple paths. */
1853 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1855 /** UNIX-like systems only: Extract special UNIX data captured with
1856 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1857 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1858 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1860 /** Do not extract security descriptors. This flag cannot be combined with
1861 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1862 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1864 /** Fail immediately if the full security descriptor of any file or directory
1865 * cannot be set exactly as specified in the WIM file. On Windows, the default
1866 * behavior without this flag when wimlib does not have permission to set the
1867 * correct security descriptor is to fall back to setting the security
1868 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1869 * owner omitted, then not at all. This flag cannot be combined with
1870 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1871 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1873 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1874 * reparse-point fixups on, so absolute symbolic links or junction points will
1875 * be fixed to be absolute relative to the actual extraction root. Reparse-
1876 * point fixups are done by default for wimlib_extract_image() and
1877 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1878 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1879 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1881 /** Force reparse-point fixups on extraction off, regardless of the state of the
1882 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1883 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1884 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1886 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1887 * paths, each of which must name a regular file, to standard output. */
1888 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1890 /** Instead of ignoring files and directories with names that cannot be
1891 * represented on the current platform (note: Windows has more restrictions on
1892 * filenames than POSIX-compliant systems), try to replace characters or append
1893 * junk to the names so that they can be extracted in some form.
1895 * Note: this flag is unlikely to have any effect when extracting a WIM image
1896 * that was captured on Windows.
1898 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1900 /** On Windows, when there exist two or more files with the same case
1901 * insensitive name but different case sensitive names, try to extract them all
1902 * by appending junk to the end of them, rather than arbitrarily extracting only
1905 * Note: this flag is unlikely to have any effect when extracting a WIM image
1906 * that was captured on Windows.
1908 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1910 /** Do not ignore failure to set timestamps on extracted files. This flag
1911 * currently only has an effect when extracting to a directory on UNIX-like
1913 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1915 /** Do not ignore failure to set short names on extracted files. This flag
1916 * currently only has an effect on Windows. */
1917 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1919 /** Do not ignore failure to extract symbolic links and junctions due to
1920 * permissions problems. This flag currently only has an effect on Windows. By
1921 * default, such failures are ignored since the default configuration of Windows
1922 * only allows the Administrator to create symbolic links. */
1923 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1925 /** Reserved for future use. */
1926 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1928 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1929 * paths to extract as wildcard patterns ("globs") which may contain the
1930 * wildcard characters @c ? and @c *. The @c ? character matches any
1931 * non-path-separator character, whereas the @c * character matches zero or more
1932 * non-path-separator characters. Consequently, each glob may match zero or
1933 * more actual paths in the WIM image.
1935 * By default, if a glob does not match any files, a warning but not an error
1936 * will be issued. This is the case even if the glob did not actually contain
1937 * wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1940 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1942 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1943 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1944 * one of the provided globs did not match a file. */
1945 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1947 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1949 * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1951 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1953 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1954 * preserve the directory structure of the archive when extracting --- that is,
1955 * place each extracted file or directory tree directly in the target directory.
1957 * The target directory will still be created if it does not already exist. */
1958 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1960 /** Windows only: Extract files as "pointers" back to the WIM archive.
1962 * The effects of this option are fairly complex. See the documentation for the
1963 * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1965 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1968 /** @addtogroup G_mounting_wim_images
1971 /** Mount the WIM image read-write rather than the default of read-only. */
1972 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1974 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main(). */
1975 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1977 /** Do not allow accessing named data streams in the mounted WIM image. */
1978 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1980 /** Access named data streams in the mounted WIM image through extended file
1981 * attributes named "user.X", where X is the name of a data stream. This is the
1983 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1985 /** Access named data streams in the mounted WIM image by specifying the file
1986 * name, a colon, then the name of the data stream. */
1987 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1989 /** Use UNIX metadata if available in the WIM image. See
1990 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1991 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1993 /** Allow other users to see the mounted filesystem. This passes the @c
1994 * allow_other option to fuse_main(). */
1995 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1998 /** @addtogroup G_creating_and_opening_wims
2001 /** Verify the WIM contents against the WIM's integrity table, if present. This
2002 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
2003 * checksummed and checked against the SHA1 message digests specified in the
2004 * integrity table. If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
2005 * issued. If the WIM file does not contain an integrity table, this flag has
2007 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
2009 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
2010 * WIM. Software can provide this flag for convenience if it explicitly does
2011 * not want to support split WIMs. */
2012 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
2014 /** Check if the WIM is writable and issue an error
2015 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
2016 * only if it is writable at the filesystem level, does not have the
2017 * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
2018 * set. It is not required to provide this flag before attempting to make
2019 * changes to the WIM, but with this flag you get an error immediately rather
2020 * than potentially much later, when wimlib_overwrite() is finally called. */
2021 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
2024 /** @addtogroup G_mounting_wim_images
2027 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
2028 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2029 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
2031 /** Commit changes to the read-write mounted WIM image.
2032 * If this flag is not specified, changes will be discarded. */
2033 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
2035 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
2036 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2037 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
2039 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2040 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2041 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
2044 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2045 * image, forces all file descriptors to the open WIM image to be closed before
2048 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2049 * this flag has no effect.
2051 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
2053 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2054 * WIM image, causes the modified image to be committed to the WIM file as a
2055 * new, unnamed image appended to the archive. The original image in the WIM
2056 * file will be unmodified. */
2057 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
2060 /** @addtogroup G_modifying_wims
2063 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2064 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
2065 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
2068 /** @addtogroup G_writing_and_overwriting_wims
2072 * Include an integrity table in the resulting WIM file.
2074 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2075 * include an integrity table if and only if one was present before. For
2076 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2077 * to not include an integrity table.
2079 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
2082 * Do not include an integrity table in the resulting WIM file. This is the
2083 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2086 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
2089 * Write the WIM as "pipable". After writing a WIM with this flag specified,
2090 * images from it can be applied directly from a pipe using
2091 * wimlib_extract_image_from_pipe(). See the documentation for the
2092 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2093 * Beware: WIMs written with this flag will not be compatible with Microsoft's
2096 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2097 * write the WIM as pipable if and only if it was pipable before. For
2098 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2099 * to write the WIM as non-pipable.
2101 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
2104 * Do not write the WIM as "pipable". This is the default behavior, unless the
2105 * ::WIMStruct was created by opening a pipable WIM.
2107 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
2110 * When writing streams to the WIM file, recompress them, even if their data is
2111 * already available in the desired compressed form (for example, in a WIM file
2112 * from which an image has been exported using wimlib_export_image()).
2114 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2115 * compression ratio for the same compression type and chunk size. Simply using
2116 * the default compression settings may suffice for this, especially if the WIM
2117 * file was created using another program/library that may not use as
2118 * sophisticated compression algorithms. Or,
2119 * wimlib_set_default_compression_level() can be called beforehand to set an
2120 * even higher compression level than the default.
2122 * If the WIM contains solid resources, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can
2123 * be used in combination with ::WIMLIB_WRITE_FLAG_SOLID to prevent any solid
2124 * resources from being re-used. Otherwise, solid resources are re-used
2125 * somewhat more liberally than normal compressed resources.
2127 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
2128 * that would not otherwise be written. For example, a call to
2129 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2130 * cause already-existing streams in the WIM file to be recompressed. To force
2131 * the WIM file to be fully rebuilt and recompressed, combine
2132 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2134 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
2137 * Immediately before closing the WIM file, sync its data to disk.
2139 * This flag forces the function to wait until the data is safely on disk before
2140 * returning success. Otherwise, modern operating systems tend to cache data
2141 * for some time (in some cases, 30+ seconds) before actually writing it to
2142 * disk, even after reporting to the application that the writes have succeeded.
2144 * wimlib_overwrite() will set this flag automatically if it decides to
2145 * overwrite the WIM file via a temporary file instead of in-place. This is
2146 * necessary on POSIX systems; it will, for example, avoid problems with delayed
2147 * allocation on ext4.
2149 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
2152 * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
2153 * could be updated in-place by appending to it.
2155 * When rebuilding the WIM file, stream reference counts will be recomputed, and
2156 * any streams with 0 reference count (e.g. from deleted files or images) will
2157 * not be included in the resulting WIM file. This can free up space that is
2158 * currently not being used.
2160 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2161 * data to be recompressed. Otherwise, compressed data is re-used if possible.
2163 * wimlib_write() ignores this flag.
2165 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
2168 * For wimlib_overwrite(), override the default behavior after one or more calls
2169 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
2170 * flag, only minimal changes to correctly remove the image from the WIM file
2171 * will be taken. In particular, all streams will be retained, even if they are
2172 * no longer referenced. This may not be what you want, because no space will
2173 * be saved by deleting an image in this way.
2175 * wimlib_write() ignores this flag.
2177 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
2180 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2181 * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header. This can be used
2182 * following a call to wimlib_set_wim_info() with the
2183 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2186 * wimlib_write() ignores this flag.
2188 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
2191 * Do not include streams already present in other WIMs. This flag can be used
2192 * to write a "delta" WIM after resources from the WIM on which the delta is to
2193 * be based were referenced with wimlib_reference_resource_files() or
2194 * wimlib_reference_resources().
2196 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
2199 * Advises the library that for writes of all WIM images, all streams needed for
2200 * the WIM are already present (not in external resource WIMs) and their
2201 * reference counts are correct, so the code does not need to recalculate which
2202 * streams are referenced. This is for optimization purposes only, since with
2203 * this flag specified, the metadata resources may not need to be decompressed
2206 * wimlib_overwrite() will set this flag automatically.
2208 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
2211 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2213 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2216 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
2219 * When writing streams in the resulting WIM file, combine multiple streams into
2220 * a single compressed resource instead of compressing them independently. This
2221 * is also known as creating a "solid archive". This tends to produce a better
2222 * compression ratio at the cost of much slower random access.
2224 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2225 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2226 * created with this flag use a different version number in their header (3584
2227 * instead of 68864) and are also called "ESD files".
2229 * If this flag is passed to wimlib_overwrite(), any new data streams will be
2230 * written in solid mode. Use both ::WIMLIB_WRITE_FLAG_REBUILD and
2231 * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
2232 * all streams recompressed in solid mode.
2234 * Currently, new solid resources will, by default, be written using LZMS
2235 * compression with 32 MiB (33554432 byte) chunks. Use
2236 * wimlib_set_output_pack_compression_type() and/or
2237 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2238 * the WIM's main compression type and chunk size; you can have a WIM that
2239 * nominally uses LZX compression and 32768 byte chunks but actually contains
2240 * LZMS-compressed solid resources, for example. However, if including solid
2241 * blocks, I suggest that you set the WIM's main compression type to LZMS as
2242 * well, either by creating the WIM with
2243 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2244 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2246 * This flag will be set by default when writing or overwriting a WIM file that
2247 * either already contains solid resources, or has had solid resources exported
2248 * into it and the WIM's main compression type is LZMS.
2250 #define WIMLIB_WRITE_FLAG_SOLID 0x00001000
2253 * Deprecated: this is the old name for ::WIMLIB_WRITE_FLAG_SOLID, retained for
2254 * source compatibility.
2256 #define WIMLIB_WRITE_FLAG_PACK_STREAMS WIMLIB_WRITE_FLAG_SOLID
2259 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2260 * file. This is only needed in the unusual case that the library user needs to
2261 * know exactly when wimlib has read each file for the last time.
2263 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2266 * If using solid compression, do not sort the streams ("files") to compress by
2267 * estimated content similarily. This flag only has an effect if
2268 * ::WIMLIB_WRITE_FLAG_SOLID is also specified.
2270 #define WIMLIB_WRITE_FLAG_NO_SOLID_SORT 0x00004000
2273 /** @addtogroup G_general
2276 /** Assume that strings are represented in UTF-8, even if this is not the
2277 * locale's character encoding. This flag is ignored on Windows, where wimlib
2278 * always uses UTF-16LE. */
2279 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2281 /** Windows-only: do not attempt to acquire additional privileges (currently
2282 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2283 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
2284 * for the case where the calling program manages these privileges itself.
2285 * Note: no error is issued if privileges cannot be acquired, although related
2286 * errors may be reported later, depending on if the operations performed
2287 * actually require additional privileges or not. */
2288 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2290 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2291 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2292 * to read all possible data and metadata for a capture operation could not be
2293 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2295 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2297 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2298 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2299 * to restore all possible data and metadata for an apply operation could not be
2300 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2302 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2304 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2306 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2308 /** Default to interpreting WIM paths case insensitively (default on Windows).
2309 * This does not apply to mounted images. */
2310 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2313 /** @addtogroup G_nonstandalone_wims
2316 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2317 * Ignored by wimlib_reference_resources(). */
2318 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2320 /** For wimlib_reference_resource_files(), issue an error
2321 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2322 * default behavior without this flag is to issue no error at that point, but
2323 * then attempt to open the glob as a literal path, which of course will fail
2324 * anyway if no file exists at that path. No effect if
2325 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2326 * wimlib_reference_resources(). */
2327 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2330 /** @addtogroup G_modifying_wims
2333 /** The specific type of update to perform. */
2334 enum wimlib_update_op {
2335 /** Add a new file or directory tree to the WIM image in a
2336 * certain location. */
2337 WIMLIB_UPDATE_OP_ADD = 0,
2339 /** Delete a file or directory tree from the WIM image. */
2340 WIMLIB_UPDATE_OP_DELETE,
2342 /** Rename a file or directory tree in the WIM image. */
2343 WIMLIB_UPDATE_OP_RENAME,
2346 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2347 struct wimlib_add_command {
2348 /** Filesystem path to the file or directory tree to add. */
2349 wimlib_tchar *fs_source_path;
2351 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2352 * specify the root directory of the WIM image. */
2353 wimlib_tchar *wim_target_path;
2355 /** Path to capture configuration file to use, or @c NULL for default.
2357 wimlib_tchar *config_file;
2359 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2363 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2364 struct wimlib_delete_command {
2366 /** Path, specified from the root of the WIM image, for the file or
2367 * directory tree within the WIM image to be deleted. */
2368 wimlib_tchar *wim_path;
2370 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2374 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2375 struct wimlib_rename_command {
2377 /** Path, specified from the root of the WIM image, for the source file
2378 * or directory tree within the WIM image. */
2379 wimlib_tchar *wim_source_path;
2381 /** Path, specified from the root of the WIM image, for the destination
2382 * file or directory tree within the WIM image. */
2383 wimlib_tchar *wim_target_path;
2385 /** Reserved; set to 0. */
2389 /** Specification of an update to perform on a WIM image. */
2390 struct wimlib_update_command {
2392 enum wimlib_update_op op;
2395 struct wimlib_add_command add;
2396 struct wimlib_delete_command delete_; /* Underscore is for C++
2398 struct wimlib_rename_command rename;
2403 /** @addtogroup G_general
2407 * Possible values of the error code returned by many functions in wimlib.
2409 * See the documentation for each wimlib function to see specifically what error
2410 * codes can be returned by a given function, and what they mean.
2412 enum wimlib_error_code {
2413 WIMLIB_ERR_SUCCESS = 0,
2414 WIMLIB_ERR_ALREADY_LOCKED = 1,
2415 WIMLIB_ERR_DECOMPRESSION = 2,
2416 WIMLIB_ERR_FUSE = 6,
2417 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2418 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2419 WIMLIB_ERR_IMAGE_COUNT = 10,
2420 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2421 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2422 WIMLIB_ERR_INTEGRITY = 13,
2423 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2424 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2425 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2426 WIMLIB_ERR_INVALID_HEADER = 17,
2427 WIMLIB_ERR_INVALID_IMAGE = 18,
2428 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2429 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2430 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2431 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2432 WIMLIB_ERR_INVALID_OVERLAY = 23,
2433 WIMLIB_ERR_INVALID_PARAM = 24,
2434 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2435 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2436 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2437 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2438 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2439 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2440 WIMLIB_ERR_IS_DIRECTORY = 32,
2441 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2442 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2443 WIMLIB_ERR_LINK = 35,
2444 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2445 WIMLIB_ERR_MKDIR = 37,
2446 WIMLIB_ERR_MQUEUE = 38,
2447 WIMLIB_ERR_NOMEM = 39,
2448 WIMLIB_ERR_NOTDIR = 40,
2449 WIMLIB_ERR_NOTEMPTY = 41,
2450 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2451 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2452 WIMLIB_ERR_NOT_PIPABLE = 44,
2453 WIMLIB_ERR_NO_FILENAME = 45,
2454 WIMLIB_ERR_NTFS_3G = 46,
2455 WIMLIB_ERR_OPEN = 47,
2456 WIMLIB_ERR_OPENDIR = 48,
2457 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2458 WIMLIB_ERR_READ = 50,
2459 WIMLIB_ERR_READLINK = 51,
2460 WIMLIB_ERR_RENAME = 52,
2461 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2462 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2463 WIMLIB_ERR_RESOURCE_ORDER = 56,
2464 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2465 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2466 WIMLIB_ERR_SET_SECURITY = 59,
2467 WIMLIB_ERR_SET_SHORT_NAME = 60,
2468 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2469 WIMLIB_ERR_SPLIT_INVALID = 62,
2470 WIMLIB_ERR_STAT = 63,
2471 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2472 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2473 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2474 WIMLIB_ERR_UNSUPPORTED = 68,
2475 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2476 WIMLIB_ERR_WIM_IS_READONLY = 71,
2477 WIMLIB_ERR_WRITE = 72,
2478 WIMLIB_ERR_XML = 73,
2479 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2480 WIMLIB_ERR_WIMBOOT = 75,
2481 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2482 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2483 WIMLIB_ERR_MKNOD = 78,
2484 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2485 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2486 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2487 WIMLIB_ERR_FVE_LOCKED_VOLUME = 82,
2491 /** Used to indicate no WIM image or an invalid WIM image. */
2492 #define WIMLIB_NO_IMAGE 0
2494 /** Used to specify all images in the WIM. */
2495 #define WIMLIB_ALL_IMAGES (-1)
2500 * @ingroup G_modifying_wims
2502 * Appends an empty image to a WIM file. This empty image will initially
2503 * contain no files or directories, although if written without further
2504 * modifications, a root directory will be created automatically for it. After
2505 * calling this function, you can use wimlib_update_image() to add files to the
2506 * new WIM image. This gives you slightly more control over making the new
2507 * image compared to calling wimlib_add_image() or
2508 * wimlib_add_image_multisource() directly.
2511 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
2514 * Name to give the new image. If @c NULL or empty, the new image is given
2515 * no name. If nonempty, it must specify a name that does not already
2517 * @param new_idx_ret
2518 * If non-<code>NULL</code>, the index of the newly added image is returned
2521 * @return 0 on success; nonzero on failure. The possible error codes are:
2523 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2524 * There is already an image in @p wim named @p name.
2525 * @retval ::WIMLIB_ERR_NOMEM
2526 * Failed to allocate the memory needed to add the new image.
2529 wimlib_add_empty_image(WIMStruct *wim,
2530 const wimlib_tchar *name,
2534 * @ingroup G_modifying_wims
2536 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2538 * The directory tree or NTFS volume is scanned immediately to load the dentry
2539 * tree into memory, and file attributes and symbolic links are read. However,
2540 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2543 * See the manual page for the @b wimlib-imagex program for more information
2544 * about the "normal" capture mode versus the NTFS capture mode (entered by
2545 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2547 * Note that @b no changes are committed to the underlying WIM file (if
2548 * any) until wimlib_write() or wimlib_overwrite() is called.
2551 * Pointer to the ::WIMStruct to which to add the image.
2553 * A path to a directory or unmounted NTFS volume that will be captured as
2556 * Name to give the new image. If @c NULL or empty, the new image is given
2557 * no name. If nonempty, it must specify a name that does not already
2559 * @param config_file
2560 * Path to capture configuration file, or @c NULL. This file may specify,
2561 * among other things, which files to exclude from capture. See the man
2562 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2563 * details of the file format. If @c NULL, the default capture
2564 * configuration shall be used. Ordinarily, the default capture
2565 * configuration will result in no files being excluded from capture purely
2566 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2567 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2569 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2571 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2572 * discarded so that it appears to be in the same state as when this function
2575 * This function is implemented by calling wimlib_add_empty_image(), then
2576 * calling wimlib_update_image() with a single "add" command, so any error code
2577 * returned by wimlib_add_empty_image() may be returned, as well as any error
2578 * codes returned by wimlib_update_image() other than ones documented as only
2579 * being returned specifically by an update involving delete or rename commands.
2581 * If a progress function is registered with @p wim, it will receive the
2582 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2583 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2584 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2587 wimlib_add_image(WIMStruct *wim,
2588 const wimlib_tchar *source,
2589 const wimlib_tchar *name,
2590 const wimlib_tchar *config_file,
2594 * @ingroup G_modifying_wims
2596 * This function is equivalent to wimlib_add_image() except it allows for
2597 * multiple sources to be combined into a single WIM image. This is done by
2598 * specifying the @p sources and @p num_sources parameters instead of the @p
2599 * source parameter of wimlib_add_image(). The rest of the parameters are the
2600 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2601 * capture</b> for full details on how this mode works.
2603 * In addition to the error codes that wimlib_add_image() can return,
2604 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2605 * when trying to overlay a non-directory on a directory or when otherwise
2606 * trying to overlay multiple conflicting files to the same location in the WIM
2607 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2608 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2609 * was not exactly one capture source with the target being the root directory.
2610 * (In this respect, there is no advantage to using
2611 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2614 wimlib_add_image_multisource(WIMStruct *wim,
2615 const struct wimlib_capture_source *sources,
2617 const wimlib_tchar *name,
2618 const wimlib_tchar *config_file,
2622 * @ingroup G_modifying_wims
2624 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2625 * location @p wim_target_path within the specified @p image of the @p wim.
2627 * This just builds an appropriate ::wimlib_add_command and passes it to
2628 * wimlib_update_image().
2631 wimlib_add_tree(WIMStruct *wim, int image,
2632 const wimlib_tchar *fs_source_path,
2633 const wimlib_tchar *wim_target_path, int add_flags);
2636 * @ingroup G_creating_and_opening_wims
2638 * Creates a ::WIMStruct for a new WIM file.
2640 * This only creates an in-memory structure for a WIM that initially contains no
2641 * images. No on-disk file is created until wimlib_write() is called.
2644 * The type of compression to be used in the new WIM file, as one of the
2645 * ::wimlib_compression_type constants.
2647 * This choice is not necessarily final; if desired, it can still be
2648 * changed at any time before the WIM is written to disk, using
2649 * wimlib_set_output_compression_type(). In addition, if you wish to use a
2650 * non-default chunk size, you will need to call
2651 * wimlib_set_output_chunk_size().
2653 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2654 * written to the memory location pointed to by this parameter. The
2655 * ::WIMStruct must be freed using using wimlib_free() when finished with
2657 * @return 0 on success; nonzero on error.
2658 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2659 * @p ctype was not a supported compression type.
2660 * @retval ::WIMLIB_ERR_NOMEM
2661 * Failed to allocate needed memory.
2664 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2667 * @ingroup G_modifying_wims
2669 * Deletes an image, or all images, from a WIM file.
2671 * Note: no changes are committed to the underlying WIM file (if any) until
2672 * wimlib_write() or wimlib_overwrite() is called.
2675 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2678 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2681 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2682 * to be left unmodified only if @p image specified a single image. If instead
2683 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2684 * possible for some but not all of the images to have been deleted when a
2685 * failure status is returned.
2687 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2688 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2690 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2691 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2692 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2693 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2694 * different reasons) to read the metadata resource for an image that needed to
2698 wimlib_delete_image(WIMStruct *wim, int image);
2701 * @ingroup G_modifying_wims
2703 * Delete the @p path from the specified @p image of the @p wim.
2705 * This just builds an appropriate ::wimlib_delete_command and passes it to
2706 * wimlib_update_image().
2709 wimlib_delete_path(WIMStruct *wim, int image,
2710 const wimlib_tchar *path, int delete_flags);
2713 * @ingroup G_modifying_wims
2715 * Exports an image, or all the images, from a WIM file, into another WIM file.
2717 * The destination image is made to share the same dentry tree and security data
2718 * structure as the source image. This places some restrictions on additional
2719 * functions that may be called. For example, you may not call wimlib_free() on
2720 * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2721 * because @p dest_wim will have references back to @p src_wim.
2723 * If this function fails, all changes to @p dest_wim are rolled back.
2725 * Please note that no changes are committed to the underlying WIM file of @p
2726 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2729 * The WIM from which to export the images, specified as a pointer to the
2730 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2731 * split WIM. In the case of a WIM file that is not standalone, this
2732 * ::WIMStruct must have had any needed external resources previously
2733 * referenced using wimlib_reference_resources() or
2734 * wimlib_reference_resource_files().
2736 * The image to export from @p src_wim, as either a 1-based image index to
2737 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2739 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2742 * For single-image exports, the name to give the exported image in @p
2743 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2744 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2745 * that case, the names are all taken from @p src_wim. This parameter is
2746 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2747 * @param dest_description
2748 * For single-image exports, the description to give the exported image in
2749 * the new WIM file. If left @c NULL, the description from @p src_wim is
2750 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2751 * NULL; in that case, the description are all taken from @p src_wim. This
2752 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2753 * @param export_flags
2754 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2756 * @return 0 on success; nonzero on error.
2757 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2758 * One or more of the names being given to an exported image was already in
2759 * use in the destination WIM.
2760 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2761 * @p src_image does not exist in @p src_wim and was not
2762 * ::WIMLIB_ALL_IMAGES.
2763 * @retval ::WIMLIB_ERR_INVALID_PARAM
2764 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2765 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2767 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2768 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2769 * example, one of them was a non-first part of a split WIM.
2770 * @retval ::WIMLIB_ERR_NOMEM
2771 * Failed to allocate needed memory.
2772 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2773 * A resource that needed to be exported could not be found in either the
2774 * source or destination WIMs. This error can occur if, for example, @p
2775 * src_wim is part of a split WIM but needed resources from the other split
2776 * WIM parts were not referenced with wimlib_reference_resources() or
2777 * wimlib_reference_resource_files() before the call to
2778 * wimlib_export_image().
2780 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2781 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2782 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2783 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2784 * different reasons) to read the metadata resource for an image in @p src_wim
2785 * that needed to be exported.
2788 wimlib_export_image(WIMStruct *src_wim, int src_image,
2789 WIMStruct *dest_wim,
2790 const wimlib_tchar *dest_name,
2791 const wimlib_tchar *dest_description,
2795 * @ingroup G_extracting_wims
2797 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2800 * The exact behavior of how wimlib extracts files from a WIM image is
2801 * controllable by the @p extract_flags parameter, but there also are
2802 * differences depending on the platform (UNIX-like vs Windows). See the manual
2803 * page for <b>wimlib-imagex apply</b> for more information, including about the
2804 * NTFS-3g extraction mode.
2807 * The WIM from which to extract the image(s), specified as a pointer to
2808 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2809 * of a split WIM. In the case of a WIM file that is not standalone, this
2810 * ::WIMStruct must have had any needed external resources previously
2811 * referenced using wimlib_reference_resources() or
2812 * wimlib_reference_resource_files().
2814 * The image to extract, specified as either the 1-based index of a single
2815 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2816 * to be extracted. However, ::WIMLIB_ALL_IMAGES cannot be used if
2817 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2819 * Directory to extract the WIM image(s) to; or, with
2820 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2821 * the unmounted NTFS volume to which to extract the image.
2822 * @param extract_flags
2823 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2825 * @return 0 on success; nonzero on error.
2826 * @retval ::WIMLIB_ERR_DECOMPRESSION
2827 * Failed to decompress data contained in the WIM.
2828 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2829 * The metadata for one of the images to extract was invalid.
2830 * @retval ::WIMLIB_ERR_INVALID_PARAM
2831 * The extraction flags were invalid; more details may be found in the
2832 * documentation for the specific extraction flags that were specified. Or
2833 * @p target was @c NULL or an empty string, or @p wim was @c NULL.
2834 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2835 * The SHA1 message digest of an extracted stream did not match the SHA1
2836 * message digest given in the WIM. In other words, the WIM file is
2837 * corrupted, so the data cannot be extracted in its original form.
2838 * @retval ::WIMLIB_ERR_LINK
2839 * Failed to create a symbolic link or a hard link.
2840 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2841 * The metadata resource for one of the images to extract was not found.
2842 * This can happen if @p wim represents a non-first part of a split WIM.
2843 * @retval ::WIMLIB_ERR_MKDIR
2844 * Failed create a directory.
2845 * @retval ::WIMLIB_ERR_NOMEM
2846 * Failed to allocate needed memory.
2847 * @retval ::WIMLIB_ERR_OPEN
2848 * Could not create a file, or failed to open an already-extracted file.
2849 * @retval ::WIMLIB_ERR_READ
2850 * Failed to read data from the WIM.
2851 * @retval ::WIMLIB_ERR_READLINK
2852 * Failed to determine the target of a symbolic link in the WIM.
2853 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2854 * Failed to fix the target of an absolute symbolic link (e.g. if the
2855 * target would have exceeded the maximum allowed length). (Only if
2856 * reparse data was supported by the extraction mode and
2857 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2859 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2860 * One of the files or directories that needed to be extracted referenced a
2861 * stream not present in the WIM's lookup table (or in any of the lookup
2862 * tables of the split WIM parts). This can happen if the WIM is not
2863 * standalone and the necessary resource WIMs, or split WIM parts, were not
2864 * referenced with wimlib_reference_resource_files().
2865 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2866 * Failed to set attributes on a file.
2867 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2868 * Failed to set reparse data on a file (only if reparse data was supported
2869 * by the extraction mode).
2870 * @retval ::WIMLIB_ERR_SET_SECURITY
2871 * Failed to set security descriptor on a file.
2872 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2873 * Failed to set the short name of a file.
2874 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2875 * Failed to set timestamps on a file.
2876 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2877 * Unexpected end-of-file occurred when reading data from the WIM.
2878 * @retval ::WIMLIB_ERR_UNSUPPORTED
2879 * A requested extraction flag, or the data or metadata that must be
2880 * extracted to support it, is unsupported in the build and configuration
2881 * of wimlib, or on the current platform or extraction mode or target
2882 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2883 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2884 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2885 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2886 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2887 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2888 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2889 * image contains one or more files with short names, but extracting short
2890 * names is not supported --- on Windows, this occurs if the target volume
2891 * does not support short names, while on non-Windows, this occurs if
2892 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2893 * @retval ::WIMLIB_ERR_WIMBOOT
2894 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2895 * there was a problem creating WIMBoot pointer files.
2896 * @retval ::WIMLIB_ERR_WRITE
2897 * Failed to write data to a file being extracted.
2899 * If a progress function is registered with @p wim, then as each image is
2900 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2901 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2902 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2903 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2904 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2907 wimlib_extract_image(WIMStruct *wim, int image,
2908 const wimlib_tchar *target, int extract_flags);
2911 * @ingroup G_extracting_wims
2913 * Extract one image from a pipe on which a pipable WIM is being sent.
2915 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2916 * subsec_pipable_wims, for more information about pipable WIMs.
2918 * This function operates in a special way to read the WIM fully sequentially.
2919 * As a result, there is no ::WIMStruct is made visible to library users, and
2920 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2921 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2922 * seekable file, not a pipe.)
2925 * File descriptor, which may be a pipe, opened for reading and positioned
2926 * at the start of the pipable WIM.
2927 * @param image_num_or_name
2928 * String that specifies the 1-based index or name of the image to extract.
2929 * It is translated to an image index using the same rules that
2930 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2931 * only a single image (not all images) can be specified. Alternatively,
2932 * specify @p NULL here to use the first image in the WIM if it contains
2933 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2935 * Same as the corresponding parameter to wimlib_extract_image().
2936 * @param extract_flags
2937 * Same as the corresponding parameter to wimlib_extract_image().
2939 * @return 0 on success; nonzero on error. The possible error codes include
2940 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2943 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2944 * Data read from the pipable WIM was invalid.
2945 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2946 * The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2949 wimlib_extract_image_from_pipe(int pipe_fd,
2950 const wimlib_tchar *image_num_or_name,
2951 const wimlib_tchar *target, int extract_flags);
2954 * @ingroup G_extracting_wims
2956 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2957 * function. The progress function will be used while extracting the WIM image
2958 * and will receive the normal extraction progress messages, such as
2959 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2960 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2963 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2964 const wimlib_tchar *image_num_or_name,
2965 const wimlib_tchar *target,
2967 wimlib_progress_func_t progfunc,
2971 * @ingroup G_extracting_wims
2973 * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2974 * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2975 * path_list_file which itself contains the list of paths to use, one per line.
2976 * Leading and trailing whitespace is ignored. Empty lines and lines beginning
2977 * with the ';' or '#' characters are ignored. No quotes are needed, as paths
2978 * are otherwise delimited by the newline character. However, quotes will be
2979 * stripped if present.
2981 * The error codes are the same as those returned by wimlib_extract_paths(),
2982 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2983 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2984 * ::WIMLIB_ERR_READ).
2987 wimlib_extract_pathlist(WIMStruct *wim, int image,
2988 const wimlib_tchar *target,
2989 const wimlib_tchar *path_list_file,
2993 * @ingroup G_extracting_wims
2995 * Extract zero or more paths (files or directory trees) from the specified WIM
2998 * By default, each path will be extracted to a corresponding subdirectory of
2999 * the target based on its location in the WIM image. For example, if one of
3000 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
3001 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
3002 * can be changed by providing the flag
3003 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
3004 * or directory tree to be placed directly in the target directory --- so the
3005 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
3007 * Symbolic links will not be dereferenced when paths in the WIM image are
3011 * WIM from which to extract the paths, specified as a pointer to the
3012 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
3013 * split WIM. In the case of a WIM file that is not standalone, this
3014 * ::WIMStruct must have had any needed external resources previously
3015 * referenced using wimlib_reference_resources() or
3016 * wimlib_reference_resource_files().
3018 * 1-based index of the WIM image from which to extract the paths.
3020 * Array of paths to extract. Each element must be the absolute path to a
3021 * file or directory within the WIM image. Separators may be either
3022 * forwards or backwards slashes, and leading path separators are optional.
3023 * The paths will be interpreted either case-sensitively (UNIX default) or
3024 * case-insensitively (Windows default); however, the behavior can be
3025 * configured explicitly at library initialization time by passing an
3026 * appropriate flag to wimlib_global_init().
3028 * By default, the characters @c * and @c ? are interpreted literally.
3029 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
3032 * By default, if any paths to extract do not exist, the error code
3033 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
3034 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
3036 * Number of paths specified in @p paths.
3038 * Directory to which to extract the paths; or with
3039 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
3040 * unmounted NTFS volume to which to extract the paths. Unlike the @p
3041 * paths being extracted, the @p target must be native path. On UNIX-like
3042 * systems it may not contain backslashes, for example.
3043 * @param extract_flags
3044 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3046 * @return 0 on success; nonzero on error. Most of the error codes are the same
3047 * as those returned by wimlib_extract_image(). Below, some of the error codes
3048 * returned in situations specific to path-mode extraction are documented:
3050 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3051 * One of the paths to extract did not exist in the WIM image. This error
3052 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
3053 * specified in @p extract_flags, or if both
3054 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
3055 * were specified in @p extract_flags.
3056 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3057 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3058 * one of the paths to extract did not name a regular file.
3060 * If a progress function is registered with @p wim, it will receive
3061 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. Note that because the extraction code
3062 * is stream-based and not file-based, there is no way to get information about
3063 * which path is currently being extracted, but based on byte count you can
3064 * still calculate an approximate percentage complete for the extraction overall
3065 * which may be all you really need anyway.
3068 wimlib_extract_paths(WIMStruct *wim,
3070 const wimlib_tchar *target,
3071 const wimlib_tchar * const *paths,
3076 * @ingroup G_wim_information
3078 * Extracts the XML data of a WIM file to a file stream. Every WIM file
3079 * includes a string of XML that describes the images contained in the WIM.
3081 * See wimlib_get_xml_data() to read the XML data into memory instead.
3084 * Pointer to the ::WIMStruct to query. This need not represent a
3085 * standalone WIM (e.g. it could represent part of a split WIM).
3087 * @c stdout, or a FILE* opened for writing, to extract the data to.
3089 * @return 0 on success; nonzero on error.
3090 * @retval ::WIMLIB_ERR_INVALID_PARAM
3091 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
3092 * @retval ::WIMLIB_ERR_NOMEM
3093 * Failed to allocate needed memory.
3094 * @retval ::WIMLIB_ERR_READ
3095 * Error reading the XML data from the WIM file.
3096 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3097 * Error reading the XML data from the WIM file.
3098 * @retval ::WIMLIB_ERR_WRITE
3099 * Failed to completely write the XML data to @p fp.
3102 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3105 * @ingroup G_general
3107 * Frees all memory allocated for a WIMStruct and closes all files associated
3111 * Pointer to the ::WIMStruct to free.
3113 * @return This function has no return value.
3116 wimlib_free(WIMStruct *wim);
3119 * @ingroup G_general
3121 * Converts a ::wimlib_compression_type value into a string.
3124 * The ::wimlib_compression_type value to convert.
3127 * A statically allocated string naming the compression algorithm,
3128 * such as "None", "LZX", "XPRESS", or "Invalid".
3130 extern const wimlib_tchar *
3131 wimlib_get_compression_type_string(int ctype);
3134 * @ingroup G_general
3136 * Converts an error code into a string describing it.
3139 * The error code returned by one of wimlib's functions.
3142 * Pointer to a statically allocated string describing the error code. If
3143 * the error code is for some reason not recognized by the library, the
3144 * string will be "Unknown error".
3146 extern const wimlib_tchar *
3147 wimlib_get_error_string(enum wimlib_error_code code);
3150 * @ingroup G_wim_information
3152 * Returns the description of the specified image.
3155 * Pointer to the ::WIMStruct to query. This need not represent a
3156 * standalone WIM (e.g. it could represent part of a split WIM).
3158 * The number of the image, numbered starting at 1.
3161 * The description of the image, or @c NULL if there is no such image, or
3162 * @c NULL if the specified image has no description. The description
3163 * string is in library-internal memory and may not be modified or freed;
3164 * in addition, the string will become invalid if the description of the
3165 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
3167 extern const wimlib_tchar *
3168 wimlib_get_image_description(const WIMStruct *wim, int image);
3171 * @ingroup G_wim_information
3173 * Returns the name of the specified image.
3176 * Pointer to the ::WIMStruct to query. This need not represent a
3177 * standalone WIM (e.g. it could represent part of a split WIM).
3179 * The number of the image, numbered starting at 1.
3182 * The name of the image, or @c NULL if there is no such image, or an empty
3183 * string if the image is unnamed. The name string is in
3184 * library-internal memory and may not be modified or freed; in addition,
3185 * the string will become invalid if the name of the image is changed, the
3186 * image is deleted, or the ::WIMStruct is destroyed.
3188 extern const wimlib_tchar *
3189 wimlib_get_image_name(const WIMStruct *wim, int image);
3192 * @ingroup G_general
3194 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
3195 * the major version, the next 10 bits contain the minor version, and the low 10
3196 * bits contain the patch version.
3198 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
3199 * << 20) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
3200 * corresponding header file.
3203 wimlib_get_version(void);
3206 * @ingroup G_wim_information
3208 * Get basic information about a WIM file.
3211 * Pointer to the ::WIMStruct to query. This need not represent a
3212 * standalone WIM (e.g. it could represent part of a split WIM).
3214 * A ::wimlib_wim_info structure that will be filled in with information
3215 * about the WIM file.
3220 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3223 * @ingroup G_wim_information
3225 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
3226 * includes a string of XML that describes the images contained in the WIM.
3228 * See wimlib_extract_xml_data() to extract the XML data to a file stream
3232 * Pointer to the ::WIMStruct to query. This need not represent a
3233 * standalone WIM (e.g. it could represent part of a split WIM).
3235 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3236 * XML data is written to this location.
3237 * @param bufsize_ret
3238 * The size of the XML data in bytes is written to this location.
3240 * @return 0 on success; nonzero on error.
3241 * @retval ::WIMLIB_ERR_INVALID_PARAM
3242 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
3243 * @p buf_ret or @p bufsize_ret was @c NULL.
3244 * @retval ::WIMLIB_ERR_NOMEM
3245 * @retval ::WIMLIB_ERR_READ
3246 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3247 * Failed to read the XML data from the WIM.
3250 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3253 * @ingroup G_general
3255 * Initialization function for wimlib. Call before using any other wimlib
3256 * function except wimlib_set_print_errors(). If not done manually, this
3257 * function will be called automatically with @p init_flags set to
3258 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
3259 * after it has already successfully run.
3262 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3264 * @return 0 on success; nonzero on failure. Currently, only the following
3265 * error code is defined:
3267 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3268 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3269 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3270 * init_flags, but the corresponding privileges could not be acquired.
3273 wimlib_global_init(int init_flags);
3276 * @ingroup G_general
3278 * Cleanup function for wimlib. You are not required to call this function, but
3279 * it will release any global resources allocated by the library.
3282 wimlib_global_cleanup(void);
3285 * @ingroup G_wim_information
3287 * Determines if an image name is already used by some image in the WIM.
3290 * Pointer to the ::WIMStruct to query. This need not represent a
3291 * standalone WIM (e.g. it could represent part of a split WIM).
3293 * The name to check.
3296 * @c true if there is already an image in @p wim named @p name; @c false
3297 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3298 * the empty string, @c false is returned.
3301 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3304 * @ingroup G_wim_information
3306 * Iterate through a file or directory tree in the WIM image. By specifying
3307 * appropriate flags and a callback function, you can get the attributes of a
3308 * file in the WIM, get a directory listing, or even get a listing of the entire
3312 * The WIM containing the image(s) over which to iterate, specified as a
3313 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3314 * or part 1 of a split WIM. In the case of a WIM file that is not
3315 * standalone, this ::WIMStruct should have had any needed external
3316 * resources previously referenced using wimlib_reference_resources() or
3317 * wimlib_reference_resource_files(). If not, see
3318 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3319 * the behavior when resources are missing.
3322 * The 1-based number of the image in @p wim that contains the files or
3323 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3324 * iteration on all images in the WIM.
3327 * Path in the WIM image at which to do the iteration.
3330 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3333 * A callback function that will receive each directory entry.
3336 * An extra parameter that will always be passed to the callback function
3339 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3340 * first nonzero value that was returned from @p cb. However, additional error
3341 * codes may be returned, including the following:
3343 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3344 * @p path did not exist in the WIM image.
3345 * @retval ::WIMLIB_ERR_NOMEM
3346 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
3348 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3349 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3350 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3351 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3352 * different reasons) to read the metadata resource for an image over which
3353 * iteration needed to be done.
3356 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3358 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3361 * @ingroup G_wim_information
3363 * Iterate through the lookup table of a WIM file. This can be used to directly
3364 * get a listing of the unique resources contained in a WIM file over all
3365 * images. Both file resources and metadata resources are included. However,
3366 * only resources actually included in the file represented by @a wim, plus
3367 * explicitly referenced external resources (via wimlib_reference_resources() or
3368 * wimlib_reference_resource_files()) are included in the iteration. For
3369 * example, if @p wim represents just one part of a split WIM, then only
3370 * resources in that part will be included, unless other resources were
3371 * explicitly referenced.
3374 * Pointer to the ::WIMStruct to query. This need not represent a
3375 * standalone WIM (e.g. it could represent part of a split WIM).
3378 * Reserved; set to 0.
3381 * A callback function that will receive each resource.
3384 * An extra parameter that will always be passed to the callback function
3387 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3388 * that was returned from @p cb.
3391 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3392 wimlib_iterate_lookup_table_callback_t cb,
3396 * @ingroup G_nonstandalone_wims
3398 * Joins a split WIM into a stand-alone one-part WIM.
3401 * An array of strings that gives the filenames of all parts of the split
3402 * WIM. No specific order is required, but all parts must be included with
3405 * Number of filenames in @p swms.
3406 * @param swm_open_flags
3407 * Open flags for the split WIM parts (e.g.
3408 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3409 * @param wim_write_flags
3410 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3411 * be used to write the joined WIM.
3412 * @param output_path
3413 * The path to write the joined WIM file to.
3415 * @return 0 on success; nonzero on error. This function may return most error
3416 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3417 * as the following error code:
3419 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3420 * The split WIMs do not form a valid WIM because they do not include all
3421 * the parts of the original WIM, there are duplicate parts, or not all the
3422 * parts have the same GUID and compression type.
3424 * Note: wimlib is generalized enough that this function is not actually needed
3425 * to join a split WIM; instead, you could open the first part of the split WIM,
3426 * then reference the other parts with wimlib_reference_resource_files(), then
3427 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3428 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3432 wimlib_join(const wimlib_tchar * const *swms,
3434 const wimlib_tchar *output_path,
3436 int wim_write_flags);
3439 * @ingroup G_nonstandalone_wims
3441 * Same as wimlib_join(), but allows specifying a progress function. The
3442 * progress function will receive the write progress messages, such as
3443 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3444 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3445 * swm_open_flags, the progress function will receive a series of
3446 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3450 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3452 const wimlib_tchar *output_path,
3454 int wim_write_flags,
3455 wimlib_progress_func_t progfunc,
3460 * @ingroup G_mounting_wim_images
3462 * Mounts an image from a WIM file on a directory read-only or read-write.
3465 * Pointer to the ::WIMStruct containing the image to be mounted.
3467 * The 1-based index of the image to mount.
3469 * The path to an existing empty directory on which to mount the WIM image.
3470 * @param mount_flags
3471 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3472 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3474 * @param staging_dir
3475 * If non-NULL, the name of a directory in which a temporary directory for
3476 * storing modified or added files will be created. Ignored if
3477 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3478 * left @c NULL, the staging directory is created in the same directory as
3479 * the WIM file that @p wim was originally read from. The staging
3480 * directory is automatically deleted when the image is unmounted.
3482 * @return 0 on success; nonzero on error. The possible error codes include:
3484 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3485 * An image from the WIM file is already mounted read-write, or another
3486 * process is currently appending data to the WIM file.
3487 * @retval ::WIMLIB_ERR_FUSE
3488 * A non-zero status code was returned by @c fuse_main().
3489 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3490 * @p image does not specify an existing, single image in @p wim.
3491 * @retval ::WIMLIB_ERR_INVALID_PARAM
3492 * @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3493 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3494 * already been modified in memory (e.g. by wimlib_update_image()).
3495 * @retval ::WIMLIB_ERR_MKDIR
3496 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3497 * staging directory could not be created.
3498 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3499 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3500 * WIM file is considered read-only because of any of the reasons mentioned
3501 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3502 * @retval ::WIMLIB_ERR_UNSUPPORTED
3503 * Mounting is not supported in this build of the library.
3505 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3506 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3507 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3508 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3509 * different reasons) to read the metadata resource for the image to mount.
3511 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3512 * UserSpacE). Depending on how FUSE is set up on your system, this function
3513 * may work as normal users in addition to the root user.
3515 * Mounting WIM images is not supported if wimlib was configured
3516 * <code>--without-fuse</code>. This includes Windows builds of wimlib;
3517 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3519 * Calling this function daemonizes the process, unless
3520 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3522 * It is safe to mount multiple images from the same underlying WIM file
3523 * read-only at the same time, but only if different ::WIMStruct's are used. It
3524 * is @b not safe to mount multiple images from the same WIM file read-write at
3527 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3528 * different process.
3531 wimlib_mount_image(WIMStruct *wim,
3533 const wimlib_tchar *dir,
3535 const wimlib_tchar *staging_dir);
3538 * @ingroup G_creating_and_opening_wims
3540 * Opens a WIM file and creates a ::WIMStruct for it.
3543 * The path to the WIM file to open.
3546 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3549 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3550 * is written to the memory location pointed to by this parameter. The
3551 * ::WIMStruct must be freed using using wimlib_free() when finished with
3554 * @return 0 on success; nonzero on error.
3555 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3556 * The number of metadata resources found in the WIM did not match the
3557 * image count specified in the WIM header, or the number of <IMAGE>
3558 * elements in the XML data of the WIM did not match the image count
3559 * specified in the WIM header.
3560 * @retval ::WIMLIB_ERR_INTEGRITY
3561 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3562 * the WIM contained an integrity table, but the SHA1 message digest for a
3563 * chunk of the WIM did not match the corresponding value in the integrity
3565 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3566 * The library did not recognize the compression chunk size of the WIM as
3567 * valid for its compression type.
3568 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3569 * The library did not recognize the compression type of the WIM.
3570 * @retval ::WIMLIB_ERR_INVALID_HEADER
3571 * The header of the WIM was otherwise invalid.
3572 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3573 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3574 * the WIM contained an integrity table, but the integrity table was
3576 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3577 * The lookup table of the WIM was invalid.
3578 * @retval ::WIMLIB_ERR_INVALID_PARAM
3579 * @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3580 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3581 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3582 * specified in @p open_flags.
3583 * @retval ::WIMLIB_ERR_NOMEM
3584 * Failed to allocated needed memory.
3585 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3586 * The file did not begin with the magic characters that identify a WIM
3588 * @retval ::WIMLIB_ERR_OPEN
3589 * Failed to open the WIM file for reading. Some possible reasons: the WIM
3590 * file does not exist, or the calling process does not have permission to
3592 * @retval ::WIMLIB_ERR_READ
3593 * Failed to read data from the WIM file.
3594 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3595 * Unexpected end-of-file while reading data from the WIM file.
3596 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3597 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3598 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3599 * The WIM cannot be opened because it contains encrypted segments. (It
3600 * may be a Windows 8 "ESD" file.)
3601 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3602 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3603 * considered read-only because of any of the reasons mentioned in the
3604 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3605 * @retval ::WIMLIB_ERR_XML
3606 * The XML data of the WIM was invalid.
3609 wimlib_open_wim(const wimlib_tchar *wim_file,
3611 WIMStruct **wim_ret);
3614 * @ingroup G_creating_and_opening_wims
3616 * Same as wimlib_open_wim(), but allows specifying a progress function and
3617 * progress context. If successful, the progress function will be registered in
3618 * the newly open ::WIMStruct, as if by an automatic call to
3619 * wimlib_register_progress_function(). In addition, if
3620 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the
3621 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3622 * messages while checking the WIM file's integrity.
3625 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3627 WIMStruct **wim_ret,
3628 wimlib_progress_func_t progfunc,
3632 * @ingroup G_writing_and_overwriting_wims
3634 * Overwrites the file that the WIM was originally read from, with changes made.
3635 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3636 * rather than wimlib_create_new_wim().
3638 * There are two ways that a WIM may be overwritten. The first is to do a full
3639 * rebuild. In this mode, the new WIM is written to a temporary file and then
3640 * renamed to the original file after it is has been completely written. The
3641 * temporary file is made in the same directory as the original WIM file. A
3642 * full rebuild may take a while, but it will save space by producing a WIM with
3645 * The second way to overwrite a WIM is by appending to the end of it and
3646 * overwriting the header. This can be much faster than a full rebuild, but the
3647 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3648 * begins with writing any new file resources *after* everything in the old WIM,
3649 * even though this will leave a hole where the old lookup table, XML data, and
3650 * integrity were. This is done so that the WIM remains valid even if the
3651 * operation is aborted mid-write. The WIM header is only overwritten at the
3652 * very last moment, and up until that point the WIM will be seen as the old
3655 * By default, wimlib_overwrite() does the append-style overwrite described
3656 * above, unless resources in the WIM are arranged in an unusual way or if
3657 * images have been deleted from the WIM. Use the flag
3658 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3659 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3660 * images have been deleted from the WIM.
3662 * If this function completes successfully, no more functions should be called
3663 * on @p wim other than wimlib_free(). If you need to continue using the WIM,
3664 * you must use wimlib_open_wim() to read it anew.
3667 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3668 * been in-memory changes made to it, which are then reflected in the
3670 * @param write_flags
3671 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3672 * @param num_threads
3673 * Number of threads to use for compression, or 0 for the default. (See
3676 * @return 0 on success; nonzero on error. This function may return most error
3677 * codes returned by wimlib_write() as well as the following error codes:
3679 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3680 * The WIM was going to be modified in-place (with no temporary file), but
3681 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3682 * because another thread or process has mounted an image from the WIM
3683 * read-write or is currently modifying the WIM in-place.
3684 * @retval ::WIMLIB_ERR_NO_FILENAME
3685 * @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim()
3686 * rather than a WIM read with wimlib_open_wim().
3687 * @retval ::WIMLIB_ERR_RENAME
3688 * The temporary file that the WIM was written to could not be renamed to
3689 * the original filename of @p wim.
3690 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3691 * The WIM file is considered read-only because of any of the reasons
3692 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3695 * If a progress function is registered with @p wim, it will receive the
3696 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3697 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3698 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3701 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3704 * @ingroup G_wim_information
3706 * Prints information about one image, or all images, contained in a WIM.
3709 * Pointer to the ::WIMStruct to query. This need not represent a
3710 * standalone WIM (e.g. it could represent part of a split WIM).
3712 * The image about which to print information. Can be the number of an
3713 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3716 * @return This function has no return value. No error checking is done when
3717 * printing the information. If @p image is invalid, an error message is
3721 wimlib_print_available_images(const WIMStruct *wim, int image);
3724 * @ingroup G_wim_information
3726 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3727 * in a way that can be accessed programatically.
3730 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3733 * @ingroup G_nonstandalone_wims
3735 * Reference resources from other WIM files or split WIM parts. This function
3736 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3737 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3738 * from other files, before calling a function such as wimlib_extract_image()
3739 * that requires the resources to be present.
3742 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3743 * necessarily "standalone". In the case of split WIMs, this should be the
3744 * first part, since only the first part contains the metadata resources.
3745 * In the case of delta WIMs, this should be the delta WIM rather than the
3746 * WIM on which it is based.
3747 * @param resource_wimfiles_or_globs
3748 * Array of paths to WIM files and/or split WIM parts to reference.
3749 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3750 * ref_flags, these are treated as globs rather than literal paths. That
3751 * is, using this function you can specify zero or more globs, each of
3752 * which expands to one or more literal paths.
3754 * Number of entries in @p resource_wimfiles_or_globs.
3756 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3757 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3759 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3760 * pass to internal calls to wimlib_open_wim() on the reference files.
3762 * @return 0 on success; nonzero on error.
3764 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3765 * One of the specified globs did not match any paths (only with both
3766 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3767 * specified in @p ref_flags).
3768 * @retval ::WIMLIB_ERR_NOMEM
3769 * Failed to allocate memory.
3770 * @retval ::WIMLIB_ERR_READ
3771 * I/O or permissions error while processing a file glob.
3773 * This function can additionally return most values that can be returned by
3774 * wimlib_open_wim().
3777 wimlib_reference_resource_files(WIMStruct *wim,
3778 const wimlib_tchar * const *resource_wimfiles_or_globs,
3784 * @ingroup G_nonstandalone_wims
3786 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3787 * where the caller must open the ::WIMStruct for each referenced file itself.
3790 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3791 * necessarily "standalone". In the case of split WIMs, this should be the
3792 * first part, since only the first part contains the metadata resources.
3793 * @param resource_wims
3794 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3795 * split WIM parts to reference.
3796 * @param num_resource_wims
3797 * Number of entries in @p resource_wims.
3799 * Currently ignored (set to 0).
3801 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3802 * @p resource_wims are referenced internally by @p wim and must not be freed
3803 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3804 * been freed with wimlib_free(), or immediately before freeing @p wim with
3807 * @retval ::WIMLIB_ERR_INVALID_PARAM
3808 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3809 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3810 * @retval ::WIMLIB_ERR_NOMEM
3811 * Failed to allocate memory.
3814 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3815 unsigned num_resource_wims, int ref_flags);
3818 * @ingroup G_modifying_wims
3820 * Declares that a newly added image is mostly the same as a prior image, but
3821 * captured at a later point in time, possibly with some modifications in the
3822 * intervening time. This is designed to be used in incremental backups of the
3823 * same filesystem or directory tree.
3825 * This function compares the metadata of the directory tree of the newly added
3826 * image against that of the old image. Any files that are present in both the
3827 * newly added image and the old image and have timestamps that indicate they
3828 * haven't been modified are deemed not to have been modified and have their
3829 * SHA1 message digest copied from the old image. Because of this and because
3830 * WIM uses single-instance streams, such files need not be read from the
3831 * filesystem when the WIM is being written or overwritten. Note that these
3832 * unchanged files will still be "archived" and will be logically present in the
3833 * new image; the optimization is that they don't need to actually be read from
3834 * the filesystem because the WIM already contains them.
3836 * This function is provided to optimize incremental backups. The resulting WIM
3837 * file will still be the same regardless of whether this function is called.
3838 * (This is, however, assuming that timestamps have not been manipulated or
3839 * unmaintained as to trick this function into thinking a file has not been
3840 * modified when really it has. To partly guard against such cases, other
3841 * metadata such as file sizes will be checked as well.)
3843 * This function must be called after adding the new image (e.g. with
3844 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3845 * wimlib_overwrite()).
3848 * Pointer to the ::WIMStruct for a WIM.
3850 * 1-based index in the WIM of the newly added image. This image can have
3851 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3852 * wimlib_add_empty_image() followed by wimlib_update_image().
3853 * @param template_wim
3854 * The ::WIMStruct for the WIM containing the template image. This can be
3855 * the same as @p wim, or it can be a different ::WIMStruct.
3856 * @param template_image
3857 * 1-based index in the WIM of a template image that reflects a prior state
3858 * of the directory tree being captured.
3860 * Reserved; must be 0.
3862 * @return 0 on success; nonzero on error.
3864 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3865 * @p new_image and/or @p template_image were not a valid image indices in
3867 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3868 * The specified ::WIMStruct did not actually contain the metadata resource
3869 * for the new or template image; for example, it was a non-first part of a
3871 * @retval ::WIMLIB_ERR_NOMEM
3872 * Failed to allocate needed memory.
3873 * @retval ::WIMLIB_ERR_INVALID_PARAM
3874 * @p new_image was equal to @p template_image, or @p new_image specified
3875 * an image that had not been modified since opening the WIM.
3877 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3878 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3879 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3880 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3881 * different reasons) to read the metadata resource for the template image.
3884 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3885 WIMStruct *template_wim, int template_image,
3889 * @ingroup G_general
3891 * Registers a progress function with a ::WIMStruct.
3894 * The ::WIMStruct for which to register the progress function.
3896 * Pointer to the progress function to register. If the WIM already has a
3897 * progress function registered, it will be replaced with this one. If @p
3898 * NULL, the current progress function (if any) will be unregistered.
3900 * The value which will be passed as the third argument to calls to @p
3904 wimlib_register_progress_function(WIMStruct *wim,
3905 wimlib_progress_func_t progfunc,
3909 * @ingroup G_modifying_wims
3911 * Rename the @p source_path to the @p dest_path in the specified @p image of
3914 * This just builds an appropriate ::wimlib_rename_command and passes it to
3915 * wimlib_update_image().
3918 wimlib_rename_path(WIMStruct *wim, int image,
3919 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3922 * @ingroup G_wim_information
3924 * Translates a string specifying the name or number of an image in the WIM into
3925 * the number of the image. The images are numbered starting at 1.
3928 * Pointer to the ::WIMStruct for a WIM.
3929 * @param image_name_or_num
3930 * A string specifying the name or number of an image in the WIM. If it
3931 * parses to a positive integer, this integer is taken to specify the
3932 * number of the image, indexed starting at 1. Otherwise, it is taken to
3933 * be the name of an image, as given in the XML data for the WIM file. It
3934 * also may be the keyword "all" or the string "*", both of which will
3935 * resolve to ::WIMLIB_ALL_IMAGES.
3937 * There is no way to search for an image actually named "all", "*", or an
3938 * integer number, or an image that has no name. However, you can use
3939 * wimlib_get_image_name() to get the name of any image.
3942 * If the string resolved to a single existing image, the number of that
3943 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3944 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3945 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3946 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3947 * images in @p wim has no name.
3950 wimlib_resolve_image(WIMStruct *wim,
3951 const wimlib_tchar *image_name_or_num);
3954 * @ingroup G_general
3956 * Sets the file to which the library will print error and warning messages.
3958 * This version of the function takes a C library <c>FILE *</c> opened for
3959 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3960 * file by name instead.
3962 * This also enables error messages, as if by a call to
3963 * wimlib_set_print_errors(true).
3965 * @return 0 on success; nonzero on error.
3966 * @retval ::WIMLIB_ERR_UNSUPPORTED
3967 * wimlib was compiled using the <c>--without-error-messages</c> option.
3970 wimlib_set_error_file(FILE *fp);
3973 * @ingroup G_general
3975 * Sets the path to the file to which the library will print error and warning
3976 * messages. The library will open this file for appending.
3978 * This also enables error messages, as if by a call to
3979 * wimlib_set_print_errors(true).
3981 * @return 0 on success; nonzero on error.
3982 * @retval ::WIMLIB_ERR_OPEN
3983 * The file named by @p path could not be opened for appending.
3984 * @retval ::WIMLIB_ERR_UNSUPPORTED
3985 * wimlib was compiled using the <c>--without-error-messages</c> option.
3988 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3991 * @ingroup G_modifying_wims
3993 * Changes the description of an image in the WIM.
3996 * Pointer to the ::WIMStruct for a WIM.
3998 * The number of the image for which to change the description.
3999 * @param description
4000 * The new description to give the image. It may be @c NULL, which
4001 * indicates that the image is to be given no description.
4003 * @return 0 on success; nonzero on error.
4004 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4005 * @p image does not specify a single existing image in @p wim.
4006 * @retval ::WIMLIB_ERR_NOMEM
4007 * Failed to allocate the memory needed to duplicate the @p description
4011 wimlib_set_image_descripton(WIMStruct *wim, int image,
4012 const wimlib_tchar *description);
4015 * @ingroup G_writing_and_overwriting_wims
4017 * Set the compression chunk size of a WIM to use in subsequent calls to
4018 * wimlib_write() or wimlib_overwrite().
4020 * A larger compression chunk size will likely result in a better compression
4021 * ratio, but the speed of random access to the WIM will be reduced.
4022 * Furthermore, the effect of a larger compression chunk size is limited by the
4023 * size of each stream ("file") being compressed.
4026 * ::WIMStruct for a WIM.
4028 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
4029 * on the compression format. See the documentation for each
4030 * ::wimlib_compression_type constant for more information. As a special
4031 * case, if @p chunk_size is specified as 0, the chunk size is set to the
4032 * default for the currently selected output compression type.
4034 * @return 0 on success; nonzero on error.
4036 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
4037 * @p chunk_size is not a supported chunk size for the currently selected
4038 * output compression type.
4041 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4044 * @ingroup G_writing_and_overwriting_wims
4046 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4050 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4053 * @ingroup G_writing_and_overwriting_wims
4055 * Set the compression type of a WIM to use in subsequent calls to
4056 * wimlib_write() or wimlib_overwrite().
4059 * ::WIMStruct for a WIM.
4061 * The compression type to set (one of ::wimlib_compression_type). If this
4062 * compression type is incompatible with the current output chunk size
4063 * (either the default or as set with wimlib_set_output_chunk_size()), the
4064 * output chunk size is reset to the default for that compression type.
4066 * @return 0 on success; nonzero on error.
4068 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4069 * @p ctype did not specify a valid compression type.
4072 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
4075 * @ingroup G_writing_and_overwriting_wims
4077 * Similar to wimlib_set_output_compression_type(), but set the compression type
4078 * for writing solid resources.
4081 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
4084 * @ingroup G_modifying_wims
4086 * Set basic information about a WIM.
4089 * Pointer to the ::WIMStruct for a WIM.
4091 * A struct ::wimlib_wim_info that contains the information to set. Only
4092 * the information explicitly specified in the @p which flags need be
4095 * Flags that specify which information to set. This is a bitwise OR of
4096 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4097 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4099 * @return 0 on success; nonzero on failure.
4100 * @retval ::WIMLIB_ERR_IMAGE_COUNT
4101 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4102 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4106 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4110 * @ingroup G_modifying_wims
4112 * Changes what is written in the \<FLAGS\> element in the WIM XML data
4113 * (something like "Core" or "Ultimate")
4116 * Pointer to the ::WIMStruct for a WIM.
4118 * The number of the image for which to change the description.
4120 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
4121 * indicates that the image is to be given no \<FLAGS\> element.
4123 * @return 0 on success; nonzero on error.
4124 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4125 * @p image does not specify a single existing image in @p wim.
4126 * @retval ::WIMLIB_ERR_NOMEM
4127 * Failed to allocate the memory needed to duplicate the @p flags string.
4130 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
4133 * @ingroup G_modifying_wims
4135 * Changes the name of an image in the WIM.
4138 * Pointer to the ::WIMStruct for a WIM.
4140 * The number of the image for which to change the name.
4142 * New name to give the new image. If @c NULL or empty, the new image is
4143 * given no name. If nonempty, it must specify a name that does not
4144 * already exist in @p wim.
4146 * @return 0 on success; nonzero on error.
4147 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
4148 * There is already an image named @p name in @p wim.
4149 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4150 * @p image does not specify a single existing image in @p wim.
4151 * @retval ::WIMLIB_ERR_NOMEM
4152 * Failed to allocate the memory needed to duplicate the @p name string.
4155 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
4158 * @ingroup G_general
4160 * Set the functions that wimlib uses to allocate and free memory.
4162 * These settings are global and not per-WIM.
4164 * The default is to use the default @c malloc() and @c free() from the C
4167 * Please note that some external functions, such as those in @c libntfs-3g, may
4168 * use the standard memory allocation functions regardless of this setting.
4170 * @param malloc_func
4171 * A function equivalent to @c malloc() that wimlib will use to allocate
4172 * memory. If @c NULL, the allocator function is set back to the default
4173 * @c malloc() from the C library.
4175 * A function equivalent to @c free() that wimlib will use to free memory.
4176 * If @c NULL, the free function is set back to the default @c free() from
4178 * @param realloc_func
4179 * A function equivalent to @c realloc() that wimlib will use to reallocate
4180 * memory. If @c NULL, the free function is set back to the default @c
4181 * realloc() from the C library.
4185 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
4186 void (*free_func)(void *),
4187 void *(*realloc_func)(void *, size_t));
4190 * @ingroup G_general
4192 * Sets whether wimlib is to print error messages to @c stderr when a function
4193 * fails. These error messages may provide information that cannot be
4194 * determined only from the error code that is returned. Not every error will
4195 * result in an error message being printed.
4197 * This setting is global and not per-WIM.
4199 * By default, error messages are not printed.
4201 * This can be called before wimlib_global_init().
4203 * @param show_messages
4204 * @c true if error messages are to be printed; @c false if error messages
4205 * are not to be printed.
4207 * @return 0 on success; nonzero on error.
4208 * @retval ::WIMLIB_ERR_UNSUPPORTED
4209 * @p show_messages was @c true, but wimlib was compiled with the @c
4210 * --without-error-messages option. Therefore, error messages cannot be
4214 wimlib_set_print_errors(bool show_messages);
4217 * @ingroup G_nonstandalone_wims
4219 * Splits a WIM into multiple parts.
4222 * The ::WIMStruct for the WIM to split.
4224 * Name of the SWM file to create. This will be the name of the first
4225 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
4226 * appended before the suffix.
4228 * The maximum size per part, in bytes. Unfortunately, it is not
4229 * guaranteed that this will really be the maximum size per part, because
4230 * some file resources in the WIM may be larger than this size, and the WIM
4231 * file format provides no way to split up file resources among multiple
4233 * @param write_flags
4234 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4235 * flags will be used to write each split WIM part. Specify 0 here to get
4236 * the default behavior.
4238 * @return 0 on success; nonzero on error. This function may return most error
4239 * codes that can be returned by wimlib_write() as well as the following error
4242 * @retval ::WIMLIB_ERR_INVALID_PARAM
4243 * @p swm_name was not a nonempty string, or @p part_size was 0.
4245 * If a progress function is registered with @p wim, for each split WIM part
4246 * that is written it will receive the messages
4247 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4248 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4251 wimlib_split(WIMStruct *wim,
4252 const wimlib_tchar *swm_name,
4257 * @ingroup G_general
4259 * Perform verification checks on a WIM file.
4262 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4263 * verification, it is a good idea to have used
4264 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4266 * If verifying a split WIM, specify the first part of the split WIM here,
4267 * and reference the other parts using wimlib_reference_resource_files()
4268 * before calling this function.
4270 * @param verify_flags
4271 * Reserved; must be 0.
4273 * @retval 0 if the WIM file was successfully verified; nonzero if it failed
4274 * verification or another error occurred. Some of the possible error codes
4277 * @retval ::WIMLIB_ERR_DECOMPRESSION
4278 * A compressed resource could not be decompressed.
4279 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4280 * The metadata resource for an image is invalid.
4281 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4282 * One of the files did not decompress to its original data, as given by a
4283 * cryptographic checksum.
4284 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4285 * One of the files referenced by an image could not be located.
4287 * If a progress function is registered with @p wim, it will receive the
4288 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4289 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4290 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4293 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4296 * @ingroup G_mounting_wim_images
4298 * Unmounts a WIM image that was mounted using wimlib_mount_image().
4300 * When unmounting a read-write mounted image, the default behavior is to
4301 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4302 * WIM image to be committed.
4305 * The directory the WIM image was mounted on.
4306 * @param unmount_flags
4307 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4309 * @return 0 on success; nonzero on error. The possible error codes include:
4311 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4312 * There is no WIM image mounted on the specified directory.
4313 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4314 * The read-write mounted WIM image cannot be committed because there are
4315 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4317 * @retval ::WIMLIB_ERR_MQUEUE
4318 * Could not create a POSIX message queue.
4319 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4320 * The WIM image was mounted by a different user.
4321 * @retval ::WIMLIB_ERR_UNSUPPORTED
4322 * Mounting is not supported in this build of the library.
4324 * Note: you can also unmount the image by using the @c umount() system call, or
4325 * by using the @c umount or @c fusermount programs. However, you need to call
4326 * this function if you want changes to be committed.
4329 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4332 * @ingroup G_mounting_wim_images
4334 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4335 * If changes are committed from a read-write mount, the progress function will
4336 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4339 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4341 wimlib_progress_func_t progfunc,
4345 * @ingroup G_modifying_wims
4347 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4350 * Pointer to the ::WIMStruct for the WIM file to update.
4352 * The 1-based index of the image in the WIM to update. It cannot be
4353 * ::WIMLIB_ALL_IMAGES.
4355 * An array of ::wimlib_update_command's that specify the update operations
4358 * Number of commands in @p cmds.
4359 * @param update_flags
4360 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4362 * @return 0 on success; nonzero on error. On failure, all update commands will
4363 * be rolled back, and no visible changes shall have been made to @p wim.
4364 * Possible error codes include:
4366 * @retval ::WIMLIB_ERR_FVE_LOCKED_VOLUME
4367 * Windows-only: One of the "add" commands attempted to add files from an
4368 * encrypted BitLocker volume that hasn't yet been unlocked.
4369 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4370 * The capture configuration structure specified for an add command was
4372 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4373 * @p image did not specify a single, existing image in @p wim.
4374 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4375 * Attempted to perform an add command that conflicted with previously
4376 * existing files in the WIM when an overlay was attempted.
4377 * @retval ::WIMLIB_ERR_INVALID_PARAM
4378 * An unknown operation type was specified in the update commands; or,
4379 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
4380 * in the @p add_flags, but the same image had previously already been
4381 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
4382 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
4383 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
4384 * specified in the @p add_flags for an add command in which @p
4385 * wim_target_path was not the root directory of the WIM image.
4386 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4387 * (Windows only): While executing an add command, tried to capture a
4388 * reparse point with invalid data.
4389 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4390 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4391 * for a WIM path that corresponded to a directory; or, a rename command
4392 * attempted to rename a directory to a non-directory.
4393 * @retval ::WIMLIB_ERR_NOMEM
4394 * Failed to allocate needed memory.
4395 * @retval ::WIMLIB_ERR_NOTDIR
4396 * A rename command attempted to rename a directory to a non-directory; or,
4397 * an add command was executed that attempted to set the root of the WIM
4398 * image as a non-directory; or, a path component used as a directory in a
4399 * rename command was not, in fact, a directory.
4400 * @retval ::WIMLIB_ERR_NOTEMPTY
4401 * A rename command attempted to rename a directory to a non-empty
4403 * @retval ::WIMLIB_ERR_NTFS_3G
4404 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4405 * error occurred while reading data from the NTFS volume using libntfs-3g.
4406 * @retval ::WIMLIB_ERR_OPEN
4407 * Failed to open a file to be captured while executing an add command.
4408 * @retval ::WIMLIB_ERR_OPENDIR
4409 * Failed to open a directory to be captured while executing an add command.
4410 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4411 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4412 * WIM path that did not exist; or, a rename command attempted to rename a
4413 * file that does not exist.
4414 * @retval ::WIMLIB_ERR_READ
4415 * While executing an add command, failed to read data from a file or
4416 * directory to be captured.
4417 * @retval ::WIMLIB_ERR_READLINK
4418 * While executing an add command, failed to read the target of a symbolic
4419 * link or junction point.
4420 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
4421 * (Windows only) Failed to perform a reparse point fixup because of
4422 * problems with the data of a reparse point.
4423 * @retval ::WIMLIB_ERR_STAT
4424 * While executing an add command, failed to get attributes for a file or
4426 * @retval ::WIMLIB_ERR_UNSUPPORTED
4427 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4428 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4429 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4430 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4431 * add_flags for an update command.
4432 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4433 * While executing an add command, attempted to capture a file that was not
4434 * a supported file type (e.g. a device file). Only if
4435 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4436 * for an update command.
4438 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4439 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4440 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4441 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4442 * different reasons) to read the metadata resource for an image that needed to
4446 wimlib_update_image(WIMStruct *wim,
4448 const struct wimlib_update_command *cmds,
4453 * @ingroup G_writing_and_overwriting_wims
4455 * Writes a WIM to a file.
4457 * This brings in resources from any external locations, such as directory trees
4458 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4459 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
4461 * By default, the new WIM file is written as stand-alone. Using the
4462 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4463 * instead. However, this function cannot directly write a "split" WIM; use
4464 * wimlib_split() for that.
4467 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
4468 * changes made to it, which are then reflected in the output file.
4470 * The path to the file to write the WIM to.
4472 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4473 * images are to be included in the new on-disk WIM file. If for some
4474 * reason you only want to include a single image, specify the index of
4475 * that image instead.
4476 * @param write_flags
4477 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
4478 * @param num_threads
4479 * Number of threads to use for compressing data. If 0, the number of
4480 * threads will be set by the library automatically. This chosen value
4481 * will generally be the number of online processors, but the
4482 * implementation may take into account other information (e.g. available
4483 * memory and overall system activity).
4485 * @return 0 on success; nonzero on error.
4487 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4488 * @p image does not specify a single existing image in @p wim, and is not
4489 * ::WIMLIB_ALL_IMAGES.
4490 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4491 * A file resource failed a SHA-1 message digest check. This can happen if
4492 * a file that had previously been scanned for inclusion in the WIM by was
4493 * concurrently modified.
4494 * @retval ::WIMLIB_ERR_INVALID_PARAM
4495 * @p path was not a nonempty string, or invalid flags were passed.
4496 * @retval ::WIMLIB_ERR_NOMEM
4497 * Failed to allocate needed memory.
4498 * @retval ::WIMLIB_ERR_OPEN
4499 * Failed to open @p path for writing, or some file resources in @p wim
4500 * refer to files in the outside filesystem, and one of these files could
4501 * not be opened for reading.
4502 * @retval ::WIMLIB_ERR_READ
4503 * An error occurred when trying to read data from the WIM file associated
4504 * with @p wim, or some file resources in @p wim refer to files in the
4505 * outside filesystem, and a read error occurred when reading one of these
4507 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4508 * A stream that needed to be written could not be found in the stream
4509 * lookup table of @p wim. This error can occur if, for example, @p wim is
4510 * part of a split WIM but needed resources from the other split WIM parts
4511 * were not referenced with wimlib_reference_resources() or
4512 * wimlib_reference_resource_files() before the call to wimlib_write().
4513 * @retval ::WIMLIB_ERR_WRITE
4514 * An error occurred when trying to write data to the new WIM file.
4516 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4517 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4518 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4519 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4520 * different reasons) to read the data from a WIM archive.
4522 * If a progress function is registered with @p wim, it will receive the
4523 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4524 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4525 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4528 wimlib_write(WIMStruct *wim,
4529 const wimlib_tchar *path,
4532 unsigned num_threads);
4535 * @ingroup G_writing_and_overwriting_wims
4537 * Same as wimlib_write(), but write the WIM directly to a file descriptor,
4538 * which need not be seekable if the write is done in a special pipable WIM
4539 * format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p write_flags. This can,
4540 * for example, allow capturing a WIM image and streaming it over the network.
4541 * See @ref subsec_pipable_wims for more information about pipable WIMs.
4543 * The file descriptor @p fd will @b not be closed when the write is complete;
4544 * the calling code is responsible for this.
4546 * Returns 0 on success; nonzero on failure. The possible error codes include
4547 * those that can be returned by wimlib_write() as well as the following:
4549 * @retval ::WIMLIB_ERR_INVALID_PARAM
4550 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4551 * specified in @p write_flags.
4554 wimlib_write_to_fd(WIMStruct *wim,
4558 unsigned num_threads);
4561 * @defgroup G_compression Compression and decompression functions
4563 * @brief Functions for XPRESS, LZX, and LZMS compression and decompression.
4565 * These functions are already used by wimlib internally when appropriate for
4566 * reading and writing WIM archives. But they are exported and documented so
4567 * that they can be used in other applications or libraries for general-purpose
4568 * lossless data compression. They are implemented in highly optimized C code,
4569 * using state-of-the-art compression techniques. The main limitation is the
4570 * lack of sliding window support; this has, however, allowed the algorithms to
4571 * be optimized for block-based compression.
4576 /** Opaque compressor handle. */
4577 struct wimlib_compressor;
4579 /** Opaque decompressor handle. */
4580 struct wimlib_decompressor;
4583 * Set the default compression level for the specified compression type. This
4584 * is the compression level that wimlib_create_compressor() assumes if it is
4585 * called with @p compression_level specified as 0.
4587 * wimlib's WIM writing code (e.g. wimlib_write()) will pass 0 to
4588 * wimlib_create_compressor() internally. Therefore, calling this function will
4589 * affect the compression level of any data later written to WIM files using the
4590 * specified compression type.
4592 * The initial state, before this function is called, is that all compression
4593 * types have a default compression level of 50.
4596 * Compression type for which to set the default compression level, as one
4597 * of the ::wimlib_compression_type constants. Or, if this is the special
4598 * value -1, the default compression levels for all compression types will
4600 * @param compression_level
4601 * The default compression level to set. If 0, the "default default" level
4602 * of 50 is restored. Otherwise, a higher value indicates higher
4603 * compression, whereas a lower value indicates lower compression. See
4604 * wimlib_create_compressor() for more information.
4606 * @return 0 on success; nonzero on error.
4608 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4609 * @p ctype was neither a supported compression type nor -1.
4612 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
4615 * Returns the approximate number of bytes needed to allocate a compressor with
4616 * wimlib_create_compressor() for the specified compression type, maximum block
4617 * size, and compression level. @p compression_level may be 0, in which case
4618 * the current default compression level for @p ctype is used. Returns 0 if the
4619 * compression type is invalid, or the @p max_block_size for that compression
4623 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4624 size_t max_block_size,
4625 unsigned int compression_level);
4628 * Allocate a compressor for the specified compression type using the specified
4629 * parameters. This function is part of wimlib's compression API; it is not
4630 * necessary to call this to process a WIM file.
4633 * Compression type for which to create the compressor, as one of the
4634 * ::wimlib_compression_type constants.
4635 * @param max_block_size
4636 * The maximum compression block size to support. This specifies the
4637 * maximum allowed value for the @p uncompressed_size parameter of
4638 * wimlib_compress() when called using this compressor.
4640 * Usually, the amount of memory used by the compressor will scale in
4641 * proportion to the @p max_block_size parameter.
4642 * wimlib_get_compressor_needed_memory() can be used to query the specific
4643 * amount of memory that will be required.
4645 * This parameter must be at least 1 and must be less than or equal to a
4646 * compression-type-specific limit.
4648 * In general, the same value of @p max_block_size must be passed to
4649 * wimlib_create_decompressor() when the data is later decompressed.
4650 * However, some compression types have looser requirements regarding this.
4651 * @param compression_level
4652 * The compression level to use. If 0, the default compression level (50,
4653 * or another value as set through wimlib_set_default_compression_level())
4654 * is used. Otherwise, a higher value indicates higher compression. The
4655 * values are scaled so that 10 is low compression, 50 is medium
4656 * compression, and 100 is high compression. This is not a percentage;
4657 * values above 100 are also valid.
4659 * Using a higher-than-default compression level can result in a better
4660 * compression ratio, but can significantly reduce performance. Similarly,
4661 * using a lower-than-default compression level can result in better
4662 * performance, but can significantly worsen the compression ratio. The
4663 * exact results will depend heavily on the compression type and what
4664 * algorithms are implemented for it. If you are considering using a
4665 * non-default compression level, you should run benchmarks to see if it is
4666 * worthwhile for your application.
4668 * The compression level does not affect the format of the compressed data.
4669 * Therefore, it is a compressor-only parameter and does not need to be
4670 * passed to the decompressor.
4671 * @param compressor_ret
4672 * A location into which to return the pointer to the allocated compressor.
4673 * The allocated compressor can be used for any number of calls to
4674 * wimlib_compress() before being freed with wimlib_free_compressor().
4676 * @return 0 on success; nonzero on error.
4678 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4679 * @p ctype was not a supported compression type.
4680 * @retval ::WIMLIB_ERR_INVALID_PARAM
4681 * @p max_block_size was invalid for the compression type, or @p
4682 * compressor_ret was @c NULL.
4683 * @retval ::WIMLIB_ERR_NOMEM
4684 * Insufficient memory to allocate the compressor.
4687 wimlib_create_compressor(enum wimlib_compression_type ctype,
4688 size_t max_block_size,
4689 unsigned int compression_level,
4690 struct wimlib_compressor **compressor_ret);
4693 * Compress a buffer of data.
4695 * @param uncompressed_data
4696 * Buffer containing the data to compress.
4697 * @param uncompressed_size
4698 * Size, in bytes, of the data to compress. This cannot be greater than
4699 * the @p max_block_size with which wimlib_create_compressor() was called.
4700 * (If it is, the data will not be compressed and 0 will be returned.)
4701 * @param compressed_data
4702 * Buffer into which to write the compressed data.
4703 * @param compressed_size_avail
4704 * Number of bytes available in @p compressed_data.
4706 * A compressor previously allocated with wimlib_create_compressor().
4709 * The size of the compressed data, in bytes, or 0 if the data could not be
4710 * compressed to @p compressed_size_avail or fewer bytes.
4713 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4714 void *compressed_data, size_t compressed_size_avail,
4715 struct wimlib_compressor *compressor);
4718 * Free a compressor previously allocated with wimlib_create_compressor().
4721 * The compressor to free. If @c NULL, no action is taken.
4724 wimlib_free_compressor(struct wimlib_compressor *compressor);
4727 * Allocate a decompressor for the specified compression type. This function is
4728 * part of wimlib's compression API; it is not necessary to call this to process
4732 * Compression type for which to create the decompressor, as one of the
4733 * ::wimlib_compression_type constants.
4734 * @param max_block_size
4735 * The maximum compression block size to support. This specifies the
4736 * maximum allowed value for the @p uncompressed_size parameter of
4737 * wimlib_decompress().
4739 * In general, this parameter must be the same as the @p max_block_size
4740 * that was passed to wimlib_create_compressor() when the data was
4741 * compressed. However, some compression types have looser requirements
4743 * @param decompressor_ret
4744 * A location into which to return the pointer to the allocated
4745 * decompressor. The allocated decompressor can be used for any number of
4746 * calls to wimlib_decompress() before being freed with
4747 * wimlib_free_decompressor().
4749 * @return 0 on success; nonzero on error.
4751 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4752 * @p ctype was not a supported compression type.
4753 * @retval ::WIMLIB_ERR_INVALID_PARAM
4754 * @p max_block_size was invalid for the compression type, or @p
4755 * decompressor_ret was @c NULL.
4756 * @retval ::WIMLIB_ERR_NOMEM
4757 * Insufficient memory to allocate the decompressor.
4760 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4761 size_t max_block_size,
4762 struct wimlib_decompressor **decompressor_ret);
4765 * Decompress a buffer of data.
4767 * @param compressed_data
4768 * Buffer containing the data to decompress.
4769 * @param compressed_size
4770 * Size, in bytes, of the data to decompress.
4771 * @param uncompressed_data
4772 * Buffer into which to write the uncompressed data.
4773 * @param uncompressed_size
4774 * Size, in bytes, of the data when uncompressed. This cannot exceed the
4775 * @p max_block_size with which wimlib_create_decompressor() was called.
4776 * (If it does, the data will not be decompressed and a nonzero value will
4778 * @param decompressor
4779 * A decompressor previously allocated with wimlib_create_decompressor().
4781 * @return 0 on success; nonzero on error.
4783 * No specific error codes are defined; any nonzero value indicates that the
4784 * decompression failed. This can only occur if the data is truly invalid;
4785 * there will never be transient errors like "out of memory", for example.
4787 * This function requires that the exact uncompressed size of the data be passed
4788 * as the @p uncompressed_size parameter. If this is not done correctly,
4789 * decompression may fail or the data may be decompressed incorrectly.
4792 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4793 void *uncompressed_data, size_t uncompressed_size,
4794 struct wimlib_decompressor *decompressor);
4797 * Free a decompressor previously allocated with wimlib_create_decompressor().
4799 * @param decompressor
4800 * The decompressor to free. If @c NULL, no action is taken.
4803 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4815 #endif /* _WIMLIB_H */