3 * @brief External header for wimlib.
5 * This file contains comments for generating documentation with Doxygen. The
6 * built HTML documentation can be viewed at http://wimlib.sourceforge.net.
7 * Make sure to see the <a href="modules.html">Modules page</a> to make more
8 * sense of the declarations in this header.
14 * This is the documentation for the library interface of wimlib 1.8.0, a C
15 * library for creating, modifying, extracting, and mounting files in the
16 * Windows Imaging Format. This documentation is intended for developers only.
17 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
18 * program, please see the manual pages and also the <a
19 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
22 * @section sec_installing Installing
26 * Download the source code from <a
27 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
28 * Install the library by running <c>configure && make && sudo make install</c>.
29 * See the README for information about configuration options. To use wimlib in
30 * your program after installing it, include wimlib.h and link your program with
35 * Download the Windows binary distribution with the appropriate architecture
36 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
37 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
38 * Link your program with the libwim-15.dll file. Make sure to also download
39 * the source code so you can get wimlib.h, as it is not included in the binary
40 * distribution. If you need to access the DLL from other programming
41 * languages, note that the calling convention is "cdecl".
43 * @section sec_examples Examples
45 * Several examples are located in the <a
46 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
47 * directory of the source distribution.
49 * There is also the <a
50 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
51 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
52 * capabilities of wimlib.
54 * @section backwards_compatibility Backwards Compatibility
56 * New releases of wimlib are intended to be API/ABI compatible with old
57 * releases, except when the libtool "age" is reset. This most recently
58 * occurred for the v1.4.0 (libwim7), v1.5.0 (libwim9), and v1.7.0 (libwim15)
59 * releases. However, the library is becoming increasingly stable, and the goal
60 * is to maintain the current API/ABI for as long as possible unless there is a
61 * strong reason not to. Even for the v1.7.0 release (libwim15), the changes
62 * were fairly limited.
64 * As with any other library, applications should not rely on internal
65 * implementation details that may be subject to change.
67 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
69 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
70 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
71 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
72 * which creates a new ::WIMStruct that initially contains no images and does
73 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
76 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
77 * Images can be extracted (or "applied") using wimlib_extract_image(), added
78 * (or "captured" or "appended") using wimlib_add_image(), deleted using
79 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
80 * modified using wimlib_update_image(). However, changes made to a WIM
81 * represented by a ::WIMStruct have no persistent effect until the WIM is
82 * actually written to an on-disk file. This can be done using wimlib_write(),
83 * but if the WIM was originally opened using wimlib_open_wim(), then
84 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
85 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
87 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
88 * files is a multi-step process. For example, to add, or "append" an image to
89 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
90 * append</b>, you must call the following functions:
92 * 1. wimlib_open_wim()
93 * 2. wimlib_add_image()
94 * 3. wimlib_overwrite()
96 * This design is very much on purpose as it makes the library more useful in
97 * general by allowing functions to be composed in different ways. For example,
98 * you can make multiple changes to a WIM and commit them all to the backing
99 * file in only one overwrite operation, which is more efficient.
101 * Note: before calling any other function declared in wimlib.h,
102 * wimlib_global_init() can (and in some cases, must) be called. See its
103 * documentation for more details.
105 * @section sec_cleaning_up Cleaning up
107 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
108 * all resources associated with it. Also, when you are completely done with
109 * using wimlib in your program, you can call wimlib_global_cleanup() to free
110 * any other resources allocated by the library.
112 * @section sec_error_handling Error Handling
114 * Most functions in wimlib return 0 on success and a positive
115 * ::wimlib_error_code value on failure. Use wimlib_get_error_string() to get a
116 * string that describes an error code. wimlib also can print error messages to
117 * standard error itself when an error happens, and these may be more
118 * informative than the error code; to enable this, call
119 * wimlib_set_print_errors(). Please note that this is for convenience only,
120 * and some errors can occur without a message being printed. Currently, error
121 * messages and strings (as well as all documentation, for that matter) are only
122 * 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 * A ::WIMStruct is not thread-safe and cannot be accessed by multiple threads
172 * concurrently, even for "read-only" operations such as extraction. However,
173 * users are free to use <i>different</i> ::WIMStruct's from different threads
174 * concurrently. It is even allowed for multiple ::WIMStruct's to be backed by
175 * the same on-disk WIM file, although "overwrites" should never be done in such
178 * In addition, several functions change global state and should only be called
179 * when a single thread is active in the library. These functions are:
181 * - wimlib_global_init()
182 * - wimlib_global_cleanup()
183 * - wimlib_set_memory_allocator()
184 * - wimlib_set_print_errors()
185 * - wimlib_set_error_file()
186 * - wimlib_set_error_file_by_name()
188 * @subsection subsec_limitations Limitations
190 * This section documents some technical limitations of wimlib not already
191 * described in the documentation for @b wimlib-imagex.
193 * - The old WIM format from Vista pre-releases is not supported.
194 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
195 * functionality other than that already present in @b ImageX, that allows you
196 * to make certain Windows-specific modifications to a Windows PE image, such
197 * as adding a driver or Windows component. Such a tool could be implemented
200 * @subsection more_info More information
202 * You are advised to read the README as well as the documentation for
203 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
204 * the API documentation.
207 /** @defgroup G_general General
209 * @brief Declarations and structures shared across the library.
212 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
214 * @brief Open an existing WIM file as a ::WIMStruct, or create a new
215 * ::WIMStruct which can be used to create a new WIM file.
218 /** @defgroup G_wim_information Retrieving WIM information and directory listings
220 * @brief Retrieve information about a WIM or WIM image.
223 /** @defgroup G_modifying_wims Modifying WIMs
225 * @brief Make changes to a ::WIMStruct, in preparation of persisting the
226 * ::WIMStruct to an on-disk file.
228 * @section sec_adding_images Capturing and adding WIM images
230 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
231 * appending an image to an existing WIM is a multi-step process, but at its
232 * core is wimlib_add_image() or an equivalent function. Normally,
233 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
234 * ::WIMStruct as a new image. However, when supported by the build of the
235 * library, there is also a special NTFS volume capture mode (entered when
236 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
237 * from an unmounted NTFS volume.
239 * Another function, wimlib_add_image_multisource() is also provided. It
240 * generalizes wimlib_add_image() to allow combining multiple files or directory
241 * trees into a single WIM image in a configurable way.
243 * For maximum customization of WIM image creation, it is also possible to add a
244 * completely empty WIM image with wimlib_add_empty_image(), then update it with
245 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
246 * wimlib_add_image_multisource() do internally.)
248 * Note that some details of how image addition/capture works are documented
249 * more fully in the documentation for <b>wimlib-imagex capture</b>.
251 * @section sec_deleting_images Deleting WIM images
253 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
254 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
255 * be made persistent in an on-disk WIM file.
257 * @section sec_exporting_images Exporting WIM images
259 * wimlib_export_image() can copy, or "export", an image from one WIM to
262 * @section sec_other_modifications Other modifications
264 * wimlib_update_image() can add, delete, and rename files in a WIM image.
266 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
267 * wimlib_set_image_flags() can change other image metadata.
269 * wimlib_set_wim_info() can change information about the WIM file itself, such
273 /** @defgroup G_extracting_wims Extracting WIMs
275 * @brief Extract files, directories, and images from a WIM.
277 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
278 * represented by a ::WIMStruct. This normally extracts the image to a
279 * directory, but when supported by the build of the library there is also a
280 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
281 * is specified) that allows extracting a WIM image directly to an unmounted
282 * NTFS volume. Various other flags allow further customization of image
285 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
286 * of (possibly wildcard) paths from a WIM image.
288 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
289 * over a pipe; see @ref subsec_pipable_wims.
291 * Some details of how WIM extraction works are described more fully in the
292 * documentation for <b>wimlib-imagex apply</b> and <b>wimlib-imagex
296 /** @defgroup G_mounting_wim_images Mounting WIM images
298 * @brief Mount and unmount WIM images.
300 * On Linux, wimlib supports mounting images from WIM files either read-only or
301 * read-write. To mount an image, call wimlib_mount_image(). To unmount an
302 * image, call wimlib_unmount_image(). Mounting can be done without root
303 * privileges because it is implemented using FUSE (Filesystem in Userspace).
305 * If wimlib is compiled using the <c>--without-fuse</c> flag, these functions
306 * will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
308 * Note: if mounting is unsupported, wimlib still provides another way to modify
309 * a WIM image (wimlib_update_image()).
313 * @defgroup G_progress Progress Messages
315 * @brief Track the progress of long WIM operations.
317 * Library users can provide a progress function which will be called
318 * periodically during operations such as extracting a WIM image or writing a
319 * WIM image. A ::WIMStruct can have a progress function of type
320 * ::wimlib_progress_func_t associated with it by calling
321 * wimlib_register_progress_function() or by opening the ::WIMStruct using
322 * wimlib_open_wim_with_progress(). Once this is done, the progress function
323 * will be called automatically during many operations, such as
324 * wimlib_extract_image() and wimlib_write().
326 * Some functions that do not operate directly on a user-provided ::WIMStruct,
327 * such as wimlib_join(), also take the progress function directly using an
328 * extended version of the function, such as wimlib_join_with_progress().
330 * In wimlib v1.7.0 and later, progress functions are no longer just
331 * unidirectional. You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
332 * the current operation to be aborted. wimlib v1.7.0 also added the third
333 * argument to ::wimlib_progress_func_t, which is a user-supplied context.
336 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
338 * @brief Create or update an on-disk WIM file.
340 * wimlib_write() creates a new on-disk WIM file, whereas wimlib_overwrite()
341 * updates an existing WIM file. See @ref sec_basic_wim_handling_concepts for
342 * more information about the API design.
345 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
347 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
349 * A ::WIMStruct backed by an on-disk file normally represents a fully
350 * standalone WIM archive. However, WIM archives can also be arranged in
351 * non-standalone ways, such as a set of on-disk files that together form a
352 * single "split WIM" or "delta WIM". Such arrangements are fully supported by
353 * wimlib. However, as a result, in such cases a ::WIMStruct created from one
354 * of these on-disk files initially only partially represents the full WIM and
355 * needs to, in effect, be logically combined with other ::WIMStruct's before
356 * performing certain operations, such as extracting files with
357 * wimlib_extract_image() or wimlib_extract_paths(). This is done by calling
358 * wimlib_reference_resource_files() or wimlib_reference_resources(). Note: if
359 * you fail to do so, you may see the error code
360 * ::WIMLIB_ERR_RESOURCE_NOT_FOUND; this just indicates that data is not
361 * available because the appropriate WIM files have not yet been referenced.
363 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
364 * specialized function (wimlib_split()) is needed to create a split WIM.
373 #include <inttypes.h>
376 /** @addtogroup G_general
379 /** Major version of the library (for example, the 1 in 1.2.5). */
380 #define WIMLIB_MAJOR_VERSION 1
382 /** Minor version of the library (for example, the 2 in 1.2.5). */
383 #define WIMLIB_MINOR_VERSION 8
385 /** Patch version of the library (for example, the 5 in 1.2.5). */
386 #define WIMLIB_PATCH_VERSION 0
393 * Opaque structure that represents a WIM, possibly backed by an on-disk file.
394 * See @ref sec_basic_wim_handling_concepts for more information.
396 #ifndef WIMLIB_WIMSTRUCT_DECLARED
397 typedef struct WIMStruct WIMStruct;
398 #define WIMLIB_WIMSTRUCT_DECLARED
402 typedef wchar_t wimlib_tchar;
404 /** See @ref sec_encodings */
405 typedef char wimlib_tchar;
409 /** Path separator for WIM paths passed back to progress callbacks.
410 * This is forward slash on UNIX and backslash on Windows. */
411 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
412 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
414 /** Path separator for WIM paths passed back to progress callbacks.
415 * This is forward slash on UNIX and backslash on Windows. */
416 # define WIMLIB_WIM_PATH_SEPARATOR '/'
417 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
420 /** Use this to specify the root directory of the WIM image. */
421 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
423 /** Use this to test if the specified path refers to the root directory of the
425 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
426 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
429 /** Length of a Globally Unique Identifier (GUID), in bytes. */
430 #define WIMLIB_GUID_LEN 16
433 * Specifies a compression type.
435 * A WIM file has a default compression type, indicated by its file header.
436 * Normally, each resource in the WIM file is compressed with this compression
437 * type. However, resources may be stored as uncompressed; for example, wimlib
438 * may do so if a resource does not compress to less than its original size. In
439 * addition, a WIM with the new version number of 3584, or "ESD file", might
440 * contain solid resources with different compression types.
442 enum wimlib_compression_type {
446 * This is a valid argument to wimlib_create_new_wim() and
447 * wimlib_set_output_compression_type(), but not to the functions in the
448 * compression API such as wimlib_create_compressor().
450 WIMLIB_COMPRESSION_TYPE_NONE = 0,
453 * The XPRESS compression format. This format combines Lempel-Ziv
454 * factorization with Huffman encoding. Compression and decompression
455 * are both fast. This format supports chunk sizes that are powers of 2
456 * between <c>2^12</c> and <c>2^16</c>, inclusively.
458 * wimlib's XPRESS compressor will, with the default settings, usually
459 * produce a better compression ratio, and work more quickly, than the
460 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
461 * Non-default compression levels are also supported. For example,
462 * level 80 will enable two-pass optimal parsing, which is significantly
463 * slower but usually improves compression by several percent over the
464 * default level of 50.
466 * If using wimlib_create_compressor() to create an XPRESS compressor
467 * directly, the @p max_block_size parameter may be any positive value
468 * up to and including <c>2^16</c>.
470 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
473 * The LZX compression format. This format combines Lempel-Ziv
474 * factorization with Huffman encoding, but with more features and
475 * complexity than XPRESS. Compression is slow to somewhat fast,
476 * depending on the settings. Decompression is fast but slower than
477 * XPRESS. This format supports chunk sizes that are powers of 2
478 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
479 * other than <c>2^15</c> are not compatible with the Microsoft
482 * wimlib's LZX compressor will, with the default settings, usually
483 * produce a better compression ratio, and work more quickly, than the
484 * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
485 * Non-default compression levels are also supported. For example,
486 * level 20 will provide fast compression, almost as fast as XPRESS.
488 * If using wimlib_create_compressor() to create an LZX compressor
489 * directly, the @p max_block_size parameter may be any positive value
490 * up to and including <c>2^21</c>.
492 WIMLIB_COMPRESSION_TYPE_LZX = 2,
495 * The LZMS compression format. This format combines Lempel-Ziv
496 * factorization with adaptive Huffman encoding and range coding.
497 * Compression and decompression are both fairly slow. This format
498 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
499 * <c>2^30</c>, inclusively. This format is best used for large chunk
500 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
501 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
502 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
503 * with the Microsoft implementation.
505 * wimlib's LZMS compressor will, with the default settings, usually
506 * produce a better compression ratio, and work more quickly, than the
507 * implementation in Microsoft's WIMGAPI (as of Windows 8.1). There is
508 * limited support for non-default compression levels, but compression
509 * will be noticably faster if you choose a level < 35.
511 * If using wimlib_create_compressor() to create an LZMS compressor
512 * directly, the @p max_block_size parameter may be any positive value
513 * up to and including <c>2^30</c>.
515 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
519 /** @addtogroup G_progress
522 /** Possible values of the first parameter to the user-supplied
523 * ::wimlib_progress_func_t progress function */
524 enum wimlib_progress_msg {
526 /** A WIM image is about to be extracted. @p info will point to
527 * ::wimlib_progress_info.extract. This message is received once per
528 * image for calls to wimlib_extract_image() and
529 * wimlib_extract_image_from_pipe(). */
530 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
532 /** One or more file or directory trees within a WIM image is about to
533 * be extracted. @p info will point to ::wimlib_progress_info.extract.
534 * This message is received only once per wimlib_extract_paths() and
535 * wimlib_extract_pathlist(), since wimlib combines all paths into a
536 * single extraction operation for optimization purposes. */
537 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
539 /** This message may be sent periodically (not for every file) while
540 * files and directories are being created, prior to file data
541 * extraction. @p info will point to ::wimlib_progress_info.extract.
542 * In particular, the @p current_file_count and @p end_file_count
543 * members may be used to track the progress of this phase of
545 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
547 /** File data is currently being extracted. @p info will point to
548 * ::wimlib_progress_info.extract. This is the main message to track
549 * the progress of an extraction operation. */
550 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
552 /** Starting to read a new part of a split pipable WIM over the pipe.
553 * @p info will point to ::wimlib_progress_info.extract. */
554 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
556 /** This message may be sent periodically (not necessarily for every
557 * file) while file and directory metadata is being extracted, following
558 * file data extraction. @p info will point to
559 * ::wimlib_progress_info.extract. The @p current_file_count and @p
560 * end_file_count members may be used to track the progress of this
561 * phase of extraction. */
562 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
564 /** The image has been successfully extracted. @p info will point to
565 * ::wimlib_progress_info.extract. This is paired with
566 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
567 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
569 /** The files or directory trees have been successfully extracted. @p
570 * info will point to ::wimlib_progress_info.extract. This is paired
571 * with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
572 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
574 /** The directory or NTFS volume is about to be scanned for metadata.
575 * @p info will point to ::wimlib_progress_info.scan. This message is
576 * received once per call to wimlib_add_image(), or once per capture
577 * source passed to wimlib_add_image_multisource(), or once per add
578 * command passed to wimlib_update_image(). */
579 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
581 /** A directory or file has been scanned. @p info will point to
582 * ::wimlib_progress_info.scan, and its @p cur_path member will be
583 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
585 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
587 /** The directory or NTFS volume has been successfully scanned. @p info
588 * will point to ::wimlib_progress_info.scan. This is paired with a
589 * previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message, possibly with many
590 * intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY messages. */
591 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
593 /** File data is currently being written to the WIM. @p info will point
594 * to ::wimlib_progress_info.write_streams. This message may be
595 * received many times while the WIM file is being written or appended
596 * to with wimlib_write(), wimlib_overwrite(), or wimlib_write_to_fd().
598 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
600 /** Per-image metadata is about to be written to the WIM file. @p info
601 * will not be valid. */
602 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
604 /** The per-image metadata has been written to the WIM file. @p info
605 * will not be valid. This message is paired with a preceding
606 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message. */
607 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
609 /** wimlib_overwrite() has successfully renamed the temporary file to
610 * the original WIM file, thereby committing the changes to the WIM
611 * file. @p info will point to ::wimlib_progress_info.rename. Note:
612 * this message is not received if wimlib_overwrite() chose to append to
613 * the WIM file in-place. */
614 WIMLIB_PROGRESS_MSG_RENAME = 15,
616 /** The contents of the WIM file are being checked against the integrity
617 * table. @p info will point to ::wimlib_progress_info.integrity. This
618 * message is only received (and may be received many times) when
619 * wimlib_open_wim_with_progress() is called with the
620 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
621 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
623 /** An integrity table is being calculated for the WIM being written.
624 * @p info will point to ::wimlib_progress_info.integrity. This message
625 * is only received (and may be received many times) when a WIM file is
626 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
627 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
629 /** A wimlib_split() operation is in progress, and a new split part is
630 * about to be started. @p info will point to
631 * ::wimlib_progress_info.split. */
632 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
634 /** A wimlib_split() operation is in progress, and a split part has been
635 * finished. @p info will point to ::wimlib_progress_info.split. */
636 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
638 /** A WIM update command is about to be executed. @p info will point to
639 * ::wimlib_progress_info.update. This message is received once per
640 * update command when wimlib_update_image() is called with the flag
641 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
642 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
644 /** A WIM update command has been executed. @p info will point to
645 * ::wimlib_progress_info.update. This message is received once per
646 * update command when wimlib_update_image() is called with the flag
647 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
648 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
650 /** A file in the WIM image is being replaced as a result of a
651 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
652 * @p info will point to ::wimlib_progress_info.replace. This is only
653 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
655 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
657 /** A WIM image is being extracted with ::WIMLIB_EXTRACT_FLAG_WIMBOOT,
658 * and a file is being extracted normally (not as a "WIMBoot pointer
659 * file") due to it matching a pattern in the <c>[PrepopulateList]</c>
660 * section of the configuration file
661 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image. @p
662 * info will point to ::wimlib_progress_info.wimboot_exclude. */
663 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
665 /** Starting to unmount a WIM image. @p info will point to
666 * ::wimlib_progress_info.unmount. */
667 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
669 /** wimlib has used a file's data for the last time (including all data
670 * streams, if it has multiple). @p info will point to
671 * ::wimlib_progress_info.done_with_file. This message is only received
672 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
673 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
675 /** wimlib_verify_wim() is starting to verify the metadata for an image.
676 * @p info will point to ::wimlib_progress_info.verify_image. */
677 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
679 /** wimlib_verify_wim() has finished verifying the metadata for an
680 * image. @p info will point to ::wimlib_progress_info.verify_image.
682 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
684 /** wimlib_verify_wim() is verifying file data integrity. @p info will
685 * point to ::wimlib_progress_info.verify_streams. */
686 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
689 * The progress function is being asked whether a file should be
690 * excluded from capture or not. @p info will point to
691 * ::wimlib_progress_info.test_file_exclusion. This is a bidirectional
692 * message that allows the progress function to set a flag if the file
693 * should be excluded.
695 * This message is only received if the flag
696 * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used. This method for file
697 * exclusions is independent of the "capture configuration file"
700 WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
703 * An error has occurred and the progress function is being asked
704 * whether to ignore the error or not. @p info will point to
705 * ::wimlib_progress_info.handle_error. This is a bidirectional
708 * This message provides a limited capability for applications to
709 * recover from "unexpected" errors (i.e. those with no in-library
710 * handling policy) arising from the underlying operating system.
711 * Normally, any such error will cause the library to abort the current
712 * operation. By implementing a handler for this message, the
713 * application can instead choose to ignore a given error.
715 * Currently, only the following types of errors will result in this
716 * progress message being sent:
718 * - Directory tree scan errors, e.g. from wimlib_add_image()
719 * - Most extraction errors; currently restricted to the Windows
720 * build of the library only.
722 WIMLIB_PROGRESS_MSG_HANDLE_ERROR = 31,
725 /** Valid return values from user-provided progress functions
726 * (::wimlib_progress_func_t).
728 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
731 enum wimlib_progress_status {
733 /** The operation should be continued. This is the normal return value.
735 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
737 /** The operation should be aborted. This will cause the current
738 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
739 WIMLIB_PROGRESS_STATUS_ABORT = 1,
743 * A pointer to this union is passed to the user-supplied
744 * ::wimlib_progress_func_t progress function. One (or none) of the structures
745 * contained in this union will be applicable for the operation
746 * (::wimlib_progress_msg) indicated in the first argument to the progress
748 union wimlib_progress_info {
750 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
751 * the primary message for tracking the progress of writing a WIM file.
753 struct wimlib_progress_info_write_streams {
755 /** An upper bound on the number of bytes of file data that will
756 * be written. This number is the uncompressed size; the actual
757 * size may be lower due to compression. In addition, this
758 * number may decrease over time as duplicated file data is
760 uint64_t total_bytes;
762 /** An upper bound on the number of distinct file data "blobs"
763 * that will be written. This will often be similar to the
764 * "number of files", but for several reasons (hard links, named
765 * data streams, empty files, etc.) it can be different. In
766 * addition, this number may decrease over time as duplicated
767 * file data is discovered. */
768 uint64_t total_streams;
770 /** The number of bytes of file data that have been written so
771 * far. This starts at 0 and ends at @p total_bytes. This
772 * number is the uncompressed size; the actual size may be lower
773 * due to compression. */
774 uint64_t completed_bytes;
776 /** The number of distinct file data "blobs" that have been
777 * written so far. This starts at 0 and ends at @p
779 uint64_t completed_streams;
781 /** The number of threads being used for data compression; or,
782 * if no compression is being peformed, this will be 1. */
783 uint32_t num_threads;
785 /** The compression type being used, as one of the
786 * ::wimlib_compression_type constants. */
787 int32_t compression_type;
789 /** The number of on-disk WIM files from which file data is
790 * being exported into the output WIM file. This can be 0, 1,
791 * or more than 1, depending on the situation. */
792 uint32_t total_parts;
794 /** This is currently broken and will always be 0. */
795 uint32_t completed_parts;
798 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
799 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
800 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
801 struct wimlib_progress_info_scan {
803 /** Top-level directory being scanned; or, when capturing an NTFS
804 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
805 * to the file or block device that contains the NTFS volume
807 const wimlib_tchar *source;
809 /** Path to the file (or directory) that has been scanned, valid
810 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
811 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
812 * relative to the root of the NTFS volume. */
813 const wimlib_tchar *cur_path;
815 /** Dentry scan status, valid on
816 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
818 /** File looks okay and will be captured. */
819 WIMLIB_SCAN_DENTRY_OK = 0,
821 /** File is being excluded from capture due to the
822 * capture configuration. */
823 WIMLIB_SCAN_DENTRY_EXCLUDED,
825 /** File is being excluded from capture due to being of
826 * an unsupported type. */
827 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
829 /** The file is an absolute symbolic link or junction
830 * that points into the capture directory, and
831 * reparse-point fixups are enabled, so its target is
832 * being adjusted. (Reparse point fixups can be
833 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
835 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
837 /** Reparse-point fixups are enabled, but the file is an
838 * absolute symbolic link or junction that does
839 * <b>not</b> point into the capture directory, so its
840 * target is <b>not</b> being adjusted. */
841 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
845 /** Target path in the WIM image. Only valid on
846 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
847 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
848 const wimlib_tchar *wim_target_path;
850 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
851 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
852 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
853 * target of the absolute symbolic link or junction. */
854 const wimlib_tchar *symlink_target;
857 /** The number of directories scanned so far, not counting
858 * excluded/unsupported files. */
859 uint64_t num_dirs_scanned;
861 /** The number of non-directories scanned so far, not counting
862 * excluded/unsupported files. If a file has multiple names
863 * (hard links), it is only counted one time. */
864 uint64_t num_nondirs_scanned;
866 /** The number of bytes of file data detected so far, not
867 * counting excluded/unsupported files. If a file has multiple
868 * names (hard links), its data is counted only one time. */
869 uint64_t num_bytes_scanned;
872 /** Valid on messages
873 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
874 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
875 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
876 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
877 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
878 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
879 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
880 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
882 * Note: most of the time of an extraction operation will be spent
883 * extracting file data, and the application will receive
884 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
885 * completed_bytes and @p total_bytes, the application can calculate a
886 * percentage complete. However, there is no way for applications to
887 * know which file is currently being extracted. This is by design
888 * because the best way to complete the extraction operation is not
889 * necessarily file-by-file.
891 struct wimlib_progress_info_extract {
893 /** The 1-based index of the image from which files are being
897 /** Extraction flags being used. */
898 uint32_t extract_flags;
900 /** If the ::WIMStruct from which the extraction being performed
901 * has a backing file, then this is an absolute path to that
902 * backing file. Otherwise, this is @c NULL. */
903 const wimlib_tchar *wimfile_name;
905 /** Name of the image from which files are being extracted, or
906 * the empty string if the image is unnamed. */
907 const wimlib_tchar *image_name;
909 /** Path to the directory or NTFS volume to which the files are
910 * being extracted. */
911 const wimlib_tchar *target;
914 const wimlib_tchar *reserved;
916 /** The number of bytes of file data that will be extracted. */
917 uint64_t total_bytes;
919 /** The number of bytes of file data that have been extracted so
920 * far. This starts at 0 and ends at @p total_bytes. */
921 uint64_t completed_bytes;
923 /** The number of file streams that will be extracted. This
924 * will often be similar to the "number of files", but for
925 * several reasons (hard links, named data streams, empty files,
926 * etc.) it can be different. */
927 uint64_t total_streams;
929 /** The number of file streams that have been extracted so far.
930 * This starts at 0 and ends at @p total_streams. */
931 uint64_t completed_streams;
933 /** Currently only used for
934 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
935 uint32_t part_number;
937 /** Currently only used for
938 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
939 uint32_t total_parts;
941 /** Currently only used for
942 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
943 uint8_t guid[WIMLIB_GUID_LEN];
945 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
946 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
947 * number of files that have been processed so far. Once the
948 * corresponding phase of extraction is complete, this value
949 * will be equal to @c end_file_count. */
950 uint64_t current_file_count;
952 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
953 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
954 * total number of files that will be processed.
956 * This number is provided for informational purposes only, e.g.
957 * for a progress bar. This number will not necessarily be
958 * equal to the number of files actually being extracted. This
959 * is because extraction backends are free to implement an
960 * extraction algorithm that might be more efficient than
961 * processing every file in the "extract file structure" and
962 * "extract file metadata" phases. For example, the current
963 * implementation of the UNIX extraction backend will create
964 * files on-demand during the "extract file data" phase.
965 * Therefore, when using that particular extraction backend, @p
966 * end_file_count will only include directories and empty files.
968 uint64_t end_file_count;
971 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
972 struct wimlib_progress_info_rename {
973 /** Name of the temporary file that the WIM was written to. */
974 const wimlib_tchar *from;
976 /** Name of the original WIM file to which the temporary file is
978 const wimlib_tchar *to;
981 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
982 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
983 struct wimlib_progress_info_update {
984 /** Pointer to the update command that will be executed or has
985 * just been executed. */
986 const struct wimlib_update_command *command;
988 /** Number of update commands that have been completed so far.
990 size_t completed_commands;
992 /** Number of update commands that are being executed as part of
993 * this call to wimlib_update_image(). */
994 size_t total_commands;
997 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
998 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
999 struct wimlib_progress_info_integrity {
1001 /** The number of bytes in the WIM file that are covered by
1002 * integrity checks. */
1003 uint64_t total_bytes;
1005 /** The number of bytes that have been processed so far. This
1006 * starts at 0 and ends at @p total_bytes. */
1007 uint64_t completed_bytes;
1009 /** The number of individually checksummed "chunks" the
1010 * integrity-checked region is divided into. */
1011 uint32_t total_chunks;
1013 /** The number of chunks that have been processed so far. This
1014 * starts at 0 and ends at @p total_chunks. */
1015 uint32_t completed_chunks;
1017 /** The size of each individually checksummed "chunk" in the
1018 * integrity-checked region. */
1019 uint32_t chunk_size;
1021 /** For ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages, this is
1022 * the path to the WIM file being checked. */
1023 const wimlib_tchar *filename;
1026 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1027 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1028 struct wimlib_progress_info_split {
1029 /** Total size of the original WIM's file and metadata resources
1031 uint64_t total_bytes;
1033 /** Number of bytes of file and metadata resources that have
1034 * been copied out of the original WIM so far. Will be 0
1035 * initially, and equal to @p total_bytes at the end. */
1036 uint64_t completed_bytes;
1038 /** Number of the split WIM part that is about to be started
1039 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1040 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1041 unsigned cur_part_number;
1043 /** Total number of split WIM parts that are being written. */
1044 unsigned total_parts;
1046 /** Name of the split WIM part that is about to be started
1047 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1048 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1049 * As of wimlib v1.7.0, the library user may change this when
1050 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1051 * cause the next split WIM part to be written to a different
1053 wimlib_tchar *part_name;
1056 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1057 struct wimlib_progress_info_replace {
1058 /** Path to the file in the WIM image that is being replaced */
1059 const wimlib_tchar *path_in_wim;
1062 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1063 struct wimlib_progress_info_wimboot_exclude {
1064 /** Path to the file in the WIM image */
1065 const wimlib_tchar *path_in_wim;
1067 /** Path to which the file is being extracted */
1068 const wimlib_tchar *extraction_path;
1071 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1072 struct wimlib_progress_info_unmount {
1073 /** Path to directory being unmounted */
1074 const wimlib_tchar *mountpoint;
1076 /** Path to WIM file being unmounted */
1077 const wimlib_tchar *mounted_wim;
1079 /** 1-based index of image being unmounted. */
1080 uint32_t mounted_image;
1082 /** Flags that were passed to wimlib_mount_image() when the
1083 * mountpoint was set up. */
1084 uint32_t mount_flags;
1086 /** Flags passed to wimlib_unmount_image(). */
1087 uint32_t unmount_flags;
1090 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1091 struct wimlib_progress_info_done_with_file {
1093 * Path to the file whose data has been written to the WIM file,
1094 * or is currently being asynchronously compressed in memory,
1095 * and therefore is no longer needed by wimlib.
1097 * WARNING: The file data will not actually be accessible in the
1098 * WIM file until the WIM file has been completely written.
1099 * Ordinarily you should <b>not</b> treat this message as a
1100 * green light to go ahead and delete the specified file, since
1101 * that would result in data loss if the WIM file cannot be
1102 * successfully created for any reason.
1104 * If a file has multiple names (hard links),
1105 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1106 * for one name. Also, this message will not be received for
1107 * empty files or reparse points (or symbolic links), unless
1108 * they have nonempty named data streams.
1110 const wimlib_tchar *path_to_file;
1113 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1114 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1115 struct wimlib_progress_info_verify_image {
1116 const wimlib_tchar *wimfile;
1117 uint32_t total_images;
1118 uint32_t current_image;
1121 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1122 struct wimlib_progress_info_verify_streams {
1123 const wimlib_tchar *wimfile;
1124 uint64_t total_streams;
1125 uint64_t total_bytes;
1126 uint64_t completed_streams;
1127 uint64_t completed_bytes;
1130 /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION. */
1131 struct wimlib_progress_info_test_file_exclusion {
1134 * Path to the file for which exclusion is being tested.
1136 * UNIX capture mode: The path will be a standard relative or
1137 * absolute UNIX filesystem path.
1139 * NTFS-3g capture mode: The path will be given relative to the
1140 * root of the NTFS volume, with a leading slash.
1142 * Windows capture mode: The path will be a Win32 namespace
1145 const wimlib_tchar *path;
1148 * Indicates whether the file or directory will be excluded from
1149 * capture or not. This will be <c>false</c> by default. The
1150 * progress function can set this to <c>true</c> if it decides
1151 * that the file needs to be excluded.
1154 } test_file_exclusion;
1156 /** Valid on messages ::WIMLIB_PROGRESS_MSG_HANDLE_ERROR. */
1157 struct wimlib_progress_info_handle_error {
1159 /** Path to the file for which the error occurred, or NULL if
1161 const wimlib_tchar *path;
1163 /** The wimlib error code associated with the error. */
1167 * Indicates whether the error will be ignored or not. This
1168 * will be <c>false</c> by default; the progress function may
1169 * set it to <c>true</c>.
1176 * A user-supplied function that will be called periodically during certain WIM
1179 * The first argument will be the type of operation that is being performed or
1180 * is about to be started or has been completed.
1182 * The second argument will be a pointer to one of a number of structures
1183 * depending on the first argument. It may be @c NULL for some message types.
1184 * Note that although this argument is not @c const, users should not modify it
1185 * except in explicitly documented cases.
1187 * The third argument will be a user-supplied value that was provided when
1188 * registering or specifying the progress function.
1190 * This function must return one of the ::wimlib_progress_status values. By
1191 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1193 typedef enum wimlib_progress_status
1194 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1195 union wimlib_progress_info *info,
1199 /** @addtogroup G_modifying_wims
1202 /** An array of these structures is passed to wimlib_add_image_multisource() to
1203 * specify the sources from which to create a WIM image. */
1204 struct wimlib_capture_source {
1205 /** Absolute or relative path to a file or directory on the external
1206 * filesystem to be included in the WIM image. */
1207 wimlib_tchar *fs_source_path;
1209 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1210 * specify the root directory of the WIM image. */
1211 wimlib_tchar *wim_target_path;
1213 /** Reserved; set to 0. */
1217 /** Set or unset the "readonly" WIM header flag (<c>WIM_HDR_FLAG_READONLY</c> in
1218 * Microsoft's documentation), based on the ::wimlib_wim_info.is_marked_readonly
1219 * member of the @p info parameter. This is distinct from basic file
1220 * permissions; this flag can be set on a WIM file that is physically writable.
1222 * wimlib disallows modifying on-disk WIM files with the readonly flag set.
1223 * However, wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG
1224 * will override this --- and in fact, this is necessary to set the readonly
1225 * flag persistently on an existing WIM file.
1227 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1229 /** Set the GUID (globally unique identifier) of the WIM file to the value
1230 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1231 #define WIMLIB_CHANGE_GUID 0x00000002
1233 /** Change the bootable image of the WIM to the value specified in
1234 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1235 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1237 /** Change the <c>WIM_HDR_FLAG_RP_FIX</c> flag of the WIM file to the value
1238 * specified in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag
1239 * generally indicates whether an image in the WIM has been captured with
1240 * reparse-point fixups enabled. wimlib also treats this flag as specifying
1241 * whether to do reparse-point fixups by default when capturing or applying WIM
1243 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1247 /** @addtogroup G_wim_information */
1252 * General information about a WIM file.
1254 * This info can also be requested for a ::WIMStruct that does not have a
1255 * backing file. In this case, fields that only make sense given a backing file
1256 * are set to default values.
1258 struct wimlib_wim_info {
1260 /** The globally unique identifier for this WIM. (Note: all parts of a
1261 * split WIM normally have identical GUIDs.) */
1262 uint8_t guid[WIMLIB_GUID_LEN];
1264 /** The number of images in this WIM file. */
1265 uint32_t image_count;
1267 /** The 1-based index of the bootable image in this WIM file, or 0 if no
1268 * image is bootable. */
1269 uint32_t boot_index;
1271 /** The version of the WIM file format used in this WIM file. */
1272 uint32_t wim_version;
1274 /** The default compression chunk size of resources in this WIM file.
1276 uint32_t chunk_size;
1278 /** For split WIMs, the 1-based index of this part within the split WIM;
1280 uint16_t part_number;
1282 /** For split WIMs, the total number of parts in the split WIM;
1284 uint16_t total_parts;
1286 /** The default compression type of resources in this WIM file, as one
1287 * of the ::wimlib_compression_type constants. */
1288 int32_t compression_type;
1290 /** The size of this WIM file in bytes, excluding the XML data and
1291 * integrity table. */
1292 uint64_t total_bytes;
1294 /** 1 iff this WIM file has an integrity table. */
1295 uint32_t has_integrity_table : 1;
1297 /** 1 iff this info struct is for a ::WIMStruct that has a backing file.
1299 uint32_t opened_from_file : 1;
1301 /** 1 iff this WIM file is considered readonly for any reason. */
1302 uint32_t is_readonly : 1;
1304 /** 1 iff reparse-point fixups are enabled for one or more images in
1306 uint32_t has_rpfix : 1;
1308 /** 1 iff this WIM file is marked read-only in its header. */
1309 uint32_t is_marked_readonly : 1;
1311 /** 1 iff this WIM file is part of a spanned set. */
1312 uint32_t spanned : 1;
1314 uint32_t write_in_progress : 1;
1315 uint32_t metadata_only : 1;
1316 uint32_t resource_only : 1;
1318 /** 1 iff this WIM file is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1319 uint32_t pipable : 1;
1320 uint32_t reserved_flags : 22;
1321 uint32_t reserved[9];
1325 * Information about a "blob", which is a fixed length sequence of binary data.
1326 * Each nonempty stream of each file in a WIM image is associated with a blob.
1327 * Blobs are deduplicated within a WIM file.
1329 * TODO: this struct needs to be renamed, and perhaps made into a union since
1330 * there are several cases. I'll try to list them below:
1332 * 1. The blob is "missing", meaning that it is referenced by hash but not
1333 * actually present in the WIM file. In this case we only know the
1334 * sha1_hash. This case can only occur with wimlib_iterate_dir_tree(), never
1335 * wimlib_iterate_lookup_table().
1337 * 2. Otherwise we know the sha1_hash, the uncompressed_size, the
1338 * reference_count, and the is_metadata flag. In addition:
1340 * A. If the blob is located in a non-solid WIM resource, then we also know
1341 * the compressed_size and offset.
1343 * B. If the blob is located in a solid WIM resource, then we also know the
1344 * offset, raw_resource_offset_in_wim, raw_resource_compressed_size, and
1345 * raw_resource_uncompressed_size. But the "offset" is actually the
1346 * offset in the uncompressed solid resource rather than the offset from
1347 * the beginning of the WIM file.
1349 * C. If the blob is *not* located in any type of WIM resource, then we don't
1350 * know any additional information.
1352 * Unknown or irrelevant fields are left zeroed.
1354 struct wimlib_resource_entry {
1356 /** If this blob is not missing, then this is the uncompressed size of
1357 * this blob in bytes. */
1358 uint64_t uncompressed_size;
1360 /** If this blob is located in a non-solid WIM resource, then this is
1361 * the compressed size of that resource. */
1362 uint64_t compressed_size;
1364 /** If this blob is located in a non-solid WIM resource, then this is
1365 * the offset of that resource within the WIM file containing it. If
1366 * this blob is located in a solid WIM resource, then this is the offset
1367 * of this blob within that solid resource when uncompressed. */
1370 /** The SHA-1 message digest of the blob's uncompressed contents. */
1371 uint8_t sha1_hash[20];
1373 /** If this blob is located in a WIM resource, then this is the part
1374 * number of the WIM file containing it. */
1375 uint32_t part_number;
1377 /** If this blob is not missing, then this is the number of times this
1378 * blob is referenced over all images in the WIM. This number is not
1379 * guaranteed to be correct. */
1380 uint32_t reference_count;
1382 /** 1 iff this blob is located in a non-solid compressed WIM resource.
1384 uint32_t is_compressed : 1;
1386 /** 1 iff this blob contains the metadata for an image. */
1387 uint32_t is_metadata : 1;
1389 uint32_t is_free : 1;
1390 uint32_t is_spanned : 1;
1392 /** 1 iff a blob with this hash was not found in the blob lookup table
1393 * of the ::WIMStruct. This normally implies a missing call to
1394 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1395 uint32_t is_missing : 1;
1397 /** 1 iff this blob is located in a solid resource. */
1398 uint32_t packed : 1;
1400 uint32_t reserved_flags : 26;
1402 /** If this blob is located in a solid WIM resource, then this is the
1403 * offset of that solid resource within the WIM file containing it. */
1404 uint64_t raw_resource_offset_in_wim;
1406 /** If this blob is located in a solid WIM resource, then this is the
1407 * compressed size of that solid resource. */
1408 uint64_t raw_resource_compressed_size;
1410 /** If this blob is located in a solid WIM resource, then this is the
1411 * uncompressed size of that solid resource. */
1412 uint64_t raw_resource_uncompressed_size;
1414 uint64_t reserved[1];
1418 * Information about a stream of a particular file in the WIM.
1420 * Normally, only WIM images captured from NTFS filesystems will have multiple
1421 * streams per file. In practice, this is a rarely used feature of the
1424 * TODO: the library now explicitly tracks stream types, which allows it to have
1425 * multiple unnamed streams (e.g. both a reparse point stream and unnamed data
1426 * stream). However, this isn't yet exposed by wimlib_iterate_dir_tree().
1428 struct wimlib_stream_entry {
1430 /** Name of the stream, or NULL if the stream is unnamed. */
1431 const wimlib_tchar *stream_name;
1433 /** Info about this stream's data, such as its hash and size if known.*/
1434 struct wimlib_resource_entry resource;
1436 uint64_t reserved[4];
1439 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1440 * Roughly, the information about a "file" in the WIM--- but really a directory
1441 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1442 * field can be used to distinguish actual file inodes. */
1443 struct wimlib_dir_entry {
1444 /** Name of the file, or NULL if this file is unnamed. Only the root
1445 * directory of an image will be unnamed. */
1446 const wimlib_tchar *filename;
1448 /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1449 * this file has no such name. */
1450 const wimlib_tchar *dos_name;
1452 /** Full path to this file within the WIM image. Path separators will
1453 * be ::WIMLIB_WIM_PATH_SEPARATOR. */
1454 const wimlib_tchar *full_path;
1456 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1457 * children, ..., etc. */
1460 /** Pointer to the security descriptor for this file, in Windows
1461 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1462 * security descriptor. */
1463 const char *security_descriptor;
1465 /** Length of the above security descriptor. */
1466 size_t security_descriptor_size;
1468 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1469 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1470 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1471 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1472 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1473 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1474 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1475 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1476 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1477 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1478 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1479 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1480 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1481 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1482 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1483 /** File attributes, such as whether the file is a directory or not.
1484 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1485 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1486 * on other platforms. */
1487 uint32_t attributes;
1489 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1490 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1491 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1492 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1493 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1494 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1495 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1496 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1497 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1498 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1499 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1500 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1501 /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1502 * the attributes), this will give the reparse tag. This tells you
1503 * whether the reparse point is a symbolic link, junction point, or some
1504 * other, more unusual kind of reparse point. */
1505 uint32_t reparse_tag;
1507 /** Number of links to this file's inode (hard links).
1509 * Currently, this will always be 1 for directories. However, it can be
1510 * greater than 1 for nondirectory files. */
1513 /** Number of named data streams this file has. Normally 0. */
1514 uint32_t num_named_streams;
1516 /** A unique identifier for this file's inode. However, as a special
1517 * case, if the inode only has a single link (@p num_links == 1), this
1520 * Note: if a WIM image is captured from a filesystem, this value is not
1521 * guaranteed to be the same as the original number of the inode on the
1523 uint64_t hard_link_group_id;
1525 /** Time this file was created. */
1526 struct timespec creation_time;
1528 /** Time this file was last written to. */
1529 struct timespec last_write_time;
1531 /** Time this file was last accessed. */
1532 struct timespec last_access_time;
1534 /** The UNIX user ID of this file. This is a wimlib extension.
1536 * This field is only valid if @p unix_mode != 0. */
1539 /** The UNIX group ID of this file. This is a wimlib extension.
1541 * This field is only valid if @p unix_mode != 0. */
1544 /** The UNIX mode of this file. This is a wimlib extension.
1546 * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1547 * @p unix_rdev are all unknown (fields are not present in the WIM
1551 /** The UNIX device ID (major and minor number) of this file. This is a
1554 * This field is only valid if @p unix_mode != 0. */
1557 uint64_t reserved[14];
1560 * Array of streams that make up this file.
1562 * The first entry will always exist and will correspond to the unnamed
1563 * data stream (default file contents), so it will have <c>stream_name
1564 * == NULL</c>. Alternatively, for reparse point files, the first entry
1565 * will correspond to the reparse data stream. Alternatively, for
1566 * encrypted files, the first entry will correspond to the encrypted
1569 * Then, following the first entry, there be @p num_named_streams
1570 * additional entries that specify the named data streams, if any, each
1571 * of which will have <c>stream_name != NULL</c>.
1573 struct wimlib_stream_entry streams[];
1577 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1580 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1584 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1587 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1590 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1591 * just on the specified path. */
1592 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1594 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1595 * itself; only its children (in the case of a non-empty directory) */
1596 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1598 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any file data blobs needed to fill
1599 * in the ::wimlib_resource_entry's for the iteration cannot be found in the
1600 * blob lookup table of the ::WIMStruct. The default behavior without this flag
1601 * is to fill in the @ref wimlib_resource_entry::sha1_hash "sha1_hash" and set
1602 * the @ref wimlib_resource_entry::is_missing "is_missing" flag. */
1603 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1607 /** @addtogroup G_modifying_wims
1610 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1611 * generic directory. This requires that wimlib was compiled with support for
1614 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1615 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1617 * Do not use this flag on Windows, where wimlib already supports all
1618 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1619 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1621 /** Follow symbolic links when scanning the directory tree. Currently only
1622 * supported on UNIX-like systems. */
1623 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1625 /** Call the progress function with the message
1626 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1628 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1630 /** Mark the image being added as the bootable image of the WIM. This flag is
1631 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1633 * Note that you can also change the bootable image of a WIM using
1634 * wimlib_set_wim_info().
1636 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1637 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1638 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1640 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1641 * (major and minor number) of each file. In addition, capture special files
1642 * such as device nodes and FIFOs. See the documentation for the
1643 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1645 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1647 /** Do not capture security descriptors. Only has an effect in NTFS capture
1648 * mode, or in Windows native builds. */
1649 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1651 /** Fail immediately if the full security descriptor of any file or directory
1652 * cannot be accessed. Only has an effect in Windows native builds. The
1653 * default behavior without this flag is to first try omitting the SACL from the
1654 * security descriptor, then to try omitting the security descriptor entirely.
1656 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1658 /** Call the progress function with the message
1659 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1660 * capture. This is a subset of the messages provided by
1661 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1662 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1664 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1665 * case of Windows) that point inside the directory being captured to instead be
1666 * absolute relative to the directory being captured.
1668 * Without this flag, the default is to do reparse-point fixups if
1669 * <c>WIM_HDR_FLAG_RP_FIX</c> is set in the WIM header or if this is the first
1670 * image being added. */
1671 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1673 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1674 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1676 /** Do not automatically exclude unsupported files or directories from capture,
1677 * such as encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1678 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1679 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1680 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1683 * Automatically select a capture configuration appropriate for capturing
1684 * filesystems containing Windows operating systems. For example,
1685 * <c>/pagefile.sys</c> and <c>"/System Volume Information"</c> will be
1688 * When this flag is specified, the corresponding @p config parameter (for
1689 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1690 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1692 * Note that the default behavior--- that is, when neither
1693 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1694 * config is @c NULL--- is to use no capture configuration, meaning that no
1695 * files are excluded from capture.
1697 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1700 * Capture image as "WIMBoot compatible". In addition, if no capture
1701 * configuration file is explicitly specified use the capture configuration file
1702 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1703 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1704 * configuration file is explicitly specified, use it and also place it at
1705 * <c>/Windows/System32/WimBootCompress.ini</c> in the WIM image.
1707 * This flag does not, by itself, change the compression type or chunk size.
1708 * Before writing the WIM file, you may wish to set the compression format to
1709 * be the same as that used by WIMGAPI and DISM:
1712 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1713 * wimlib_set_output_chunk_size(wim, 4096);
1716 * However, "WIMBoot" also works with other XPRESS chunk sizes as well as LZX
1717 * with 32768 byte chunks.
1719 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1720 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1722 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1725 * If the add command involves adding a non-directory file to a location at
1726 * which there already exists a nondirectory file in the WIM image, issue
1727 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1728 * effect when updating an existing image with wimlib_update_image().
1729 * This was the default behavior in wimlib v1.6.2 and earlier.
1731 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1734 * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1737 * Note: This method for file exclusions is independent from the capture
1738 * configuration file mechanism.
1740 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1742 /* Note: the WIMLIB_ADD_IMAGE_FLAG names are retained for source compatibility.
1743 * Use the WIMLIB_ADD_FLAG names in new code. */
1744 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1745 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1746 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1747 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1748 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1749 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1750 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1751 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1752 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1753 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1754 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1755 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1756 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1757 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1761 /** @addtogroup G_modifying_wims
1764 /** Do not issue an error if the path to delete does not exist. */
1765 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1767 /** Delete the file or directory tree recursively; if not specified, an error is
1768 * issued if the path to delete is a directory. */
1769 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1772 /** @addtogroup G_modifying_wims
1776 * If a single image is being exported, mark it bootable in the destination WIM.
1777 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1778 * the image in the source WIM (if any) that is marked as bootable is also
1779 * marked as bootable in the destination WIM.
1781 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1783 /** Give the exported image(s) no names. Avoids problems with image name
1786 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1788 /** Give the exported image(s) no descriptions. */
1789 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1791 /** This advises the library that the program is finished with the source
1792 * WIMStruct and will not attempt to access it after the call to
1793 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1794 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1797 * Mark each exported image as WIMBoot-compatible.
1799 * Note: by itself, this does change the destination WIM's compression type, nor
1800 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1801 * image. Before writing the destination WIM, it's recommended to do something
1805 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1806 * wimlib_set_output_chunk_size(wim, 4096);
1807 * wimlib_add_tree(wim, image, L"myconfig.ini",
1808 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1811 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1814 /** @addtogroup G_extracting_wims
1817 /** Extract the image directly to an NTFS volume rather than a generic directory.
1818 * This mode is only available if wimlib was compiled with libntfs-3g support;
1819 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1820 * extraction target will be interpreted as the path to an NTFS volume image (as
1821 * a regular file or block device) rather than a directory. It will be opened
1822 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1823 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1824 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1825 * wimlib_extract_paths() when passed multiple paths. */
1826 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1828 /** UNIX-like systems only: Extract special UNIX data captured with
1829 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1830 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1831 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1833 /** Do not extract security descriptors. This flag cannot be combined with
1834 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1835 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1837 /** Fail immediately if the full security descriptor of any file or directory
1838 * cannot be set exactly as specified in the WIM file. On Windows, the default
1839 * behavior without this flag when wimlib does not have permission to set the
1840 * correct security descriptor is to fall back to setting the security
1841 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1842 * owner omitted, then not at all. This flag cannot be combined with
1843 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1844 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1846 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1847 * reparse-point fixups on, so absolute symbolic links or junction points will
1848 * be fixed to be absolute relative to the actual extraction root. Reparse-
1849 * point fixups are done by default for wimlib_extract_image() and
1850 * wimlib_extract_image_from_pipe() if <c>WIM_HDR_FLAG_RP_FIX</c> is set in the
1851 * WIM header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.
1853 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1855 /** Force reparse-point fixups on extraction off, regardless of the state of the
1856 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1857 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1858 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1860 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1861 * paths, each of which must name a regular file, to standard output. */
1862 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1864 /** Instead of ignoring files and directories with names that cannot be
1865 * represented on the current platform (note: Windows has more restrictions on
1866 * filenames than POSIX-compliant systems), try to replace characters or append
1867 * junk to the names so that they can be extracted in some form.
1869 * Note: this flag is unlikely to have any effect when extracting a WIM image
1870 * that was captured on Windows.
1872 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1874 /** On Windows, when there exist two or more files with the same case
1875 * insensitive name but different case sensitive names, try to extract them all
1876 * by appending junk to the end of them, rather than arbitrarily extracting only
1879 * Note: this flag is unlikely to have any effect when extracting a WIM image
1880 * that was captured on Windows.
1882 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1884 /** Do not ignore failure to set timestamps on extracted files. This flag
1885 * currently only has an effect when extracting to a directory on UNIX-like
1887 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1889 /** Do not ignore failure to set short names on extracted files. This flag
1890 * currently only has an effect on Windows. */
1891 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1893 /** Do not ignore failure to extract symbolic links and junctions due to
1894 * permissions problems. This flag currently only has an effect on Windows. By
1895 * default, such failures are ignored since the default configuration of Windows
1896 * only allows the Administrator to create symbolic links. */
1897 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1899 /** Reserved for future use. */
1900 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1902 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1903 * paths to extract as wildcard patterns ("globs") which may contain the
1904 * wildcard characters @c ? and @c *. The @c ? character matches any
1905 * non-path-separator character, whereas the @c * character matches zero or more
1906 * non-path-separator characters. Consequently, each glob may match zero or
1907 * more actual paths in the WIM image.
1909 * By default, if a glob does not match any files, a warning but not an error
1910 * will be issued. This is the case even if the glob did not actually contain
1911 * wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1914 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1916 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1917 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1918 * one of the provided globs did not match a file. */
1919 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1921 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1923 * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1925 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1927 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1928 * preserve the directory structure of the archive when extracting --- that is,
1929 * place each extracted file or directory tree directly in the target directory.
1931 * The target directory will still be created if it does not already exist. */
1932 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1934 /** Windows only: Extract files as "pointers" back to the WIM archive.
1936 * The effects of this option are fairly complex. See the documentation for the
1937 * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1939 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1942 /** @addtogroup G_mounting_wim_images
1945 /** Mount the WIM image read-write rather than the default of read-only. */
1946 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1948 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main(). */
1949 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1951 /** Do not allow accessing named data streams in the mounted WIM image. */
1952 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1954 /** Access named data streams in the mounted WIM image through extended file
1955 * attributes named "user.X", where X is the name of a data stream. This is the
1957 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1959 /** Access named data streams in the mounted WIM image by specifying the file
1960 * name, a colon, then the name of the data stream. */
1961 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1963 /** Use UNIX metadata if available in the WIM image. See
1964 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1965 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1967 /** Allow other users to see the mounted filesystem. This passes the @c
1968 * allow_other option to fuse_main(). */
1969 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1972 /** @addtogroup G_creating_and_opening_wims
1975 /** Verify the WIM contents against the WIM's integrity table, if present. The
1976 * integrity table stores checksums for the raw data of the WIM file, divided
1977 * into fixed size chunks. Verification will compute checksums and compare them
1978 * with the stored values. If there are any mismatches, then
1979 * ::WIMLIB_ERR_INTEGRITY will be issued. If the WIM file does not contain an
1980 * integrity table, then this flag has no effect. */
1981 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1983 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
1984 * WIM. Software can provide this flag for convenience if it explicitly does
1985 * not want to support split WIMs. */
1986 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1988 /** Check if the WIM is writable and issue an error
1989 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
1990 * only if it is writable at the filesystem level, does not have the
1991 * <c>WIM_HDR_FLAG_READONLY</c> flag set in its header, and is not part of a
1992 * spanned set. It is not required to provide this flag before attempting to
1993 * make changes to the WIM, but with this flag you get an error immediately
1994 * rather than potentially much later, when wimlib_overwrite() is finally
1996 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1999 /** @addtogroup G_mounting_wim_images
2002 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
2003 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2004 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
2006 /** Commit changes to the read-write mounted WIM image.
2007 * If this flag is not specified, changes will be discarded. */
2008 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
2010 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
2011 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2012 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
2014 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2015 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
2016 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
2019 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2020 * image, forces all file descriptors to the open WIM image to be closed before
2023 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2024 * this flag has no effect.
2026 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
2028 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2029 * WIM image, causes the modified image to be committed to the WIM file as a
2030 * new, unnamed image appended to the archive. The original image in the WIM
2031 * file will be unmodified. */
2032 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
2035 /** @addtogroup G_modifying_wims
2038 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2039 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
2040 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
2043 /** @addtogroup G_writing_and_overwriting_wims
2047 * Include an integrity table in the resulting WIM file.
2049 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2050 * include an integrity table if and only if one was present before. For
2051 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2052 * to not include an integrity table.
2054 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
2057 * Do not include an integrity table in the resulting WIM file. This is the
2058 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2061 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
2064 * Write the WIM as "pipable". After writing a WIM with this flag specified,
2065 * images from it can be applied directly from a pipe using
2066 * wimlib_extract_image_from_pipe(). See the documentation for the
2067 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2068 * Beware: WIMs written with this flag will not be compatible with Microsoft's
2071 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2072 * write the WIM as pipable if and only if it was pipable before. For
2073 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2074 * to write the WIM as non-pipable.
2076 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
2079 * Do not write the WIM as "pipable". This is the default behavior, unless the
2080 * ::WIMStruct was created by opening a pipable WIM.
2082 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
2085 * When writing data to the WIM file, recompress it, even if the data is already
2086 * available in the desired compressed form (for example, in a WIM file from
2087 * which an image has been exported using wimlib_export_image()).
2089 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2090 * compression ratio for the same compression type and chunk size. Simply using
2091 * the default compression settings may suffice for this, especially if the WIM
2092 * file was created using another program/library that may not use as
2093 * sophisticated compression algorithms. Or,
2094 * wimlib_set_default_compression_level() can be called beforehand to set an
2095 * even higher compression level than the default.
2097 * If the WIM contains solid resources, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can
2098 * be used in combination with ::WIMLIB_WRITE_FLAG_SOLID to prevent any solid
2099 * resources from being re-used. Otherwise, solid resources are re-used
2100 * somewhat more liberally than normal compressed resources.
2102 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of data
2103 * that would not otherwise be written. For example, a call to
2104 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2105 * cause already-existing data in the WIM file to be recompressed. To force the
2106 * WIM file to be fully rebuilt and recompressed, combine
2107 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2109 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
2112 * Immediately before closing the WIM file, sync its data to disk.
2114 * This flag forces the function to wait until the data is safely on disk before
2115 * returning success. Otherwise, modern operating systems tend to cache data
2116 * for some time (in some cases, 30+ seconds) before actually writing it to
2117 * disk, even after reporting to the application that the writes have succeeded.
2119 * wimlib_overwrite() will set this flag automatically if it decides to
2120 * overwrite the WIM file via a temporary file instead of in-place. This is
2121 * necessary on POSIX systems; it will, for example, avoid problems with delayed
2122 * allocation on ext4.
2124 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
2127 * For wimlib_overwrite(): rebuild the entire WIM file, even if it otherwise
2128 * could be updated in-place by appending to it. Any data that existed in the
2129 * original WIM file but is not actually needed by any of the remaining images
2130 * will not be included. This can free up space left over after previous
2131 * in-place modifications to the WIM file.
2133 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2134 * data to be recompressed. Otherwise, compressed data is re-used if possible.
2136 * wimlib_write() ignores this flag.
2138 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
2141 * For wimlib_overwrite(): override the default behavior after one or more calls
2142 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
2143 * flag, only minimal changes to correctly remove the image from the WIM file
2144 * will be taken. This can be much faster, but it will result in the WIM file
2145 * getting larger rather than smaller.
2147 * wimlib_write() ignores this flag.
2149 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
2152 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2153 * flag (<c>WIM_HDR_FLAG_READONLY</c>) is set in the WIM header. This can be
2154 * used following a call to wimlib_set_wim_info() with the
2155 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2158 * wimlib_write() ignores this flag.
2160 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
2163 * Do not include file data already present in other WIMs. This flag can be
2164 * used to write a "delta" WIM after the WIM files on which the delta is to be
2165 * based were referenced with wimlib_reference_resource_files() or
2166 * wimlib_reference_resources().
2168 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
2170 /** Deprecated; this flag should not be used outside of the library itself. */
2171 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
2174 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2176 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2179 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
2182 * Concatenate files and compress them together, rather than compress each file
2183 * independently. This is also known as creating a "solid archive". This tends
2184 * to produce a better compression ratio at the cost of much slower random
2187 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2188 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2189 * created with this flag use a different version number in their header (3584
2190 * instead of 68864) and are also called "ESD files".
2192 * Note that providing this flag does not affect the "append by default"
2193 * behavior of wimlib_overwrite(). In other words, wimlib_overwrite() with just
2194 * ::WIMLIB_WRITE_FLAG_SOLID can be used to append solid-compressed data to a
2195 * WIM file that originally did not contain any solid-compressed data. But if
2196 * you instead want to rebuild and recompress an entire WIM file in solid mode,
2197 * then also provide ::WIMLIB_WRITE_FLAG_REBUILD and
2198 * ::WIMLIB_WRITE_FLAG_RECOMPRESS.
2200 * Currently, new solid resources will, by default, be written using LZMS
2201 * compression with 64 MiB (67108864 byte) chunks. Use
2202 * wimlib_set_output_pack_compression_type() and/or
2203 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2204 * the WIM's main compression type and chunk size; you can have a WIM that
2205 * nominally uses LZX compression and 32768 byte chunks but actually contains
2206 * LZMS-compressed solid resources, for example. However, if including solid
2207 * resources, I suggest that you set the WIM's main compression type to LZMS as
2208 * well, either by creating the WIM with
2209 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2210 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2212 * This flag will be set by default when writing or overwriting a WIM file that
2213 * either already contains solid resources, or has had solid resources exported
2214 * into it and the WIM's main compression type is LZMS.
2216 #define WIMLIB_WRITE_FLAG_SOLID 0x00001000
2219 * Deprecated: this is the old name for ::WIMLIB_WRITE_FLAG_SOLID, retained for
2220 * source compatibility.
2222 #define WIMLIB_WRITE_FLAG_PACK_STREAMS WIMLIB_WRITE_FLAG_SOLID
2225 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2226 * file. This is only needed in the unusual case that the library user needs to
2227 * know exactly when wimlib has read each file for the last time.
2229 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2232 * Do not consider content similarily when arranging file data for solid
2233 * compression. Providing this flag will typically worsen the compression
2234 * ratio, so only provide this flag if you know what you are doing.
2236 #define WIMLIB_WRITE_FLAG_NO_SOLID_SORT 0x00004000
2239 /** @addtogroup G_general
2242 /** Assume that strings are represented in UTF-8, even if this is not the
2243 * locale's character encoding. This flag is ignored on Windows, where wimlib
2244 * always uses UTF-16LE. */
2245 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2247 /** Windows-only: do not attempt to acquire additional privileges (currently
2248 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2249 * SeTakeOwnershipPrivilege) when initializing the library. This flag is
2250 * intended for the case where the calling program manages these privileges
2251 * itself. Note: by default, no error is issued if privileges cannot be
2252 * acquired, although related errors may be reported later, depending on if the
2253 * operations performed actually require additional privileges or not. */
2254 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2256 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2257 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2258 * to read all possible data and metadata for a capture operation could not be
2259 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2261 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2263 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2264 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2265 * to restore all possible data and metadata for an apply operation could not be
2266 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2268 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2270 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2272 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2274 /** Default to interpreting WIM paths case insensitively (default on Windows).
2275 * This does not apply to mounted images. */
2276 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2279 /** @addtogroup G_nonstandalone_wims
2282 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2283 * Ignored by wimlib_reference_resources(). */
2284 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2286 /** For wimlib_reference_resource_files(), issue an error
2287 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2288 * default behavior without this flag is to issue no error at that point, but
2289 * then attempt to open the glob as a literal path, which of course will fail
2290 * anyway if no file exists at that path. No effect if
2291 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2292 * wimlib_reference_resources(). */
2293 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2296 /** @addtogroup G_modifying_wims
2299 /** The specific type of update to perform. */
2300 enum wimlib_update_op {
2301 /** Add a new file or directory tree to the WIM image in a
2302 * certain location. */
2303 WIMLIB_UPDATE_OP_ADD = 0,
2305 /** Delete a file or directory tree from the WIM image. */
2306 WIMLIB_UPDATE_OP_DELETE,
2308 /** Rename a file or directory tree in the WIM image. */
2309 WIMLIB_UPDATE_OP_RENAME,
2312 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2313 struct wimlib_add_command {
2314 /** Filesystem path to the file or directory tree to add. */
2315 wimlib_tchar *fs_source_path;
2317 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2318 * specify the root directory of the WIM image. */
2319 wimlib_tchar *wim_target_path;
2321 /** Path to capture configuration file to use, or @c NULL for default.
2323 wimlib_tchar *config_file;
2325 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2329 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2330 struct wimlib_delete_command {
2332 /** Path, specified from the root of the WIM image, for the file or
2333 * directory tree within the WIM image to be deleted. */
2334 wimlib_tchar *wim_path;
2336 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2340 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2341 struct wimlib_rename_command {
2343 /** Path, specified from the root of the WIM image, for the source file
2344 * or directory tree within the WIM image. */
2345 wimlib_tchar *wim_source_path;
2347 /** Path, specified from the root of the WIM image, for the destination
2348 * file or directory tree within the WIM image. */
2349 wimlib_tchar *wim_target_path;
2351 /** Reserved; set to 0. */
2355 /** Specification of an update to perform on a WIM image. */
2356 struct wimlib_update_command {
2358 enum wimlib_update_op op;
2361 struct wimlib_add_command add;
2362 struct wimlib_delete_command delete_; /* Underscore is for C++
2364 struct wimlib_rename_command rename;
2369 /** @addtogroup G_general
2373 * Possible values of the error code returned by many functions in wimlib.
2375 * See the documentation for each wimlib function to see specifically what error
2376 * codes can be returned by a given function, and what they mean.
2378 enum wimlib_error_code {
2379 WIMLIB_ERR_SUCCESS = 0,
2380 WIMLIB_ERR_ALREADY_LOCKED = 1,
2381 WIMLIB_ERR_DECOMPRESSION = 2,
2382 WIMLIB_ERR_FUSE = 6,
2383 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2384 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2385 WIMLIB_ERR_IMAGE_COUNT = 10,
2386 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2387 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2388 WIMLIB_ERR_INTEGRITY = 13,
2389 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2390 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2391 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2392 WIMLIB_ERR_INVALID_HEADER = 17,
2393 WIMLIB_ERR_INVALID_IMAGE = 18,
2394 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2395 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2396 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2397 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2398 WIMLIB_ERR_INVALID_OVERLAY = 23,
2399 WIMLIB_ERR_INVALID_PARAM = 24,
2400 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2401 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2402 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2403 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2404 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2405 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2406 WIMLIB_ERR_IS_DIRECTORY = 32,
2407 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2408 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2409 WIMLIB_ERR_LINK = 35,
2410 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2411 WIMLIB_ERR_MKDIR = 37,
2412 WIMLIB_ERR_MQUEUE = 38,
2413 WIMLIB_ERR_NOMEM = 39,
2414 WIMLIB_ERR_NOTDIR = 40,
2415 WIMLIB_ERR_NOTEMPTY = 41,
2416 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2417 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2418 WIMLIB_ERR_NOT_PIPABLE = 44,
2419 WIMLIB_ERR_NO_FILENAME = 45,
2420 WIMLIB_ERR_NTFS_3G = 46,
2421 WIMLIB_ERR_OPEN = 47,
2422 WIMLIB_ERR_OPENDIR = 48,
2423 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2424 WIMLIB_ERR_READ = 50,
2425 WIMLIB_ERR_READLINK = 51,
2426 WIMLIB_ERR_RENAME = 52,
2427 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2428 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2429 WIMLIB_ERR_RESOURCE_ORDER = 56,
2430 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2431 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2432 WIMLIB_ERR_SET_SECURITY = 59,
2433 WIMLIB_ERR_SET_SHORT_NAME = 60,
2434 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2435 WIMLIB_ERR_SPLIT_INVALID = 62,
2436 WIMLIB_ERR_STAT = 63,
2437 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2438 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2439 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2440 WIMLIB_ERR_UNSUPPORTED = 68,
2441 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2442 WIMLIB_ERR_WIM_IS_READONLY = 71,
2443 WIMLIB_ERR_WRITE = 72,
2444 WIMLIB_ERR_XML = 73,
2445 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2446 WIMLIB_ERR_WIMBOOT = 75,
2447 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2448 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2449 WIMLIB_ERR_MKNOD = 78,
2450 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2451 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2452 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2453 WIMLIB_ERR_FVE_LOCKED_VOLUME = 82,
2457 /** Used to indicate no WIM image or an invalid WIM image. */
2458 #define WIMLIB_NO_IMAGE 0
2460 /** Used to specify all images in the WIM. */
2461 #define WIMLIB_ALL_IMAGES (-1)
2466 * @ingroup G_modifying_wims
2468 * Append an empty image to a ::WIMStruct.
2470 * The new image will initially contain no files or directories, although if
2471 * written without further modifications, then a root directory will be created
2472 * automatically for it.
2474 * After calling this function, you can use wimlib_update_image() to add files
2475 * to the new WIM image. This gives you more control over making the new image
2476 * compared to calling wimlib_add_image() or wimlib_add_image_multisource().
2479 * Pointer to the ::WIMStruct to which to add the image.
2481 * Name to give the new image. If @c NULL or empty, the new image is given
2482 * no name. If nonempty, it must specify a name that does not already
2484 * @param new_idx_ret
2485 * If non-<c>NULL</c>, the index of the newly added image is returned in
2488 * @return 0 on success; a ::wimlib_error_code value on failure.
2490 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2491 * The WIM already contains an image with the requested name.
2494 wimlib_add_empty_image(WIMStruct *wim,
2495 const wimlib_tchar *name,
2499 * @ingroup G_modifying_wims
2501 * Add an image to a ::WIMStruct from an on-disk directory tree or NTFS volume.
2503 * The directory tree or NTFS volume is scanned immediately to load the dentry
2504 * tree into memory, and file metadata is read. However, actual file data may
2505 * not be read until the ::WIMStruct is persisted to disk using wimlib_write()
2506 * or wimlib_overwrite().
2508 * See the documentation for the @b wimlib-imagex program for more information
2509 * about the "normal" capture mode versus the NTFS capture mode (entered by
2510 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2512 * Note that no changes are committed to disk until wimlib_write() or
2513 * wimlib_overwrite() is called.
2516 * Pointer to the ::WIMStruct to which to add the image.
2518 * A path to a directory or unmounted NTFS volume that will be captured as
2521 * Name to give the new image. If @c NULL or empty, the new image is given
2522 * no name. If nonempty, it must specify a name that does not already
2524 * @param config_file
2525 * Path to capture configuration file, or @c NULL. This file may specify,
2526 * among other things, which files to exclude from capture. See the
2527 * documentation for <b>wimlib-imagex capture</b> (<b>--config</b> option)
2528 * for details of the file format. If @c NULL, the default capture
2529 * configuration will be used. Ordinarily, the default capture
2530 * configuration will result in no files being excluded from capture purely
2531 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2532 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2534 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2536 * @return 0 on success; a ::wimlib_error_code value on failure.
2538 * This function is implemented by calling wimlib_add_empty_image(), then
2539 * calling wimlib_update_image() with a single "add" command, so any error code
2540 * returned by wimlib_add_empty_image() may be returned, as well as any error
2541 * codes returned by wimlib_update_image() other than ones documented as only
2542 * being returned specifically by an update involving delete or rename commands.
2544 * If a progress function is registered with @p wim, then it will receive the
2545 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2546 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2547 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2550 wimlib_add_image(WIMStruct *wim,
2551 const wimlib_tchar *source,
2552 const wimlib_tchar *name,
2553 const wimlib_tchar *config_file,
2557 * @ingroup G_modifying_wims
2559 * This function is equivalent to wimlib_add_image() except it allows for
2560 * multiple sources to be combined into a single WIM image. This is done by
2561 * specifying the @p sources and @p num_sources parameters instead of the @p
2562 * source parameter of wimlib_add_image(). The rest of the parameters are the
2563 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2564 * capture</b> for full details on how this mode works.
2566 * In addition to the error codes that wimlib_add_image() can return,
2567 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2568 * when trying to overlay a non-directory on a directory or when otherwise
2569 * trying to overlay multiple conflicting files to the same location in the WIM
2570 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2571 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2572 * was not exactly one capture source with the target being the root directory.
2573 * (In this respect, there is no advantage to using
2574 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2578 wimlib_add_image_multisource(WIMStruct *wim,
2579 const struct wimlib_capture_source *sources,
2581 const wimlib_tchar *name,
2582 const wimlib_tchar *config_file,
2586 * @ingroup G_modifying_wims
2588 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2589 * location @p wim_target_path within the specified @p image of the @p wim.
2591 * This just builds an appropriate ::wimlib_add_command and passes it to
2592 * wimlib_update_image().
2595 wimlib_add_tree(WIMStruct *wim, int image,
2596 const wimlib_tchar *fs_source_path,
2597 const wimlib_tchar *wim_target_path, int add_flags);
2600 * @ingroup G_creating_and_opening_wims
2602 * Create a ::WIMStruct which initially contains no images and is not backed by
2606 * The "output compression type" to assign to the ::WIMStruct. This is the
2607 * compression type that will be used if the ::WIMStruct is later persisted
2608 * to an on-disk file using wimlib_write().
2610 * This choice is not necessarily final. If desired, it can still be
2611 * changed at any time before wimlib_write() is called, using
2612 * wimlib_set_output_compression_type(). In addition, if you wish to use a
2613 * non-default compression chunk size, then you will need to call
2614 * wimlib_set_output_chunk_size().
2616 * On success, a pointer to the new ::WIMStruct is written to the memory
2617 * location pointed to by this parameter. This ::WIMStruct must be freed
2618 * using using wimlib_free() when finished with it.
2620 * @return 0 on success; a ::wimlib_error_code value on failure.
2622 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2623 * @p ctype was not a supported compression type.
2624 * @retval ::WIMLIB_ERR_NOMEM
2625 * Insufficient memory to allocate a new ::WIMStruct.
2628 wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret);
2631 * @ingroup G_modifying_wims
2633 * Delete an image, or all images, from a ::WIMStruct.
2635 * Note that no changes are committed to disk until wimlib_write() or
2636 * wimlib_overwrite() is called.
2639 * Pointer to the ::WIMStruct from which to delete the image.
2641 * The 1-based index of the image to delete, or ::WIMLIB_ALL_IMAGES to
2642 * delete all images.
2644 * @return 0 on success; a ::wimlib_error_code value on failure.
2646 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2647 * @p image does not exist in the WIM.
2649 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2650 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2651 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2652 * indicate failure (for different reasons) to read the metadata resource for an
2653 * image that needed to be deleted.
2655 * If this function fails when @p image was ::WIMLIB_ALL_IMAGES, then it's
2656 * possible that some but not all of the images were deleted.
2659 wimlib_delete_image(WIMStruct *wim, int image);
2662 * @ingroup G_modifying_wims
2664 * Delete the @p path from the specified @p image of the @p wim.
2666 * This just builds an appropriate ::wimlib_delete_command and passes it to
2667 * wimlib_update_image().
2670 wimlib_delete_path(WIMStruct *wim, int image,
2671 const wimlib_tchar *path, int delete_flags);
2674 * @ingroup G_modifying_wims
2676 * Export an image, or all images, from a ::WIMStruct into another ::WIMStruct.
2678 * Note: after calling this function, the exported WIM image(s) cannot be
2679 * independently modified because the image metadata will be shared between the
2680 * two ::WIMStruct's. In addition, @p dest_wim will depend on @p src_wim, so @p
2681 * src_wim cannot be freed until @p dest_wim is ready to be freed as well.
2683 * Note: no changes are committed to disk until wimlib_write() or
2684 * wimlib_overwrite() is called.
2687 * The WIM from which to export the images, specified as a pointer to the
2688 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2689 * split WIM. In the case of a WIM file that is not standalone, this
2690 * ::WIMStruct must have had any needed external resources previously
2691 * referenced using wimlib_reference_resources() or
2692 * wimlib_reference_resource_files().
2694 * The 1-based index of the image from @p src_wim to export, or
2695 * ::WIMLIB_ALL_IMAGES.
2697 * The ::WIMStruct to which to export the images.
2699 * For single-image exports, the name to give the exported image in @p
2700 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2701 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2702 * that case, the names are all taken from @p src_wim. This parameter is
2703 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2704 * @param dest_description
2705 * For single-image exports, the description to give the exported image in
2706 * the new WIM file. If left @c NULL, the description from @p src_wim is
2707 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2708 * NULL; in that case, the description are all taken from @p src_wim. This
2709 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2710 * @param export_flags
2711 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2713 * @return 0 on success; a ::wimlib_error_code value on failure.
2715 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2716 * One or more of the names being given to an exported image was already in
2717 * use in the destination WIM.
2718 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2719 * @p src_image does not exist in @p src_wim.
2720 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2721 * At least one of @p src_wim and @p dest_wim do not contain image
2722 * metadata. For example, one of them was a non-first part of a split WIM.
2723 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2724 * A file data blob that needed to be exported could not be found in the
2725 * blob lookup table of @p src_wim. See @ref G_nonstandalone_wims.
2727 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2728 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2729 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2730 * indicate failure (for different reasons) to read the metadata resource for an
2731 * image in @p src_wim that needed to be exported.
2734 wimlib_export_image(WIMStruct *src_wim, int src_image,
2735 WIMStruct *dest_wim,
2736 const wimlib_tchar *dest_name,
2737 const wimlib_tchar *dest_description,
2741 * @ingroup G_extracting_wims
2743 * Extract an image, or all images, from a ::WIMStruct.
2745 * The exact behavior of how wimlib extracts files from a WIM image is
2746 * controllable by the @p extract_flags parameter, but there also are
2747 * differences depending on the platform (UNIX-like vs Windows). See the
2748 * documentation for <b>wimlib-imagex apply</b> for more information, including
2749 * about the NTFS-3g extraction mode.
2752 * The WIM from which to extract the image(s), specified as a pointer to the
2753 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2754 * split WIM. In the case of a WIM file that is not standalone, this
2755 * ::WIMStruct must have had any needed external resources previously
2756 * referenced using wimlib_reference_resources() or
2757 * wimlib_reference_resource_files().
2759 * The 1-based index of the image to extract, or ::WIMLIB_ALL_IMAGES to
2760 * extract all images. Note: ::WIMLIB_ALL_IMAGES is unsupported in NTFS-3g
2763 * A null-terminated string which names the location to which the image(s)
2764 * will be extracted. By default, this is interpreted as a path to a
2765 * directory. Alternatively, if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in
2766 * @p extract_flags, then this is interpreted as a path to an unmounted
2768 * @param extract_flags
2769 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2771 * @return 0 on success; a ::wimlib_error_code value on failure.
2773 * @retval ::WIMLIB_ERR_DECOMPRESSION
2774 * Failed to decompress data contained in the WIM.
2775 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2776 * The metadata for one of the images to extract was invalid.
2777 * @retval ::WIMLIB_ERR_INVALID_PARAM
2778 * The extraction flags were invalid; more details may be found in the
2779 * documentation for the specific extraction flags that were specified. Or
2780 * @p target was @c NULL or an empty string, or @p wim was @c NULL.
2781 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2782 * The data of a file that needed to be extracted was corrupt.
2783 * @retval ::WIMLIB_ERR_LINK
2784 * Failed to create a symbolic link or a hard link.
2785 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2786 * The metadata resource for one of the images to extract was not found.
2787 * This can happen if @p wim represents a non-first part of a split WIM.
2788 * @retval ::WIMLIB_ERR_MKDIR
2789 * Failed create a directory.
2790 * @retval ::WIMLIB_ERR_OPEN
2791 * Could not create a file, or failed to open an already-extracted file.
2792 * @retval ::WIMLIB_ERR_READ
2793 * Failed to read data from the WIM.
2794 * @retval ::WIMLIB_ERR_READLINK
2795 * Failed to determine the target of a symbolic link in the WIM.
2796 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2797 * Failed to fix the target of an absolute symbolic link (e.g. if the
2798 * target would have exceeded the maximum allowed length). (Only if
2799 * reparse data was supported by the extraction mode and
2800 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2802 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2803 * A file data blob that needed to be extracted could not be found in the
2804 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
2805 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2806 * Failed to set attributes on a file.
2807 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2808 * Failed to set reparse data on a file (only if reparse data was supported
2809 * by the extraction mode).
2810 * @retval ::WIMLIB_ERR_SET_SECURITY
2811 * Failed to set security descriptor on a file.
2812 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2813 * Failed to set the short name of a file.
2814 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2815 * Failed to set timestamps on a file.
2816 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2817 * Unexpected end-of-file occurred when reading data from the WIM.
2818 * @retval ::WIMLIB_ERR_UNSUPPORTED
2819 * A requested extraction flag, or the data or metadata that must be
2820 * extracted to support it, is unsupported in the build and configuration
2821 * of wimlib, or on the current platform or extraction mode or target
2822 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2823 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2824 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2825 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2826 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2827 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2828 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2829 * image contains one or more files with short names, but extracting short
2830 * names is not supported --- on Windows, this occurs if the target volume
2831 * does not support short names, while on non-Windows, this occurs if
2832 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2833 * @retval ::WIMLIB_ERR_WIMBOOT
2834 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2835 * there was a problem creating WIMBoot pointer files.
2836 * @retval ::WIMLIB_ERR_WRITE
2837 * Failed to write data to a file being extracted.
2839 * If a progress function is registered with @p wim, then as each image is
2840 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2841 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2842 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2843 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2844 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2847 wimlib_extract_image(WIMStruct *wim, int image,
2848 const wimlib_tchar *target, int extract_flags);
2851 * @ingroup G_extracting_wims
2853 * Extract one image from a pipe on which a pipable WIM is being sent.
2855 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2856 * subsec_pipable_wims, for more information about pipable WIMs.
2858 * This function operates in a special way to read the WIM fully sequentially.
2859 * As a result, there is no ::WIMStruct is made visible to library users, and
2860 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2861 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2862 * seekable file, not a pipe.)
2865 * File descriptor, which may be a pipe, opened for reading and positioned
2866 * at the start of the pipable WIM.
2867 * @param image_num_or_name
2868 * String that specifies the 1-based index or name of the image to extract.
2869 * It is translated to an image index using the same rules that
2870 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2871 * only a single image (not all images) can be specified. Alternatively,
2872 * specify @p NULL here to use the first image in the WIM if it contains
2873 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2875 * Same as the corresponding parameter to wimlib_extract_image().
2876 * @param extract_flags
2877 * Same as the corresponding parameter to wimlib_extract_image().
2879 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
2880 * error codes include those returned by wimlib_extract_image() and
2881 * wimlib_open_wim() as well as the following:
2883 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2884 * Data read from the pipable WIM was invalid.
2885 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2886 * The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2889 wimlib_extract_image_from_pipe(int pipe_fd,
2890 const wimlib_tchar *image_num_or_name,
2891 const wimlib_tchar *target, int extract_flags);
2894 * @ingroup G_extracting_wims
2896 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2897 * function. The progress function will be used while extracting the WIM image
2898 * and will receive the normal extraction progress messages, such as
2899 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2900 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2903 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2904 const wimlib_tchar *image_num_or_name,
2905 const wimlib_tchar *target,
2907 wimlib_progress_func_t progfunc,
2911 * @ingroup G_extracting_wims
2913 * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2914 * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2915 * path_list_file which itself contains the list of paths to use, one per line.
2916 * Leading and trailing whitespace is ignored. Empty lines and lines beginning
2917 * with the ';' or '#' characters are ignored. No quotes are needed, as paths
2918 * are otherwise delimited by the newline character. However, quotes will be
2919 * stripped if present.
2921 * The error codes are the same as those returned by wimlib_extract_paths(),
2922 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2923 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2924 * ::WIMLIB_ERR_READ).
2927 wimlib_extract_pathlist(WIMStruct *wim, int image,
2928 const wimlib_tchar *target,
2929 const wimlib_tchar *path_list_file,
2933 * @ingroup G_extracting_wims
2935 * Extract zero or more paths (files or directory trees) from the specified WIM
2938 * By default, each path will be extracted to a corresponding subdirectory of
2939 * the target based on its location in the WIM image. For example, if one of
2940 * the paths to extract is <c>/Windows/explorer.exe</c> and the target is
2941 * <c>outdir</c>, the file will be extracted to
2942 * <c>outdir/Windows/explorer.exe</c>. This behavior can be changed by
2943 * providing the flag ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which
2944 * will cause each file or directory tree to be placed directly in the target
2945 * directory --- so the same example would extract <c>/Windows/explorer.exe</c>
2946 * to <c>outdir/explorer.exe</c>.
2948 * Symbolic links will not be dereferenced when paths in the WIM image are
2952 * WIM from which to extract the paths, specified as a pointer to the
2953 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2954 * split WIM. In the case of a WIM file that is not standalone, this
2955 * ::WIMStruct must have had any needed external resources previously
2956 * referenced using wimlib_reference_resources() or
2957 * wimlib_reference_resource_files().
2959 * The 1-based index of the WIM image from which to extract the paths.
2961 * Array of paths to extract. Each element must be the absolute path to a
2962 * file or directory within the WIM image. Path separators may be either
2963 * forwards or backwards slashes, and leading path separators are optional.
2964 * The paths will be interpreted either case-sensitively (UNIX default) or
2965 * case-insensitively (Windows default); however, the behavior can be
2966 * configured explicitly at library initialization time by passing an
2967 * appropriate flag to wimlib_global_init().
2969 * By default, the characters @c * and @c ? are interpreted literally.
2970 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2973 * By default, if any paths to extract do not exist, the error code
2974 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2975 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2977 * Number of paths specified in @p paths.
2979 * Directory to which to extract the paths; or with
2980 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2981 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2982 * paths being extracted, the @p target must be native path. On UNIX-like
2983 * systems it may not contain backslashes, for example.
2984 * @param extract_flags
2985 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2987 * @return 0 on success; a ::wimlib_error_code value on failure. Most of the
2988 * error codes are the same as those returned by wimlib_extract_image(). Below,
2989 * some of the error codes returned in situations specific to path-mode
2990 * extraction are documented:
2992 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2993 * One of the paths to extract does not exist in the WIM image. This error
2994 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2995 * specified in @p extract_flags, or if both
2996 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2997 * were specified in @p extract_flags.
2998 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2999 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3000 * one of the paths to extract did not name a regular file.
3002 * If a progress function is registered with @p wim, then it will receive
3003 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS.
3006 wimlib_extract_paths(WIMStruct *wim,
3008 const wimlib_tchar *target,
3009 const wimlib_tchar * const *paths,
3014 * @ingroup G_wim_information
3016 * Similar to wimlib_get_xml_data(), but the XML document will be written to the
3017 * specified standard C <c>FILE*</c> instead of retrieved in an in-memory
3020 * @return 0 on success; a ::wimlib_error_code value on failure. This may
3021 * return any error code which can be returned by wimlib_get_xml_data() as well
3022 * as the following error codes:
3024 * @retval ::WIMLIB_ERR_WRITE
3025 * Failed to write the data to the requested file.
3028 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3031 * @ingroup G_general
3033 * Free all memory allocated for a WIMStruct and close all files associated with
3037 * Pointer to the ::WIMStruct to free. If @c NULL, no action is taken.
3040 wimlib_free(WIMStruct *wim);
3043 * @ingroup G_general
3045 * Convert a ::wimlib_compression_type value into a string.
3048 * The compression type value to convert.
3051 * A statically allocated string naming the compression type, such as
3052 * "None", "LZX", or "XPRESS". If the value was unrecognized, then
3053 * the resulting string will be "Invalid".
3055 extern const wimlib_tchar *
3056 wimlib_get_compression_type_string(enum wimlib_compression_type ctype);
3059 * @ingroup G_general
3061 * Convert a wimlib error code into a string describing it.
3064 * An error code returned by one of wimlib's functions.
3067 * Pointer to a statically allocated string describing the error code. If
3068 * the value was unrecognized, then the resulting string will be "Unknown
3071 extern const wimlib_tchar *
3072 wimlib_get_error_string(enum wimlib_error_code code);
3075 * @ingroup G_wim_information
3077 * Get the description of the specified image.
3080 * Pointer to the ::WIMStruct to query. This need not represent a
3081 * standalone WIM (e.g. it could represent part of a split WIM).
3083 * The 1-based index of the image for which to query the description.
3086 * The description of the image, or @c NULL if there is no such image, or
3087 * @c NULL if the specified image has no description. The string may not
3088 * remain valid after later library calls, so the caller should duplicate
3091 extern const wimlib_tchar *
3092 wimlib_get_image_description(const WIMStruct *wim, int image);
3095 * @ingroup G_wim_information
3097 * Get the name of the specified image.
3100 * Pointer to the ::WIMStruct to query. This need not represent a
3101 * standalone WIM (e.g. it could represent part of a split WIM).
3103 * The 1-based index of the image for which to query the name.
3106 * The name of the image, or @c NULL if there is no such image, or an empty
3107 * string if the image is unnamed. The string may not remain valid after
3108 * later library calls, so the caller should duplicate it if needed.
3110 extern const wimlib_tchar *
3111 wimlib_get_image_name(const WIMStruct *wim, int image);
3114 * @ingroup G_general
3116 * Return the version of wimlib as a 32-bit number whose top 12 bits contain the
3117 * major version, the next 10 bits contain the minor version, and the low 10
3118 * bits contain the patch version.
3120 * In other words, the returned value is equal to <c>((WIMLIB_MAJOR_VERSION <<
3121 * 20) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</c> for the
3122 * corresponding header file.
3125 wimlib_get_version(void);
3128 * @ingroup G_wim_information
3130 * Get basic information about a WIM file.
3133 * Pointer to the ::WIMStruct to query. This need not represent a
3134 * standalone WIM (e.g. it could represent part of a split WIM).
3136 * A ::wimlib_wim_info structure that will be filled in with information
3137 * about the WIM file.
3142 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3145 * @ingroup G_wim_information
3147 * Read a WIM file's XML document into an in-memory buffer.
3149 * The XML document contains metadata about the WIM file and the images stored
3153 * Pointer to the ::WIMStruct to query. This need not represent a
3154 * standalone WIM (e.g. it could represent part of a split WIM).
3156 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3157 * XML document is written to this location.
3158 * @param bufsize_ret
3159 * The size of the XML document in bytes is written to this location.
3161 * @return 0 on success; a ::wimlib_error_code value on failure.
3163 * @retval ::WIMLIB_ERR_NO_FILENAME
3164 * @p wim is not backed by a file and therefore does not have an XML
3166 * @retval ::WIMLIB_ERR_READ
3167 * Failed to read the XML document from the WIM file.
3168 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3169 * Failed to read the XML document from the WIM file.
3172 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3175 * @ingroup G_general
3177 * Initialization function for wimlib. Call before using any other wimlib
3178 * function (except possibly wimlib_set_print_errors()). If not done manually,
3179 * this function will be called automatically with @p init_flags set to
3180 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
3181 * after it has already successfully run.
3184 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3186 * @return 0 on success; a ::wimlib_error_code value on failure.
3188 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3189 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3190 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3191 * init_flags, but the corresponding privileges could not be acquired.
3194 wimlib_global_init(int init_flags);
3197 * @ingroup G_general
3199 * Cleanup function for wimlib. You are not required to call this function, but
3200 * it will release any global resources allocated by the library.
3203 wimlib_global_cleanup(void);
3206 * @ingroup G_wim_information
3208 * Determine if an image name is already used by some image in the WIM.
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 * The name to check.
3217 * @c true if there is already an image in @p wim named @p name; @c false
3218 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3219 * the empty string, then @c false is returned.
3222 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3225 * @ingroup G_wim_information
3227 * Iterate through a file or directory tree in the WIM image. By specifying
3228 * appropriate flags and a callback function, you can get the attributes of a
3229 * file in the WIM image, get a directory listing, or even get a listing of the
3233 * The ::WIMStruct containing the image(s) over which to iterate. This
3234 * ::WIMStruct must contain image metadata, so it cannot be the non-first
3235 * part of a split WIM (for example).
3237 * The 1-based index of the image that contains the files or directories to
3238 * iterate over, or ::WIMLIB_ALL_IMAGES to iterate over all images.
3240 * Path in the WIM image at which to do the iteration.
3242 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3244 * A callback function that will receive each directory entry.
3246 * An extra parameter that will always be passed to the callback function
3249 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3250 * first nonzero value that was returned from @p cb. However, additional
3251 * ::wimlib_error_code values may be returned, including the following:
3253 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3254 * @p path does not exist in the WIM image.
3255 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3256 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED was specified, but the
3257 * data for some files could not be found in the blob lookup table of @p
3260 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3261 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3262 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3263 * indicate failure (for different reasons) to read the metadata resource for an
3264 * image over which iteration needed to be done.
3267 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3269 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3272 * @ingroup G_wim_information
3274 * Iterate through the blob lookup table of a ::WIMStruct. This can be used to
3275 * directly get a listing of the unique "blobs" contained in a WIM file, which
3276 * are deduplicated over all images.
3278 * Specifically, each listed blob may be from any of the following sources:
3280 * - Metadata blobs, if the ::WIMStruct contains image metadata
3281 * - File blobs from the on-disk WIM file (if any) backing the ::WIMStruct
3282 * - File blobs from files that have been added to the in-memory ::WIMStruct,
3283 * e.g. by using wimlib_add_image()
3284 * - File blobs from external WIMs referenced by
3285 * wimlib_reference_resource_files() or wimlib_reference_resources()
3288 * Pointer to the ::WIMStruct for which to get the blob listing.
3290 * Reserved; set to 0.
3292 * A callback function that will receive each blob.
3294 * An extra parameter that will always be passed to the callback function
3297 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3298 * that was returned from @p cb.
3301 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3302 wimlib_iterate_lookup_table_callback_t cb,
3306 * @ingroup G_nonstandalone_wims
3308 * Join a split WIM into a stand-alone (one-part) WIM.
3311 * An array of strings that gives the filenames of all parts of the split
3312 * WIM. No specific order is required, but all parts must be included with
3315 * Number of filenames in @p swms.
3316 * @param swm_open_flags
3317 * Open flags for the split WIM parts (e.g.
3318 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3319 * @param wim_write_flags
3320 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3321 * be used to write the joined WIM.
3322 * @param output_path
3323 * The path to write the joined WIM file to.
3325 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3326 * may return most error codes that can be returned by wimlib_open_wim() and
3327 * wimlib_write(), as well as the following error codes:
3329 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3330 * The split WIMs do not form a valid WIM because they do not include all
3331 * the parts of the original WIM, there are duplicate parts, or not all the
3332 * parts have the same GUID and compression type.
3334 * Note: wimlib is generalized enough that this function is not actually needed
3335 * to join a split WIM; instead, you could open the first part of the split WIM,
3336 * then reference the other parts with wimlib_reference_resource_files(), then
3337 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3338 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3342 wimlib_join(const wimlib_tchar * const *swms,
3344 const wimlib_tchar *output_path,
3346 int wim_write_flags);
3349 * @ingroup G_nonstandalone_wims
3351 * Same as wimlib_join(), but allows specifying a progress function. The
3352 * progress function will receive the write progress messages, such as
3353 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3354 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3355 * swm_open_flags, the progress function will receive a series of
3356 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3360 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3362 const wimlib_tchar *output_path,
3364 int wim_write_flags,
3365 wimlib_progress_func_t progfunc,
3370 * @ingroup G_mounting_wim_images
3372 * Mount an image from a WIM file on a directory read-only or read-write.
3375 * Pointer to the ::WIMStruct containing the image to be mounted. This
3376 * ::WIMStruct must have a backing file.
3378 * The 1-based index of the image to mount. This image cannot have been
3379 * previously modified in memory.
3381 * The path to an existing empty directory on which to mount the WIM image.
3382 * @param mount_flags
3383 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3384 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3386 * @param staging_dir
3387 * If non-NULL, the name of a directory in which a temporary directory for
3388 * storing modified or added files will be created. Ignored if
3389 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3390 * left @c NULL, the staging directory is created in the same directory as
3391 * the backing WIM file. The staging directory is automatically deleted
3392 * when the image is unmounted.
3394 * @return 0 on success; a ::wimlib_error_code value on failure.
3396 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3397 * Another process is currently modifying the WIM file.
3398 * @retval ::WIMLIB_ERR_FUSE
3399 * A non-zero status code was returned by @c fuse_main().
3400 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3401 * @p image does not exist in @p wim.
3402 * @retval ::WIMLIB_ERR_INVALID_PARAM
3403 * @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3404 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3405 * already been modified in memory (e.g. by wimlib_update_image()).
3406 * @retval ::WIMLIB_ERR_MKDIR
3407 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3408 * staging directory could not be created.
3409 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3410 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3411 * WIM file is considered read-only because of any of the reasons mentioned
3412 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3413 * @retval ::WIMLIB_ERR_UNSUPPORTED
3414 * Mounting is not supported in this build of the library.
3416 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3417 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3418 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3419 * indicate failure (for different reasons) to read the metadata resource for
3420 * the image to mount.
3422 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3423 * UserSpacE). Depending on how FUSE is set up on your system, this function
3424 * may work as normal users in addition to the root user.
3426 * Mounting WIM images is not supported if wimlib was configured
3427 * <c>--without-fuse</c>. This includes Windows builds of wimlib;
3428 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3430 * Calling this function daemonizes the process, unless
3431 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3433 * It is safe to mount multiple images from the same WIM file read-only at the
3434 * same time, but only if different ::WIMStruct's are used. It is @b not safe
3435 * to mount multiple images from the same WIM file read-write at the same time.
3437 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3438 * different process.
3441 wimlib_mount_image(WIMStruct *wim,
3443 const wimlib_tchar *dir,
3445 const wimlib_tchar *staging_dir);
3448 * @ingroup G_creating_and_opening_wims
3450 * Open a WIM file and create a ::WIMStruct for it.
3453 * The path to the WIM file to open.
3455 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3457 * On success, a pointer to a new ::WIMStruct backed by the specified
3458 * on-disk WIM file is written to the memory location pointed to by this
3459 * parameter. This ::WIMStruct must be freed using using wimlib_free()
3460 * when finished with it.
3462 * @return 0 on success; a ::wimlib_error_code value on failure.
3464 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3465 * The number of metadata resources found in the WIM did not match the
3466 * image count specified in the WIM header, or the number of <IMAGE>
3467 * elements in the XML data of the WIM did not match the image count
3468 * specified in the WIM header.
3469 * @retval ::WIMLIB_ERR_INTEGRITY
3470 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags, and
3471 * the WIM file failed the integrity check.
3472 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3473 * The library did not recognize the compression chunk size of the WIM as
3474 * valid for its compression type.
3475 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3476 * The library did not recognize the compression type of the WIM.
3477 * @retval ::WIMLIB_ERR_INVALID_HEADER
3478 * The header of the WIM was otherwise invalid.
3479 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3480 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3481 * the WIM contained an integrity table, but the integrity table was
3483 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3484 * The lookup table of the WIM was invalid.
3485 * @retval ::WIMLIB_ERR_INVALID_PARAM
3486 * @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3487 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3488 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3489 * specified in @p open_flags.
3490 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3491 * The file did not begin with the magic characters that identify a WIM
3493 * @retval ::WIMLIB_ERR_OPEN
3494 * Failed to open the WIM file for reading. Some possible reasons: the WIM
3495 * file does not exist, or the calling process does not have permission to
3497 * @retval ::WIMLIB_ERR_READ
3498 * Failed to read data from the WIM file.
3499 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3500 * Unexpected end-of-file while reading data from the WIM file.
3501 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3502 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3503 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3504 * The WIM cannot be opened because it contains encrypted segments. (It
3505 * may be a Windows 8 "ESD" file.)
3506 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3507 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3508 * considered read-only because of any of the reasons mentioned in the
3509 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3510 * @retval ::WIMLIB_ERR_XML
3511 * The XML data of the WIM was invalid.
3514 wimlib_open_wim(const wimlib_tchar *wim_file,
3516 WIMStruct **wim_ret);
3519 * @ingroup G_creating_and_opening_wims
3521 * Same as wimlib_open_wim(), but allows specifying a progress function and
3522 * progress context. If successful, the progress function will be registered in
3523 * the newly open ::WIMStruct, as if by an automatic call to
3524 * wimlib_register_progress_function(). In addition, if
3525 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, then the
3526 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3527 * messages while checking the WIM file's integrity.
3530 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3532 WIMStruct **wim_ret,
3533 wimlib_progress_func_t progfunc,
3537 * @ingroup G_writing_and_overwriting_wims
3539 * Commit a ::WIMStruct to disk, overwriting its backing file or appending to it
3542 * There are two alternative ways in which changes may be committed:
3544 * 1. Full rebuild: write the updated WIM to a temporary file, then rename the
3545 * temporary file to the original.
3546 * 2. Appending: append updates to the new original WIM file, then overwrite
3547 * its header such that those changes become visible to new readers.
3549 * Append mode is often much faster, but it wastes some amount of space due to
3550 * leaving "holes" in the WIM file. Because of the greater efficiency,
3551 * wimlib_overwrite() normally defaults to append mode. However,
3552 * ::WIMLIB_WRITE_FLAG_REBUILD can be used to explicitly request a full rebuild.
3553 * In addition, if wimlib_delete_image() has been used on the ::WIMStruct, then
3554 * the default mode switches to rebuild mode, and
3555 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE can be used to explicitly request append
3558 * If this function completes successfully, then no more functions can be called
3559 * on the ::WIMStruct other than wimlib_free(). If you need to continue using
3560 * the WIM file, you must use wimlib_open_wim() to open a new ::WIMStruct for
3564 * Pointer to a ::WIMStruct to commit to its backing file.
3565 * @param write_flags
3566 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3567 * @param num_threads
3568 * The number of threads to use for compressing data, or 0 to have the
3569 * library automatically choose an appropriate number.
3571 * @return 0 on success; a ::wimlib_error_code value on failure. This function
3572 * may return most error codes returned by wimlib_write() as well as the
3573 * following error codes:
3575 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3576 * Another process is currently modifying the WIM file.
3577 * @retval ::WIMLIB_ERR_NO_FILENAME
3578 * @p wim is not backed by an on-disk file. In other words, it is a
3579 * ::WIMStruct created by wimlib_create_new_wim() rather than
3580 * wimlib_open_wim().
3581 * @retval ::WIMLIB_ERR_RENAME
3582 * The temporary file to which the WIM was written could not be renamed to
3583 * the original file.
3584 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3585 * The WIM file is considered read-only because of any of the reasons
3586 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3589 * If a progress function is registered with @p wim, then it will receive the
3590 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3591 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3592 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3595 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3598 * @ingroup G_wim_information
3600 * Print information about one image, or all images, contained in a WIM.
3603 * Pointer to the ::WIMStruct to query. This need not represent a
3604 * standalone WIM (e.g. it could represent part of a split WIM).
3606 * The 1-based index of the image for which to print information, or
3607 * ::WIMLIB_ALL_IMAGES to print information about all images.
3609 * @return This function has no return value. No error checking is done when
3610 * printing the information. If @p image is invalid, an error message is
3614 wimlib_print_available_images(const WIMStruct *wim, int image);
3617 * @ingroup G_wim_information
3619 * Print the header of the WIM file (intended for debugging only).
3622 wimlib_print_header(const WIMStruct *wim);
3625 * @ingroup G_nonstandalone_wims
3627 * Reference file data from other WIM files or split WIM parts. This function
3628 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3629 * to load additional file data before calling a function such as
3630 * wimlib_extract_image() that requires the file data to be present.
3633 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3634 * necessarily "standalone". In the case of split WIMs, this should be the
3635 * first part, since only the first part contains the metadata resources.
3636 * In the case of delta WIMs, this should be the delta WIM rather than the
3637 * WIM on which it is based.
3638 * @param resource_wimfiles_or_globs
3639 * Array of paths to WIM files and/or split WIM parts to reference.
3640 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3641 * ref_flags, these are treated as globs rather than literal paths. That
3642 * is, using this function you can specify zero or more globs, each of
3643 * which expands to one or more literal paths.
3645 * Number of entries in @p resource_wimfiles_or_globs.
3647 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3648 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3650 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3651 * pass to internal calls to wimlib_open_wim() on the reference files.
3653 * @return 0 on success; a ::wimlib_error_code value on failure.
3655 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3656 * One of the specified globs did not match any paths (only with both
3657 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3658 * specified in @p ref_flags).
3659 * @retval ::WIMLIB_ERR_READ
3660 * I/O or permissions error while processing a file glob.
3662 * This function can additionally return most values that can be returned by
3663 * wimlib_open_wim().
3666 wimlib_reference_resource_files(WIMStruct *wim,
3667 const wimlib_tchar * const *resource_wimfiles_or_globs,
3673 * @ingroup G_nonstandalone_wims
3675 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3676 * where the caller must open the ::WIMStruct for each referenced file itself.
3679 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3680 * necessarily "standalone". In the case of split WIMs, this should be the
3681 * first part, since only the first part contains the metadata resources.
3682 * @param resource_wims
3683 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3684 * split WIM parts to reference.
3685 * @param num_resource_wims
3686 * Number of entries in @p resource_wims.
3688 * Reserved; must be 0.
3690 * @return 0 on success; a ::wimlib_error_code value on failure. On success,
3691 * the ::WIMStruct's of the @p resource_wims are referenced internally by @p wim
3692 * and must not be freed with wimlib_free() or overwritten with
3693 * wimlib_overwrite() until @p wim has been freed with wimlib_free(), or
3694 * immediately before freeing @p wim with wimlib_free().
3697 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3698 unsigned num_resource_wims, int ref_flags);
3701 * @ingroup G_modifying_wims
3703 * Declare that a newly added image is mostly the same as a prior image, but
3704 * captured at a later point in time, possibly with some modifications in the
3705 * intervening time. This is designed to be used in incremental backups of the
3706 * same filesystem or directory tree.
3708 * This function compares the metadata of the directory tree of the newly added
3709 * image against that of the old image. Any files that are present in both the
3710 * newly added image and the old image and have timestamps that indicate they
3711 * haven't been modified are deemed not to have been modified and have their
3712 * checksums copied from the old image. Because of this and because WIM uses
3713 * single-instance streams, such files need not be read from the filesystem when
3714 * the WIM is being written or overwritten. Note that these unchanged files
3715 * will still be "archived" and will be logically present in the new image; the
3716 * optimization is that they don't need to actually be read from the filesystem
3717 * because the WIM already contains them.
3719 * This function is provided to optimize incremental backups. The resulting WIM
3720 * file will still be the same regardless of whether this function is called.
3721 * (This is, however, assuming that timestamps have not been manipulated or
3722 * unmaintained as to trick this function into thinking a file has not been
3723 * modified when really it has. To partly guard against such cases, other
3724 * metadata such as file sizes will be checked as well.)
3726 * This function must be called after adding the new image (e.g. with
3727 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3728 * wimlib_overwrite()).
3731 * Pointer to the ::WIMStruct containing the newly added image.
3733 * The 1-based index in @p wim of the newly added image.
3734 * @param template_wim
3735 * Pointer to the ::WIMStruct containing the template image. This can be,
3736 * but does not have to be, the same ::WIMStruct as @p wim.
3737 * @param template_image
3738 * The 1-based index in @p template_wim of the template image.
3740 * Reserved; must be 0.
3742 * @return 0 on success; a ::wimlib_error_code value on failure.
3744 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3745 * @p new_image does not exist in @p wim or @p template_image does not
3746 * exist in @p template_wim.
3747 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3748 * The specified ::WIMStruct did not actually contain the metadata resource
3749 * for the new or template image; for example, it was a non-first part of a
3751 * @retval ::WIMLIB_ERR_INVALID_PARAM
3752 * @p new_image was equal to @p template_image, or @p new_image specified
3753 * an image that had not been modified since opening the WIM.
3755 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3756 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3757 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
3758 * indicate failure (for different reasons) to read the metadata resource for
3759 * the template image.
3762 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3763 WIMStruct *template_wim, int template_image,
3767 * @ingroup G_general
3769 * Register a progress function with a ::WIMStruct.
3772 * The ::WIMStruct for which to register the progress function.
3774 * Pointer to the progress function to register. If the WIM already has a
3775 * progress function registered, it will be replaced with this one. If @p
3776 * NULL, the current progress function (if any) will be unregistered.
3778 * The value which will be passed as the third argument to calls to @p
3782 wimlib_register_progress_function(WIMStruct *wim,
3783 wimlib_progress_func_t progfunc,
3787 * @ingroup G_modifying_wims
3789 * Rename the @p source_path to the @p dest_path in the specified @p image of
3792 * This just builds an appropriate ::wimlib_rename_command and passes it to
3793 * wimlib_update_image().
3796 wimlib_rename_path(WIMStruct *wim, int image,
3797 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3800 * @ingroup G_wim_information
3802 * Translate a string specifying the name or number of an image in the WIM into
3803 * the number of the image. The images are numbered starting at 1.
3806 * Pointer to the ::WIMStruct for a WIM.
3807 * @param image_name_or_num
3808 * A string specifying the name or number of an image in the WIM. If it
3809 * parses to a positive integer, this integer is taken to specify the
3810 * number of the image, indexed starting at 1. Otherwise, it is taken to
3811 * be the name of an image, as given in the XML data for the WIM file. It
3812 * also may be the keyword "all" or the string "*", both of which will
3813 * resolve to ::WIMLIB_ALL_IMAGES.
3815 * There is no way to search for an image actually named "all", "*", or an
3816 * integer number, or an image that has no name. However, you can use
3817 * wimlib_get_image_name() to get the name of any image.
3820 * If the string resolved to a single existing image, the number of that
3821 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3822 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3823 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3824 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3825 * images in @p wim has no name. (Since a WIM may have multiple unnamed
3826 * images, an unnamed image must be specified by index to eliminate the
3830 wimlib_resolve_image(WIMStruct *wim,
3831 const wimlib_tchar *image_name_or_num);
3834 * @ingroup G_general
3836 * Set the file to which the library will print error and warning messages.
3838 * This version of the function takes a C library <c>FILE*</c> opened for
3839 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3840 * file by name instead.
3842 * This also enables error messages, as if by a call to
3843 * wimlib_set_print_errors(true).
3845 * @return 0 on success; a ::wimlib_error_code value on failure.
3847 * @retval ::WIMLIB_ERR_UNSUPPORTED
3848 * wimlib was compiled using the <c>--without-error-messages</c> option.
3851 wimlib_set_error_file(FILE *fp);
3854 * @ingroup G_general
3856 * Set the path to the file to which the library will print error and warning
3857 * messages. The library will open this file for appending.
3859 * This also enables error messages, as if by a call to
3860 * wimlib_set_print_errors(true).
3862 * @return 0 on success; a ::wimlib_error_code value on failure.
3864 * @retval ::WIMLIB_ERR_OPEN
3865 * The file named by @p path could not be opened for appending.
3866 * @retval ::WIMLIB_ERR_UNSUPPORTED
3867 * wimlib was compiled using the <c>--without-error-messages</c> option.
3870 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3873 * @ingroup G_modifying_wims
3875 * Change the description of a WIM image.
3878 * Pointer to the ::WIMStruct for the WIM.
3880 * The 1-based index of the image for which to change the description.
3881 * @param description
3882 * The new description to give the image. It may be @c NULL, which
3883 * indicates that the image is to be given no description.
3885 * @return 0 on success; a ::wimlib_error_code value on failure.
3887 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3888 * @p image does not exist in @p wim.
3891 wimlib_set_image_descripton(WIMStruct *wim, int image,
3892 const wimlib_tchar *description);
3895 * @ingroup G_modifying_wims
3897 * Change what is stored in the \<FLAGS\> element in the WIM XML document
3898 * (usually something like "Core" or "Ultimate")
3901 * Pointer to the ::WIMStruct for the WIM.
3903 * The 1-based index of the image for which to change the flags.
3905 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3906 * indicates that the image is to be given no \<FLAGS\> element.
3908 * @return 0 on success; a ::wimlib_error_code value on failure.
3910 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3911 * @p image does not exist in @p wim.
3914 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3917 * @ingroup G_modifying_wims
3919 * Change the name of a WIM image.
3922 * Pointer to the ::WIMStruct for the WIM.
3924 * The 1-based index of the image for which to change the name.
3926 * New name to give the new image. If @c NULL or empty, the new image is
3927 * given no name. Otherwise, it must specify a name that does not already
3930 * @return 0 on success; a ::wimlib_error_code value on failure.
3932 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3933 * The WIM already contains an image with the requested name.
3934 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3935 * @p image does not exist in @p wim.
3938 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3941 * @ingroup G_general
3943 * Set the functions that wimlib uses to allocate and free memory.
3945 * These settings are global and not per-WIM.
3947 * The default is to use the default @c malloc(), @c free(), and @c realloc()
3948 * from the standard C library.
3950 * Note: some external functions, such as those in @c libntfs-3g, may use the
3951 * standard memory allocation functions regardless of this setting.
3953 * @param malloc_func
3954 * A function equivalent to @c malloc() that wimlib will use to allocate
3955 * memory. If @c NULL, the allocator function is set back to the default
3956 * @c malloc() from the C library.
3958 * A function equivalent to @c free() that wimlib will use to free memory.
3959 * If @c NULL, the free function is set back to the default @c free() from
3961 * @param realloc_func
3962 * A function equivalent to @c realloc() that wimlib will use to reallocate
3963 * memory. If @c NULL, the free function is set back to the default @c
3964 * realloc() from the C library.
3969 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3970 void (*free_func)(void *),
3971 void *(*realloc_func)(void *, size_t));
3974 * @ingroup G_writing_and_overwriting_wims
3976 * Set a ::WIMStruct's output compression chunk size. This is the compression
3977 * chunk size that will be used for writing non-solid resources in subsequent
3978 * calls to wimlib_write() or wimlib_overwrite(). A larger compression chunk
3979 * size often results in a better compression ratio, but compression may be
3980 * slower and the speed of random access to data may be reduced. In addition,
3981 * some chunk sizes are not compatible with Microsoft software.
3984 * The ::WIMStruct for which to set the output chunk size.
3986 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3987 * on the compression type. See the documentation for each
3988 * ::wimlib_compression_type constant for more information. As a special
3989 * case, if @p chunk_size is specified as 0, then the chunk size will be
3990 * reset to the default for the currently selected output compression type.
3992 * @return 0 on success; a ::wimlib_error_code value on failure.
3994 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3995 * @p chunk_size was not 0 or a supported chunk size for the currently
3996 * selected output compression type.
3999 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4002 * @ingroup G_writing_and_overwriting_wims
4004 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4008 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4011 * @ingroup G_writing_and_overwriting_wims
4013 * Set a ::WIMStruct's output compression type. This is the compression type
4014 * that will be used for writing non-solid resources in subsequent calls to
4015 * wimlib_write() or wimlib_overwrite().
4018 * The ::WIMStruct for which to set the output compression type.
4020 * The compression type to set. If this compression type is incompatible
4021 * with the current output chunk size, then the output chunk size will be
4022 * reset to the default for the new compression type.
4024 * @return 0 on success; a ::wimlib_error_code value on failure.
4026 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4027 * @p ctype did not specify a valid compression type.
4030 wimlib_set_output_compression_type(WIMStruct *wim,
4031 enum wimlib_compression_type ctype);
4034 * @ingroup G_writing_and_overwriting_wims
4036 * Similar to wimlib_set_output_compression_type(), but set the compression type
4037 * for writing solid resources. This cannot be ::WIMLIB_COMPRESSION_TYPE_NONE.
4040 wimlib_set_output_pack_compression_type(WIMStruct *wim,
4041 enum wimlib_compression_type ctype);
4044 * @ingroup G_general
4046 * Set whether wimlib can print error and warning messages to the error file,
4047 * which defaults to standard error. Error and warning messages may provide
4048 * information that cannot be determined only from returned error codes.
4050 * By default, error messages are not printed.
4052 * This setting applies globally (it is not per-WIM).
4054 * This can be called before wimlib_global_init().
4056 * @param show_messages
4057 * @c true if messages are to be printed; @c false if messages are not to
4060 * @return 0 on success; a ::wimlib_error_code value on failure.
4062 * @retval ::WIMLIB_ERR_UNSUPPORTED
4063 * wimlib was compiled using the <c>--without-error-messages</c> option.
4066 wimlib_set_print_errors(bool show_messages);
4069 * @ingroup G_modifying_wims
4071 * Set basic information about a WIM.
4074 * Pointer to the ::WIMStruct for a WIM.
4076 * A struct ::wimlib_wim_info that contains the information to set. Only
4077 * the information explicitly specified in the @p which flags need be
4080 * Flags that specify which information to set. This is a bitwise OR of
4081 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4082 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4084 * @return 0 on success; a ::wimlib_error_code value on failure.
4086 * @retval ::WIMLIB_ERR_IMAGE_COUNT
4087 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4088 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4092 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4096 * @ingroup G_nonstandalone_wims
4098 * Split a WIM into multiple parts.
4101 * The ::WIMStruct for the WIM to split.
4103 * Name of the split WIM (SWM) file to create. This will be the name of
4104 * the first part. The other parts will, by default, have the same name
4105 * with 2, 3, 4, ..., etc. appended before the suffix. However, the exact
4106 * names can be customized using the progress function.
4108 * The maximum size per part, in bytes. Unfortunately, it is not
4109 * guaranteed that this will really be the maximum size per part, because
4110 * some file resources in the WIM may be larger than this size, and the WIM
4111 * file format provides no way to split up file resources among multiple
4113 * @param write_flags
4114 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4115 * flags will be used to write each split WIM part. Specify 0 here to get
4116 * the default behavior.
4118 * @return 0 on success; a ::wimlib_error_code value on failure. This function
4119 * may return most error codes that can be returned by wimlib_write() as well as
4120 * the following error codes:
4122 * @retval ::WIMLIB_ERR_INVALID_PARAM
4123 * @p swm_name was not a nonempty string, or @p part_size was 0.
4124 * @retval ::WIMLIB_ERR_UNSUPPORTED
4125 * The WIM contains solid resources. Splitting a WIM containing solid
4126 * resources is not supported.
4128 * If a progress function is registered with @p wim, then for each split WIM
4129 * part that is written it will receive the messages
4130 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4131 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4134 wimlib_split(WIMStruct *wim,
4135 const wimlib_tchar *swm_name,
4140 * @ingroup G_general
4142 * Perform verification checks on a WIM file.
4144 * This function is intended for safety checking and/or debugging. If used on a
4145 * well-formed WIM file, it should always succeed.
4148 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4149 * verification, it is a good idea to have used
4150 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4152 * If verifying a split WIM, specify the first part of the split WIM here,
4153 * and reference the other parts using wimlib_reference_resource_files()
4154 * before calling this function.
4155 * @param verify_flags
4156 * Reserved; must be 0.
4158 * @return 0 if the WIM file was successfully verified; a ::wimlib_error_code
4159 * value if it failed verification or another error occurred.
4161 * @retval ::WIMLIB_ERR_DECOMPRESSION
4162 * A compressed resource could not be decompressed.
4163 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4164 * The metadata resource for an image is invalid.
4165 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4166 * File data stored in the WIM file is corrupt.
4167 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4168 * The data for a file in an image could not be found. See @ref
4169 * G_nonstandalone_wims.
4171 * If a progress function is registered with @p wim, then it will receive the
4172 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4173 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4174 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4177 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4180 * @ingroup G_mounting_wim_images
4182 * Unmount a WIM image that was mounted using wimlib_mount_image().
4184 * When unmounting a read-write mounted image, the default behavior is to
4185 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4186 * WIM image to be committed.
4189 * The directory the WIM image was mounted on.
4190 * @param unmount_flags
4191 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4193 * @return 0 on success; a ::wimlib_error_code value on failure.
4195 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4196 * There is no WIM image mounted on the specified directory.
4197 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4198 * The read-write mounted WIM image cannot be committed because there are
4199 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4201 * @retval ::WIMLIB_ERR_MQUEUE
4202 * Could not create a POSIX message queue.
4203 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4204 * The WIM image was mounted by a different user.
4205 * @retval ::WIMLIB_ERR_UNSUPPORTED
4206 * Mounting is not supported in this build of the library.
4208 * Note: you can also unmount the image by using the @c umount() system call, or
4209 * by using the @c umount or @c fusermount programs. However, you need to call
4210 * this function if you want changes to be committed.
4213 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4216 * @ingroup G_mounting_wim_images
4218 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4219 * If changes are committed from a read-write mount, the progress function will
4220 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4223 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4225 wimlib_progress_func_t progfunc,
4229 * @ingroup G_modifying_wims
4231 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4234 * Pointer to the ::WIMStruct containing the image to update.
4236 * The 1-based index of the image to update.
4238 * An array of ::wimlib_update_command's that specify the update operations
4241 * Number of commands in @p cmds.
4242 * @param update_flags
4243 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4245 * @return 0 on success; a ::wimlib_error_code value on failure. On failure,
4246 * all update commands will be rolled back, and no visible changes will have
4247 * been made to @p wim.
4249 * @retval ::WIMLIB_ERR_FVE_LOCKED_VOLUME
4250 * Windows-only: One of the "add" commands attempted to add files from an
4251 * encrypted BitLocker volume that hasn't yet been unlocked.
4252 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4253 * The capture configuration structure specified for an add command was
4255 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4256 * @p image did not exist in @p wim.
4257 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4258 * Attempted to perform an add command that conflicted with previously
4259 * existing files in the WIM when an overlay was attempted.
4260 * @retval ::WIMLIB_ERR_INVALID_PARAM
4261 * An unknown operation type was specified in the update commands; or,
4262 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
4263 * in the @p add_flags, but the same image had previously already been
4264 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
4265 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
4266 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
4267 * specified in the @p add_flags for an add command in which @p
4268 * wim_target_path was not the root directory of the WIM image.
4269 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4270 * (Windows only): While executing an add command, tried to capture a
4271 * reparse point with invalid data.
4272 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4273 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4274 * for a WIM path that corresponded to a directory; or, a rename command
4275 * attempted to rename a directory to a non-directory.
4276 * @retval ::WIMLIB_ERR_NOTDIR
4277 * A rename command attempted to rename a directory to a non-directory; or,
4278 * an add command was executed that attempted to set the root of the WIM
4279 * image as a non-directory; or, a path component used as a directory in a
4280 * rename command was not, in fact, a directory.
4281 * @retval ::WIMLIB_ERR_NOTEMPTY
4282 * A rename command attempted to rename a directory to a non-empty
4284 * @retval ::WIMLIB_ERR_NTFS_3G
4285 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4286 * error occurred while reading data from the NTFS volume using libntfs-3g.
4287 * @retval ::WIMLIB_ERR_OPEN
4288 * Failed to open a file to be captured while executing an add command.
4289 * @retval ::WIMLIB_ERR_OPENDIR
4290 * Failed to open a directory to be captured while executing an add command.
4291 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4292 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4293 * WIM path that did not exist; or, a rename command attempted to rename a
4294 * file that does not exist.
4295 * @retval ::WIMLIB_ERR_READ
4296 * While executing an add command, failed to read data from a file or
4297 * directory to be captured.
4298 * @retval ::WIMLIB_ERR_READLINK
4299 * While executing an add command, failed to read the target of a symbolic
4300 * link or junction point.
4301 * @retval ::WIMLIB_ERR_STAT
4302 * While executing an add command, failed to get attributes for a file or
4304 * @retval ::WIMLIB_ERR_UNSUPPORTED
4305 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4306 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4307 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4308 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4309 * add_flags for an update command.
4310 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4311 * While executing an add command, attempted to capture a file that was not
4312 * a supported file type (e.g. a device file). Only if
4313 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4314 * for an update command.
4316 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4317 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4318 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4319 * indicate failure (for different reasons) to read the metadata resource for an
4320 * image that needed to be updated.
4323 wimlib_update_image(WIMStruct *wim,
4325 const struct wimlib_update_command *cmds,
4330 * @ingroup G_writing_and_overwriting_wims
4332 * Persist a ::WIMStruct to a new on-disk WIM file.
4334 * This brings in file data from any external locations, such as directory trees
4335 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4336 * wimlib_export_image(), and incorporates it into a new on-disk WIM file.
4338 * By default, the new WIM file is written as stand-alone. Using the
4339 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4340 * instead. However, this function cannot directly write a "split" WIM; use
4341 * wimlib_split() for that.
4344 * Pointer to the ::WIMStruct being persisted.
4346 * The path to the on-disk file to write.
4348 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4349 * images are to be included in the new on-disk WIM file. If for some
4350 * reason you only want to include a single image, specify the 1-based
4351 * index of that image instead.
4352 * @param write_flags
4353 * Bitwise OR of flags prefixed with @c WIMLIB_WRITE_FLAG.
4354 * @param num_threads
4355 * The number of threads to use for compressing data, or 0 to have the
4356 * library automatically choose an appropriate number.
4358 * @return 0 on success; a ::wimlib_error_code value on failure.
4360 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4361 * @p image did not exist in @p wim.
4362 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4363 * A file, stored in another WIM, which needed to be written was corrupt;
4364 * or a file that had previously been scanned for inclusion in the WIM was
4365 * concurrently modified.
4366 * @retval ::WIMLIB_ERR_INVALID_PARAM
4367 * @p path was not a nonempty string, or invalid flags were passed.
4368 * @retval ::WIMLIB_ERR_OPEN
4369 * Failed to open the output WIM file for writing, or failed to open a file
4370 * whose data needed to be included in the WIM.
4371 * @retval ::WIMLIB_ERR_READ
4372 * Failed to read data that needed to be included in the WIM.
4373 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4374 * A file data blob that needed to be written could not be found in the
4375 * blob lookup table of @p wim. See @ref G_nonstandalone_wims.
4376 * @retval ::WIMLIB_ERR_WRITE
4377 * An error occurred when trying to write data to the new WIM file.
4379 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4380 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4381 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
4382 * indicate failure (for different reasons) to read the data from a WIM file.
4384 * If a progress function is registered with @p wim, then it will receive the
4385 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4386 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4387 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4390 wimlib_write(WIMStruct *wim,
4391 const wimlib_tchar *path,
4394 unsigned num_threads);
4397 * @ingroup G_writing_and_overwriting_wims
4399 * Same as wimlib_write(), but write the WIM directly to a file descriptor,
4400 * which need not be seekable if the write is done in a special pipable WIM
4401 * format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p write_flags. This can,
4402 * for example, allow capturing a WIM image and streaming it over the network.
4403 * See @ref subsec_pipable_wims for more information about pipable WIMs.
4405 * The file descriptor @p fd will @b not be closed when the write is complete;
4406 * the calling code is responsible for this.
4408 * @return 0 on success; a ::wimlib_error_code value on failure. The possible
4409 * error codes include those that can be returned by wimlib_write() as well as
4412 * @retval ::WIMLIB_ERR_INVALID_PARAM
4413 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4414 * specified in @p write_flags.
4417 wimlib_write_to_fd(WIMStruct *wim,
4421 unsigned num_threads);
4424 * @defgroup G_compression Compression and decompression functions
4426 * @brief Functions for XPRESS, LZX, and LZMS compression and decompression.
4428 * These functions are already used by wimlib internally when appropriate for
4429 * reading and writing WIM archives. But they are exported and documented so
4430 * that they can be used in other applications or libraries for general-purpose
4431 * lossless data compression. They are implemented in highly optimized C code,
4432 * using state-of-the-art compression techniques. The main limitation is the
4433 * lack of sliding window support; this has, however, allowed the algorithms to
4434 * be optimized for block-based compression.
4439 /** Opaque compressor handle. */
4440 struct wimlib_compressor;
4442 /** Opaque decompressor handle. */
4443 struct wimlib_decompressor;
4446 * Set the default compression level for the specified compression type. This
4447 * is the compression level that wimlib_create_compressor() assumes if it is
4448 * called with @p compression_level specified as 0.
4450 * wimlib's WIM writing code (e.g. wimlib_write()) will pass 0 to
4451 * wimlib_create_compressor() internally. Therefore, calling this function will
4452 * affect the compression level of any data later written to WIM files using the
4453 * specified compression type.
4455 * The initial state, before this function is called, is that all compression
4456 * types have a default compression level of 50.
4459 * Compression type for which to set the default compression level, as one
4460 * of the ::wimlib_compression_type constants. Or, if this is the special
4461 * value -1, the default compression levels for all compression types will
4463 * @param compression_level
4464 * The default compression level to set. If 0, the "default default" level
4465 * of 50 is restored. Otherwise, a higher value indicates higher
4466 * compression, whereas a lower value indicates lower compression. See
4467 * wimlib_create_compressor() for more information.
4469 * @return 0 on success; a ::wimlib_error_code value on failure.
4471 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4472 * @p ctype was neither a supported compression type nor -1.
4475 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
4478 * Return the approximate number of bytes needed to allocate a compressor with
4479 * wimlib_create_compressor() for the specified compression type, maximum block
4480 * size, and compression level. @p compression_level may be 0, in which case
4481 * the current default compression level for @p ctype is used. Returns 0 if the
4482 * compression type is invalid, or the @p max_block_size for that compression
4486 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4487 size_t max_block_size,
4488 unsigned int compression_level);
4490 #define WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE 0x80000000
4493 * Allocate a compressor for the specified compression type using the specified
4494 * parameters. This function is part of wimlib's compression API; it is not
4495 * necessary to call this to process a WIM file.
4498 * Compression type for which to create the compressor, as one of the
4499 * ::wimlib_compression_type constants.
4500 * @param max_block_size
4501 * The maximum compression block size to support. This specifies the
4502 * maximum allowed value for the @p uncompressed_size parameter of
4503 * wimlib_compress() when called using this compressor.
4505 * Usually, the amount of memory used by the compressor will scale in
4506 * proportion to the @p max_block_size parameter.
4507 * wimlib_get_compressor_needed_memory() can be used to query the specific
4508 * amount of memory that will be required.
4510 * This parameter must be at least 1 and must be less than or equal to a
4511 * compression-type-specific limit.
4513 * In general, the same value of @p max_block_size must be passed to
4514 * wimlib_create_decompressor() when the data is later decompressed.
4515 * However, some compression types have looser requirements regarding this.
4516 * @param compression_level
4517 * The compression level to use. If 0, the default compression level (50,
4518 * or another value as set through wimlib_set_default_compression_level())
4519 * is used. Otherwise, a higher value indicates higher compression. The
4520 * values are scaled so that 10 is low compression, 50 is medium
4521 * compression, and 100 is high compression. This is not a percentage;
4522 * values above 100 are also valid.
4524 * Using a higher-than-default compression level can result in a better
4525 * compression ratio, but can significantly reduce performance. Similarly,
4526 * using a lower-than-default compression level can result in better
4527 * performance, but can significantly worsen the compression ratio. The
4528 * exact results will depend heavily on the compression type and what
4529 * algorithms are implemented for it. If you are considering using a
4530 * non-default compression level, you should run benchmarks to see if it is
4531 * worthwhile for your application.
4533 * The compression level does not affect the format of the compressed data.
4534 * Therefore, it is a compressor-only parameter and does not need to be
4535 * passed to the decompressor.
4537 * Since wimlib v1.8.0, this parameter can be OR-ed with the flag
4538 * ::WIMLIB_COMPRESSOR_FLAG_DESTRUCTIVE. This creates the compressor in a
4539 * mode where it is allowed to modify the input buffer. Specifically, in
4540 * this mode, if compression succeeds, the input buffer may have been
4541 * modified, whereas if compression does not succeed the input buffer still
4542 * may have been written to but will have been restored exactly to its
4543 * original state. This mode is designed to save some memory when using
4544 * large buffer sizes.
4545 * @param compressor_ret
4546 * A location into which to return the pointer to the allocated compressor.
4547 * The allocated compressor can be used for any number of calls to
4548 * wimlib_compress() before being freed with wimlib_free_compressor().
4550 * @return 0 on success; a ::wimlib_error_code value on failure.
4552 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4553 * @p ctype was not a supported compression type.
4554 * @retval ::WIMLIB_ERR_INVALID_PARAM
4555 * @p max_block_size was invalid for the compression type, or @p
4556 * compressor_ret was @c NULL.
4557 * @retval ::WIMLIB_ERR_NOMEM
4558 * Insufficient memory to allocate the compressor.
4561 wimlib_create_compressor(enum wimlib_compression_type ctype,
4562 size_t max_block_size,
4563 unsigned int compression_level,
4564 struct wimlib_compressor **compressor_ret);
4567 * Compress a buffer of data.
4569 * @param uncompressed_data
4570 * Buffer containing the data to compress.
4571 * @param uncompressed_size
4572 * Size, in bytes, of the data to compress. This cannot be greater than
4573 * the @p max_block_size with which wimlib_create_compressor() was called.
4574 * (If it is, the data will not be compressed and 0 will be returned.)
4575 * @param compressed_data
4576 * Buffer into which to write the compressed data.
4577 * @param compressed_size_avail
4578 * Number of bytes available in @p compressed_data.
4580 * A compressor previously allocated with wimlib_create_compressor().
4583 * The size of the compressed data, in bytes, or 0 if the data could not be
4584 * compressed to @p compressed_size_avail or fewer bytes.
4587 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4588 void *compressed_data, size_t compressed_size_avail,
4589 struct wimlib_compressor *compressor);
4592 * Free a compressor previously allocated with wimlib_create_compressor().
4595 * The compressor to free. If @c NULL, no action is taken.
4598 wimlib_free_compressor(struct wimlib_compressor *compressor);
4601 * Allocate a decompressor for the specified compression type. This function is
4602 * part of wimlib's compression API; it is not necessary to call this to process
4606 * Compression type for which to create the decompressor, as one of the
4607 * ::wimlib_compression_type constants.
4608 * @param max_block_size
4609 * The maximum compression block size to support. This specifies the
4610 * maximum allowed value for the @p uncompressed_size parameter of
4611 * wimlib_decompress().
4613 * In general, this parameter must be the same as the @p max_block_size
4614 * that was passed to wimlib_create_compressor() when the data was
4615 * compressed. However, some compression types have looser requirements
4617 * @param decompressor_ret
4618 * A location into which to return the pointer to the allocated
4619 * decompressor. The allocated decompressor can be used for any number of
4620 * calls to wimlib_decompress() before being freed with
4621 * wimlib_free_decompressor().
4623 * @return 0 on success; a ::wimlib_error_code value on failure.
4625 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4626 * @p ctype was not a supported compression type.
4627 * @retval ::WIMLIB_ERR_INVALID_PARAM
4628 * @p max_block_size was invalid for the compression type, or @p
4629 * decompressor_ret was @c NULL.
4630 * @retval ::WIMLIB_ERR_NOMEM
4631 * Insufficient memory to allocate the decompressor.
4634 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4635 size_t max_block_size,
4636 struct wimlib_decompressor **decompressor_ret);
4639 * Decompress a buffer of data.
4641 * @param compressed_data
4642 * Buffer containing the data to decompress.
4643 * @param compressed_size
4644 * Size, in bytes, of the data to decompress.
4645 * @param uncompressed_data
4646 * Buffer into which to write the uncompressed data.
4647 * @param uncompressed_size
4648 * Size, in bytes, of the data when uncompressed. This cannot exceed the
4649 * @p max_block_size with which wimlib_create_decompressor() was called.
4650 * (If it does, the data will not be decompressed and a nonzero value will
4652 * @param decompressor
4653 * A decompressor previously allocated with wimlib_create_decompressor().
4655 * @return 0 on success; nonzero on failure.
4657 * No specific error codes are defined; any nonzero value indicates that the
4658 * decompression failed. This can only occur if the data is truly invalid;
4659 * there will never be transient errors like "out of memory", for example.
4661 * This function requires that the exact uncompressed size of the data be passed
4662 * as the @p uncompressed_size parameter. If this is not done correctly,
4663 * decompression may fail or the data may be decompressed incorrectly.
4666 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4667 void *uncompressed_data, size_t uncompressed_size,
4668 struct wimlib_decompressor *decompressor);
4671 * Free a decompressor previously allocated with wimlib_create_decompressor().
4673 * @param decompressor
4674 * The decompressor to free. If @c NULL, no action is taken.
4677 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4689 #endif /* _WIMLIB_H */