3 * @brief External header for wimlib.
5 * This file contains extensive comments for generating documentation with
6 * Doxygen. The built HTML documentation can be viewed at
7 * http://wimlib.sourceforge.net. Make sure to see the <a
8 * href="modules.html">Modules page</a> to make more sense of the declarations
13 * Copyright (C) 2012, 2013, 2014 Eric Biggers
15 * This file is part of wimlib, a library for working with WIM files.
17 * wimlib is free software; you can redistribute it and/or modify it under the
18 * terms of the GNU General Public License as published by the Free
19 * Software Foundation; either version 3 of the License, or (at your option)
22 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
23 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
24 * A PARTICULAR PURPOSE. See the GNU General Public License for more
27 * You should have received a copy of the GNU General Public License
28 * along with wimlib; if not, see http://www.gnu.org/licenses/.
34 * This is the documentation for the library interface of wimlib 1.7.1, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the manual pages and also the <a
39 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
42 * @section sec_installing Installing
46 * Download the source code from <a
47 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
48 * Install the library by running <c>configure && make && sudo make install</c>.
49 * See the README for information about configuration options. To use wimlib in
50 * your program after installing it, include wimlib.h and link your program with
55 * Download the Windows binary distribution with the appropriate architecture
56 * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
57 * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
58 * Link your program with the libwim-15.dll file. Make sure to also download
59 * the source code so you can get wimlib.h, as it is not included in the binary
60 * distribution. If you need to access the DLL from other programming
61 * languages, note that the calling convention is "cdecl".
63 * @section sec_examples Examples
65 * Several examples are located in the <a
66 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
67 * directory of the source distribution.
69 * There is also the <a
70 * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
71 * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
72 * capabilities of wimlib.
74 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
76 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
77 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
78 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
79 * which creates a new ::WIMStruct that initially contains no images and does
80 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
83 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
84 * Images can be extracted (or "applied") using wimlib_extract_image(), added
85 * (or "captured" or "appended") using wimlib_add_image(), deleted using
86 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
87 * modified using wimlib_update_image(). However, changes made to a WIM
88 * represented by a ::WIMStruct have no persistent effect until the WIM is
89 * actually written to an on-disk file. This can be done using wimlib_write(),
90 * but if the WIM was originally opened using wimlib_open_wim(), then
91 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
92 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
94 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
95 * files is a multi-step process. For example, to add, or "append" an image to
96 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
97 * append</b>, you must call the following functions:
99 * 1. wimlib_open_wim()
100 * 2. wimlib_add_image()
101 * 3. wimlib_overwrite()
103 * This design is very much on purpose as it makes the library more useful in
104 * general by allowing functions to be composed in different ways. For example,
105 * you can make multiple changes to a WIM and commit them all to the underlying
106 * file in only one overwrite operation, which is more efficient.
108 * Note: before calling any other function declared in wimlib.h,
109 * wimlib_global_init() can (and in some cases, must) be called. See its
110 * documentation for more details.
112 * @section sec_cleaning_up Cleaning up
114 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
115 * all resources associated with it. Also, when you are completely done with
116 * using wimlib in your program, you can call wimlib_global_cleanup() to free
117 * any other resources allocated by the library.
119 * @section sec_error_handling Error Handling
121 * Most functions in wimlib return 0 on success and a positive error code on
122 * failure. Use wimlib_get_error_string() to get a string that describes an
123 * error code. wimlib also can print error messages to standard error itself
124 * when an error happens, and these may be more informative than the error code;
125 * to enable this, call wimlib_set_print_errors(). Please note that this is for
126 * convenience only, and some errors can occur without a message being printed.
127 * Currently, error messages and strings (as well as all documentation, for that
128 * matter) are only available in English.
130 * @section sec_encodings Locales and character encodings
132 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
133 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
136 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
137 * and the encoding is UTF-16LE.
139 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
140 * and the encoding is the locale-dependent multibyte encoding. I recommend you
141 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
142 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
143 * call wimlib_global_init() after having set your desired locale.
145 * @section sec_advanced Additional information and features
148 * @subsection subsec_mounting_wim_images Mounting WIM images
150 * See @ref G_mounting_wim_images.
152 * @subsection subsec_progress_functions Progress Messages
154 * See @ref G_progress.
156 * @subsection subsec_non_standalone_wims Non-standalone WIMs
158 * See @ref G_nonstandalone_wims.
160 * @subsection subsec_pipable_wims Pipable WIMs
162 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
163 * compatible with Microsoft's software. To create a pipable WIM, call
164 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
165 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
166 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
167 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
168 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
169 * s using a seekable file descriptor using the regular function calls (e.g.
170 * wimlib_open_wim(), wimlib_extract_image()).
172 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
173 * capture</b> for more information about pipable WIMs.
175 * @subsection subsec_thread_safety Thread Safety
177 * wimlib is thread-safe, with the following exceptions:
178 * - Different threads cannot operate on the same ::WIMStruct at the same time;
179 * they must use different ::WIMStruct's.
180 * - You must call wimlib_global_init() in one thread before calling any other
182 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
183 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
184 * concurrently in the same process, will daemonize the entire process when it
185 * does so for the first time. This includes changing the working directory
186 * to the root directory.
188 * @subsection subsec_limitations Limitations
190 * This section documents some technical limitations of wimlib not already
191 * documented in the man page for @b wimlib-imagex.
193 * - The old WIM format from Vista pre-releases is not supported.
194 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
195 * functionality other than that already present in @b ImageX, that allows you
196 * to make certain Windows-specific modifications to a Windows PE image, such
197 * as adding a driver or Windows component. Such a tool could be implemented
200 * @subsection more_info More information
202 * You are advised to read the README as well as the manual pages for
203 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
204 * the API documentation.
207 /** @defgroup G_general General
209 * @brief Declarations and structures shared across the library.
212 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
214 * @brief Create new WIMs and open existing WIMs.
217 /** @defgroup G_wim_information Retrieving WIM information and directory listings
219 * @brief Retrieve information about a WIM or WIM image.
222 /** @defgroup G_modifying_wims Modifying WIMs
224 * @brief Make changes to a WIM.
226 * @section sec_adding_images Capturing and adding WIM images
228 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
229 * appending an image to an existing WIM is a multi-step process, but at its
230 * core is wimlib_add_image() or an equivalent function. Normally,
231 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
232 * ::WIMStruct as a new image. However, when supported by the build of the
233 * library, there is also a special NTFS volume capture mode (entered when
234 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
235 * from an unmounted NTFS volume.
237 * Another function, wimlib_add_image_multisource() is also provided. It
238 * generalizes wimlib_add_image() to allow combining multiple files or directory
239 * trees into a single WIM image in a configurable way.
241 * For maximum customization of WIM image creation, it is also possible to add a
242 * completely empty WIM image with wimlib_add_empty_image(), then update it with
243 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
244 * wimlib_add_image_multisource() do internally.)
246 * Note that some details of how image addition/capture works are documented
247 * more fully in the manual page for <b>wimlib-imagex capture</b>.
249 * @section sec_deleting_images Deleting WIM images
251 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
252 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
253 * be made persistent in an on-disk WIM file.
255 * @section sec_exporting_images Exporting WIM images
257 * wimlib_export_image() can copy, or "export", an image from one WIM to
260 * @section sec_other_modifications Other modifications
262 * wimlib_update_image() can add, delete, and rename files in a WIM image.
264 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
265 * wimlib_set_image_flags() can change other image metadata.
267 * wimlib_set_wim_info() can change information about the WIM file itself, such
271 /** @defgroup G_extracting_wims Extracting WIMs
273 * @brief Extract files, directories, and images from a WIM.
275 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
276 * represented by a ::WIMStruct. This normally extracts the image to a
277 * directory, but when supported by the build of the library there is also a
278 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
279 * is specified) that allows extracting a WIM image directly to an unmounted
280 * NTFS volume. Various other flags allow further customization of image
283 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
284 * of (possibly wildcard) paths from a WIM image.
286 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
287 * over a pipe; see @ref subsec_pipable_wims.
289 * Some details of how WIM extraction works are documented more fully in the
290 * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
293 /** @defgroup G_mounting_wim_images Mounting WIM images
295 * @brief Mount and unmount WIM images.
297 * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
298 * mounting images from WIM files either read-only or read-write. To mount an
299 * image, call wimlib_mount_image(). To unmount an image, call
300 * wimlib_unmount_image(). Mounting can be done without root privileges because
301 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
302 * compiled with the <code>--without-fuse</code> flag, these functions will be
303 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED. Note that mounting an
304 * image read-write is an alternative to calling wimlib_update_image().
308 * @defgroup G_progress Progress Messages
310 * @brief Track the progress of long WIM operations.
312 * Library users can provide a progress function which will be called
313 * periodically during operations such as extracting a WIM image or writing a
314 * WIM image. A ::WIMStruct can have a progress function of type
315 * ::wimlib_progress_func_t associated with it by calling
316 * wimlib_register_progress_function() or by opening the ::WIMStruct using
317 * wimlib_open_wim_with_progress(). Once this is done, the progress function
318 * will be called automatically during many operations, such as
319 * wimlib_extract_image() and wimlib_write().
321 * Some functions that do not operate directly on a user-provided ::WIMStruct,
322 * such as wimlib_join(), also take the progress function directly using an
323 * extended version of the function, such as wimlib_join_with_progress().
325 * In wimlib v1.7.0 and later, progress functions are no longer just
326 * unidirectional. You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
327 * the current operation to be aborted. wimlib v1.7.0 also added the third
328 * argument to ::wimlib_progress_func_t, which is a user-supplied context.
331 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
333 * @brief Write and overwrite on-disk WIM files.
335 * As described in @ref sec_basic_wim_handling_concepts, these functions are
336 * fundamental to the design of the library as they allow new or modified
337 * ::WIMStruct's to actually be written to on-disk files. Call wimlib_write()
338 * to write a new WIM file, or wimlib_overwrite() to persistently update an
342 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
344 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
346 * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it
347 * than that. Normally, WIM files are "standalone". However, WIM files can
348 * also be arranged in non-standalone ways, such as a set of on-disk files that
349 * together form a single "split WIM" or "delta WIM". Such arrangements are
350 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
351 * created from one of these on-disk files initially only partially represents
352 * the full WIM and needs to, in effect, be logically combined with other
353 * ::WIMStruct's before performing certain operations, such as extracting files
354 * with wimlib_extract_image() or wimlib_extract_paths(). This is done by
355 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
357 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
358 * specialized function (wimlib_split()) is needed to create a split WIM.
367 #include <inttypes.h>
371 # define _wimlib_deprecated __attribute__((deprecated))
373 # define _wimlib_deprecated
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 7
385 /** Patch version of the library (for example, the 5 in 1.2.5). */
386 #define WIMLIB_PATCH_VERSION 1
393 * Opaque structure that represents a WIM file. This is an in-memory structure
394 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
395 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
396 * continuing to exist so that data can be read from it as needed.
398 * Most functions in this library will work the same way regardless of whether a
399 * given ::WIMStruct was obtained through wimlib_open_wim() or
400 * wimlib_create_new_wim(). Exceptions are documented.
402 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
403 * file from a ::WIMStruct.
405 * See @ref sec_basic_wim_handling_concepts for more information.
407 #ifndef WIMLIB_WIMSTRUCT_DECLARED
408 typedef struct WIMStruct WIMStruct;
409 #define WIMLIB_WIMSTRUCT_DECLARED
413 typedef wchar_t wimlib_tchar;
415 /** See @ref sec_encodings */
416 typedef char wimlib_tchar;
420 /** Path separator for WIM paths passed back to progress callbacks.
421 * This is forward slash on UNIX and backslash on Windows. */
422 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
423 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
425 /** Path separator for WIM paths passed back to progress callbacks.
426 * This is forward slash on UNIX and backslash on Windows. */
427 # define WIMLIB_WIM_PATH_SEPARATOR '/'
428 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
431 /** Use this to specify the root directory of the WIM image. */
432 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
434 /** Use this to test if the specified path refers to the root directory of the
436 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
437 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
440 /** Length of a Globally Unique Identifier (GUID) */
441 #define WIMLIB_GUID_LEN 16
444 * Specifies a compression format. Pass one of these values to
445 * wimlib_create_new_wim(), wimlib_create_compressor(), or
446 * wimlib_create_decompressor().
448 * A WIM file has one default compression type and chunk size. Normally, each
449 * resource is compressed with this compression type. However, resources may be
450 * stored as uncompressed. In addition, a WIM with the new version number of
451 * 3584, or "ESD file", might contain solid blocks with different compression
454 enum wimlib_compression_type {
455 /** No compression. */
456 WIMLIB_COMPRESSION_TYPE_NONE = 0,
458 /** The XPRESS compression format. This format combines Lempel-Ziv
459 * factorization with Huffman encoding. Compression and decompression
460 * are both fast. This format supports chunk sizes that are powers of 2
461 * between <c>2^12</c> and <c>2^26</c>, inclusively. */
462 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
464 /** The LZX compression format. This format combines Lempel-Ziv
465 * factorization with Huffman encoding, but with more features and
466 * complexity than XPRESS. Compression is slow to somewhat fast,
467 * depending on the settings. Decompression is fast but slower than
468 * XPRESS. This format supports chunk sizes that are powers of 2
469 * between <c>2^15</c> and <c>2^21</c>, inclusively. Note: chunk sizes
470 * other than <c>2^15</c> are not compatible with the Microsoft
472 WIMLIB_COMPRESSION_TYPE_LZX = 2,
474 /** The LZMS compression format. This format combines Lempel-Ziv
475 * factorization with adaptive Huffman encoding and range coding.
476 * Compression and decompression are both fairly slow. This format
477 * supports chunk sizes that are powers of 2 between <c>2^15</c> and
478 * <c>2^30</c>, inclusively. This format is best used for large chunk
479 * sizes. Note: LZMS compression is only compatible with wimlib v1.6.0
480 * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
481 * later. Also, chunk sizes larger than <c>2^26</c> are not compatible
482 * with the Microsoft implementation. */
483 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
487 /** @addtogroup G_progress
490 /** Possible values of the first parameter to the user-supplied
491 * ::wimlib_progress_func_t progress function */
492 enum wimlib_progress_msg {
494 /** A WIM image is about to be extracted. @p info will point to
495 * ::wimlib_progress_info.extract. This message is received once per
496 * image for calls to wimlib_extract_image() and
497 * wimlib_extract_image_from_pipe(). */
498 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
500 /** One or more file or directory trees within a WIM image is about to
501 * be extracted. @p info will point to ::wimlib_progress_info.extract.
502 * This message is received only once per wimlib_extract_paths() and
503 * wimlib_extract_pathlist(), since wimlib combines all paths into a
504 * single extraction operation for optimization purposes. */
505 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
507 /** File data is currently being extracted. @p info will point to
508 * ::wimlib_progress_info.extract. This is the main message to track
509 * the progress of an extraction operation. */
510 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
512 /** Starting to read a new part of a split pipable WIM over the pipe.
513 * @p info will point to ::wimlib_progress_info.extract. */
514 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
516 /** Confirms that the image has been successfully extracted. @p info
517 * will point to ::wimlib_progress_info.extract. This is paired with
518 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
519 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
521 /** Confirms that the files or directory trees have been successfully
522 * extracted. @p info will point to ::wimlib_progress_info.extract.
523 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
524 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
526 /** The directory or NTFS volume is about to be scanned for metadata.
527 * @p info will point to ::wimlib_progress_info.scan. This message is
528 * received once per call to wimlib_add_image(), or once per capture
529 * source passed to wimlib_add_image_multisource(), or once per add
530 * command passed to wimlib_update_image(). */
531 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
533 /** A directory or file has been scanned. @p info will point to
534 * ::wimlib_progress_info.scan, and its @p cur_path member will be
535 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
537 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
539 /** Confirms that the directory or NTFS volume has been successfully
540 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
541 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
542 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
544 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
546 /** File resources ("streams") are currently being written to the WIM.
547 * @p info will point to ::wimlib_progress_info.write_streams. This
548 * message may be received many times while the WIM file is being
549 * written or appended to with wimlib_write(), wimlib_overwrite(), or
550 * wimlib_write_to_fd(). */
551 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
553 /** Per-image metadata is about to be written to the WIM file. @p info
554 * will not be valid. */
555 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
557 /** Confirms that per-image metadata has been successfully been written
558 * to the WIM file. @p info will not be valid. This message is paired
559 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
561 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
563 /** wimlib_overwrite() has successfully renamed the temporary file to
564 * the original WIM file, thereby committing the update. @p info will
565 * point to ::wimlib_progress_info.rename. Note: this message is not
566 * received if wimlib_overwrite() chose to append to the WIM file
568 WIMLIB_PROGRESS_MSG_RENAME = 15,
570 /** The contents of the WIM file are being checked against the integrity
571 * table. @p info will point to ::wimlib_progress_info.integrity. This
572 * message is only received (and may be received many times) when
573 * wimlib_open_wim_with_progress() is called with the
574 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
575 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
577 /** An integrity table is being calculated for the WIM being written.
578 * @p info will point to ::wimlib_progress_info.integrity. This message
579 * is only received (and may be received many times) when a WIM file is
580 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
581 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
583 /** A wimlib_split() operation is in progress, and a new split part is
584 * about to be started. @p info will point to
585 * ::wimlib_progress_info.split. */
586 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
588 /** A wimlib_split() operation is in progress, and a split part has been
589 * finished. @p info will point to ::wimlib_progress_info.split. */
590 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
592 /** A WIM update command is just about to be executed. @p info will
593 * point to ::wimlib_progress_info.update. This message is received
594 * once per update command when wimlib_update_image() is called with the
595 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
596 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
598 /** A WIM update command has just been executed. @p info will point to
599 * ::wimlib_progress_info.update. This message is received once per
600 * update command when wimlib_update_image() is called with the flag
601 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
602 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
604 /** A file in the WIM image is being replaced as a result of a
605 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
606 * @p info will point to ::wimlib_progress_info.replace. This is only
607 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
609 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
611 /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
612 * a file is being extracted normally (not as a WIMBoot "pointer file")
613 * due to it matching a pattern in the [PrepopulateList] section of the
614 * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
615 * WIM image. @p info will point to
616 * ::wimlib_progress_info.wimboot_exclude.
618 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
620 /** Starting to unmount a WIM image. @p info will point to
621 * ::wimlib_progress_info.unmount. */
622 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
624 /** wimlib has used a file's data for the last time (including all data
625 * streams, if it has multiple). @p info will point to
626 * ::wimlib_progress_info.done_with_file. This message is only received
627 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
628 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
631 /** Valid return values from user-provided progress functions
632 * (::wimlib_progress_func_t).
634 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
637 enum wimlib_progress_status {
639 /** The operation should be continued. This is the normal return value.
641 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
643 /** The operation should be aborted. This will cause the current
644 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
645 WIMLIB_PROGRESS_STATUS_ABORT = 1,
649 * A pointer to this union is passed to the user-supplied
650 * ::wimlib_progress_func_t progress function. One (or none) of the structures
651 * contained in this union will be applicable for the operation
652 * (::wimlib_progress_msg) indicated in the first argument to the progress
654 union wimlib_progress_info {
656 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
657 * document them if they aren't given a name... */
659 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
660 * the primary message for tracking the progress of writing a WIM file.
662 struct wimlib_progress_info_write_streams {
663 /** Total number of uncompressed bytes of stream data being
664 * written. This can be thought of as the total uncompressed
665 * size of the files being archived, with some caveats. WIM
666 * files use single-instance streams, so the size provided here
667 * only counts distinct streams, except for the following
668 * exception: the size provided here may include the sizes of
669 * all newly added (e.g. with wimlib_add_image() streams,
670 * pending automatic de-duplication during the write operation
671 * itself. When each such stream de-duplication occurs, this
672 * number will be decreased by the size of the duplicate stream
673 * that need not be written.
675 * In the case of a wimlib_overwrite() that the library opted to
676 * perform in-place, both @p total_streams and @p total_bytes
677 * will only count the streams actually being written and not
678 * pre-existing streams in the WIM file. */
679 uint64_t total_bytes;
681 /** Total number of streams being written. This can be thought
682 * of as the total number of files being archived, with some
683 * caveats. In general, a single file or directory may contain
684 * multiple data streams, each of which will be represented
685 * separately in this number. Furthermore, WIM files use
686 * single-instance streams, so the stream count provided here
687 * only counts distinct streams, except for the following
688 * exception: the stream count provided here may include newly
689 * added (e.g. with wimlib_add_image() streams, pending
690 * automatic de-duplication during the write operation itself.
691 * When each such stream de-duplication occurs, this number will
692 * be decreased by 1 to account for the duplicate stream that
693 * need not be written. */
694 uint64_t total_streams;
696 /** Number of uncompressed bytes of stream data that have been
697 * written so far. This number be 0 initially, and will be
698 * equal to @p total_bytes at the end of the write operation.
699 * Note that @p total_bytes (but not @p completed_bytes) may
700 * decrease throughout the write operation due to the discovery
701 * of stream duplications. */
702 uint64_t completed_bytes;
704 /** Number of streams that have been written so far. This
705 * number will be 0 initially, and will be equal to @p
706 * total_streams at the end of the write operation. Note that
707 * @p total_streams (but not @p completed_streams) may decrease
708 * throughout the write operation due to the discovery of stream
711 * For applications that wish to calculate a simple "percent
712 * complete" for the write operation, it will likely be more
713 * accurate to calculate the percentage from @p completed_bytes
714 * and @p total_bytes rather than @p completed_streams and
715 * @p total_streams because the time for the operation to
716 * complete is mainly determined by the number of bytes that
717 * need to be read, compressed, and written, not just the number
718 * of files being archived. */
719 uint64_t completed_streams;
721 /** Number of threads that are being used to compress streams,
722 * or 1 if streams are being written uncompressed. */
723 uint32_t num_threads;
725 /** The compression type being used to write the streams, as one
726 * of the ::wimlib_compression_type constants. */
727 int32_t compression_type;
729 /** Number of split WIM parts from which streams are being
730 * written (may be 0 if irrelevant). */
731 uint32_t total_parts;
733 /** This is currently broken and will always be 0. */
734 uint32_t completed_parts;
737 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
738 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
739 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
740 struct wimlib_progress_info_scan {
741 /** Top-level directory being scanned; or, when capturing an NTFS
742 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
743 * to the file or block device that contains the NTFS volume
745 const wimlib_tchar *source;
747 /** Path to the file (or directory) that has been scanned, valid
748 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
749 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
750 * relative to the root of the NTFS volume. */
751 const wimlib_tchar *cur_path;
753 /** Dentry scan status, valid on
754 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
756 /** The file looks okay and will be captured. */
757 WIMLIB_SCAN_DENTRY_OK = 0,
759 /** File is being excluded from capture due to the
760 * capture configuration. */
761 WIMLIB_SCAN_DENTRY_EXCLUDED,
763 /** File is being excluded from capture due to being
764 * unsupported (e.g. an encrypted or device file). */
765 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
767 /** The file is an absolute symbolic link or junction
768 * that points into the capture directory, and
769 * reparse-point fixups are enabled, so its target is
770 * being adjusted. (Reparse point fixups can be
771 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
773 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
775 /** Reparse-point fixups are enabled, but the file is an
776 * absolute symbolic link or junction that does
777 * <b>not</b> point into the capture directory, so its
778 * target is <b>not</b> being adjusted. */
779 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
783 /** Target path in the WIM image. Only valid on
784 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
785 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
786 const wimlib_tchar *wim_target_path;
788 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
789 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
790 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
791 * target of the absolute symbolic link or junction. */
792 const wimlib_tchar *symlink_target;
795 /** Number of directories scanned so far, including the root
796 * directory but excluding any unsupported/excluded directories.
798 * Details: On Windows and in NTFS capture mode, a reparse point
799 * counts as a directory if and only if it has
800 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
801 * counts as a directory if and only if when fully dereferenced
802 * it points to an accessible directory. If a file has multiple
803 * names (hard links), it is only counted one time. */
804 uint64_t num_dirs_scanned;
806 /** Number of non-directories scanned so far, excluding any
807 * unsupported/excluded files.
809 * Details: On Windows and in NTFS capture mode, a reparse point
810 * counts as a non-directory if and only if it does not have
811 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
812 * counts as a non-directory if and only if when fully
813 * dereferenced it points to a non-directory or its target is
814 * inaccessible. If a file has multiple names (hard links), it
815 * is only counted one time. */
816 uint64_t num_nondirs_scanned;
818 /** Number of bytes of file data that have been detected so far.
820 * Details: This data may not actually have been read yet, and
821 * it will not actually be written to the WIM file until
822 * wimlib_write() or wimlib_overwrite() has been called. Data
823 * from excluded files is not counted. This number includes
824 * default file contents as well as named data streams and
825 * reparse point data. The size of reparse point data is
826 * tallied after any reparse-point fixups, and in the case of
827 * capturing a symbolic link on a UNIX-like system, the creation
828 * of the reparse point data itself. If a file has multiple
829 * names (hard links), its size(s) are only counted one time.
830 * On Windows, encrypted files have their encrypted size
831 * counted, not their unencrypted size; however, compressed
832 * files have their uncompressed size counted. */
833 uint64_t num_bytes_scanned;
836 /** Valid on messages
837 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
838 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
839 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
840 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
841 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
842 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
844 * Note: most of the time of an extraction operation will be spent
845 * extracting streams, and the application will receive
846 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
847 * completed_bytes and @p total_bytes, the application can calculate a
848 * percentage complete. However, note that this message does not, in
849 * general, actually provide information about which "file" is currently
850 * being extracted. This is because wimlib, by default, extracts the
851 * individual data streams in whichever order it determines to be the
854 struct wimlib_progress_info_extract {
855 /** Number of the image from which files are being extracted
859 /** Extraction flags being used. */
860 uint32_t extract_flags;
862 /** Full path to the WIM file from which files are being
863 * extracted, or @c NULL if the WIMStruct has no associated
865 const wimlib_tchar *wimfile_name;
867 /** Name of the image from which files are being extracted, or
868 * the empty string if the image is unnamed. */
869 const wimlib_tchar *image_name;
871 /** Path to the directory or NTFS volume to which the files are
872 * being extracted. */
873 const wimlib_tchar *target;
876 const wimlib_tchar *reserved;
878 /** Number of bytes of uncompressed data that will be extracted.
879 * If a file has multiple names (hard links), its size (or
880 * sizes, in the case of named data streams) is only counted one
881 * time. For "reparse points" and symbolic links, the size to
882 * be extracted is the size of the reparse data buffer.
884 * This number will stay constant throughout the extraction. */
885 uint64_t total_bytes;
887 /** Number of bytes of uncompressed data that have been
888 * extracted so far. This initially be 0 and will equal to @p
889 * total_bytes at the end of the extraction. */
890 uint64_t completed_bytes;
892 /** Number of (not necessarily unique) streams that will be
893 * extracted. This may be more or less than the number of
894 * "files" to be extracted due to hard links as well as
895 * potentially multiple streams per file (named data streams).
896 * A "stream" may be the default contents of a file, a named
897 * data stream, or a reparse data buffer. */
898 uint64_t total_streams;
900 /** Number of (not necessarily unique) streams that have been
901 * extracted so far. */
902 uint64_t completed_streams;
904 /** Currently only used for
905 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
906 uint32_t part_number;
908 /** Currently only used for
909 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
910 uint32_t total_parts;
912 /** Currently only used for
913 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
914 uint8_t guid[WIMLIB_GUID_LEN];
917 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
918 struct wimlib_progress_info_rename {
919 /** Name of the temporary file that the WIM was written to. */
920 const wimlib_tchar *from;
922 /** Name of the original WIM file to which the temporary file is
924 const wimlib_tchar *to;
927 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
928 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
929 struct wimlib_progress_info_update {
930 /** Pointer to the update command that will be executed or has
931 * just been executed. */
932 const struct wimlib_update_command *command;
934 /** Number of update commands that have been completed so far.
936 size_t completed_commands;
938 /** Number of update commands that are being executed as part of
939 * this call to wimlib_update_image(). */
940 size_t total_commands;
943 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
944 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
945 struct wimlib_progress_info_integrity {
946 /** Number of bytes from the end of the WIM header to the end of
947 * the lookup table (the area that is covered by the SHA1
948 * integrity checks.) */
949 uint64_t total_bytes;
951 /** Number of bytes that have been SHA1-summed so far. Will be
952 * 0 initially, and equal @p total_bytes at the end. */
953 uint64_t completed_bytes;
955 /** Number of chunks that the checksummed region is divided
957 uint32_t total_chunks;
959 /** Number of chunks that have been SHA1-summed so far. Will
960 * be 0 initially, and equal to @p total_chunks at the end. */
961 uint32_t completed_chunks;
963 /** Size of the chunks used for the integrity calculation. */
966 /** Filename of the WIM (only valid if the message is
967 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
968 const wimlib_tchar *filename;
971 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
972 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
973 struct wimlib_progress_info_split {
974 /** Total size of the original WIM's file and metadata resources
976 uint64_t total_bytes;
978 /** Number of bytes of file and metadata resources that have
979 * been copied out of the original WIM so far. Will be 0
980 * initially, and equal to @p total_bytes at the end. */
981 uint64_t completed_bytes;
983 /** Number of the split WIM part that is about to be started
984 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
985 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
986 unsigned cur_part_number;
988 /** Total number of split WIM parts that are being written. */
989 unsigned total_parts;
991 /** Name of the split WIM part that is about to be started
992 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
993 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
994 * As of wimlib v1.7.0, the library user may change this when
995 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
996 * cause the next split WIM part to be written to a different
998 wimlib_tchar *part_name;
1001 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1002 struct wimlib_progress_info_replace {
1003 /** Path to the file in the WIM image that is being replaced */
1004 const wimlib_tchar *path_in_wim;
1007 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1008 struct wimlib_progress_info_wimboot_exclude {
1009 /** Path to the file in the WIM image */
1010 const wimlib_tchar *path_in_wim;
1012 /** Path to which the file is being extracted */
1013 const wimlib_tchar *extraction_path;
1016 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1017 struct wimlib_progress_info_unmount {
1018 /** Path to directory being unmounted */
1019 const wimlib_tchar *mountpoint;
1021 /** Path to WIM file being unmounted */
1022 const wimlib_tchar *mounted_wim;
1024 /** 1-based index of image being unmounted. */
1025 uint32_t mounted_image;
1027 /** Flags that were passed to wimlib_mount_image() when the
1028 * mountpoint was set up. */
1029 uint32_t mount_flags;
1031 /** Flags passed to wimlib_unmount_image(). */
1032 uint32_t unmount_flags;
1035 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1036 struct wimlib_progress_info_done_with_file {
1037 /* Path to the file whose data has been written to the WIM file,
1038 * or is currently being asynchronously compressed in memory,
1039 * and therefore is no longer needed by wimlib.
1041 * WARNING: The file data will not actually be accessible in the
1042 * WIM file until the WIM file has been completely written.
1043 * Ordinarily you should <b>not</b> treat this message as a
1044 * green light to go ahead and delete the specified file, since
1045 * that would result in data loss if the WIM file cannot be
1046 * successfully created for any reason.
1048 * If a file has multiple names (hard links),
1049 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1050 * for one name. Also, this message will not be received for
1051 * empty files or reparse points (or symbolic links), unless
1052 * they have nonempty named data streams.
1054 const wimlib_tchar *path_to_file;
1059 * A user-supplied function that will be called periodically during certain WIM
1062 * The first argument will be the type of operation that is being performed or
1063 * is about to be started or has been completed.
1065 * The second argument will be a pointer to one of a number of structures
1066 * depending on the first argument. It may be @c NULL for some message types.
1067 * Note that although this argument is not @c const, users should not modify it
1068 * except in explicitly documented cases.
1070 * The third argument will be a user-supplied value that was provided when
1071 * registering or specifying the progress function.
1073 * This function must return one of the ::wimlib_progress_status values. By
1074 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1076 typedef enum wimlib_progress_status
1077 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1078 union wimlib_progress_info *info,
1082 /** @addtogroup G_modifying_wims
1085 /** An array of these structures is passed to wimlib_add_image_multisource() to
1086 * specify the sources from which to create a WIM image. */
1087 struct wimlib_capture_source {
1088 /** Absolute or relative path to a file or directory on the external
1089 * filesystem to be included in the WIM image. */
1090 wimlib_tchar *fs_source_path;
1092 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1093 * specify the root directory of the WIM image. */
1094 wimlib_tchar *wim_target_path;
1096 /** Reserved; set to 0. */
1100 /** Set or unset the WIM header flag that marks it read-only
1101 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
1102 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
1103 * is distinct from basic file permissions; this flag can be set on a WIM file
1104 * that is physically writable. If this flag is set, all further operations to
1105 * modify the WIM will fail, except calling wimlib_overwrite() with
1106 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
1107 * allows you to set this flag persistently on the underlying WIM file.
1109 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1111 /** Set the GUID (globally unique identifier) of the WIM file to the value
1112 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1113 #define WIMLIB_CHANGE_GUID 0x00000002
1115 /** Change the bootable image of the WIM to the value specified in
1116 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1117 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1119 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1120 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
1121 * indicates whether an image in the WIM has been captured with reparse-point
1122 * fixups enabled. wimlib also treats this flag as specifying whether to do
1123 * reparse-point fixups by default when capturing or applying WIM images. */
1124 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1128 /** @addtogroup G_wim_information
1133 /** General information about a WIM file. */
1134 struct wimlib_wim_info {
1136 /** Globally unique identifier for the WIM file. Note: all parts of a
1137 * split WIM should have an identical value in this field. */
1138 uint8_t guid[WIMLIB_GUID_LEN];
1140 /** Number of images in the WIM. */
1141 uint32_t image_count;
1143 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1145 uint32_t boot_index;
1147 /** Version of the WIM file. */
1148 uint32_t wim_version;
1150 /** Chunk size used for compression. */
1151 uint32_t chunk_size;
1153 /** For split WIMs, the 1-based index of this part within the split WIM;
1155 uint16_t part_number;
1157 /** For split WIMs, the total number of parts in the split WIM;
1159 uint16_t total_parts;
1161 /** One of the ::wimlib_compression_type values that specifies the
1162 * method used to compress resources in the WIM. */
1163 int32_t compression_type;
1165 /** Size of the WIM file in bytes, excluding the XML data and integrity
1167 uint64_t total_bytes;
1169 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1170 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1171 * this will always be 0, even if the ::WIMStruct was written to
1172 * somewhere by calling wimlib_write() with the
1173 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1174 uint32_t has_integrity_table : 1;
1176 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1177 * wimlib_create_new_wim(). */
1178 uint32_t opened_from_file : 1;
1180 /** 1 if the WIM is considered readonly for any reason. */
1181 uint32_t is_readonly : 1;
1183 /** 1 if reparse-point fixups are supposedly enabled for one or more
1184 * images in the WIM. */
1185 uint32_t has_rpfix : 1;
1187 /** 1 if the WIM is marked as read-only. */
1188 uint32_t is_marked_readonly : 1;
1190 /** 1 if the WIM is part of a spanned set. */
1191 uint32_t spanned : 1;
1193 uint32_t write_in_progress : 1;
1194 uint32_t metadata_only : 1;
1195 uint32_t resource_only : 1;
1197 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1198 uint32_t pipable : 1;
1199 uint32_t reserved_flags : 22;
1200 uint32_t reserved[9];
1203 /** Information about a unique stream in the WIM file. (A stream is the same
1204 * thing as a "resource", except in the case of packed resources.) */
1205 struct wimlib_resource_entry {
1206 /** Uncompressed size of the stream in bytes. */
1207 uint64_t uncompressed_size;
1209 /** Compressed size of the stream in bytes. This will be the same as @p
1210 * uncompressed_size if the stream is uncompressed. Or, if @p
1211 * is_packed_streams is 1, this will be 0. */
1212 uint64_t compressed_size;
1214 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1215 * if @p packed is 1, then this is actually the offset at which this
1216 * stream begins in the uncompressed contents of the packed resource.
1220 /** SHA1 message digest of the stream's uncompressed contents. */
1221 uint8_t sha1_hash[20];
1223 /** Which part number of the split WIM this stream is in. This should
1224 * be the same as the part number provided by wimlib_get_wim_info(). */
1225 uint32_t part_number;
1227 /** Number of times this stream is referenced over all WIM images. */
1228 uint32_t reference_count;
1230 /** 1 if this stream is compressed. */
1231 uint32_t is_compressed : 1;
1233 /** 1 if this stream is a metadata resource rather than a file resource.
1235 uint32_t is_metadata : 1;
1237 uint32_t is_free : 1;
1238 uint32_t is_spanned : 1;
1240 /** 1 if this stream was not found in the lookup table of the
1241 * ::WIMStruct. This normally implies a missing call to
1242 * wimlib_reference_resource_files() or wimlib_reference_resources().
1244 uint32_t is_missing : 1;
1246 /** 1 if this stream is located in a packed resource which may contain
1247 * other streams (all compressed together) as well. */
1248 uint32_t packed : 1;
1250 uint32_t reserved_flags : 26;
1252 /** If @p packed is 1, then this will specify the offset of the packed
1253 * resource in the WIM. */
1254 uint64_t raw_resource_offset_in_wim;
1256 /** If @p is_packed_streams is 1, then this will specify the compressed
1257 * size of the packed resource in the WIM. */
1258 uint64_t raw_resource_compressed_size;
1260 uint64_t reserved[2];
1263 /** Information about a stream of a particular file in the WIM. */
1264 struct wimlib_stream_entry {
1265 /** Name of the stream, or NULL if the stream is unnamed. */
1266 const wimlib_tchar *stream_name;
1267 /** Location, size, etc. of the stream within the WIM file. */
1268 struct wimlib_resource_entry resource;
1269 uint64_t reserved[4];
1272 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1273 * Roughly, the information about a "file" in the WIM--- but really a directory
1274 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1275 * field can be used to distinguish actual file inodes. */
1276 struct wimlib_dir_entry {
1277 /** Name of the file, or NULL if this file is unnamed (only possible for
1278 * the root directory) */
1279 const wimlib_tchar *filename;
1281 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1283 const wimlib_tchar *dos_name;
1285 /** Full path to this file within the WIM image. */
1286 const wimlib_tchar *full_path;
1288 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1289 * children, ..., etc. */
1292 /** Pointer to the security descriptor for this file, in Windows
1293 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1294 * security descriptor. */
1295 const char *security_descriptor;
1297 /** Length of the above security descriptor. */
1298 size_t security_descriptor_size;
1300 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1301 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1302 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1303 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1304 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1305 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1306 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1307 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1308 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1309 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1310 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1311 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1312 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1313 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1314 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1315 /** File attributes, such as whether the file is a directory or not.
1316 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1317 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1318 * on other platforms. */
1319 uint32_t attributes;
1321 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1322 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1323 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1324 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1325 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1326 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1327 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1328 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1329 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1330 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1331 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1332 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1333 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1334 * attributes), this will give the reparse tag. This tells you whether
1335 * the reparse point is a symbolic link, junction point, or some other,
1336 * more unusual kind of reparse point. */
1337 uint32_t reparse_tag;
1339 /* Number of (hard) links to this file. */
1342 /** Number of named data streams that this file has. Normally 0. */
1343 uint32_t num_named_streams;
1345 /** Roughly, the inode number of this file. However, it may be 0 if
1346 * @p num_links == 1. */
1347 uint64_t hard_link_group_id;
1349 /** Time this file was created. */
1350 struct timespec creation_time;
1352 /** Time this file was last written to. */
1353 struct timespec last_write_time;
1355 /** Time this file was last accessed. */
1356 struct timespec last_access_time;
1358 /* UNIX data (wimlib extension), only valid if unix_mode != 0 */
1364 uint64_t reserved[14];
1366 /** Array of streams that make up this file. The first entry will
1367 * always exist and will correspond to the unnamed data stream (default
1368 * file contents), so it will have @p stream_name == @c NULL. There
1369 * will then be @p num_named_streams additional entries that specify the
1370 * named data streams, if any, each of which will have @p stream_name !=
1372 struct wimlib_stream_entry streams[];
1376 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1379 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1383 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1386 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1389 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1390 * just on the specified path. */
1391 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1393 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1394 * itself; only its children (in the case of a non-empty directory) */
1395 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1397 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1398 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1399 * table of the ::WIMStruct. The default behavior without this flag is to fill
1400 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1401 * wimlib_resource_entry::is_missing "is_missing" flag. */
1402 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1406 /** @addtogroup G_modifying_wims
1409 /** Directly capture an NTFS volume rather than a generic directory. This flag
1410 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1411 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1412 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1414 /** Follow symlinks; archive and dump the files they point to. Currently only
1415 * supported on UNIX-like systems. */
1416 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1418 /** Call the progress function with the message
1419 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1421 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1423 /** Mark the image being added as the bootable image of the WIM. Not valid for
1424 * wimlib_update_image(). */
1425 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1427 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1428 * (major and minor number) of each file. See the documentation for the
1429 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1431 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1433 /** Do not capture security descriptors. Only has an effect in NTFS capture
1434 * mode, or in Windows native builds. */
1435 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1437 /** Fail immediately if the full security descriptor of any file or directory
1438 * cannot be accessed. Only has an effect in Windows native builds. The
1439 * default behavior without this flag is to first try omitting the SACL from the
1440 * security descriptor, then to try omitting the security descriptor entirely.
1442 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1444 /** Call the progress function with the message
1445 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1446 * capture. This is a subset of the messages provided by
1447 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1448 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1450 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1451 * in the case of Windows) that point inside the directory being captured to
1452 * instead be absolute relative to the directory being captured, rather than the
1455 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1456 * the WIM header or if this is the first image being added.
1457 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1458 * reparse point fixups enabled and currently cannot be unset. */
1459 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1461 /** Don't do reparse point fixups. The default behavior is described in the
1462 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1463 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1465 /** Do not automatically exclude unsupported files or directories from capture;
1466 * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1467 * UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1468 * such a file is encountered. */
1469 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1472 * Automatically select a capture configuration appropriate for capturing
1473 * filesystems containing Windows operating systems. For example,
1474 * "pagefile.sys" and "System Volume Information" will be excluded.
1476 * When this flag is specified, the corresponding @p config parameter or member
1479 * Note that the default behavior--- that is, when this flag is not specified
1480 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1481 * no files are excluded from capture.
1483 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1486 * Capture image as WIMBoot compatible. In addition, if no capture
1487 * configuration file is explicitly specified use the capture configuration file
1488 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1489 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1490 * configuration file is explicitly specified, use it and also place it at
1491 * /Windows/System32/WimBootCompress.ini in the WIM image.
1493 * Note: this will not by itself change the compression type. Before writing
1494 * the WIM file, it's recommended to also do:
1497 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1498 * wimlib_set_output_chunk_size(wim, 4096);
1501 * since that makes access to the data faster (at the cost of a worse
1502 * compression ratio compared to the 32768-byte LZX chunks usually used).
1504 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1507 * If the add command involves adding a non-directory file to a location at
1508 * which there already exists a nondirectory file in the WIM image, issue
1509 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1510 * effect when updating an existing image with wimlib_update_image().
1511 * This was the default behavior in wimlib v1.6.2 and earlier.
1513 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1515 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1516 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1517 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1518 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1519 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1520 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1521 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1522 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1523 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1524 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1525 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1526 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1527 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1528 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1532 /** @addtogroup G_modifying_wims
1535 /** Do not issue an error if the path to delete does not exist. */
1536 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1538 /** Delete the file or directory tree recursively; if not specified, an error is
1539 * issued if the path to delete is a directory. */
1540 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1543 /** @addtogroup G_modifying_wims
1547 * If a single image is being exported, mark it bootable in the destination WIM.
1548 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1549 * the image in the source WIM (if any) that is marked as bootable is also
1550 * marked as bootable in the destination WIM.
1552 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1554 /** Give the exported image(s) no names. Avoids problems with image name
1557 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1559 /** Give the exported image(s) no descriptions. */
1560 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1562 /** This advises the library that the program is finished with the source
1563 * WIMStruct and will not attempt to access it after the call to
1564 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1565 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1568 * Mark each exported image as WIMBoot-compatible.
1570 * Note: by itself, this does change the destination WIM's compression type, nor
1571 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1572 * image. Before writing the destination WIM, it's recommended to do something
1576 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1577 * wimlib_set_output_chunk_size(wim, 4096);
1578 * wimlib_add_tree(wim, image, L"myconfig.ini",
1579 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1582 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1585 /** @addtogroup G_extracting_wims
1588 /** Extract the image directly to an NTFS volume rather than a generic directory.
1589 * This mode is only available if wimlib was compiled with libntfs-3g support;
1590 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1591 * extraction target will be interpreted as the path to an NTFS volume image (as
1592 * a regular file or block device) rather than a directory. It will be opened
1593 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1594 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1595 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1596 * wimlib_extract_paths() when passed multiple paths. */
1597 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1599 /** UNIX-like systems only: Extract special UNIX data captured with
1600 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1601 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1602 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1604 /** Do not extract security descriptors. This flag cannot be combined with
1605 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1606 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1608 /** Fail immediately if the full security descriptor of any file or directory
1609 * cannot be set exactly as specified in the WIM file. On Windows, the default
1610 * behavior without this flag when wimlib does not have permission to set the
1611 * correct security descriptor is to fall back to setting the security
1612 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1613 * owner omitted, then not at all. This flag cannot be combined with
1614 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1615 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1617 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1618 * reparse-point fixups on, so absolute symbolic links or junction points will
1619 * be fixed to be absolute relative to the actual extraction root. Reparse-
1620 * point fixups are done by default for wimlib_extract_image() and
1621 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1622 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1623 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1625 /** Force reparse-point fixups on extraction off, regardless of the state of the
1626 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1627 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1628 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1630 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1631 * paths, each of which must name a regular file, to standard output. */
1632 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1634 /** Instead of ignoring files and directories with names that cannot be
1635 * represented on the current platform (note: Windows has more restrictions on
1636 * filenames than POSIX-compliant systems), try to replace characters or append
1637 * junk to the names so that they can be extracted in some form. */
1638 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1640 /** On Windows, when there exist two or more files with the same case
1641 * insensitive name but different case sensitive names, try to extract them all
1642 * by appending junk to the end of them, rather than arbitrarily extracting only
1644 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1646 /** Do not ignore failure to set timestamps on extracted files. */
1647 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1649 /** Do not ignore failure to set short names on extracted files. */
1650 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1652 /** On Windows, do not ignore failure to extract symbolic links and junctions
1653 * due to permissions problems. By default, such failures are ignored since the
1654 * default configuration of Windows only allows the Administrator to create
1655 * symbolic links. */
1656 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1658 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1659 * behavior is currently less than satisfactory. Do not use (yet). */
1660 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1662 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1663 * paths to extract as wildcard patterns ("globs") which may contain the
1664 * wildcard characters @c ? and @c *. The @c ? character matches any
1665 * non-path-separator character, whereas the @c * character matches zero or more
1666 * non-path-separator characters. Consequently, each glob may match zero or
1667 * more actual paths in the WIM image. By default, if a glob does not match any
1668 * files, a warning but not an error will be issued, even if the glob did not
1669 * actually contain wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1670 * to get an error instead. */
1671 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1673 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1674 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1675 * one of the provided globs did not match a file. */
1676 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1678 /** Do not extract Windows file attributes such as readonly, hidden, etc. */
1679 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1681 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1682 * preserve the directory structure of the archive when extracting --- that is,
1683 * place each extracted file or directory tree directly in the target directory.
1685 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1687 /** Windows only: Extract files as "pointers" back to the WIM archive. See the
1688 * documentation for the <b>--wimboot</b> option of <b>wimlib-imagex apply</b>
1689 * for more information. */
1690 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1693 /** @addtogroup G_mounting_wim_images
1696 /** Mount the WIM image read-write rather than the default of read-only. */
1697 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1699 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1700 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1702 /** Do not allow accessing named data streams in the mounted WIM image. */
1703 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1705 /** Access named data streams in the mounted WIM image through extended file
1706 * attributes named "user.X", where X is the name of a data stream. This is the
1708 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1710 /** Access named data streams in the mounted WIM image by specifying the file
1711 * name, a colon, then the name of the data stream. */
1712 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1714 /** Use UNIX metadata if available in the WIM image. See
1715 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1716 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1718 /** Allow other users to see the mounted filesystem. This passes the @c
1719 * allow_other option to the FUSE mount. */
1720 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1723 /** @addtogroup G_creating_and_opening_wims
1726 /** Verify the WIM contents against the WIM's integrity table, if present. This
1727 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1728 * checksummed and checked against the SHA1 message digests specified in the
1729 * integrity table. If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
1730 * issued. If the WIM file does not contain an integrity table, this flag has
1732 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1734 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
1735 * WIM. Software can provide this flag for convenience if it explicitly does
1736 * not want to support split WIMs. */
1737 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1739 /** Check if the WIM is writable and issue an error
1740 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
1741 * only if it is writable at the filesystem level, does not have the
1742 * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
1743 * set. It is not required to provide this flag before attempting to make
1744 * changes to the WIM, but with this flag you get an error sooner rather than
1746 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1749 /** @addtogroup G_mounting_wim_images
1752 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
1753 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1754 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1756 /** Commit changes to the read-write mounted WIM image.
1757 * If this flag is not specified, changes will be discarded. */
1758 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1760 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
1761 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1762 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1764 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
1765 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1766 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1769 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
1770 * image, forces all file descriptors to the open WIM image to be closed before
1773 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
1774 * this flag has no effect.
1776 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
1778 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1779 * WIM image, causes the modified image to be committed to the WIM file as a
1780 * new, unnamed image appended to the archive. The original image in the WIM
1781 * file will be unmodified. */
1782 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
1785 /** @addtogroup G_modifying_wims
1788 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1789 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1790 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1793 /** @addtogroup G_writing_and_overwriting_wims
1797 * Include an integrity table in the resulting WIM file.
1799 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1800 * include an integrity table if and only if one was present before. For
1801 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1802 * to not include an integrity table.
1804 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1807 * Do not include an integrity table in the resulting WIM file. This is the
1808 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
1811 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1814 * Write the WIM as "pipable". After writing a WIM with this flag specified,
1815 * images from it can be applied directly from a pipe using
1816 * wimlib_extract_image_from_pipe(). See the documentation for the
1817 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
1818 * Beware: WIMs written with this flag will not be compatible with Microsoft's
1821 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1822 * write the WIM as pipable if and only if it was pipable before. For
1823 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1824 * to write the WIM as non-pipable.
1826 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1829 * Do not write the WIM as "pipable". This is the default behavior, unless the
1830 * ::WIMStruct was created by opening a pipable WIM.
1832 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1835 * When writing streams to the WIM file, recompress them, even if their data is
1836 * already available in the desired compressed form (for example, in a WIM file
1837 * from which an image has been exported using wimlib_export_image()).
1839 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
1840 * compression ratio for the same compression type and chunk size. wimlib's LZX
1841 * compressor currently can be given different parameters in order to achieve
1842 * different balances between compression ratio and time. In its default mode
1843 * as of v1.7.0, it usually compresses slightly better than the competing
1844 * Microsoft implementation and is almost as fast.
1846 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can also be used in combination with
1847 * ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any solid blocks from being
1848 * re-used. (Otherwise, solid blocks are re-used somewhat more liberally than
1849 * normal compressed blocks.)
1851 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
1852 * that would not otherwise be written. For example, a call to
1853 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
1854 * cause already-existing streams in the WIM file to be recompressed. To force
1855 * the WIM file to be fully rebuilt and recompressed, combine
1856 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
1858 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1861 * Immediately before closing the WIM file, sync its data to disk.
1863 * wimlib_overwrite() will set this flag automatically if it decides to
1864 * overwrite the WIM file via a temporary file instead of in-place.
1866 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1869 * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
1870 * could be updated merely by appending to it.
1872 * When rebuilding the WIM file, stream reference counts will be recomputed, and
1873 * any streams with 0 reference count (e.g. from deleted files or images) will
1874 * not be included in the resulting WIM file.
1876 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
1877 * data to be recompressed. Otherwise, compressed data is re-used if possible.
1879 * wimlib_write() ignores this flag.
1881 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1884 * For wimlib_overwrite(), override the default behavior after one or more calls
1885 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
1886 * flag, only minimal changes to correctly remove the image from the WIM file
1887 * will be taken. In particular, all streams will be retained, even if they are
1888 * no longer referenced. This may not be what you want, because no space will
1889 * be saved by deleting an image in this way.
1891 * wimlib_write() ignores this flag.
1893 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1896 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
1897 * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header. This can be used
1898 * following a call to wimlib_set_wim_info() with the
1899 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
1902 * wimlib_write() ignores this flag.
1904 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1907 * Do not include streams already present in other WIMs. This flag can be used
1908 * to write a "delta" WIM after resources from the WIM on which the delta is to
1909 * be based were referenced with wimlib_reference_resource_files() or
1910 * wimlib_reference_resources().
1912 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1915 * Advises the library that for writes of all WIM images, all streams needed for
1916 * the WIM are already present (not in external resource WIMs) and their
1917 * reference counts are correct, so the code does not need to recalculate which
1918 * streams are referenced. This is for optimization purposes only, since with
1919 * this flag specified, the metadata resources may not need to be decompressed
1922 * wimlib_overwrite() will set this flag automatically.
1924 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1927 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
1929 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
1932 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
1935 * When writing streams in the resulting WIM file, pack multiple streams into a
1936 * single compressed resource instead of compressing them independently. This
1937 * is also known as creating a "solid archive". This tends to produce a better
1938 * compression ratio at the cost of much slower random access.
1940 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
1941 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
1942 * created with this flag use a different version number in their header (3584
1943 * instead of 68864) and are also called "ESD files".
1945 * If this flag is passed to wimlib_overwrite(), any new data streams will be
1946 * written in solid mode. Use both ::WIMLIB_WRITE_FLAG_REBUILD and
1947 * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
1948 * all streams recompressed in solid mode.
1950 * Currently, new solid blocks will, by default, be written using LZMS
1951 * compression with 64 MiB (67108864 byte) chunks. Use
1952 * wimlib_set_output_pack_compression_type() and/or
1953 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
1954 * the WIM's main compression type and chunk size; you can have a WIM that
1955 * nominally uses LZX compression and 32768 byte chunks but actually contains
1956 * LZMS-compressed solid blocks, for example. However, if including solid
1957 * blocks, I suggest that you set the WIM's main compression type to LZMS as
1958 * well, either by creating the WIM with
1959 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
1960 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
1962 * This flag will be set by default when writing or overwriting a WIM file that
1963 * either already contains packed streams, or has had packed streams exported
1964 * into it and the WIM's main compression type is LZMS.
1966 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1969 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
1970 * file. This is only needed in the unusual case that the library user needs to
1971 * know exactly when wimlib has read each file for the last time.
1973 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
1976 /** @addtogroup G_general
1979 /** Assume that strings are represented in UTF-8, even if this is not the
1980 * locale's character encoding. This flag is ignored on Windows, where wimlib
1981 * always uses UTF-16LE. */
1982 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1984 /** Windows-only: do not attempt to acquire additional privileges (currently
1985 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1986 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1987 * for the case where the calling program manages these privileges itself.
1988 * Note: no error is issued if privileges cannot be acquired, although related
1989 * errors may be reported later, depending on if the operations performed
1990 * actually require additional privileges or not. */
1991 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1993 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1994 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1995 * to read all possible data and metadata for a capture operation could not be
1996 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1998 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2000 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2001 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2002 * to restore all possible data and metadata for an apply operation could not be
2003 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2005 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2007 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2009 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2011 /** Default to interpreting WIM paths case insensitively (default on Windows).
2012 * This does not apply to mounted images. */
2013 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2016 /** @addtogroup G_nonstandalone_wims
2019 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2020 * Ignored by wimlib_reference_resources(). */
2021 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2023 /** For wimlib_reference_resource_files(), issue an error
2024 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2025 * default behavior without this flag is to issue no error at that point, but
2026 * then attempt to open the glob as a literal path, which of course will fail
2027 * anyway if no file exists at that path. No effect if
2028 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2029 * wimlib_reference_resources(). */
2030 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2033 /** @addtogroup G_modifying_wims
2036 /** The specific type of update to perform. */
2037 enum wimlib_update_op {
2038 /** Add a new file or directory tree to the WIM image in a
2039 * certain location. */
2040 WIMLIB_UPDATE_OP_ADD = 0,
2042 /** Delete a file or directory tree from the WIM image. */
2043 WIMLIB_UPDATE_OP_DELETE,
2045 /** Rename a file or directory tree in the WIM image. */
2046 WIMLIB_UPDATE_OP_RENAME,
2049 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2050 struct wimlib_add_command {
2051 /** Filesystem path to the file or directory tree to add. */
2052 wimlib_tchar *fs_source_path;
2054 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2055 * specify the root directory of the WIM image. */
2056 wimlib_tchar *wim_target_path;
2058 /** Path to capture configuration file to use, or @c NULL for default.
2060 wimlib_tchar *config_file;
2062 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2066 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2067 struct wimlib_delete_command {
2069 /** Path, specified from the root of the WIM image, for the file or
2070 * directory tree within the WIM image to be deleted. */
2071 wimlib_tchar *wim_path;
2073 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2077 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2078 struct wimlib_rename_command {
2080 /** Path, specified from the root of the WIM image, for the source file
2081 * or directory tree within the WIM image. */
2082 wimlib_tchar *wim_source_path;
2084 /** Path, specified from the root of the WIM image, for the destination
2085 * file or directory tree within the WIM image. */
2086 wimlib_tchar *wim_target_path;
2088 /** Reserved; set to 0. */
2092 /** Specification of an update to perform on a WIM image. */
2093 struct wimlib_update_command {
2095 enum wimlib_update_op op;
2098 struct wimlib_add_command add;
2099 struct wimlib_delete_command delete_; /* Underscore is for C++
2101 struct wimlib_rename_command rename;
2106 /** @addtogroup G_general
2110 * Possible values of the error code returned by many functions in wimlib.
2112 * See the documentation for each wimlib function to see specifically what error
2113 * codes can be returned by a given function, and what they mean.
2115 enum wimlib_error_code {
2116 WIMLIB_ERR_SUCCESS = 0,
2117 WIMLIB_ERR_ALREADY_LOCKED = 1,
2118 WIMLIB_ERR_DECOMPRESSION = 2,
2119 WIMLIB_ERR_FUSE = 6,
2120 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2121 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2122 WIMLIB_ERR_IMAGE_COUNT = 10,
2123 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2124 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2125 WIMLIB_ERR_INTEGRITY = 13,
2126 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2127 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2128 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2129 WIMLIB_ERR_INVALID_HEADER = 17,
2130 WIMLIB_ERR_INVALID_IMAGE = 18,
2131 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2132 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2133 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2134 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2135 WIMLIB_ERR_INVALID_OVERLAY = 23,
2136 WIMLIB_ERR_INVALID_PARAM = 24,
2137 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2138 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2139 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2140 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2141 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2142 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2143 WIMLIB_ERR_IS_DIRECTORY = 32,
2144 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2145 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2146 WIMLIB_ERR_LINK = 35,
2147 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2148 WIMLIB_ERR_MKDIR = 37,
2149 WIMLIB_ERR_MQUEUE = 38,
2150 WIMLIB_ERR_NOMEM = 39,
2151 WIMLIB_ERR_NOTDIR = 40,
2152 WIMLIB_ERR_NOTEMPTY = 41,
2153 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2154 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2155 WIMLIB_ERR_NOT_PIPABLE = 44,
2156 WIMLIB_ERR_NO_FILENAME = 45,
2157 WIMLIB_ERR_NTFS_3G = 46,
2158 WIMLIB_ERR_OPEN = 47,
2159 WIMLIB_ERR_OPENDIR = 48,
2160 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2161 WIMLIB_ERR_READ = 50,
2162 WIMLIB_ERR_READLINK = 51,
2163 WIMLIB_ERR_RENAME = 52,
2164 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2165 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2166 WIMLIB_ERR_RESOURCE_ORDER = 56,
2167 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2168 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2169 WIMLIB_ERR_SET_SECURITY = 59,
2170 WIMLIB_ERR_SET_SHORT_NAME = 60,
2171 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2172 WIMLIB_ERR_SPLIT_INVALID = 62,
2173 WIMLIB_ERR_STAT = 63,
2174 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2175 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2176 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2177 WIMLIB_ERR_UNSUPPORTED = 68,
2178 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2179 WIMLIB_ERR_WIM_IS_READONLY = 71,
2180 WIMLIB_ERR_WRITE = 72,
2181 WIMLIB_ERR_XML = 73,
2182 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2183 WIMLIB_ERR_WIMBOOT = 75,
2184 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2185 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2186 WIMLIB_ERR_MKNOD = 78,
2187 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2188 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2189 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2193 /** Used to indicate no WIM image or an invalid WIM image. */
2194 #define WIMLIB_NO_IMAGE 0
2196 /** Used to specify all images in the WIM. */
2197 #define WIMLIB_ALL_IMAGES (-1)
2202 * @ingroup G_modifying_wims
2204 * Appends an empty image to a WIM file. This empty image will initially
2205 * contain no files or directories, although if written without further
2206 * modifications, a root directory will be created automatically for it. After
2207 * calling this function, you can use wimlib_update_image() to add files to the
2208 * new WIM image. This gives you slightly more control over making the new
2209 * image compared to calling wimlib_add_image() or
2210 * wimlib_add_image_multisource() directly.
2213 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
2216 * Name to give the new image. If @c NULL or empty, the new image is given
2217 * no name. If nonempty, it must specify a name that does not already
2219 * @param new_idx_ret
2220 * If non-<code>NULL</code>, the index of the newly added image is returned
2223 * @return 0 on success; nonzero on failure. The possible error codes are:
2225 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2226 * There is already an image in @p wim named @p name.
2227 * @retval ::WIMLIB_ERR_NOMEM
2228 * Failed to allocate the memory needed to add the new image.
2229 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2230 * The WIM file is considered read-only because of any of the reasons
2231 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2235 wimlib_add_empty_image(WIMStruct *wim,
2236 const wimlib_tchar *name,
2240 * @ingroup G_modifying_wims
2242 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2244 * The directory tree or NTFS volume is scanned immediately to load the dentry
2245 * tree into memory, and file attributes and symbolic links are read. However,
2246 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2249 * See the manual page for the @b wimlib-imagex program for more information
2250 * about the "normal" capture mode versus the NTFS capture mode (entered by
2251 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2253 * Note that @b no changes are committed to the underlying WIM file (if
2254 * any) until wimlib_write() or wimlib_overwrite() is called.
2257 * Pointer to the ::WIMStruct to which to add the image.
2259 * A path to a directory or unmounted NTFS volume that will be captured as
2262 * Name to give the new image. If @c NULL or empty, the new image is given
2263 * no name. If nonempty, it must specify a name that does not already
2265 * @param config_file
2266 * Path to capture configuration file, or @c NULL. This file may specify,
2267 * among other things, which files to exclude from capture. See the man
2268 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2269 * details of the file format. If @c NULL, the default capture
2270 * configuration shall be used. Ordinarily, the default capture
2271 * configuration will result in no files being excluded from capture purely
2272 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2273 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2275 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2277 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2278 * discarded so that it appears to be in the same state as when this function
2281 * This function is implemented by calling wimlib_add_empty_image(), then
2282 * calling wimlib_update_image() with a single "add" command, so any error code
2283 * returned by wimlib_add_empty_image() may be returned, as well as any error
2284 * codes returned by wimlib_update_image() other than ones documented as only
2285 * being returned specifically by an update involving delete or rename commands.
2287 * If a progress function is registered with @p wim, it will receive the
2288 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2289 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2290 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2293 wimlib_add_image(WIMStruct *wim,
2294 const wimlib_tchar *source,
2295 const wimlib_tchar *name,
2296 const wimlib_tchar *config_file,
2300 * @ingroup G_modifying_wims
2302 * This function is equivalent to wimlib_add_image() except it allows for
2303 * multiple sources to be combined into a single WIM image. This is done by
2304 * specifying the @p sources and @p num_sources parameters instead of the @p
2305 * source parameter of wimlib_add_image(). The rest of the parameters are the
2306 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2307 * capture</b> for full details on how this mode works.
2309 * In addition to the error codes that wimlib_add_image() can return,
2310 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2311 * when trying to overlay a non-directory on a directory or when otherwise
2312 * trying to overlay multiple conflicting files to the same location in the WIM
2313 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2314 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2315 * was not exactly one capture source with the target being the root directory.
2316 * (In this respect, there is no advantage to using
2317 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2320 wimlib_add_image_multisource(WIMStruct *wim,
2321 const struct wimlib_capture_source *sources,
2323 const wimlib_tchar *name,
2324 const wimlib_tchar *config_file,
2328 * @ingroup G_modifying_wims
2330 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2331 * location @p wim_target_path within the specified @p image of the @p wim.
2333 * This just builds an appropriate ::wimlib_add_command and passes it to
2334 * wimlib_update_image().
2337 wimlib_add_tree(WIMStruct *wim, int image,
2338 const wimlib_tchar *fs_source_path,
2339 const wimlib_tchar *wim_target_path, int add_flags);
2342 * @ingroup G_creating_and_opening_wims
2344 * Creates a ::WIMStruct for a new WIM file.
2346 * This only creates an in-memory structure for a WIM that initially contains no
2347 * images. No on-disk file is created until wimlib_write() is called.
2350 * The type of compression to be used in the new WIM file, as one of the
2351 * ::wimlib_compression_type constants.
2353 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2354 * written to the memory location pointed to by this parameter. The
2355 * ::WIMStruct must be freed using using wimlib_free() when finished with
2357 * @return 0 on success; nonzero on error.
2358 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2359 * @p ctype was not a supported compression type.
2360 * @retval ::WIMLIB_ERR_NOMEM
2361 * Failed to allocate needed memory.
2364 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2367 * @ingroup G_modifying_wims
2369 * Deletes an image, or all images, from a WIM file.
2371 * All streams referenced by the image(s) being deleted are removed from the
2372 * lookup table of the WIM if they are not referenced by any other images in the
2375 * Please note that @b no changes are committed to the underlying WIM file (if
2376 * any) until wimlib_write() or wimlib_overwrite() is called.
2379 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2382 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2384 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2385 * to be left unmodified only if @p image specified a single image. If instead
2386 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2387 * possible for some but not all of the images to have been deleted when a
2388 * failure status is returned.
2390 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2391 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2392 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2393 * The WIM file is considered read-only because of any of the reasons
2394 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2397 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2398 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2399 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2400 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2401 * different reasons) to read the metadata resource for an image that needed to
2405 wimlib_delete_image(WIMStruct *wim, int image);
2408 * @ingroup G_modifying_wims
2410 * Delete the @p path from the specified @p image of the @p wim.
2412 * This just builds an appropriate ::wimlib_delete_command and passes it to
2413 * wimlib_update_image().
2416 wimlib_delete_path(WIMStruct *wim, int image,
2417 const wimlib_tchar *path, int delete_flags);
2420 * @ingroup G_modifying_wims
2422 * Exports an image, or all the images, from a WIM file, into another WIM file.
2424 * The destination image is made to share the same dentry tree and security data
2425 * structure as the source image. This places some restrictions on additional
2426 * functions that may be called. For example, you may not call wimlib_free() on
2427 * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2428 * because @p dest_wim will have references back to @p src_wim.
2430 * If this function fails, all changes to @p dest_wim are rolled back.
2432 * Please note that no changes are committed to the underlying WIM file of @p
2433 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2436 * The WIM from which to export the images, specified as a pointer to the
2437 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2438 * split WIM. In the case of a WIM file that is not standalone, this
2439 * ::WIMStruct must have had any needed external resources previously
2440 * referenced using wimlib_reference_resources() or
2441 * wimlib_reference_resource_files().
2443 * The image to export from @p src_wim, as either a 1-based image index to
2444 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2446 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2449 * For single-image exports, the name to give the exported image in @p
2450 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2451 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2452 * that case, the names are all taken from @p src_wim. This parameter is
2453 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2454 * @param dest_description
2455 * For single-image exports, the description to give the exported image in
2456 * the new WIM file. If left @c NULL, the description from @p src_wim is
2457 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2458 * NULL; in that case, the description are all taken from @p src_wim. This
2459 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2460 * @param export_flags
2461 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2463 * @return 0 on success; nonzero on error.
2464 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2465 * One or more of the names being given to an exported image was already in
2466 * use in the destination WIM.
2467 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2468 * @p src_image does not exist in @p src_wim and was not
2469 * ::WIMLIB_ALL_IMAGES.
2470 * @retval ::WIMLIB_ERR_INVALID_PARAM
2471 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2472 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2474 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2475 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2476 * example, one of them was a non-first part of a split WIM.
2477 * @retval ::WIMLIB_ERR_NOMEM
2478 * Failed to allocate needed memory.
2479 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2480 * A resource that needed to be exported could not be found in either the
2481 * source or destination WIMs. This error can occur if, for example, @p
2482 * src_wim is part of a split WIM but needed resources from the other split
2483 * WIM parts were not referenced with wimlib_reference_resources() or
2484 * wimlib_reference_resource_files() before the call to
2485 * wimlib_export_image().
2486 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2487 * @p dest_wim is considered read-only because of any of the reasons
2488 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2491 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2492 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2493 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2494 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2495 * different reasons) to read the metadata resource for an image in @p src_wim
2496 * that needed to be exported.
2499 wimlib_export_image(WIMStruct *src_wim, int src_image,
2500 WIMStruct *dest_wim,
2501 const wimlib_tchar *dest_name,
2502 const wimlib_tchar *dest_description,
2506 * @ingroup G_extracting_wims
2508 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2511 * The exact behavior of how wimlib extracts files from a WIM image is
2512 * controllable by the @p extract_flags parameter, but there also are
2513 * differences depending on the platform (UNIX-like vs Windows). See the manual
2514 * page for <b>wimlib-imagex apply</b> for more information, including about the
2515 * special "NTFS volume extraction mode" entered by providing
2516 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2519 * The WIM from which to extract the image(s), specified as a pointer to
2520 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2521 * of a split WIM. In the case of a WIM file that is not standalone, this
2522 * ::WIMStruct must have had any needed external resources previously
2523 * referenced using wimlib_reference_resources() or
2524 * wimlib_reference_resource_files().
2526 * The image to extract, specified as either the 1-based index of a single
2527 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2528 * to be extracted. ::WIMLIB_ALL_IMAGES cannot be used if
2529 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2531 * Directory to extract the WIM image(s) to; or, with
2532 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2533 * the unmounted NTFS volume to which to extract the image.
2534 * @param extract_flags
2535 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2537 * @return 0 on success; nonzero on error.
2538 * @retval ::WIMLIB_ERR_DECOMPRESSION
2539 * Failed to decompress data contained in the WIM.
2540 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2541 * The metadata for one of the images to extract was invalid.
2542 * @retval ::WIMLIB_ERR_INVALID_PARAM
2543 * The extraction flags were invalid; more details may be found in the
2544 * documentation for the specific extraction flags that were specified. Or
2545 * @p target was @c NULL or the empty string, or @p wim was @c NULL.
2546 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2547 * The SHA1 message digest of an extracted stream did not match the SHA1
2548 * message digest given in the WIM.
2549 * @retval ::WIMLIB_ERR_LINK
2550 * Failed to create a symbolic link or a hard link.
2551 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2552 * The metadata resource for one of the images to extract was not found.
2553 * This can happen if @p wim represents a non-first part of a split WIM.
2554 * @retval ::WIMLIB_ERR_MKDIR
2555 * Failed create a directory.
2556 * @retval ::WIMLIB_ERR_NOMEM
2557 * Failed to allocate needed memory.
2558 * @retval ::WIMLIB_ERR_OPEN
2559 * Could not create a file, or failed to open an already-extracted file.
2560 * @retval ::WIMLIB_ERR_READ
2561 * Failed to read data from the WIM.
2562 * @retval ::WIMLIB_ERR_READLINK
2563 * Failed to determine the target of a symbolic link in the WIM.
2564 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2565 * Failed to fix the target of an absolute symbolic link (e.g. if the
2566 * target would have exceeded the maximum allowed length). (Only if
2567 * reparse data was supported by the extraction mode and
2568 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2570 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2571 * One of the files or directories that needed to be extracted referenced a
2572 * stream not present in the WIM's lookup table (or in any of the lookup
2573 * tables of the split WIM parts).
2574 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2575 * Failed to set attributes on a file.
2576 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2577 * Failed to set reparse data on a file (only if reparse data was supported
2578 * by the extraction mode).
2579 * @retval ::WIMLIB_ERR_SET_SECURITY
2580 * Failed to set security descriptor on a file
2581 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2583 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2584 * Failed to set the short name of a file (only if
2585 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2586 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2587 * Failed to set timestamps on a file (only if
2588 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2589 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2590 * Unexpected end-of-file occurred when reading data from the WIM.
2591 * @retval ::WIMLIB_ERR_UNSUPPORTED
2592 * A requested extraction flag, or the data or metadata that must be
2593 * extracted to support it, is unsupported in the build and configuration
2594 * of wimlib, or on the current platform or extraction mode or target
2595 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2596 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2597 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2598 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2599 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2600 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2601 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2602 * image contains one or more files with short names, but extracting short
2603 * names is not supported --- on Windows, this occurs if the target volume
2604 * does not support short names, while on non-Windows, this occurs if
2605 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2606 * @retval ::WIMLIB_ERR_WIMBOOT
2607 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2608 * there was a problem creating WIMBoot pointer files.
2609 * @retval ::WIMLIB_ERR_WRITE
2610 * Failed to write data to a file being extracted.
2612 * If a progress function is registered with @p wim, then as each image is
2613 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2614 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then
2615 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2618 wimlib_extract_image(WIMStruct *wim, int image,
2619 const wimlib_tchar *target, int extract_flags);
2622 * @ingroup G_extracting_wims
2624 * Since wimlib v1.5.0: Extract one image from a pipe on which a pipable WIM is
2627 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2628 * about pipable WIMs.
2630 * This function operates in a special way to read the WIM fully sequentially.
2631 * As a result, there is no ::WIMStruct is made visible to library users, and
2632 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2633 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2634 * seekable file, not a pipe.)
2637 * File descriptor, which may be a pipe, opened for reading and positioned
2638 * at the start of the pipable WIM.
2639 * @param image_num_or_name
2640 * String that specifies the 1-based index or name of the image to extract.
2641 * It is translated to an image index using the same rules that
2642 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2643 * only a single image (not all images) can be specified. Alternatively,
2644 * specify @p NULL here to use the first image in the WIM if it contains
2645 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2647 * Same as the corresponding parameter to wimlib_extract_image().
2648 * @param extract_flags
2649 * Same as the corresponding parameter to wimlib_extract_image().
2651 * @return 0 on success; nonzero on error. The possible error codes include
2652 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2655 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2656 * Data read from the pipable WIM was invalid.
2657 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2658 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2661 wimlib_extract_image_from_pipe(int pipe_fd,
2662 const wimlib_tchar *image_num_or_name,
2663 const wimlib_tchar *target, int extract_flags);
2666 * @ingroup G_extracting_wims
2668 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2669 * function. The progress function will be used while extracting the WIM image
2670 * and will receive the normal extraction progress messages, such as
2671 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2672 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2675 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2676 const wimlib_tchar *image_num_or_name,
2677 const wimlib_tchar *target,
2679 wimlib_progress_func_t progfunc,
2683 * @ingroup G_extracting_wims
2685 * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to
2686 * extract from the WIM image are specified in the ASCII, UTF-8, or UTF-16LE
2687 * text file named by @p path_list_file which itself contains the list of paths
2688 * to use, one per line. Leading and trailing whitespace, and otherwise empty
2689 * lines and lines beginning with the ';' character are ignored. No quotes are
2690 * needed as paths are otherwise delimited by the newline character.
2692 * The error codes are the same as those returned by wimlib_extract_paths(),
2693 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2694 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2695 * ::WIMLIB_ERR_READ).
2698 wimlib_extract_pathlist(WIMStruct *wim, int image,
2699 const wimlib_tchar *target,
2700 const wimlib_tchar *path_list_file,
2704 * @ingroup G_extracting_wims
2706 * Since wimlib v1.6.0: Extract zero or more paths (files or directory trees)
2707 * from the specified WIM image.
2709 * By default, each path will be extracted to a corresponding subdirectory of
2710 * the target based on its location in the WIM image. For example, if one of
2711 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2712 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2713 * can be changed by providing the flag
2714 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2715 * or directory tree to be placed directly in the target directory --- so the
2716 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2718 * Symbolic links will not be dereferenced when paths in the WIM image are
2722 * WIM from which to extract the paths, specified as a pointer to the
2723 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2724 * split WIM. In the case of a WIM file that is not standalone, this
2725 * ::WIMStruct must have had any needed external resources previously
2726 * referenced using wimlib_reference_resources() or
2727 * wimlib_reference_resource_files().
2729 * 1-based index of the WIM image from which to extract the paths.
2731 * Array of paths to extract. Each element must be the absolute path to a
2732 * file or directory within the WIM image. Separators may be either
2733 * forwards or backwards slashes, and leading path separators are optional.
2734 * The paths will be interpreted either case-sensitively (UNIX default) or
2735 * case-insensitively (Windows default); this can be changed by
2736 * wimlib_global_init().
2738 * By default, the characters @c * and @c ? are interpreted literally.
2739 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2742 * By default, if any paths to extract do not exist, the error code
2743 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2744 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2746 * Number of paths specified in @p paths.
2748 * Directory to which to extract the paths; or with
2749 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2750 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2751 * paths being extracted, the @p target must be native path. On UNIX-like
2752 * systems it may not contain backslashes, for example.
2753 * @param extract_flags
2754 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2756 * @return 0 on success; nonzero on error. Most of the error codes are the same
2757 * as those returned by wimlib_extract_image(). Below, some of the error codes
2758 * returned in situations specific to path-mode extraction are documented:
2760 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2761 * @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2763 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2764 * One of the paths to extract did not exist in the WIM image. This error
2765 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2766 * specified in @p extract_flags, or if both
2767 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2768 * were specified in @p extract_flags.
2769 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2770 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2771 * one of the paths to extract did not name a regular file.
2773 * If a progress function is registered with @p wim, it will receive
2774 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. Note that because the extraction code
2775 * is stream-based and not file-based, there is no way to get information about
2776 * which path is currently being extracted, but based on byte count you can
2777 * still calculate an approximate percentage complete for the extraction overall
2778 * which may be all you really need anyway.
2781 wimlib_extract_paths(WIMStruct *wim,
2783 const wimlib_tchar *target,
2784 const wimlib_tchar * const *paths,
2789 * @ingroup G_wim_information
2791 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2792 * includes a string of XML that describes the images contained in the WIM.
2794 * See wimlib_get_xml_data() to read the XML data into memory instead.
2797 * Pointer to the ::WIMStruct to query. This need not represent a
2798 * standalone WIM (e.g. it could represent part of a split WIM).
2800 * @c stdout, or a FILE* opened for writing, to extract the data to.
2802 * @return 0 on success; nonzero on error.
2803 * @retval ::WIMLIB_ERR_INVALID_PARAM
2804 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2805 * @retval ::WIMLIB_ERR_NOMEM
2806 * Failed to allocate needed memory.
2807 * @retval ::WIMLIB_ERR_READ
2808 * Error reading the XML data from the WIM file.
2809 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2810 * Error reading the XML data from the WIM file.
2811 * @retval ::WIMLIB_ERR_WRITE
2812 * Failed to completely write the XML data to @p fp.
2815 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2818 * @ingroup G_general
2820 * Frees all memory allocated for a WIMStruct and closes all files associated
2824 * Pointer to the ::WIMStruct to free.
2826 * @return This function has no return value.
2829 wimlib_free(WIMStruct *wim);
2832 * @ingroup G_general
2834 * Converts a ::wimlib_compression_type value into a string.
2837 * The ::wimlib_compression_type value to convert.
2840 * A statically allocated string naming the compression algorithm,
2841 * such as "None", "LZX", "XPRESS", or "Invalid".
2843 extern const wimlib_tchar *
2844 wimlib_get_compression_type_string(int ctype);
2847 * @ingroup G_general
2849 * Converts an error code into a string describing it.
2852 * The error code returned by one of wimlib's functions.
2855 * Pointer to a statically allocated string describing the error code,
2856 * or @c NULL if the error code is not valid.
2858 extern const wimlib_tchar *
2859 wimlib_get_error_string(enum wimlib_error_code code);
2862 * @ingroup G_wim_information
2864 * Returns the description of the specified image.
2867 * Pointer to the ::WIMStruct to query. This need not represent a
2868 * standalone WIM (e.g. it could represent part of a split WIM).
2870 * The number of the image, numbered starting at 1.
2873 * The description of the image, or @c NULL if there is no such image, or
2874 * @c NULL if the specified image has no description. The description
2875 * string is in library-internal memory and may not be modified or freed;
2876 * in addition, the string will become invalid if the description of the
2877 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2879 extern const wimlib_tchar *
2880 wimlib_get_image_description(const WIMStruct *wim, int image);
2883 * @ingroup G_wim_information
2885 * Returns the name of the specified image.
2888 * Pointer to the ::WIMStruct to query. This need not represent a
2889 * standalone WIM (e.g. it could represent part of a split WIM).
2891 * The number of the image, numbered starting at 1.
2894 * The name of the image, or @c NULL if there is no such image, or an empty
2895 * string if the image is unnamed. The name string is in
2896 * library-internal memory and may not be modified or freed; in addition,
2897 * the string will become invalid if the name of the image is changed, the
2898 * image is deleted, or the ::WIMStruct is destroyed.
2900 extern const wimlib_tchar *
2901 wimlib_get_image_name(const WIMStruct *wim, int image);
2904 * @ingroup G_general
2906 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2907 * the major version, the next 10 bits contain the minor version, and the low 10
2908 * bits contain the patch version.
2910 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2911 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2912 * corresponding header file.
2915 wimlib_get_version(void);
2918 * @ingroup G_wim_information
2920 * Get basic information about a WIM file.
2923 * Pointer to the ::WIMStruct to query. This need not represent a
2924 * standalone WIM (e.g. it could represent part of a split WIM).
2926 * A ::wimlib_wim_info structure that will be filled in with information
2927 * about the WIM file.
2932 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2935 * @ingroup G_wim_information
2937 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2938 * includes a string of XML that describes the images contained in the WIM.
2940 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2944 * Pointer to the ::WIMStruct to query. This need not represent a
2945 * standalone WIM (e.g. it could represent part of a split WIM).
2947 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2948 * XML data is written to this location.
2949 * @param bufsize_ret
2950 * The size of the XML data in bytes is written to this location.
2952 * @return 0 on success; nonzero on error.
2953 * @retval ::WIMLIB_ERR_INVALID_PARAM
2954 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2955 * @p buf_ret or @p bufsize_ret was @c NULL.
2956 * @retval ::WIMLIB_ERR_NOMEM
2957 * @retval ::WIMLIB_ERR_READ
2958 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2959 * Failed to read the XML data from the WIM.
2962 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2965 * @ingroup G_general
2967 * Initialization function for wimlib. Call before using any other wimlib
2968 * function except wimlib_set_print_errors(). If not done manually, this
2969 * function will be called automatically with @p init_flags set to
2970 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
2971 * after it has already successfully run.
2974 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2976 * @return 0 on success; nonzero on failure. Currently, only the following
2977 * error code is defined:
2979 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2980 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2981 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2982 * init_flags, but the corresponding privileges could not be acquired.
2985 wimlib_global_init(int init_flags);
2988 * @ingroup G_general
2990 * Cleanup function for wimlib. You are not required to call this function, but
2991 * it will release any global resources allocated by the library.
2994 wimlib_global_cleanup(void);
2997 * @ingroup G_wim_information
2999 * Determines if an image name is already used by some image in the WIM.
3002 * Pointer to the ::WIMStruct to query. This need not represent a
3003 * standalone WIM (e.g. it could represent part of a split WIM).
3005 * The name to check.
3008 * @c true if there is already an image in @p wim named @p name; @c false
3009 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3010 * the empty string, @c false is returned.
3013 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3016 * @ingroup G_wim_information
3018 * Iterate through a file or directory tree in the WIM image. By specifying
3019 * appropriate flags and a callback function, you can get the attributes of a
3020 * file in the WIM, get a directory listing, or even get a listing of the entire
3024 * The WIM containing the image(s) over which to iterate, specified as a
3025 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3026 * or part 1 of a split WIM. In the case of a WIM file that is not
3027 * standalone, this ::WIMStruct should have had any needed external
3028 * resources previously referenced using wimlib_reference_resources() or
3029 * wimlib_reference_resource_files(). If not, see
3030 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3031 * the behavior when resources are missing.
3034 * The 1-based number of the image in @p wim that contains the files or
3035 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3036 * iteration on all images in the WIM.
3039 * Path in the WIM image at which to do the iteration.
3042 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3045 * A callback function that will receive each directory entry.
3048 * An extra parameter that will always be passed to the callback function
3051 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3052 * first nonzero value that was returned from @p cb. However, additional error
3053 * codes may be returned, including the following:
3055 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3056 * @p path did not exist in the WIM image.
3057 * @retval ::WIMLIB_ERR_NOMEM
3058 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
3060 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3061 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3062 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3063 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3064 * different reasons) to read the metadata resource for an image over which
3065 * iteration needed to be done.
3068 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3070 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3073 * @ingroup G_wim_information
3075 * Iterate through the lookup table of a WIM file. This can be used to directly
3076 * get a listing of the unique resources contained in a WIM file over all
3077 * images. Both file resources and metadata resources are included. However,
3078 * only resources actually included in the file represented by @a wim, plus
3079 * explicitly referenced external resources (via wimlib_reference_resources() or
3080 * wimlib_reference_resource_files()) are included in the iteration. For
3081 * example, if @p wim represents just one part of a split WIM, then only
3082 * resources in that part will be included, unless other resources were
3083 * explicitly referenced.
3086 * Pointer to the ::WIMStruct to query. This need not represent a
3087 * standalone WIM (e.g. it could represent part of a split WIM).
3090 * Reserved; set to 0.
3093 * A callback function that will receive each resource.
3096 * An extra parameter that will always be passed to the callback function
3099 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3100 * that was returned from @p cb.
3103 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3104 wimlib_iterate_lookup_table_callback_t cb,
3108 * @ingroup G_nonstandalone_wims
3110 * Joins a split WIM into a stand-alone one-part WIM.
3113 * An array of strings that gives the filenames of all parts of the split
3114 * WIM. No specific order is required, but all parts must be included with
3117 * Number of filenames in @p swms.
3118 * @param swm_open_flags
3119 * Open flags for the split WIM parts (e.g.
3120 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3121 * @param wim_write_flags
3122 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3123 * be used to write the joined WIM.
3124 * @param output_path
3125 * The path to write the joined WIM file to.
3127 * @return 0 on success; nonzero on error. This function may return most error
3128 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3129 * as the following error code:
3131 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3132 * The split WIMs do not form a valid WIM because they do not include all
3133 * the parts of the original WIM, there are duplicate parts, or not all the
3134 * parts have the same GUID and compression type.
3136 * Note: wimlib is generalized enough that this function is not actually needed
3137 * to join a split WIM; instead, you could open the first part of the split WIM,
3138 * then reference the other parts with wimlib_reference_resource_files(), then
3139 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3140 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3144 wimlib_join(const wimlib_tchar * const *swms,
3146 const wimlib_tchar *output_path,
3148 int wim_write_flags);
3151 * @ingroup G_nonstandalone_wims
3153 * Same as wimlib_join(), but allows specifying a progress function. The
3154 * progress function will receive the write progress messages, such as
3155 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3156 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3157 * swm_open_flags, the progress function will receive a series of
3158 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3162 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3164 const wimlib_tchar *output_path,
3166 int wim_write_flags,
3167 wimlib_progress_func_t progfunc,
3172 * @ingroup G_mounting_wim_images
3174 * Mounts an image from a WIM file on a directory read-only or read-write.
3177 * Pointer to the ::WIMStruct containing the image to be mounted.
3179 * The 1-based index of the image to mount.
3181 * The path to an existing empty directory on which to mount the WIM image.
3182 * @param mount_flags
3183 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3184 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3186 * @param staging_dir
3187 * If non-NULL, the name of a directory in which a temporary directory for
3188 * storing modified or added files will be created. Ignored if
3189 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3190 * left @c NULL, the staging directory is created in the same directory as
3191 * the WIM file that @p wim was originally read from. The staging
3192 * directory is deleted when the image is unmounted.
3194 * @return 0 on success; nonzero on error. The possible error codes include:
3196 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3197 * An image from the WIM file is already mounted read-write, or another
3198 * process is currently appending data to the WIM file.
3199 * @retval ::WIMLIB_ERR_FUSE
3200 * A non-zero status code was returned by @c fuse_main().
3201 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3202 * @p image does not specify an existing, single image in @p wim.
3203 * @retval ::WIMLIB_ERR_INVALID_PARAM
3204 * @p wim was @c NULL; or @p dir was NULL or the empty string; or an
3205 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3206 * already been modified in memory (e.g. by wimlib_update_image()).
3207 * @retval ::WIMLIB_ERR_MKDIR
3208 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3209 * staging directory could not be created.
3210 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3211 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3212 * WIM file is considered read-only because of any of the reasons mentioned
3213 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3214 * @retval ::WIMLIB_ERR_UNSUPPORTED
3215 * Mounting is not supported, either because the platform is Windows, or
3216 * because the platform is UNIX-like and wimlib was compiled using
3217 * <code>--without-fuse</code>.
3219 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3220 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3221 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3222 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3223 * different reasons) to read the metadata resource for the image to mount.
3225 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3226 * UserSpacE). Depending on how FUSE is set up on your system, this function
3227 * may work as normal users in addition to the root user.
3229 * Mounting WIM images is not supported if wimlib was configured
3230 * <code>--without-fuse</code>. This includes Windows builds of wimlib;
3231 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3233 * Calling this function daemonizes the process, unless
3234 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3236 * It is safe to mount multiple images from the same underlying WIM file
3237 * read-only at the same time, but only if different ::WIMStruct's are used. It
3238 * is @b not safe to mount multiple images from the same WIM file read-write at
3241 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3242 * different process.
3245 wimlib_mount_image(WIMStruct *wim,
3247 const wimlib_tchar *dir,
3249 const wimlib_tchar *staging_dir);
3252 * @ingroup G_creating_and_opening_wims
3254 * Opens a WIM file and creates a ::WIMStruct for it.
3257 * The path to the WIM file to open.
3260 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3263 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3264 * is written to the memory location pointed to by this parameter. The
3265 * ::WIMStruct must be freed using using wimlib_free() when finished with
3268 * @return 0 on success; nonzero on error.
3269 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3270 * The number of metadata resources found in the WIM did not match the
3271 * image count specified in the WIM header, or the number of <IMAGE>
3272 * elements in the XML data of the WIM did not match the image count
3273 * specified in the WIM header.
3274 * @retval ::WIMLIB_ERR_INTEGRITY
3275 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3276 * the WIM contained an integrity table, but the SHA1 message digest for a
3277 * chunk of the WIM did not match the corresponding value in the integrity
3279 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3280 * The library did not recognize the compression chunk size of the WIM as
3281 * valid for its compression type.
3282 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3283 * The library did not recognize the compression type of the WIM.
3284 * @retval ::WIMLIB_ERR_INVALID_HEADER
3285 * The header of the WIM was otherwise invalid.
3286 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3287 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3288 * the WIM contained an integrity table, but the integrity table was
3290 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3291 * The lookup table of the WIM was invalid.
3292 * @retval ::WIMLIB_ERR_INVALID_PARAM
3293 * @p wim_ret was @c NULL.
3294 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3295 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3296 * specified in @p open_flags.
3297 * @retval ::WIMLIB_ERR_NOMEM
3298 * Failed to allocated needed memory.
3299 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3300 * The file did not begin with the magic characters that identify a WIM
3302 * @retval ::WIMLIB_ERR_OPEN
3303 * Failed to open the file for reading.
3304 * @retval ::WIMLIB_ERR_READ
3305 * Failed to read data from the file.
3306 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3307 * Unexpected end-of-file while reading data from the file.
3308 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3309 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3310 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3311 * The WIM cannot be opened because it contains encrypted segments. (It
3312 * may be a Windows 8 "ESD" file.)
3313 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3314 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3315 * considered read-only because of any of the reasons mentioned in the
3316 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3317 * @retval ::WIMLIB_ERR_XML
3318 * The XML data of the WIM was invalid.
3321 wimlib_open_wim(const wimlib_tchar *wim_file,
3323 WIMStruct **wim_ret);
3326 * @ingroup G_creating_and_opening_wims
3328 * Same as wimlib_open_wim(), but allows specifying a progress function and
3329 * progress context. If successful, the progress function will be registered in
3330 * the newly open ::WIMStruct, as if by an automatic call to
3331 * wimlib_register_progress_function(). In addition, if
3332 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the
3333 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3334 * messages while checking the WIM's integrity.
3337 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3339 WIMStruct **wim_ret,
3340 wimlib_progress_func_t progfunc,
3344 * @ingroup G_writing_and_overwriting_wims
3346 * Overwrites the file that the WIM was originally read from, with changes made.
3347 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3348 * rather than wimlib_create_new_wim().
3350 * There are two ways that a WIM may be overwritten. The first is to do a full
3351 * rebuild. In this mode, the new WIM is written to a temporary file and then
3352 * renamed to the original file after it is has been completely written. The
3353 * temporary file is made in the same directory as the original WIM file. A
3354 * full rebuild may take a while, but it will save space by producing a WIM with
3357 * The second way to overwrite a WIM is by appending to the end of it and
3358 * overwriting the header. This can be much faster than a full rebuild, but the
3359 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3360 * begins with writing any new file resources *after* everything in the old WIM,
3361 * even though this will leave a hole where the old lookup table, XML data, and
3362 * integrity were. This is done so that the WIM remains valid even if the
3363 * operation is aborted mid-write. The WIM header is only overwritten at the
3364 * very last moment, and up until that point the WIM will be seen as the old
3367 * By default, wimlib_overwrite() does the append-style overwrite described
3368 * above, unless resources in the WIM are arranged in an unusual way or if
3369 * images have been deleted from the WIM. Use the flag
3370 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3371 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3372 * images have been deleted from the WIM.
3374 * If this function completes successfully, no more functions should be called
3375 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3376 * the WIM file anew.
3379 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3380 * been in-memory changes made to it, which are then reflected in the
3382 * @param write_flags
3383 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3384 * @param num_threads
3385 * Number of threads to use for compression (see wimlib_write()).
3387 * @return 0 on success; nonzero on error. This function may return most error
3388 * codes returned by wimlib_write() as well as the following error codes:
3390 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3391 * The WIM was going to be modified in-place (with no temporary file), but
3392 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3393 * because another thread or process has mounted an image from the WIM
3394 * read-write or is currently modifying the WIM in-place.
3395 * @retval ::WIMLIB_ERR_NO_FILENAME
3396 * @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim()
3397 * rather than a WIM read with wimlib_open_wim().
3398 * @retval ::WIMLIB_ERR_RENAME
3399 * The temporary file that the WIM was written to could not be renamed to
3400 * the original filename of @p wim.
3401 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3402 * The WIM file is considered read-only because of any of the reasons
3403 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3406 * If a progress function is registered with @p wim, it will receive the
3407 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3408 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3409 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3412 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3415 * @ingroup G_wim_information
3417 * Prints information about one image, or all images, contained in a WIM.
3420 * Pointer to the ::WIMStruct to query. This need not represent a
3421 * standalone WIM (e.g. it could represent part of a split WIM).
3423 * The image about which to print information. Can be the number of an
3424 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3427 * @return This function has no return value. No error checking is done when
3428 * printing the information. If @p image is invalid, an error message is
3432 wimlib_print_available_images(const WIMStruct *wim, int image);
3435 * @ingroup G_wim_information
3437 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3438 * in a way that can be accessed programatically.
3441 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3444 * @ingroup G_nonstandalone_wims
3446 * Reference resources from other WIM files or split WIM parts. This function
3447 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3448 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3449 * from other files, before calling a function such as wimlib_extract_image()
3450 * that requires the resources to be present.
3453 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3454 * necessarily "standalone". In the case of split WIMs, this should be the
3455 * first part, since only the first part contains the metadata resources.
3456 * In the case of delta WIMs, this should be the delta WIM rather than the
3457 * WIM on which it is based.
3458 * @param resource_wimfiles_or_globs
3459 * Array of paths to WIM files and/or split WIM parts to reference.
3460 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3461 * ref_flags, these are treated as globs rather than literal paths. That
3462 * is, using this function you can specify zero or more globs, each of
3463 * which expands to one or more literal paths.
3465 * Number of entries in @p resource_wimfiles_or_globs.
3467 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3468 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3470 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3471 * pass to internal calls to wimlib_open_wim() on the reference files.
3473 * @return 0 on success; nonzero on error.
3475 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3476 * One of the specified globs did not match any paths (only with both
3477 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3478 * specified in @p ref_flags).
3479 * @retval ::WIMLIB_ERR_NOMEM
3480 * Failed to allocate memory.
3481 * @retval ::WIMLIB_ERR_READ
3482 * I/O or permissions error while processing a file glob.
3484 * This function can additionally return most values that can be returned by
3485 * wimlib_open_wim().
3488 wimlib_reference_resource_files(WIMStruct *wim,
3489 const wimlib_tchar * const *resource_wimfiles_or_globs,
3495 * @ingroup G_nonstandalone_wims
3497 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3498 * where the caller must open the ::WIMStruct for each referenced file itself.
3501 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3502 * necessarily "standalone". In the case of split WIMs, this should be the
3503 * first part, since only the first part contains the metadata resources.
3504 * @param resource_wims
3505 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3506 * split WIM parts to reference.
3507 * @param num_resource_wims
3508 * Number of entries in @p resource_wims.
3510 * Currently ignored (set to 0).
3512 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3513 * @p resource_wims are referenced internally by @p wim and must not be freed
3514 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3515 * been freed with wimlib_free(), or immediately before freeing @p wim with
3518 * @retval ::WIMLIB_ERR_INVALID_PARAM
3519 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3520 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3521 * @retval ::WIMLIB_ERR_NOMEM
3522 * Failed to allocate memory.
3525 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3526 unsigned num_resource_wims, int ref_flags);
3529 * @ingroup G_modifying_wims
3531 * Declares that a newly added image is mostly the same as a prior image, but
3532 * captured at a later point in time, possibly with some modifications in the
3533 * intervening time. This is designed to be used in incremental backups of the
3534 * same filesystem or directory tree.
3536 * This function compares the metadata of the directory tree of the newly added
3537 * image against that of the old image. Any files that are present in both the
3538 * newly added image and the old image and have timestamps that indicate they
3539 * haven't been modified are deemed not to have been modified and have their
3540 * SHA1 message digest copied from the old image. Because of this and because
3541 * WIM uses single-instance streams, such files need not be read from the
3542 * filesystem when the WIM is being written or overwritten. Note that these
3543 * unchanged files will still be "archived" and will be logically present in the
3544 * new image; the optimization is that they don't need to actually be read from
3545 * the filesystem because the WIM already contains them.
3547 * This function is provided to optimize incremental backups. The resulting WIM
3548 * file will still be the same regardless of whether this function is called.
3549 * (This is, however, assuming that timestamps have not been manipulated or
3550 * unmaintained as to trick this function into thinking a file has not been
3551 * modified when really it has. To partly guard against such cases, other
3552 * metadata such as file sizes will be checked as well.)
3554 * This function must be called after adding the new image (e.g. with
3555 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3556 * wimlib_overwrite()).
3559 * Pointer to the ::WIMStruct for a WIM.
3561 * 1-based index in the WIM of the newly added image. This image can have
3562 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3563 * wimlib_add_empty_image() followed by wimlib_update_image().
3564 * @param template_wim
3565 * The ::WIMStruct for the WIM containing the template image. This can be
3566 * the same as @p wim, or it can be a different ::WIMStruct.
3567 * @param template_image
3568 * 1-based index in the WIM of a template image that reflects a prior state
3569 * of the directory tree being captured.
3571 * Reserved; must be 0.
3573 * @return 0 on success; nonzero on error.
3575 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3576 * @p new_image and/or @p template_image were not a valid image indices in
3578 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3579 * The specified ::WIMStruct did not actually contain the metadata resource
3580 * for the new or template image; for example, it was a non-first part of a
3582 * @retval ::WIMLIB_ERR_NOMEM
3583 * Failed to allocate needed memory.
3584 * @retval ::WIMLIB_ERR_INVALID_PARAM
3585 * @p new_image was equal to @p template_image, or @p new_image specified
3586 * an image that had not been modified since opening the WIM.
3588 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3589 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3590 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3591 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3592 * different reasons) to read the metadata resource for the template image.
3595 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3596 WIMStruct *template_wim, int template_image,
3600 * @ingroup G_general
3602 * Registers a progress function with a ::WIMStruct.
3605 * The ::WIMStruct for which to register the progress function.
3607 * Pointer to the progress function to register. If the WIM already has a
3608 * progress function registered, it will be replaced with this one. If @p
3609 * NULL, the current progress function (if any) will be unregistered.
3611 * The value which will be passed as the third argument to calls to @p
3615 wimlib_register_progress_function(WIMStruct *wim,
3616 wimlib_progress_func_t progfunc,
3620 * @ingroup G_modifying_wims
3622 * Rename the @p source_path to the @p dest_path in the specified @p image of
3625 * This just builds an appropriate ::wimlib_rename_command and passes it to
3626 * wimlib_update_image().
3629 wimlib_rename_path(WIMStruct *wim, int image,
3630 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3633 * @ingroup G_wim_information
3635 * Translates a string specifying the name or number of an image in the WIM into
3636 * the number of the image. The images are numbered starting at 1.
3639 * Pointer to the ::WIMStruct for a WIM.
3640 * @param image_name_or_num
3641 * A string specifying the name or number of an image in the WIM. If it
3642 * parses to a positive integer, this integer is taken to specify the
3643 * number of the image, indexed starting at 1. Otherwise, it is taken to
3644 * be the name of an image, as given in the XML data for the WIM file. It
3645 * also may be the keyword "all" or the string "*", both of which will
3646 * resolve to ::WIMLIB_ALL_IMAGES.
3648 * There is no way to search for an image actually named "all", "*", or an
3649 * integer number, or an image that has no name. However, you can use
3650 * wimlib_get_image_name() to get the name of any image.
3653 * If the string resolved to a single existing image, the number of that
3654 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3655 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3656 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3657 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3658 * images in @p wim has no name.
3661 wimlib_resolve_image(WIMStruct *wim,
3662 const wimlib_tchar *image_name_or_num);
3665 * @ingroup G_modifying_wims
3667 * Changes the description of an image in the WIM.
3670 * Pointer to the ::WIMStruct for a WIM.
3672 * The number of the image for which to change the description.
3673 * @param description
3674 * The new description to give the image. It may be @c NULL, which
3675 * indicates that the image is to be given no description.
3677 * @return 0 on success; nonzero on error.
3678 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3679 * @p image does not specify a single existing image in @p wim.
3680 * @retval ::WIMLIB_ERR_NOMEM
3681 * Failed to allocate the memory needed to duplicate the @p description
3683 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3684 * @p wim is considered read-only because of any of the reasons mentioned
3685 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3688 wimlib_set_image_descripton(WIMStruct *wim, int image,
3689 const wimlib_tchar *description);
3692 * @ingroup G_writing_and_overwriting_wims
3694 * Set the compression chunk size of a WIM to use in subsequent calls to
3695 * wimlib_write() or wimlib_overwrite().
3697 * A larger compression chunk size will likely result in a better compression
3698 * ratio, but the speed of random access to the WIM will be reduced.
3699 * Furthermore, the effect of a larger compression chunk size is limited by the
3700 * size of each stream ("file") being compressed.
3703 * ::WIMStruct for a WIM.
3705 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3706 * on the compression format. See the documentation for each
3707 * ::wimlib_compression_type constant for more information. As a special
3708 * case, if @p chunk_size is specified as 0, the chunk size is set to the
3709 * default for the currently selected output compression type.
3711 * @return 0 on success; nonzero on error.
3713 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3714 * @p chunk_size is not a supported chunk size for the currently selected
3715 * output compression type.
3718 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3721 * @ingroup G_writing_and_overwriting_wims
3723 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3724 * packed streams (solid blocks).
3727 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3730 * @ingroup G_writing_and_overwriting_wims
3732 * Set the compression type of a WIM to use in subsequent calls to
3733 * wimlib_write() or wimlib_overwrite().
3736 * ::WIMStruct for a WIM.
3738 * The compression type to set (one of ::wimlib_compression_type). If this
3739 * compression type is incompatible with the current output chunk size
3740 * (either the default or as set with wimlib_set_output_chunk_size()), the
3741 * output chunk size is reset to the default for that compression type.
3743 * @return 0 on success; nonzero on error.
3745 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3746 * @p ctype did not specify a valid compression type.
3749 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3752 * @ingroup G_writing_and_overwriting_wims
3754 * Similar to wimlib_set_output_compression_type(), but set the compression type
3755 * for writing packed streams (solid blocks).
3758 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3761 * @ingroup G_modifying_wims
3763 * Set basic information about a WIM.
3766 * Pointer to the ::WIMStruct for a WIM.
3768 * A struct ::wimlib_wim_info that contains the information to set. Only
3769 * the information explicitly specified in the @p which flags need be
3772 * Flags that specify which information to set. This is a bitwise OR of
3773 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3774 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3776 * @return 0 on success; nonzero on failure.
3777 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3778 * The WIM file is considered read-only because of any of the reasons
3779 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3780 * flag. However, as a special case, if you are using
3781 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3782 * function will not fail due to the readonly flag being previously set.
3783 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3784 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3785 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3789 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3793 * @ingroup G_modifying_wims
3795 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3796 * (something like "Core" or "Ultimate")
3799 * Pointer to the ::WIMStruct for a WIM.
3801 * The number of the image for which to change the description.
3803 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3804 * indicates that the image is to be given no \<FLAGS\> element.
3806 * @return 0 on success; nonzero on error.
3807 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3808 * @p image does not specify a single existing image in @p wim.
3809 * @retval ::WIMLIB_ERR_NOMEM
3810 * Failed to allocate the memory needed to duplicate the @p flags string.
3811 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3812 * @p wim is considered read-only because of any of the reasons mentioned
3813 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3816 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3819 * @ingroup G_modifying_wims
3821 * Changes the name of an image in the WIM.
3824 * Pointer to the ::WIMStruct for a WIM.
3826 * The number of the image for which to change the name.
3828 * New name to give the new image. If @c NULL or empty, the new image is
3829 * given no name. If nonempty, it must specify a name that does not
3830 * already exist in @p wim.
3832 * @return 0 on success; nonzero on error.
3833 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3834 * There is already an image named @p name in @p wim.
3835 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3836 * @p image does not specify a single existing image in @p wim.
3837 * @retval ::WIMLIB_ERR_NOMEM
3838 * Failed to allocate the memory needed to duplicate the @p name string.
3839 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3840 * @p wim is considered read-only because of any of the reasons mentioned
3841 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3844 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3847 * @ingroup G_general
3849 * Set the functions that wimlib uses to allocate and free memory.
3851 * These settings are global and not per-WIM.
3853 * The default is to use the default @c malloc() and @c free() from the C
3856 * Please note that some external functions, such as those in @c libntfs-3g, may
3857 * use the standard memory allocation functions regardless of this setting.
3859 * @param malloc_func
3860 * A function equivalent to @c malloc() that wimlib will use to allocate
3861 * memory. If @c NULL, the allocator function is set back to the default
3862 * @c malloc() from the C library.
3864 * A function equivalent to @c free() that wimlib will use to free memory.
3865 * If @c NULL, the free function is set back to the default @c free() from
3867 * @param realloc_func
3868 * A function equivalent to @c realloc() that wimlib will use to reallocate
3869 * memory. If @c NULL, the free function is set back to the default @c
3870 * realloc() from the C library.
3874 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3875 void (*free_func)(void *),
3876 void *(*realloc_func)(void *, size_t));
3879 * @ingroup G_general
3881 * Sets whether wimlib is to print error messages to @c stderr when a function
3882 * fails. These error messages may provide information that cannot be
3883 * determined only from the error code that is returned. Not every error will
3884 * result in an error message being printed.
3886 * This setting is global and not per-WIM.
3888 * By default, error messages are not printed.
3890 * This can be called before wimlib_global_init().
3892 * @param show_messages
3893 * @c true if error messages are to be printed; @c false if error messages
3894 * are not to be printed.
3896 * @return 0 on success; nonzero on error.
3897 * @retval ::WIMLIB_ERR_UNSUPPORTED
3898 * @p show_messages was @c true, but wimlib was compiled with the @c
3899 * --without-error-messages option. Therefore, error messages cannot be
3903 wimlib_set_print_errors(bool show_messages);
3906 * @ingroup G_nonstandalone_wims
3908 * Splits a WIM into multiple parts.
3911 * The ::WIMStruct for the WIM to split.
3913 * Name of the SWM file to create. This will be the name of the first
3914 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3915 * appended before the suffix.
3917 * The maximum size per part, in bytes. Unfortunately, it is not
3918 * guaranteed that this will really be the maximum size per part, because
3919 * some file resources in the WIM may be larger than this size, and the WIM
3920 * file format provides no way to split up file resources among multiple
3922 * @param write_flags
3923 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3924 * flags will be used to write each split WIM part. Specify 0 here to get
3925 * the default behavior.
3927 * @return 0 on success; nonzero on error. This function may return most error
3928 * codes that can be returned by wimlib_write() as well as the following error
3931 * @retval ::WIMLIB_ERR_INVALID_PARAM
3932 * @p swm_name was not a nonempty string, or @p part_size was 0.
3934 * If a progress function is registered with @p wim, for each split WIM part
3935 * that is written it will receive the messages
3936 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3937 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
3940 wimlib_split(WIMStruct *wim,
3941 const wimlib_tchar *swm_name,
3946 * @ingroup G_mounting_wim_images
3948 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3950 * When unmounting a read-write mounted image, the default behavior is to
3951 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
3952 * WIM image to be committed.
3955 * The directory the WIM image was mounted on.
3956 * @param unmount_flags
3957 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
3959 * @return 0 on success; nonzero on error. The possible error codes include:
3961 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
3962 * There is no WIM image mounted on the specified directory.
3963 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
3964 * The read-write mounted WIM image cannot be committed because there are
3965 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
3967 * @retval ::WIMLIB_ERR_MQUEUE
3968 * Could not create a POSIX message queue.
3969 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
3970 * The WIM image was mounted by a different user.
3971 * @retval ::WIMLIB_ERR_UNSUPPORTED
3972 * Mounting is not supported, either because the platform is Windows, or
3973 * because the platform is UNIX-like and wimlib was compiled using @c
3976 * Note: you can also unmount the image by using the @c umount() system call, or
3977 * by using the @c umount or @c fusermount programs. However, you need to call
3978 * this function if you want changes to be committed.
3981 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
3984 * @ingroup G_mounting_wim_images
3986 * Same as wimlib_unmount_image(), but allows specifying a progress function.
3987 * If changes are committed from a read-write mount, the progress function will
3988 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
3991 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
3993 wimlib_progress_func_t progfunc,
3997 * @ingroup G_modifying_wims
3999 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4002 * Pointer to the ::WIMStruct for the WIM file to update.
4004 * The 1-based index of the image in the WIM to update. It cannot be
4005 * ::WIMLIB_ALL_IMAGES.
4007 * An array of ::wimlib_update_command's that specify the update operations
4010 * Number of commands in @p cmds.
4011 * @param update_flags
4012 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4014 * @return 0 on success; nonzero on error. On failure, all update commands will
4015 * be rolled back, and no visible changes shall have been made to @p wim.
4016 * Possible error codes include:
4018 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4019 * The capture configuration structure specified for an add command was
4021 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4022 * @p image did not specify a single, existing image in @p wim.
4023 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4024 * Attempted to perform an add command that conflicted with previously
4025 * existing files in the WIM when an overlay was attempted.
4026 * @retval ::WIMLIB_ERR_INVALID_PARAM
4027 * An unknown operation type was specified in the update commands; or,
4028 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
4029 * in the @p add_flags, but the same image had previously already been
4030 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
4031 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
4032 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
4033 * specified in the @p add_flags for an add command in which @p
4034 * wim_target_path was not the root directory of the WIM image.
4035 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4036 * (Windows only): While executing an add command, tried to capture a
4037 * reparse point with invalid data.
4038 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4039 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4040 * for a WIM path that corresponded to a directory; or, a rename command
4041 * attempted to rename a directory to a non-directory.
4042 * @retval ::WIMLIB_ERR_NOMEM
4043 * Failed to allocate needed memory.
4044 * @retval ::WIMLIB_ERR_NOTDIR
4045 * A rename command attempted to rename a directory to a non-directory; or,
4046 * an add command was executed that attempted to set the root of the WIM
4047 * image as a non-directory; or, a path component used as a directory in a
4048 * rename command was not, in fact, a directory.
4049 * @retval ::WIMLIB_ERR_NOTEMPTY
4050 * A rename command attempted to rename a directory to a non-empty
4052 * @retval ::WIMLIB_ERR_NTFS_3G
4053 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4054 * error occurred while reading data from the NTFS volume using libntfs-3g.
4055 * @retval ::WIMLIB_ERR_OPEN
4056 * Failed to open a file to be captured while executing an add command.
4057 * @retval ::WIMLIB_ERR_OPENDIR
4058 * Failed to open a directory to be captured while executing an add command.
4059 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4060 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4061 * WIM path that did not exist; or, a rename command attempted to rename a
4062 * file that does not exist.
4063 * @retval ::WIMLIB_ERR_READ
4064 * While executing an add command, failed to read data from a file or
4065 * directory to be captured.
4066 * @retval ::WIMLIB_ERR_READLINK
4067 * While executing an add command, failed to read the target of a symbolic
4068 * link or junction point.
4069 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
4070 * (Windows only) Failed to perform a reparse point fixup because of
4071 * problems with the data of a reparse point.
4072 * @retval ::WIMLIB_ERR_STAT
4073 * While executing an add command, failed to get attributes for a file or
4075 * @retval ::WIMLIB_ERR_UNSUPPORTED
4076 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4077 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4078 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4079 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4080 * add_flags for an update command.
4081 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4082 * While executing an add command, attempted to capture a file that was not
4083 * a supported file type (e.g. a device file). Only if
4084 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4085 * for an update command.
4086 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4087 * The WIM file is considered read-only because of any of the reasons
4088 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
4091 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4092 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4093 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4094 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4095 * different reasons) to read the metadata resource for an image that needed to
4099 wimlib_update_image(WIMStruct *wim,
4101 const struct wimlib_update_command *cmds,
4106 * @ingroup G_writing_and_overwriting_wims
4108 * Writes a WIM to a file.
4110 * This brings in resources from any external locations, such as directory trees
4111 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4112 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
4114 * By default, the new WIM file is written as stand-alone. Using the
4115 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4116 * instead. However, this function cannot directly write a "split" WIM; use
4117 * wimlib_split() for that.
4120 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
4121 * changes made to it, which are then reflected in the output file.
4123 * The path to the file to write the WIM to.
4125 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4126 * images are to be included in the new on-disk WIM file. If for some
4127 * reason you only want to include a single image, specify the index of
4128 * that image instead.
4129 * @param write_flags
4130 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
4131 * @param num_threads
4132 * Number of threads to use for compressing data. If 0, the number of
4133 * threads is taken to be the number of online processors. Note: if no
4134 * data compression needs to be done, no additional threads will be created
4135 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
4136 * exporting an image from a compressed WIM to another WIM of the same
4137 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
4140 * @return 0 on success; nonzero on error.
4142 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4143 * @p image does not specify a single existing image in @p wim, and is not
4144 * ::WIMLIB_ALL_IMAGES.
4145 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4146 * A file that had previously been scanned for inclusion in the WIM by
4147 * wimlib_add_image() was concurrently modified, so it failed the SHA1
4148 * message digest check.
4149 * @retval ::WIMLIB_ERR_INVALID_PARAM
4150 * @p path was @c NULL.
4151 * @retval ::WIMLIB_ERR_NOMEM
4152 * Failed to allocate needed memory.
4153 * @retval ::WIMLIB_ERR_OPEN
4154 * Failed to open @p path for writing, or some file resources in @p wim
4155 * refer to files in the outside filesystem, and one of these files could
4156 * not be opened for reading.
4157 * @retval ::WIMLIB_ERR_READ
4158 * An error occurred when trying to read data from the WIM file associated
4159 * with @p wim, or some file resources in @p wim refer to files in the
4160 * outside filesystem, and a read error occurred when reading one of these
4162 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4163 * A stream that needed to be written could not be found in the stream
4164 * lookup table of @p wim. This error can occur if, for example, @p wim is
4165 * part of a split WIM but needed resources from the other split WIM parts
4166 * were not referenced with wimlib_reference_resources() or
4167 * wimlib_reference_resource_files() before the call to wimlib_write().
4168 * @retval ::WIMLIB_ERR_WRITE
4169 * An error occurred when trying to write data to the new WIM file.
4171 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4172 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4173 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4174 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4175 * different reasons) to read the metadata resource for an image that needed to
4178 * If a progress function is registered with @p wim, it will receive the
4179 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4180 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4181 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4184 wimlib_write(WIMStruct *wim,
4185 const wimlib_tchar *path,
4188 unsigned num_threads);
4191 * @ingroup G_writing_and_overwriting_wims
4193 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
4194 * file descriptor, which need not be seekable if the write is done in a special
4195 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
4196 * write_flags. This can, for example, allow capturing a WIM image and
4197 * streaming it over the network. See the documentation for
4198 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
4200 * The file descriptor @p fd will @b not be closed when the write is complete;
4201 * the calling code is responsible for this.
4203 * Returns 0 on success; nonzero on failure. The possible error codes include
4204 * those that can be returned by wimlib_write() as well as the following:
4206 * @retval ::WIMLIB_ERR_INVALID_PARAM
4207 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4208 * specified in @p write_flags.
4211 wimlib_write_to_fd(WIMStruct *wim,
4215 unsigned num_threads);
4218 * @defgroup G_compression Compression and decompression functions
4220 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
4221 * exported for convenience only, as they are already used by wimlib internally
4224 * These functions can be used for general-purpose lossless data compression,
4225 * but some limitations apply; for example, none of the compressors or
4226 * decompressors currently support sliding windows, and there also exist
4227 * slightly different variants of these formats that are not supported
4233 /** Header for compression parameters to pass to wimlib_create_compressor() or
4234 * wimlib_set_default_compressor_params(). */
4235 struct wimlib_compressor_params_header {
4236 /** Size of the parameters, in bytes. */
4240 /** Header for decompression parameters to pass to wimlib_create_decompressor()
4241 * or wimlib_set_default_decompressor_params() */
4242 struct wimlib_decompressor_params_header {
4243 /** Size of the parameters, in bytes. */
4247 /** LZX compression parameters that can optionally be passed to
4248 * wimlib_create_compressor() with the compression type
4249 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
4250 struct wimlib_lzx_compressor_params {
4251 /** hdr.size Must be set to the size of this structure, in bytes. */
4252 struct wimlib_compressor_params_header hdr;
4254 /** Relatively fast LZX compression algorithm with a decent compression
4256 #define WIMLIB_LZX_ALGORITHM_FAST 0
4258 /** Slower LZX compression algorithm that provides a better compression
4259 * ratio. This is the default. */
4260 #define WIMLIB_LZX_ALGORITHM_SLOW 1
4262 /** Algorithm to use to perform the compression: either
4263 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
4264 * format is still LZX; this refers to the method the code will use to
4265 * perform LZX-compatible compression. */
4266 uint32_t algorithm : 3;
4268 /** If set to 1, the default parameters for the specified algorithm are
4269 * used rather than the ones specified in the following union. */
4270 uint32_t use_defaults : 1;
4273 /** Parameters for the fast algorithm. */
4274 struct wimlib_lzx_fast_params {
4275 uint32_t fast_reserved1[10];
4278 /** Parameters for the "slow" algorithm. */
4279 struct wimlib_lzx_slow_params {
4280 /** If set to 1, the compressor can output length 2
4281 * matches. If set 0, the compressor can only output
4282 * matches of length 3 or greater. Suggested value: 1
4284 uint32_t use_len2_matches : 1;
4286 uint32_t slow_reserved1 : 31;
4288 /** Matches with length (in bytes) greater than or equal
4289 * to this value are immediately taken without spending
4290 * time on minimum-cost measurements. Suggested value:
4292 uint32_t nice_match_length;
4294 /** Number of passes to compute a match/literal sequence
4295 * for each LZX block. This is for an iterative
4296 * algorithm that attempts to minimize the cost of the
4297 * match/literal sequence by using a cost model provided
4298 * by the previous iteration. Must be at least 1.
4299 * Suggested value: 2. */
4300 uint32_t num_optim_passes;
4302 /** Reserved; set to 0. */
4303 uint32_t slow_reserved_blocksplit;
4305 /** Maximum depth to search for matches at each
4306 * position. Suggested value: 50. */
4307 uint32_t max_search_depth;
4309 /* Note: max_matches_per_pos has been removed and no
4310 * longer has any effect. */
4312 uint32_t slow_reserved2[3];
4314 /** Assumed cost of a main symbol with zero frequency.
4315 * Must be at least 1 and no more than 16. Suggested
4317 uint8_t main_nostat_cost;
4319 /** Assumed cost of a length symbol with zero frequency.
4320 * Must be at least 1 and no more than 16. Suggested
4322 uint8_t len_nostat_cost;
4324 /** Assumed cost of an aligned symbol with zero
4325 * frequency. Must be at least 1 and no more than 8.
4326 * Suggested value: 7. */
4327 uint8_t aligned_nostat_cost;
4329 uint8_t slow_reserved3[5];
4334 /** LZMS compression parameters that can optionally be passed to
4335 * wimlib_create_compressor() with the compression type
4336 * ::WIMLIB_COMPRESSION_TYPE_LZMS. */
4337 struct wimlib_lzms_compressor_params {
4338 /** hdr.size Must be set to the size of this structure, in bytes. */
4339 struct wimlib_compressor_params_header hdr;
4341 /** Minimum match length to output. This must be at least 2. Suggested
4343 uint32_t min_match_length;
4345 /** Maximum match length to output. This must be at least @p
4346 * min_match_length. Suggested value: @p UINT32_MAX. */
4347 uint32_t max_match_length;
4349 /** Matches with length (in bytes) greater than or equal to this value
4350 * are immediately taken without spending time on minimum-cost
4351 * measurements. The minimum of @p max_match_length and @p
4352 * nice_match_length may not exceed 65536. Suggested value: 32. */
4353 uint32_t nice_match_length;
4355 /** Maximum depth to search for matches at each position. Suggested
4357 uint32_t max_search_depth;
4359 /* Note: max_matches_per_pos has been removed and no longer has any
4364 /** Length of the array for the near-optimal LZ parsing algorithm. This
4365 * must be at least 1. Suggested value: 1024. */
4366 uint32_t optim_array_length;
4368 uint64_t reserved2[4];
4371 /** Opaque compressor handle. */
4372 struct wimlib_compressor;
4374 /** Opaque decompressor handle. */
4375 struct wimlib_decompressor;
4378 * Set the default compression parameters for the specified compression type.
4379 * This will affect both explicit and library-internal calls to
4380 * wimlib_create_compressor().
4383 * Compression type for which to set the default compression parameters.
4385 * Compression-type specific parameters. This may be @c NULL, in which
4386 * case the "default default" parameters are restored.
4388 * @return 0 on success; nonzero on error.
4390 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4391 * @p ctype was not a supported compression type.
4392 * @retval ::WIMLIB_ERR_INVALID_PARAM
4393 * @p params were invalid.
4394 * @retval ::WIMLIB_ERR_NOMEM
4395 * Not enough memory to duplicate the parameters (perhaps @c params->size
4399 wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
4400 const struct wimlib_compressor_params_header *params);
4403 * Returns the approximate number of bytes needed to allocate a compressor with
4404 * wimlib_create_compressor() for the specified compression type, block size,
4405 * and parameters. @p params may be @c NULL, in which case the current default
4406 * parameters for @p ctype are used. Returns 0 if the compression type or
4407 * parameters are invalid.
4410 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4411 size_t max_block_size,
4412 const struct wimlib_compressor_params_header *params);
4415 * Allocate a compressor for the specified compression type using the specified
4416 * parameters. This function is part of wimlib's compression API; it is not
4417 * necessary to call this to process a WIM file.
4420 * Compression type for which to create the compressor.
4421 * @param max_block_size
4422 * Maximum block size to support. The exact meaning and allowed values for
4423 * this parameter depend on the compression type, but it at least specifies
4424 * the maximum allowed value for @p uncompressed_size to wimlib_compress().
4425 * @param extra_params
4426 * An optional pointer to extra compressor parameters for the specified
4427 * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params
4428 * may be specified here. For LZMS, a pointer to
4429 * ::wimlib_lzms_compressor_params may be specified here. If left @c NULL,
4430 * the default parameters are used.
4431 * @param compressor_ret
4432 * A location into which to return the pointer to the allocated compressor,
4433 * which can be used for any number of calls to wimlib_compress() before
4434 * being freed with wimlib_free_compressor().
4436 * @return 0 on success; nonzero on error.
4438 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4439 * @p ctype was not a supported compression type.
4440 * @retval ::WIMLIB_ERR_INVALID_PARAM
4441 * The compression parameters were invalid.
4442 * @retval ::WIMLIB_ERR_NOMEM
4443 * Insufficient memory to allocate the compressor.
4446 wimlib_create_compressor(enum wimlib_compression_type ctype,
4447 size_t max_block_size,
4448 const struct wimlib_compressor_params_header *extra_params,
4449 struct wimlib_compressor **compressor_ret);
4452 * Losslessly compress a block of data using a compressor previously created
4453 * with wimlib_create_compressor().
4455 * @param uncompressed_data
4456 * Buffer containing the data to compress.
4457 * @param uncompressed_size
4458 * Size, in bytes, of the data to compress.
4459 * @param compressed_data
4460 * Buffer into which to write the compressed data.
4461 * @param compressed_size_avail
4462 * Number of bytes available in @p compressed_data.
4464 * A compressor previously allocated with wimlib_create_compressor().
4467 * The size of the compressed data, in bytes, or 0 if the input data could
4468 * not be compressed to @p compressed_size_avail or fewer bytes.
4471 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4472 void *compressed_data, size_t compressed_size_avail,
4473 struct wimlib_compressor *compressor);
4476 * Free a compressor previously allocated with wimlib_create_compressor().
4479 * The compressor to free.
4482 wimlib_free_compressor(struct wimlib_compressor *compressor);
4485 * Set the default decompression parameters for the specified compression type.
4486 * This will affect both explicit and library-internal calls to
4487 * wimlib_create_decompressor().
4490 * Compression type for which to set the default decompression parameters.
4492 * Compression-type specific parameters. This may be @c NULL, in which
4493 * case the "default default" parameters are restored.
4495 * @return 0 on success; nonzero on error.
4497 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4498 * @p ctype was not a supported compression type.
4499 * @retval ::WIMLIB_ERR_NOMEM
4500 * Not enough memory to duplicate the parameters (perhaps @c params->size
4504 wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
4505 const struct wimlib_decompressor_params_header *params);
4508 * Allocate a decompressor for the specified compression type using the
4509 * specified parameters. This function is part of wimlib's compression API; it
4510 * is not necessary to call this to process a WIM file.
4513 * Compression type for which to create the decompressor.
4514 * @param max_block_size
4515 * Maximum block size to support. The exact meaning and allowed values for
4516 * this parameter depend on the compression type, but it at least specifies
4517 * the maximum allowed value for @p uncompressed_size to
4518 * wimlib_decompress().
4519 * @param extra_params
4520 * An optional pointer to extra decompressor parameters for the specified
4521 * compression type. If @c NULL, the default parameters are used.
4522 * @param decompressor_ret
4523 * A location into which to return the pointer to the allocated
4524 * decompressor, which can be used for any number of calls to
4525 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4527 * @return 0 on success; nonzero on error.
4529 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4530 * @p ctype was not a supported compression type.
4531 * @retval ::WIMLIB_ERR_INVALID_PARAM
4532 * The decompression parameters were invalid.
4533 * @retval ::WIMLIB_ERR_NOMEM
4534 * Insufficient memory to allocate the decompressor.
4537 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4538 size_t max_block_size,
4539 const struct wimlib_decompressor_params_header *extra_params,
4540 struct wimlib_decompressor **decompressor_ret);
4543 * Decompress a block of data using a decompressor previously created with
4544 * wimlib_create_decompressor().
4546 * @param compressed_data
4547 * Buffer containing the data to decompress.
4548 * @param compressed_size
4549 * Size, in bytes, of the data to decompress.
4550 * @param uncompressed_data
4551 * Buffer into which to write the uncompressed data.
4552 * @param uncompressed_size
4553 * Size, in bytes, of the data when uncompressed.
4554 * @param decompressor
4555 * A decompressor previously allocated with wimlib_create_decompressor().
4557 * @return 0 on success; nonzero on error.
4560 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4561 void *uncompressed_data, size_t uncompressed_size,
4562 struct wimlib_decompressor *decompressor);
4565 * Free a decompressor previously allocated with wimlib_create_decompressor().
4567 * @param decompressor
4568 * The decompressor to free.
4571 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4583 #endif /* _WIMLIB_H */