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^16</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 /** This message may be sent periodically (not for every file) while
508 * files or directories are being created, prior to data stream
509 * extraction. @p info will point to ::wimlib_progress_info.extract.
511 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
513 /** File data is currently being extracted. @p info will point to
514 * ::wimlib_progress_info.extract. This is the main message to track
515 * the progress of an extraction operation. */
516 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
518 /** Starting to read a new part of a split pipable WIM over the pipe.
519 * @p info will point to ::wimlib_progress_info.extract. */
520 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
522 /** This message may be sent periodically (not for every file) while
523 * file and directory metadata is being applied, following data stream
524 * extraction. @p info will point to ::wimlib_progress_info.extract.
526 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
528 /** Confirms that the image has been successfully extracted. @p info
529 * will point to ::wimlib_progress_info.extract. This is paired with
530 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
531 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
533 /** Confirms that the files or directory trees have been successfully
534 * extracted. @p info will point to ::wimlib_progress_info.extract.
535 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
536 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
538 /** The directory or NTFS volume is about to be scanned for metadata.
539 * @p info will point to ::wimlib_progress_info.scan. This message is
540 * received once per call to wimlib_add_image(), or once per capture
541 * source passed to wimlib_add_image_multisource(), or once per add
542 * command passed to wimlib_update_image(). */
543 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
545 /** A directory or file has been scanned. @p info will point to
546 * ::wimlib_progress_info.scan, and its @p cur_path member will be
547 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
549 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
551 /** Confirms that the directory or NTFS volume has been successfully
552 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
553 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
554 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
556 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
558 /** File resources ("streams") are currently being written to the WIM.
559 * @p info will point to ::wimlib_progress_info.write_streams. This
560 * message may be received many times while the WIM file is being
561 * written or appended to with wimlib_write(), wimlib_overwrite(), or
562 * wimlib_write_to_fd(). */
563 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
565 /** Per-image metadata is about to be written to the WIM file. @p info
566 * will not be valid. */
567 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
569 /** Confirms that per-image metadata has been successfully been written
570 * to the WIM file. @p info will not be valid. This message is paired
571 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
573 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
575 /** wimlib_overwrite() has successfully renamed the temporary file to
576 * the original WIM file, thereby committing the update. @p info will
577 * point to ::wimlib_progress_info.rename. Note: this message is not
578 * received if wimlib_overwrite() chose to append to the WIM file
580 WIMLIB_PROGRESS_MSG_RENAME = 15,
582 /** The contents of the WIM file are being checked against the integrity
583 * table. @p info will point to ::wimlib_progress_info.integrity. This
584 * message is only received (and may be received many times) when
585 * wimlib_open_wim_with_progress() is called with the
586 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
587 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
589 /** An integrity table is being calculated for the WIM being written.
590 * @p info will point to ::wimlib_progress_info.integrity. This message
591 * is only received (and may be received many times) when a WIM file is
592 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
593 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
595 /** A wimlib_split() operation is in progress, and a new split part is
596 * about to be started. @p info will point to
597 * ::wimlib_progress_info.split. */
598 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
600 /** A wimlib_split() operation is in progress, and a split part has been
601 * finished. @p info will point to ::wimlib_progress_info.split. */
602 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
604 /** A WIM update command is just about to be executed. @p info will
605 * point to ::wimlib_progress_info.update. This message is received
606 * once per update command when wimlib_update_image() is called with the
607 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
608 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
610 /** A WIM update command has just been executed. @p info will point to
611 * ::wimlib_progress_info.update. This message is received once per
612 * update command when wimlib_update_image() is called with the flag
613 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
614 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
616 /** A file in the WIM image is being replaced as a result of a
617 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
618 * @p info will point to ::wimlib_progress_info.replace. This is only
619 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
621 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
623 /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
624 * a file is being extracted normally (not as a WIMBoot "pointer file")
625 * due to it matching a pattern in the [PrepopulateList] section of the
626 * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
627 * WIM image. @p info will point to
628 * ::wimlib_progress_info.wimboot_exclude.
630 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
632 /** Starting to unmount a WIM image. @p info will point to
633 * ::wimlib_progress_info.unmount. */
634 WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
636 /** wimlib has used a file's data for the last time (including all data
637 * streams, if it has multiple). @p info will point to
638 * ::wimlib_progress_info.done_with_file. This message is only received
639 * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided. */
640 WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
642 /** wimlib_verify_wim() is starting to verify the metadata for an image.
643 * @p info will point to ::wimlib_progress_info.verify_image. */
644 WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
646 /** wimlib_verify_wim() has finished verifying the metadata for an
647 * image. @p info will point to ::wimlib_progress_info.verify_image.
649 WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
651 /** wimlib_verify_wim() is verifying stream integrity. @p info will
652 * point to ::wimlib_progress_info.verify_streams. */
653 WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
656 /** Valid return values from user-provided progress functions
657 * (::wimlib_progress_func_t).
659 * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
662 enum wimlib_progress_status {
664 /** The operation should be continued. This is the normal return value.
666 WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
668 /** The operation should be aborted. This will cause the current
669 * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS. */
670 WIMLIB_PROGRESS_STATUS_ABORT = 1,
674 * A pointer to this union is passed to the user-supplied
675 * ::wimlib_progress_func_t progress function. One (or none) of the structures
676 * contained in this union will be applicable for the operation
677 * (::wimlib_progress_msg) indicated in the first argument to the progress
679 union wimlib_progress_info {
681 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
682 * document them if they aren't given a name... */
684 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
685 * the primary message for tracking the progress of writing a WIM file.
687 struct wimlib_progress_info_write_streams {
688 /** Total number of uncompressed bytes of stream data being
689 * written. This can be thought of as the total uncompressed
690 * size of the files being archived, with some caveats. WIM
691 * files use single-instance streams, so the size provided here
692 * only counts distinct streams, except for the following
693 * exception: the size provided here may include the sizes of
694 * all newly added (e.g. with wimlib_add_image() streams,
695 * pending automatic de-duplication during the write operation
696 * itself. When each such stream de-duplication occurs, this
697 * number will be decreased by the size of the duplicate stream
698 * that need not be written.
700 * In the case of a wimlib_overwrite() that the library opted to
701 * perform in-place, both @p total_streams and @p total_bytes
702 * will only count the streams actually being written and not
703 * pre-existing streams in the WIM file. */
704 uint64_t total_bytes;
706 /** Total number of streams being written. This can be thought
707 * of as the total number of files being archived, with some
708 * caveats. In general, a single file or directory may contain
709 * multiple data streams, each of which will be represented
710 * separately in this number. Furthermore, WIM files use
711 * single-instance streams, so the stream count provided here
712 * only counts distinct streams, except for the following
713 * exception: the stream count provided here may include newly
714 * added (e.g. with wimlib_add_image() streams, pending
715 * automatic de-duplication during the write operation itself.
716 * When each such stream de-duplication occurs, this number will
717 * be decreased by 1 to account for the duplicate stream that
718 * need not be written. */
719 uint64_t total_streams;
721 /** Number of uncompressed bytes of stream data that have been
722 * written so far. This number be 0 initially, and will be
723 * equal to @p total_bytes at the end of the write operation.
724 * Note that @p total_bytes (but not @p completed_bytes) may
725 * decrease throughout the write operation due to the discovery
726 * of stream duplications. */
727 uint64_t completed_bytes;
729 /** Number of streams that have been written so far. This
730 * number will be 0 initially, and will be equal to @p
731 * total_streams at the end of the write operation. Note that
732 * @p total_streams (but not @p completed_streams) may decrease
733 * throughout the write operation due to the discovery of stream
736 * For applications that wish to calculate a simple "percent
737 * complete" for the write operation, it will likely be more
738 * accurate to calculate the percentage from @p completed_bytes
739 * and @p total_bytes rather than @p completed_streams and
740 * @p total_streams because the time for the operation to
741 * complete is mainly determined by the number of bytes that
742 * need to be read, compressed, and written, not just the number
743 * of files being archived. */
744 uint64_t completed_streams;
746 /** Number of threads that are being used to compress streams,
747 * or 1 if streams are being written uncompressed. */
748 uint32_t num_threads;
750 /** The compression type being used to write the streams, as one
751 * of the ::wimlib_compression_type constants. */
752 int32_t compression_type;
754 /** Number of split WIM parts from which streams are being
755 * written (may be 0 if irrelevant). */
756 uint32_t total_parts;
758 /** This is currently broken and will always be 0. */
759 uint32_t completed_parts;
762 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
763 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
764 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
765 struct wimlib_progress_info_scan {
766 /** Top-level directory being scanned; or, when capturing an NTFS
767 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
768 * to the file or block device that contains the NTFS volume
770 const wimlib_tchar *source;
772 /** Path to the file (or directory) that has been scanned, valid
773 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
774 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
775 * relative to the root of the NTFS volume. */
776 const wimlib_tchar *cur_path;
778 /** Dentry scan status, valid on
779 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
781 /** The file looks okay and will be captured. */
782 WIMLIB_SCAN_DENTRY_OK = 0,
784 /** File is being excluded from capture due to the
785 * capture configuration. */
786 WIMLIB_SCAN_DENTRY_EXCLUDED,
788 /** File is being excluded from capture due to being
789 * unsupported (e.g. an encrypted or device file). */
790 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
792 /** The file is an absolute symbolic link or junction
793 * that points into the capture directory, and
794 * reparse-point fixups are enabled, so its target is
795 * being adjusted. (Reparse point fixups can be
796 * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
798 WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
800 /** Reparse-point fixups are enabled, but the file is an
801 * absolute symbolic link or junction that does
802 * <b>not</b> point into the capture directory, so its
803 * target is <b>not</b> being adjusted. */
804 WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
808 /** Target path in the WIM image. Only valid on
809 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
810 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
811 const wimlib_tchar *wim_target_path;
813 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
814 * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
815 * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
816 * target of the absolute symbolic link or junction. */
817 const wimlib_tchar *symlink_target;
820 /** Number of directories scanned so far, including the root
821 * directory but excluding any unsupported/excluded directories.
823 * Details: On Windows and in NTFS capture mode, a reparse point
824 * counts as a directory if and only if it has
825 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
826 * counts as a directory if and only if when fully dereferenced
827 * it points to an accessible directory. If a file has multiple
828 * names (hard links), it is only counted one time. */
829 uint64_t num_dirs_scanned;
831 /** Number of non-directories scanned so far, excluding any
832 * unsupported/excluded files.
834 * Details: On Windows and in NTFS capture mode, a reparse point
835 * counts as a non-directory if and only if it does not have
836 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
837 * counts as a non-directory if and only if when fully
838 * dereferenced it points to a non-directory or its target is
839 * inaccessible. If a file has multiple names (hard links), it
840 * is only counted one time. */
841 uint64_t num_nondirs_scanned;
843 /** Number of bytes of file data that have been detected so far.
845 * Details: This data may not actually have been read yet, and
846 * it will not actually be written to the WIM file until
847 * wimlib_write() or wimlib_overwrite() has been called. Data
848 * from excluded files is not counted. This number includes
849 * default file contents as well as named data streams and
850 * reparse point data. The size of reparse point data is
851 * tallied after any reparse-point fixups, and in the case of
852 * capturing a symbolic link on a UNIX-like system, the creation
853 * of the reparse point data itself. If a file has multiple
854 * names (hard links), its size(s) are only counted one time.
855 * On Windows, encrypted files have their encrypted size
856 * counted, not their unencrypted size; however, compressed
857 * files have their uncompressed size counted. */
858 uint64_t num_bytes_scanned;
861 /** Valid on messages
862 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
863 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
864 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
865 * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
866 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
867 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
868 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
869 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
871 * Note: most of the time of an extraction operation will be spent
872 * extracting streams, and the application will receive
873 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
874 * completed_bytes and @p total_bytes, the application can calculate a
875 * percentage complete. However, note that this message does not, in
876 * general, actually provide information about which "file" is currently
877 * being extracted. This is because wimlib, by default, extracts the
878 * individual data streams in whichever order it determines to be the
881 struct wimlib_progress_info_extract {
882 /** Number of the image from which files are being extracted
886 /** Extraction flags being used. */
887 uint32_t extract_flags;
889 /** Full path to the WIM file from which files are being
890 * extracted, or @c NULL if the WIMStruct has no associated
892 const wimlib_tchar *wimfile_name;
894 /** Name of the image from which files are being extracted, or
895 * the empty string if the image is unnamed. */
896 const wimlib_tchar *image_name;
898 /** Path to the directory or NTFS volume to which the files are
899 * being extracted. */
900 const wimlib_tchar *target;
903 const wimlib_tchar *reserved;
905 /** Number of bytes of uncompressed data that will be extracted.
906 * If a file has multiple names (hard links), its size (or
907 * sizes, in the case of named data streams) is only counted one
908 * time. For "reparse points" and symbolic links, the size to
909 * be extracted is the size of the reparse data buffer.
911 * This number will stay constant throughout the extraction. */
912 uint64_t total_bytes;
914 /** Number of bytes of uncompressed data that have been
915 * extracted so far. This initially be 0 and will equal to @p
916 * total_bytes at the end of the extraction. */
917 uint64_t completed_bytes;
919 /** Number of (not necessarily unique) streams that will be
920 * extracted. This may be more or less than the number of
921 * "files" to be extracted due to hard links as well as
922 * potentially multiple streams per file (named data streams).
923 * A "stream" may be the default contents of a file, a named
924 * data stream, or a reparse data buffer. */
925 uint64_t total_streams;
927 /** Number of (not necessarily unique) streams that have been
928 * extracted so far. */
929 uint64_t completed_streams;
931 /** Currently only used for
932 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
933 uint32_t part_number;
935 /** Currently only used for
936 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
937 uint32_t total_parts;
939 /** Currently only used for
940 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
941 uint8_t guid[WIMLIB_GUID_LEN];
944 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
945 struct wimlib_progress_info_rename {
946 /** Name of the temporary file that the WIM was written to. */
947 const wimlib_tchar *from;
949 /** Name of the original WIM file to which the temporary file is
951 const wimlib_tchar *to;
954 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
955 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
956 struct wimlib_progress_info_update {
957 /** Pointer to the update command that will be executed or has
958 * just been executed. */
959 const struct wimlib_update_command *command;
961 /** Number of update commands that have been completed so far.
963 size_t completed_commands;
965 /** Number of update commands that are being executed as part of
966 * this call to wimlib_update_image(). */
967 size_t total_commands;
970 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
971 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
972 struct wimlib_progress_info_integrity {
973 /** Number of bytes from the end of the WIM header to the end of
974 * the lookup table (the area that is covered by the SHA1
975 * integrity checks.) */
976 uint64_t total_bytes;
978 /** Number of bytes that have been SHA1-summed so far. Will be
979 * 0 initially, and equal @p total_bytes at the end. */
980 uint64_t completed_bytes;
982 /** Number of chunks that the checksummed region is divided
984 uint32_t total_chunks;
986 /** Number of chunks that have been SHA1-summed so far. Will
987 * be 0 initially, and equal to @p total_chunks at the end. */
988 uint32_t completed_chunks;
990 /** Size of the chunks used for the integrity calculation. */
993 /** Filename of the WIM (only valid if the message is
994 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
995 const wimlib_tchar *filename;
998 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
999 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1000 struct wimlib_progress_info_split {
1001 /** Total size of the original WIM's file and metadata resources
1003 uint64_t total_bytes;
1005 /** Number of bytes of file and metadata resources that have
1006 * been copied out of the original WIM so far. Will be 0
1007 * initially, and equal to @p total_bytes at the end. */
1008 uint64_t completed_bytes;
1010 /** Number of the split WIM part that is about to be started
1011 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1012 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1013 unsigned cur_part_number;
1015 /** Total number of split WIM parts that are being written. */
1016 unsigned total_parts;
1018 /** Name of the split WIM part that is about to be started
1019 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1020 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1021 * As of wimlib v1.7.0, the library user may change this when
1022 * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1023 * cause the next split WIM part to be written to a different
1025 wimlib_tchar *part_name;
1028 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
1029 struct wimlib_progress_info_replace {
1030 /** Path to the file in the WIM image that is being replaced */
1031 const wimlib_tchar *path_in_wim;
1034 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
1035 struct wimlib_progress_info_wimboot_exclude {
1036 /** Path to the file in the WIM image */
1037 const wimlib_tchar *path_in_wim;
1039 /** Path to which the file is being extracted */
1040 const wimlib_tchar *extraction_path;
1043 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN. */
1044 struct wimlib_progress_info_unmount {
1045 /** Path to directory being unmounted */
1046 const wimlib_tchar *mountpoint;
1048 /** Path to WIM file being unmounted */
1049 const wimlib_tchar *mounted_wim;
1051 /** 1-based index of image being unmounted. */
1052 uint32_t mounted_image;
1054 /** Flags that were passed to wimlib_mount_image() when the
1055 * mountpoint was set up. */
1056 uint32_t mount_flags;
1058 /** Flags passed to wimlib_unmount_image(). */
1059 uint32_t unmount_flags;
1062 /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE. */
1063 struct wimlib_progress_info_done_with_file {
1064 /* Path to the file whose data has been written to the WIM file,
1065 * or is currently being asynchronously compressed in memory,
1066 * and therefore is no longer needed by wimlib.
1068 * WARNING: The file data will not actually be accessible in the
1069 * WIM file until the WIM file has been completely written.
1070 * Ordinarily you should <b>not</b> treat this message as a
1071 * green light to go ahead and delete the specified file, since
1072 * that would result in data loss if the WIM file cannot be
1073 * successfully created for any reason.
1075 * If a file has multiple names (hard links),
1076 * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1077 * for one name. Also, this message will not be received for
1078 * empty files or reparse points (or symbolic links), unless
1079 * they have nonempty named data streams.
1081 const wimlib_tchar *path_to_file;
1084 /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1085 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE. */
1086 struct wimlib_progress_info_verify_image {
1087 const wimlib_tchar *wimfile;
1088 uint32_t total_images;
1089 uint32_t current_image;
1092 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS. */
1093 struct wimlib_progress_info_verify_streams {
1094 const wimlib_tchar *wimfile;
1095 uint64_t total_streams;
1096 uint64_t total_bytes;
1097 uint64_t completed_streams;
1098 uint64_t completed_bytes;
1103 * A user-supplied function that will be called periodically during certain WIM
1106 * The first argument will be the type of operation that is being performed or
1107 * is about to be started or has been completed.
1109 * The second argument will be a pointer to one of a number of structures
1110 * depending on the first argument. It may be @c NULL for some message types.
1111 * Note that although this argument is not @c const, users should not modify it
1112 * except in explicitly documented cases.
1114 * The third argument will be a user-supplied value that was provided when
1115 * registering or specifying the progress function.
1117 * This function must return one of the ::wimlib_progress_status values. By
1118 * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1120 typedef enum wimlib_progress_status
1121 (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1122 union wimlib_progress_info *info,
1126 /** @addtogroup G_modifying_wims
1129 /** An array of these structures is passed to wimlib_add_image_multisource() to
1130 * specify the sources from which to create a WIM image. */
1131 struct wimlib_capture_source {
1132 /** Absolute or relative path to a file or directory on the external
1133 * filesystem to be included in the WIM image. */
1134 wimlib_tchar *fs_source_path;
1136 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1137 * specify the root directory of the WIM image. */
1138 wimlib_tchar *wim_target_path;
1140 /** Reserved; set to 0. */
1144 /** Set or unset the WIM header flag that marks it read-only
1145 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
1146 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
1147 * is distinct from basic file permissions; this flag can be set on a WIM file
1148 * that is physically writable. If this flag is set, all further operations to
1149 * modify the WIM will fail, except calling wimlib_overwrite() with
1150 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
1151 * allows you to set this flag persistently on the underlying WIM file.
1153 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
1155 /** Set the GUID (globally unique identifier) of the WIM file to the value
1156 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1157 #define WIMLIB_CHANGE_GUID 0x00000002
1159 /** Change the bootable image of the WIM to the value specified in
1160 * ::wimlib_wim_info.boot_index of the @p info parameter. */
1161 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
1163 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1164 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
1165 * indicates whether an image in the WIM has been captured with reparse-point
1166 * fixups enabled. wimlib also treats this flag as specifying whether to do
1167 * reparse-point fixups by default when capturing or applying WIM images. */
1168 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
1172 /** @addtogroup G_wim_information
1177 /** General information about a WIM file. */
1178 struct wimlib_wim_info {
1180 /** Globally unique identifier for the WIM file. Note: all parts of a
1181 * split WIM should have an identical value in this field. */
1182 uint8_t guid[WIMLIB_GUID_LEN];
1184 /** Number of images in the WIM. */
1185 uint32_t image_count;
1187 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1189 uint32_t boot_index;
1191 /** Version of the WIM file. */
1192 uint32_t wim_version;
1194 /** Chunk size used for compression. */
1195 uint32_t chunk_size;
1197 /** For split WIMs, the 1-based index of this part within the split WIM;
1199 uint16_t part_number;
1201 /** For split WIMs, the total number of parts in the split WIM;
1203 uint16_t total_parts;
1205 /** One of the ::wimlib_compression_type values that specifies the
1206 * method used to compress resources in the WIM. */
1207 int32_t compression_type;
1209 /** Size of the WIM file in bytes, excluding the XML data and integrity
1211 uint64_t total_bytes;
1213 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1214 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1215 * this will always be 0, even if the ::WIMStruct was written to
1216 * somewhere by calling wimlib_write() with the
1217 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1218 uint32_t has_integrity_table : 1;
1220 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1221 * wimlib_create_new_wim(). */
1222 uint32_t opened_from_file : 1;
1224 /** 1 if the WIM is considered readonly for any reason. */
1225 uint32_t is_readonly : 1;
1227 /** 1 if reparse-point fixups are supposedly enabled for one or more
1228 * images in the WIM. */
1229 uint32_t has_rpfix : 1;
1231 /** 1 if the WIM is marked as read-only. */
1232 uint32_t is_marked_readonly : 1;
1234 /** 1 if the WIM is part of a spanned set. */
1235 uint32_t spanned : 1;
1237 uint32_t write_in_progress : 1;
1238 uint32_t metadata_only : 1;
1239 uint32_t resource_only : 1;
1241 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1242 uint32_t pipable : 1;
1243 uint32_t reserved_flags : 22;
1244 uint32_t reserved[9];
1247 /** Information about a unique stream in the WIM file. (A stream is the same
1248 * thing as a "resource", except in the case of packed resources.) */
1249 struct wimlib_resource_entry {
1250 /** Uncompressed size of the stream in bytes. */
1251 uint64_t uncompressed_size;
1253 /** Compressed size of the stream in bytes. This will be the same as @p
1254 * uncompressed_size if the stream is uncompressed. Or, if @p
1255 * is_packed_streams is 1, this will be 0. */
1256 uint64_t compressed_size;
1258 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1259 * if @p packed is 1, then this is actually the offset at which this
1260 * stream begins in the uncompressed contents of the packed resource.
1264 /** SHA1 message digest of the stream's uncompressed contents. */
1265 uint8_t sha1_hash[20];
1267 /** Which part number of the split WIM this stream is in. This should
1268 * be the same as the part number provided by wimlib_get_wim_info(). */
1269 uint32_t part_number;
1271 /** Number of times this stream is referenced over all WIM images. */
1272 uint32_t reference_count;
1274 /** 1 if this stream is compressed. */
1275 uint32_t is_compressed : 1;
1277 /** 1 if this stream is a metadata resource rather than a file resource.
1279 uint32_t is_metadata : 1;
1281 uint32_t is_free : 1;
1282 uint32_t is_spanned : 1;
1284 /** 1 if this stream was not found in the lookup table of the
1285 * ::WIMStruct. This normally implies a missing call to
1286 * wimlib_reference_resource_files() or wimlib_reference_resources().
1288 uint32_t is_missing : 1;
1290 /** 1 if this stream is located in a packed resource which may contain
1291 * other streams (all compressed together) as well. */
1292 uint32_t packed : 1;
1294 uint32_t reserved_flags : 26;
1296 /** If @p packed is 1, then this will specify the offset of the packed
1297 * resource in the WIM. */
1298 uint64_t raw_resource_offset_in_wim;
1300 /** If @p is_packed_streams is 1, then this will specify the compressed
1301 * size of the packed resource in the WIM. */
1302 uint64_t raw_resource_compressed_size;
1304 uint64_t reserved[2];
1307 /** Information about a stream of a particular file in the WIM. */
1308 struct wimlib_stream_entry {
1309 /** Name of the stream, or NULL if the stream is unnamed. */
1310 const wimlib_tchar *stream_name;
1311 /** Location, size, etc. of the stream within the WIM file. */
1312 struct wimlib_resource_entry resource;
1313 uint64_t reserved[4];
1316 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1317 * Roughly, the information about a "file" in the WIM--- but really a directory
1318 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1319 * field can be used to distinguish actual file inodes. */
1320 struct wimlib_dir_entry {
1321 /** Name of the file, or NULL if this file is unnamed (only possible for
1322 * the root directory) */
1323 const wimlib_tchar *filename;
1325 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1327 const wimlib_tchar *dos_name;
1329 /** Full path to this file within the WIM image. */
1330 const wimlib_tchar *full_path;
1332 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1333 * children, ..., etc. */
1336 /** Pointer to the security descriptor for this file, in Windows
1337 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1338 * security descriptor. */
1339 const char *security_descriptor;
1341 /** Length of the above security descriptor. */
1342 size_t security_descriptor_size;
1344 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1345 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1346 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1347 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1348 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1349 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1350 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1351 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1352 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1353 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1354 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1355 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1356 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1357 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1358 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1359 /** File attributes, such as whether the file is a directory or not.
1360 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1361 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1362 * on other platforms. */
1363 uint32_t attributes;
1365 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1366 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1367 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1368 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1369 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1370 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1371 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1372 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1373 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1374 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1375 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1376 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1377 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1378 * attributes), this will give the reparse tag. This tells you whether
1379 * the reparse point is a symbolic link, junction point, or some other,
1380 * more unusual kind of reparse point. */
1381 uint32_t reparse_tag;
1383 /* Number of (hard) links to this file. */
1386 /** Number of named data streams that this file has. Normally 0. */
1387 uint32_t num_named_streams;
1389 /** Roughly, the inode number of this file. However, it may be 0 if
1390 * @p num_links == 1. */
1391 uint64_t hard_link_group_id;
1393 /** Time this file was created. */
1394 struct timespec creation_time;
1396 /** Time this file was last written to. */
1397 struct timespec last_write_time;
1399 /** Time this file was last accessed. */
1400 struct timespec last_access_time;
1402 /* UNIX data (wimlib extension), only valid if unix_mode != 0 */
1408 uint64_t reserved[14];
1410 /** Array of streams that make up this file. The first entry will
1411 * always exist and will correspond to the unnamed data stream (default
1412 * file contents), so it will have @p stream_name == @c NULL. There
1413 * will then be @p num_named_streams additional entries that specify the
1414 * named data streams, if any, each of which will have @p stream_name !=
1416 struct wimlib_stream_entry streams[];
1420 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1423 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1427 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1430 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1433 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1434 * just on the specified path. */
1435 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1437 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1438 * itself; only its children (in the case of a non-empty directory) */
1439 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1441 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1442 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1443 * table of the ::WIMStruct. The default behavior without this flag is to fill
1444 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1445 * wimlib_resource_entry::is_missing "is_missing" flag. */
1446 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1450 /** @addtogroup G_modifying_wims
1453 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1454 * generic directory. This requires that wimlib was compiled with support for
1457 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1458 * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1460 * Do not use this flag on Windows, where wimlib already supports all
1461 * Windows-native filesystems, including NTFS, through the Windows APIs. */
1462 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1464 /** Follow symbolic links when scanning the directory tree. Currently only
1465 * supported on UNIX-like systems. */
1466 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1468 /** Call the progress function with the message
1469 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1471 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1473 /** Mark the image being added as the bootable image of the WIM. This flag is
1474 * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1476 * Note that you can also change the bootable image of a WIM using
1477 * wimlib_set_wim_info().
1479 * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1480 * from, ::WIMLIB_ADD_FLAG_WIMBOOT. */
1481 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1483 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1484 * (major and minor number) of each file. Also allows capturing special files
1485 * such as device nodes and FIFOs. See the documentation for the
1486 * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1488 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1490 /** Do not capture security descriptors. Only has an effect in NTFS capture
1491 * mode, or in Windows native builds. */
1492 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1494 /** Fail immediately if the full security descriptor of any file or directory
1495 * cannot be accessed. Only has an effect in Windows native builds. The
1496 * default behavior without this flag is to first try omitting the SACL from the
1497 * security descriptor, then to try omitting the security descriptor entirely.
1499 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1501 /** Call the progress function with the message
1502 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1503 * capture. This is a subset of the messages provided by
1504 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1505 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1507 /** Reparse-point fixups: Modify absolute symbolic links (and junctions, in the
1508 * case of Windows) that point inside the directory being captured to instead be
1509 * absolute relative to the directory being captured.
1511 * Without this flag, the default is to do reparse-point fixups if
1512 * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image
1513 * being added. WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is
1514 * captured with reparse point fixups enabled and currently cannot be unset. */
1515 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1517 /** Don't do reparse point fixups. See ::WIMLIB_ADD_FLAG_RPFIX. */
1518 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1520 /** Do not automatically exclude unsupported files or directories from capture;
1521 * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1522 * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA. Instead,
1523 * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered. */
1524 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1527 * Automatically select a capture configuration appropriate for capturing
1528 * filesystems containing Windows operating systems. For example,
1529 * "/pagefile.sys" and "System Volume Information" will be excluded.
1531 * When this flag is specified, the corresponding @p config parameter (for
1532 * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1533 * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1535 * Note that the default behavior--- that is, when neither
1536 * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1537 * config is @c NULL--- is to use no capture configuration, meaning that no
1538 * files are excluded from capture.
1540 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1543 * Capture image as WIMBoot compatible. In addition, if no capture
1544 * configuration file is explicitly specified use the capture configuration file
1545 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1546 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1547 * configuration file is explicitly specified, use it and also place it at
1548 * /Windows/System32/WimBootCompress.ini in the WIM image.
1550 * Note: this will not by itself change the compression type. Before writing
1551 * the WIM file, it's recommended to also do:
1554 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1555 * wimlib_set_output_chunk_size(wim, 4096);
1558 * since that makes access to the data faster (at the cost of a worse
1559 * compression ratio compared to the 32768-byte LZX chunks usually used).
1561 * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1562 * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1564 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1567 * If the add command involves adding a non-directory file to a location at
1568 * which there already exists a nondirectory file in the WIM image, issue
1569 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1570 * effect when updating an existing image with wimlib_update_image().
1571 * This was the default behavior in wimlib v1.6.2 and earlier.
1573 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1575 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1576 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1577 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1578 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1579 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1580 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1581 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1582 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1583 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1584 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1585 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1586 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1587 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1588 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1592 /** @addtogroup G_modifying_wims
1595 /** Do not issue an error if the path to delete does not exist. */
1596 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1598 /** Delete the file or directory tree recursively; if not specified, an error is
1599 * issued if the path to delete is a directory. */
1600 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1603 /** @addtogroup G_modifying_wims
1607 * If a single image is being exported, mark it bootable in the destination WIM.
1608 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1609 * the image in the source WIM (if any) that is marked as bootable is also
1610 * marked as bootable in the destination WIM.
1612 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1614 /** Give the exported image(s) no names. Avoids problems with image name
1617 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1619 /** Give the exported image(s) no descriptions. */
1620 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1622 /** This advises the library that the program is finished with the source
1623 * WIMStruct and will not attempt to access it after the call to
1624 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1625 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1628 * Mark each exported image as WIMBoot-compatible.
1630 * Note: by itself, this does change the destination WIM's compression type, nor
1631 * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1632 * image. Before writing the destination WIM, it's recommended to do something
1636 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1637 * wimlib_set_output_chunk_size(wim, 4096);
1638 * wimlib_add_tree(wim, image, L"myconfig.ini",
1639 * L"\\Windows\\System32\\WimBootCompress.ini", 0);
1642 #define WIMLIB_EXPORT_FLAG_WIMBOOT 0x00000010
1645 /** @addtogroup G_extracting_wims
1648 /** Extract the image directly to an NTFS volume rather than a generic directory.
1649 * This mode is only available if wimlib was compiled with libntfs-3g support;
1650 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1651 * extraction target will be interpreted as the path to an NTFS volume image (as
1652 * a regular file or block device) rather than a directory. It will be opened
1653 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1654 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1655 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1656 * wimlib_extract_paths() when passed multiple paths. */
1657 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1659 /** UNIX-like systems only: Extract special UNIX data captured with
1660 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1661 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1662 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1664 /** Do not extract security descriptors. This flag cannot be combined with
1665 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1666 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1668 /** Fail immediately if the full security descriptor of any file or directory
1669 * cannot be set exactly as specified in the WIM file. On Windows, the default
1670 * behavior without this flag when wimlib does not have permission to set the
1671 * correct security descriptor is to fall back to setting the security
1672 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1673 * owner omitted, then not at all. This flag cannot be combined with
1674 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1675 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1677 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1678 * reparse-point fixups on, so absolute symbolic links or junction points will
1679 * be fixed to be absolute relative to the actual extraction root. Reparse-
1680 * point fixups are done by default for wimlib_extract_image() and
1681 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1682 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1683 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1685 /** Force reparse-point fixups on extraction off, regardless of the state of the
1686 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1687 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1688 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1690 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1691 * paths, each of which must name a regular file, to standard output. */
1692 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1694 /** Instead of ignoring files and directories with names that cannot be
1695 * represented on the current platform (note: Windows has more restrictions on
1696 * filenames than POSIX-compliant systems), try to replace characters or append
1697 * junk to the names so that they can be extracted in some form. */
1698 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1700 /** On Windows, when there exist two or more files with the same case
1701 * insensitive name but different case sensitive names, try to extract them all
1702 * by appending junk to the end of them, rather than arbitrarily extracting only
1704 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1706 /** Do not ignore failure to set timestamps on extracted files. */
1707 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1709 /** Do not ignore failure to set short names on extracted files. */
1710 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1712 /** On Windows, do not ignore failure to extract symbolic links and junctions
1713 * due to permissions problems. By default, such failures are ignored since the
1714 * default configuration of Windows only allows the Administrator to create
1715 * symbolic links. */
1716 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1718 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1719 * behavior is currently less than satisfactory. Do not use (yet). */
1720 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1722 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1723 * paths to extract as wildcard patterns ("globs") which may contain the
1724 * wildcard characters @c ? and @c *. The @c ? character matches any
1725 * non-path-separator character, whereas the @c * character matches zero or more
1726 * non-path-separator characters. Consequently, each glob may match zero or
1727 * more actual paths in the WIM image. By default, if a glob does not match any
1728 * files, a warning but not an error will be issued, even if the glob did not
1729 * actually contain wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1730 * to get an error instead. */
1731 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1733 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1734 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1735 * one of the provided globs did not match a file. */
1736 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1738 /** Do not extract Windows file attributes such as readonly, hidden, etc. */
1739 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1741 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1742 * preserve the directory structure of the archive when extracting --- that is,
1743 * place each extracted file or directory tree directly in the target directory.
1745 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1747 /** Windows only: Extract files as "pointers" back to the WIM archive. See the
1748 * documentation for the <b>--wimboot</b> option of <b>wimlib-imagex apply</b>
1749 * for more information. */
1750 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1753 /** @addtogroup G_mounting_wim_images
1756 /** Mount the WIM image read-write rather than the default of read-only. */
1757 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1759 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1760 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1762 /** Do not allow accessing named data streams in the mounted WIM image. */
1763 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1765 /** Access named data streams in the mounted WIM image through extended file
1766 * attributes named "user.X", where X is the name of a data stream. This is the
1768 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1770 /** Access named data streams in the mounted WIM image by specifying the file
1771 * name, a colon, then the name of the data stream. */
1772 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1774 /** Use UNIX metadata if available in the WIM image. See
1775 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1776 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1778 /** Allow other users to see the mounted filesystem. This passes the @c
1779 * allow_other option to the FUSE mount. */
1780 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1783 /** @addtogroup G_creating_and_opening_wims
1786 /** Verify the WIM contents against the WIM's integrity table, if present. This
1787 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1788 * checksummed and checked against the SHA1 message digests specified in the
1789 * integrity table. If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
1790 * issued. If the WIM file does not contain an integrity table, this flag has
1792 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1794 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
1795 * WIM. Software can provide this flag for convenience if it explicitly does
1796 * not want to support split WIMs. */
1797 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1799 /** Check if the WIM is writable and issue an error
1800 * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not. A WIM is considered writable
1801 * only if it is writable at the filesystem level, does not have the
1802 * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
1803 * set. It is not required to provide this flag before attempting to make
1804 * changes to the WIM, but with this flag you get an error sooner rather than
1806 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1809 /** @addtogroup G_mounting_wim_images
1812 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
1813 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1814 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1816 /** Commit changes to the read-write mounted WIM image.
1817 * If this flag is not specified, changes will be discarded. */
1818 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1820 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
1821 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1822 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1824 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
1825 * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified. */
1826 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1829 * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
1830 * image, forces all file descriptors to the open WIM image to be closed before
1833 * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
1834 * this flag has no effect.
1836 #define WIMLIB_UNMOUNT_FLAG_FORCE 0x00000010
1838 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1839 * WIM image, causes the modified image to be committed to the WIM file as a
1840 * new, unnamed image appended to the archive. The original image in the WIM
1841 * file will be unmodified. */
1842 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
1845 /** @addtogroup G_modifying_wims
1848 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1849 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1850 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1853 /** @addtogroup G_writing_and_overwriting_wims
1857 * Include an integrity table in the resulting WIM file.
1859 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1860 * include an integrity table if and only if one was present before. For
1861 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1862 * to not include an integrity table.
1864 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1867 * Do not include an integrity table in the resulting WIM file. This is the
1868 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
1871 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1874 * Write the WIM as "pipable". After writing a WIM with this flag specified,
1875 * images from it can be applied directly from a pipe using
1876 * wimlib_extract_image_from_pipe(). See the documentation for the
1877 * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
1878 * Beware: WIMs written with this flag will not be compatible with Microsoft's
1881 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1882 * write the WIM as pipable if and only if it was pipable before. For
1883 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1884 * to write the WIM as non-pipable.
1886 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1889 * Do not write the WIM as "pipable". This is the default behavior, unless the
1890 * ::WIMStruct was created by opening a pipable WIM.
1892 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1895 * When writing streams to the WIM file, recompress them, even if their data is
1896 * already available in the desired compressed form (for example, in a WIM file
1897 * from which an image has been exported using wimlib_export_image()).
1899 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
1900 * compression ratio for the same compression type and chunk size. wimlib's LZX
1901 * compressor currently can be given different parameters in order to achieve
1902 * different balances between compression ratio and time. In its default mode
1903 * as of v1.7.0, it usually compresses slightly better than the competing
1904 * Microsoft implementation and is almost as fast.
1906 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can also be used in combination with
1907 * ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any solid blocks from being
1908 * re-used. (Otherwise, solid blocks are re-used somewhat more liberally than
1909 * normal compressed blocks.)
1911 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
1912 * that would not otherwise be written. For example, a call to
1913 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
1914 * cause already-existing streams in the WIM file to be recompressed. To force
1915 * the WIM file to be fully rebuilt and recompressed, combine
1916 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
1918 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1921 * Immediately before closing the WIM file, sync its data to disk.
1923 * wimlib_overwrite() will set this flag automatically if it decides to
1924 * overwrite the WIM file via a temporary file instead of in-place.
1926 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1929 * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
1930 * could be updated merely by appending to it.
1932 * When rebuilding the WIM file, stream reference counts will be recomputed, and
1933 * any streams with 0 reference count (e.g. from deleted files or images) will
1934 * not be included in the resulting WIM file.
1936 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
1937 * data to be recompressed. Otherwise, compressed data is re-used if possible.
1939 * wimlib_write() ignores this flag.
1941 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1944 * For wimlib_overwrite(), override the default behavior after one or more calls
1945 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
1946 * flag, only minimal changes to correctly remove the image from the WIM file
1947 * will be taken. In particular, all streams will be retained, even if they are
1948 * no longer referenced. This may not be what you want, because no space will
1949 * be saved by deleting an image in this way.
1951 * wimlib_write() ignores this flag.
1953 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1956 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
1957 * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header. This can be used
1958 * following a call to wimlib_set_wim_info() with the
1959 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
1962 * wimlib_write() ignores this flag.
1964 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1967 * Do not include streams already present in other WIMs. This flag can be used
1968 * to write a "delta" WIM after resources from the WIM on which the delta is to
1969 * be based were referenced with wimlib_reference_resource_files() or
1970 * wimlib_reference_resources().
1972 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1975 * Advises the library that for writes of all WIM images, all streams needed for
1976 * the WIM are already present (not in external resource WIMs) and their
1977 * reference counts are correct, so the code does not need to recalculate which
1978 * streams are referenced. This is for optimization purposes only, since with
1979 * this flag specified, the metadata resources may not need to be decompressed
1982 * wimlib_overwrite() will set this flag automatically.
1984 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1987 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
1989 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
1992 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
1995 * When writing streams in the resulting WIM file, pack multiple streams into a
1996 * single compressed resource instead of compressing them independently. This
1997 * is also known as creating a "solid archive". This tends to produce a better
1998 * compression ratio at the cost of much slower random access.
2000 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2001 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
2002 * created with this flag use a different version number in their header (3584
2003 * instead of 68864) and are also called "ESD files".
2005 * If this flag is passed to wimlib_overwrite(), any new data streams will be
2006 * written in solid mode. Use both ::WIMLIB_WRITE_FLAG_REBUILD and
2007 * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
2008 * all streams recompressed in solid mode.
2010 * Currently, new solid blocks will, by default, be written using LZMS
2011 * compression with 32 MiB (33554432 byte) chunks. Use
2012 * wimlib_set_output_pack_compression_type() and/or
2013 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
2014 * the WIM's main compression type and chunk size; you can have a WIM that
2015 * nominally uses LZX compression and 32768 byte chunks but actually contains
2016 * LZMS-compressed solid blocks, for example. However, if including solid
2017 * blocks, I suggest that you set the WIM's main compression type to LZMS as
2018 * well, either by creating the WIM with
2019 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2020 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2022 * This flag will be set by default when writing or overwriting a WIM file that
2023 * either already contains packed streams, or has had packed streams exported
2024 * into it and the WIM's main compression type is LZMS.
2026 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
2029 * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2030 * file. This is only needed in the unusual case that the library user needs to
2031 * know exactly when wimlib has read each file for the last time.
2033 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES 0x00002000
2036 /** @addtogroup G_general
2039 /** Assume that strings are represented in UTF-8, even if this is not the
2040 * locale's character encoding. This flag is ignored on Windows, where wimlib
2041 * always uses UTF-16LE. */
2042 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
2044 /** Windows-only: do not attempt to acquire additional privileges (currently
2045 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2046 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
2047 * for the case where the calling program manages these privileges itself.
2048 * Note: no error is issued if privileges cannot be acquired, although related
2049 * errors may be reported later, depending on if the operations performed
2050 * actually require additional privileges or not. */
2051 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
2053 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2054 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2055 * to read all possible data and metadata for a capture operation could not be
2056 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2058 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
2060 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2061 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2062 * to restore all possible data and metadata for an apply operation could not be
2063 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2065 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
2067 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2069 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
2071 /** Default to interpreting WIM paths case insensitively (default on Windows).
2072 * This does not apply to mounted images. */
2073 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
2076 /** @addtogroup G_nonstandalone_wims
2079 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2080 * Ignored by wimlib_reference_resources(). */
2081 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
2083 /** For wimlib_reference_resource_files(), issue an error
2084 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
2085 * default behavior without this flag is to issue no error at that point, but
2086 * then attempt to open the glob as a literal path, which of course will fail
2087 * anyway if no file exists at that path. No effect if
2088 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
2089 * wimlib_reference_resources(). */
2090 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
2093 /** @addtogroup G_modifying_wims
2096 /** The specific type of update to perform. */
2097 enum wimlib_update_op {
2098 /** Add a new file or directory tree to the WIM image in a
2099 * certain location. */
2100 WIMLIB_UPDATE_OP_ADD = 0,
2102 /** Delete a file or directory tree from the WIM image. */
2103 WIMLIB_UPDATE_OP_DELETE,
2105 /** Rename a file or directory tree in the WIM image. */
2106 WIMLIB_UPDATE_OP_RENAME,
2109 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2110 struct wimlib_add_command {
2111 /** Filesystem path to the file or directory tree to add. */
2112 wimlib_tchar *fs_source_path;
2114 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
2115 * specify the root directory of the WIM image. */
2116 wimlib_tchar *wim_target_path;
2118 /** Path to capture configuration file to use, or @c NULL for default.
2120 wimlib_tchar *config_file;
2122 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2126 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2127 struct wimlib_delete_command {
2129 /** Path, specified from the root of the WIM image, for the file or
2130 * directory tree within the WIM image to be deleted. */
2131 wimlib_tchar *wim_path;
2133 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
2137 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2138 struct wimlib_rename_command {
2140 /** Path, specified from the root of the WIM image, for the source file
2141 * or directory tree within the WIM image. */
2142 wimlib_tchar *wim_source_path;
2144 /** Path, specified from the root of the WIM image, for the destination
2145 * file or directory tree within the WIM image. */
2146 wimlib_tchar *wim_target_path;
2148 /** Reserved; set to 0. */
2152 /** Specification of an update to perform on a WIM image. */
2153 struct wimlib_update_command {
2155 enum wimlib_update_op op;
2158 struct wimlib_add_command add;
2159 struct wimlib_delete_command delete_; /* Underscore is for C++
2161 struct wimlib_rename_command rename;
2166 /** @addtogroup G_general
2170 * Possible values of the error code returned by many functions in wimlib.
2172 * See the documentation for each wimlib function to see specifically what error
2173 * codes can be returned by a given function, and what they mean.
2175 enum wimlib_error_code {
2176 WIMLIB_ERR_SUCCESS = 0,
2177 WIMLIB_ERR_ALREADY_LOCKED = 1,
2178 WIMLIB_ERR_DECOMPRESSION = 2,
2179 WIMLIB_ERR_FUSE = 6,
2180 WIMLIB_ERR_GLOB_HAD_NO_MATCHES = 8,
2181 WIMLIB_ERR_ICONV_NOT_AVAILABLE = 9,
2182 WIMLIB_ERR_IMAGE_COUNT = 10,
2183 WIMLIB_ERR_IMAGE_NAME_COLLISION = 11,
2184 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES = 12,
2185 WIMLIB_ERR_INTEGRITY = 13,
2186 WIMLIB_ERR_INVALID_CAPTURE_CONFIG = 14,
2187 WIMLIB_ERR_INVALID_CHUNK_SIZE = 15,
2188 WIMLIB_ERR_INVALID_COMPRESSION_TYPE = 16,
2189 WIMLIB_ERR_INVALID_HEADER = 17,
2190 WIMLIB_ERR_INVALID_IMAGE = 18,
2191 WIMLIB_ERR_INVALID_INTEGRITY_TABLE = 19,
2192 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY = 20,
2193 WIMLIB_ERR_INVALID_METADATA_RESOURCE = 21,
2194 WIMLIB_ERR_INVALID_MULTIBYTE_STRING = 22,
2195 WIMLIB_ERR_INVALID_OVERLAY = 23,
2196 WIMLIB_ERR_INVALID_PARAM = 24,
2197 WIMLIB_ERR_INVALID_PART_NUMBER = 25,
2198 WIMLIB_ERR_INVALID_PIPABLE_WIM = 26,
2199 WIMLIB_ERR_INVALID_REPARSE_DATA = 27,
2200 WIMLIB_ERR_INVALID_RESOURCE_HASH = 28,
2201 WIMLIB_ERR_INVALID_UTF16_STRING = 30,
2202 WIMLIB_ERR_INVALID_UTF8_STRING = 31,
2203 WIMLIB_ERR_IS_DIRECTORY = 32,
2204 WIMLIB_ERR_IS_SPLIT_WIM = 33,
2205 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2206 WIMLIB_ERR_LINK = 35,
2207 WIMLIB_ERR_METADATA_NOT_FOUND = 36,
2208 WIMLIB_ERR_MKDIR = 37,
2209 WIMLIB_ERR_MQUEUE = 38,
2210 WIMLIB_ERR_NOMEM = 39,
2211 WIMLIB_ERR_NOTDIR = 40,
2212 WIMLIB_ERR_NOTEMPTY = 41,
2213 WIMLIB_ERR_NOT_A_REGULAR_FILE = 42,
2214 WIMLIB_ERR_NOT_A_WIM_FILE = 43,
2215 WIMLIB_ERR_NOT_PIPABLE = 44,
2216 WIMLIB_ERR_NO_FILENAME = 45,
2217 WIMLIB_ERR_NTFS_3G = 46,
2218 WIMLIB_ERR_OPEN = 47,
2219 WIMLIB_ERR_OPENDIR = 48,
2220 WIMLIB_ERR_PATH_DOES_NOT_EXIST = 49,
2221 WIMLIB_ERR_READ = 50,
2222 WIMLIB_ERR_READLINK = 51,
2223 WIMLIB_ERR_RENAME = 52,
2224 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED = 54,
2225 WIMLIB_ERR_RESOURCE_NOT_FOUND = 55,
2226 WIMLIB_ERR_RESOURCE_ORDER = 56,
2227 WIMLIB_ERR_SET_ATTRIBUTES = 57,
2228 WIMLIB_ERR_SET_REPARSE_DATA = 58,
2229 WIMLIB_ERR_SET_SECURITY = 59,
2230 WIMLIB_ERR_SET_SHORT_NAME = 60,
2231 WIMLIB_ERR_SET_TIMESTAMPS = 61,
2232 WIMLIB_ERR_SPLIT_INVALID = 62,
2233 WIMLIB_ERR_STAT = 63,
2234 WIMLIB_ERR_UNEXPECTED_END_OF_FILE = 65,
2235 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE = 66,
2236 WIMLIB_ERR_UNKNOWN_VERSION = 67,
2237 WIMLIB_ERR_UNSUPPORTED = 68,
2238 WIMLIB_ERR_UNSUPPORTED_FILE = 69,
2239 WIMLIB_ERR_WIM_IS_READONLY = 71,
2240 WIMLIB_ERR_WRITE = 72,
2241 WIMLIB_ERR_XML = 73,
2242 WIMLIB_ERR_WIM_IS_ENCRYPTED = 74,
2243 WIMLIB_ERR_WIMBOOT = 75,
2244 WIMLIB_ERR_ABORTED_BY_PROGRESS = 76,
2245 WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS = 77,
2246 WIMLIB_ERR_MKNOD = 78,
2247 WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY = 79,
2248 WIMLIB_ERR_NOT_A_MOUNTPOINT = 80,
2249 WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT = 81,
2253 /** Used to indicate no WIM image or an invalid WIM image. */
2254 #define WIMLIB_NO_IMAGE 0
2256 /** Used to specify all images in the WIM. */
2257 #define WIMLIB_ALL_IMAGES (-1)
2262 * @ingroup G_modifying_wims
2264 * Appends an empty image to a WIM file. This empty image will initially
2265 * contain no files or directories, although if written without further
2266 * modifications, a root directory will be created automatically for it. After
2267 * calling this function, you can use wimlib_update_image() to add files to the
2268 * new WIM image. This gives you slightly more control over making the new
2269 * image compared to calling wimlib_add_image() or
2270 * wimlib_add_image_multisource() directly.
2273 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
2276 * Name to give the new image. If @c NULL or empty, the new image is given
2277 * no name. If nonempty, it must specify a name that does not already
2279 * @param new_idx_ret
2280 * If non-<code>NULL</code>, the index of the newly added image is returned
2283 * @return 0 on success; nonzero on failure. The possible error codes are:
2285 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2286 * There is already an image in @p wim named @p name.
2287 * @retval ::WIMLIB_ERR_NOMEM
2288 * Failed to allocate the memory needed to add the new image.
2289 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2290 * The WIM file is considered read-only because of any of the reasons
2291 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2295 wimlib_add_empty_image(WIMStruct *wim,
2296 const wimlib_tchar *name,
2300 * @ingroup G_modifying_wims
2302 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2304 * The directory tree or NTFS volume is scanned immediately to load the dentry
2305 * tree into memory, and file attributes and symbolic links are read. However,
2306 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2309 * See the manual page for the @b wimlib-imagex program for more information
2310 * about the "normal" capture mode versus the NTFS capture mode (entered by
2311 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2313 * Note that @b no changes are committed to the underlying WIM file (if
2314 * any) until wimlib_write() or wimlib_overwrite() is called.
2317 * Pointer to the ::WIMStruct to which to add the image.
2319 * A path to a directory or unmounted NTFS volume that will be captured as
2322 * Name to give the new image. If @c NULL or empty, the new image is given
2323 * no name. If nonempty, it must specify a name that does not already
2325 * @param config_file
2326 * Path to capture configuration file, or @c NULL. This file may specify,
2327 * among other things, which files to exclude from capture. See the man
2328 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2329 * details of the file format. If @c NULL, the default capture
2330 * configuration shall be used. Ordinarily, the default capture
2331 * configuration will result in no files being excluded from capture purely
2332 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2333 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2335 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2337 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2338 * discarded so that it appears to be in the same state as when this function
2341 * This function is implemented by calling wimlib_add_empty_image(), then
2342 * calling wimlib_update_image() with a single "add" command, so any error code
2343 * returned by wimlib_add_empty_image() may be returned, as well as any error
2344 * codes returned by wimlib_update_image() other than ones documented as only
2345 * being returned specifically by an update involving delete or rename commands.
2347 * If a progress function is registered with @p wim, it will receive the
2348 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2349 * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2350 * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2353 wimlib_add_image(WIMStruct *wim,
2354 const wimlib_tchar *source,
2355 const wimlib_tchar *name,
2356 const wimlib_tchar *config_file,
2360 * @ingroup G_modifying_wims
2362 * This function is equivalent to wimlib_add_image() except it allows for
2363 * multiple sources to be combined into a single WIM image. This is done by
2364 * specifying the @p sources and @p num_sources parameters instead of the @p
2365 * source parameter of wimlib_add_image(). The rest of the parameters are the
2366 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2367 * capture</b> for full details on how this mode works.
2369 * In addition to the error codes that wimlib_add_image() can return,
2370 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2371 * when trying to overlay a non-directory on a directory or when otherwise
2372 * trying to overlay multiple conflicting files to the same location in the WIM
2373 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2374 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2375 * was not exactly one capture source with the target being the root directory.
2376 * (In this respect, there is no advantage to using
2377 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2380 wimlib_add_image_multisource(WIMStruct *wim,
2381 const struct wimlib_capture_source *sources,
2383 const wimlib_tchar *name,
2384 const wimlib_tchar *config_file,
2388 * @ingroup G_modifying_wims
2390 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2391 * location @p wim_target_path within the specified @p image of the @p wim.
2393 * This just builds an appropriate ::wimlib_add_command and passes it to
2394 * wimlib_update_image().
2397 wimlib_add_tree(WIMStruct *wim, int image,
2398 const wimlib_tchar *fs_source_path,
2399 const wimlib_tchar *wim_target_path, int add_flags);
2402 * @ingroup G_creating_and_opening_wims
2404 * Creates a ::WIMStruct for a new WIM file.
2406 * This only creates an in-memory structure for a WIM that initially contains no
2407 * images. No on-disk file is created until wimlib_write() is called.
2410 * The type of compression to be used in the new WIM file, as one of the
2411 * ::wimlib_compression_type constants.
2413 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2414 * written to the memory location pointed to by this parameter. The
2415 * ::WIMStruct must be freed using using wimlib_free() when finished with
2417 * @return 0 on success; nonzero on error.
2418 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2419 * @p ctype was not a supported compression type.
2420 * @retval ::WIMLIB_ERR_NOMEM
2421 * Failed to allocate needed memory.
2424 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2427 * @ingroup G_modifying_wims
2429 * Deletes an image, or all images, from a WIM file.
2431 * All streams referenced by the image(s) being deleted are removed from the
2432 * lookup table of the WIM if they are not referenced by any other images in the
2435 * Please note that @b no changes are committed to the underlying WIM file (if
2436 * any) until wimlib_write() or wimlib_overwrite() is called.
2439 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2442 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2444 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2445 * to be left unmodified only if @p image specified a single image. If instead
2446 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2447 * possible for some but not all of the images to have been deleted when a
2448 * failure status is returned.
2450 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2451 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2452 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2453 * The WIM file is considered read-only because of any of the reasons
2454 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2457 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2458 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2459 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2460 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2461 * different reasons) to read the metadata resource for an image that needed to
2465 wimlib_delete_image(WIMStruct *wim, int image);
2468 * @ingroup G_modifying_wims
2470 * Delete the @p path from the specified @p image of the @p wim.
2472 * This just builds an appropriate ::wimlib_delete_command and passes it to
2473 * wimlib_update_image().
2476 wimlib_delete_path(WIMStruct *wim, int image,
2477 const wimlib_tchar *path, int delete_flags);
2480 * @ingroup G_modifying_wims
2482 * Exports an image, or all the images, from a WIM file, into another WIM file.
2484 * The destination image is made to share the same dentry tree and security data
2485 * structure as the source image. This places some restrictions on additional
2486 * functions that may be called. For example, you may not call wimlib_free() on
2487 * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2488 * because @p dest_wim will have references back to @p src_wim.
2490 * If this function fails, all changes to @p dest_wim are rolled back.
2492 * Please note that no changes are committed to the underlying WIM file of @p
2493 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2496 * The WIM from which to export the images, specified as a pointer to the
2497 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2498 * split WIM. In the case of a WIM file that is not standalone, this
2499 * ::WIMStruct must have had any needed external resources previously
2500 * referenced using wimlib_reference_resources() or
2501 * wimlib_reference_resource_files().
2503 * The image to export from @p src_wim, as either a 1-based image index to
2504 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2506 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2509 * For single-image exports, the name to give the exported image in @p
2510 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2511 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2512 * that case, the names are all taken from @p src_wim. This parameter is
2513 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2514 * @param dest_description
2515 * For single-image exports, the description to give the exported image in
2516 * the new WIM file. If left @c NULL, the description from @p src_wim is
2517 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2518 * NULL; in that case, the description are all taken from @p src_wim. This
2519 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2520 * @param export_flags
2521 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2523 * @return 0 on success; nonzero on error.
2524 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2525 * One or more of the names being given to an exported image was already in
2526 * use in the destination WIM.
2527 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2528 * @p src_image does not exist in @p src_wim and was not
2529 * ::WIMLIB_ALL_IMAGES.
2530 * @retval ::WIMLIB_ERR_INVALID_PARAM
2531 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2532 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2534 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2535 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2536 * example, one of them was a non-first part of a split WIM.
2537 * @retval ::WIMLIB_ERR_NOMEM
2538 * Failed to allocate needed memory.
2539 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2540 * A resource that needed to be exported could not be found in either the
2541 * source or destination WIMs. This error can occur if, for example, @p
2542 * src_wim is part of a split WIM but needed resources from the other split
2543 * WIM parts were not referenced with wimlib_reference_resources() or
2544 * wimlib_reference_resource_files() before the call to
2545 * wimlib_export_image().
2546 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2547 * @p dest_wim is considered read-only because of any of the reasons
2548 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2551 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2552 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2553 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2554 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2555 * different reasons) to read the metadata resource for an image in @p src_wim
2556 * that needed to be exported.
2559 wimlib_export_image(WIMStruct *src_wim, int src_image,
2560 WIMStruct *dest_wim,
2561 const wimlib_tchar *dest_name,
2562 const wimlib_tchar *dest_description,
2566 * @ingroup G_extracting_wims
2568 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2571 * The exact behavior of how wimlib extracts files from a WIM image is
2572 * controllable by the @p extract_flags parameter, but there also are
2573 * differences depending on the platform (UNIX-like vs Windows). See the manual
2574 * page for <b>wimlib-imagex apply</b> for more information, including about the
2575 * special "NTFS volume extraction mode" entered by providing
2576 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2579 * The WIM from which to extract the image(s), specified as a pointer to
2580 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2581 * of a split WIM. In the case of a WIM file that is not standalone, this
2582 * ::WIMStruct must have had any needed external resources previously
2583 * referenced using wimlib_reference_resources() or
2584 * wimlib_reference_resource_files().
2586 * The image to extract, specified as either the 1-based index of a single
2587 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2588 * to be extracted. ::WIMLIB_ALL_IMAGES cannot be used if
2589 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2591 * Directory to extract the WIM image(s) to; or, with
2592 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2593 * the unmounted NTFS volume to which to extract the image.
2594 * @param extract_flags
2595 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2597 * @return 0 on success; nonzero on error.
2598 * @retval ::WIMLIB_ERR_DECOMPRESSION
2599 * Failed to decompress data contained in the WIM.
2600 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2601 * The metadata for one of the images to extract was invalid.
2602 * @retval ::WIMLIB_ERR_INVALID_PARAM
2603 * The extraction flags were invalid; more details may be found in the
2604 * documentation for the specific extraction flags that were specified. Or
2605 * @p target was @c NULL or the empty string, or @p wim was @c NULL.
2606 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2607 * The SHA1 message digest of an extracted stream did not match the SHA1
2608 * message digest given in the WIM.
2609 * @retval ::WIMLIB_ERR_LINK
2610 * Failed to create a symbolic link or a hard link.
2611 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2612 * The metadata resource for one of the images to extract was not found.
2613 * This can happen if @p wim represents a non-first part of a split WIM.
2614 * @retval ::WIMLIB_ERR_MKDIR
2615 * Failed create a directory.
2616 * @retval ::WIMLIB_ERR_NOMEM
2617 * Failed to allocate needed memory.
2618 * @retval ::WIMLIB_ERR_OPEN
2619 * Could not create a file, or failed to open an already-extracted file.
2620 * @retval ::WIMLIB_ERR_READ
2621 * Failed to read data from the WIM.
2622 * @retval ::WIMLIB_ERR_READLINK
2623 * Failed to determine the target of a symbolic link in the WIM.
2624 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2625 * Failed to fix the target of an absolute symbolic link (e.g. if the
2626 * target would have exceeded the maximum allowed length). (Only if
2627 * reparse data was supported by the extraction mode and
2628 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2630 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2631 * One of the files or directories that needed to be extracted referenced a
2632 * stream not present in the WIM's lookup table (or in any of the lookup
2633 * tables of the split WIM parts).
2634 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2635 * Failed to set attributes on a file.
2636 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2637 * Failed to set reparse data on a file (only if reparse data was supported
2638 * by the extraction mode).
2639 * @retval ::WIMLIB_ERR_SET_SECURITY
2640 * Failed to set security descriptor on a file
2641 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2643 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2644 * Failed to set the short name of a file (only if
2645 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2646 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2647 * Failed to set timestamps on a file (only if
2648 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2649 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2650 * Unexpected end-of-file occurred when reading data from the WIM.
2651 * @retval ::WIMLIB_ERR_UNSUPPORTED
2652 * A requested extraction flag, or the data or metadata that must be
2653 * extracted to support it, is unsupported in the build and configuration
2654 * of wimlib, or on the current platform or extraction mode or target
2655 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2656 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2657 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2658 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2659 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2660 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2661 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2662 * image contains one or more files with short names, but extracting short
2663 * names is not supported --- on Windows, this occurs if the target volume
2664 * does not support short names, while on non-Windows, this occurs if
2665 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2666 * @retval ::WIMLIB_ERR_WIMBOOT
2667 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2668 * there was a problem creating WIMBoot pointer files.
2669 * @retval ::WIMLIB_ERR_WRITE
2670 * Failed to write data to a file being extracted.
2672 * If a progress function is registered with @p wim, then as each image is
2673 * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2674 * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2675 * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2676 * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2677 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2680 wimlib_extract_image(WIMStruct *wim, int image,
2681 const wimlib_tchar *target, int extract_flags);
2684 * @ingroup G_extracting_wims
2686 * Since wimlib v1.5.0: Extract one image from a pipe on which a pipable WIM is
2689 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2690 * about pipable WIMs.
2692 * This function operates in a special way to read the WIM fully sequentially.
2693 * As a result, there is no ::WIMStruct is made visible to library users, and
2694 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2695 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2696 * seekable file, not a pipe.)
2699 * File descriptor, which may be a pipe, opened for reading and positioned
2700 * at the start of the pipable WIM.
2701 * @param image_num_or_name
2702 * String that specifies the 1-based index or name of the image to extract.
2703 * It is translated to an image index using the same rules that
2704 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2705 * only a single image (not all images) can be specified. Alternatively,
2706 * specify @p NULL here to use the first image in the WIM if it contains
2707 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2709 * Same as the corresponding parameter to wimlib_extract_image().
2710 * @param extract_flags
2711 * Same as the corresponding parameter to wimlib_extract_image().
2713 * @return 0 on success; nonzero on error. The possible error codes include
2714 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2717 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2718 * Data read from the pipable WIM was invalid.
2719 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2720 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2723 wimlib_extract_image_from_pipe(int pipe_fd,
2724 const wimlib_tchar *image_num_or_name,
2725 const wimlib_tchar *target, int extract_flags);
2728 * @ingroup G_extracting_wims
2730 * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2731 * function. The progress function will be used while extracting the WIM image
2732 * and will receive the normal extraction progress messages, such as
2733 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2734 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2737 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2738 const wimlib_tchar *image_num_or_name,
2739 const wimlib_tchar *target,
2741 wimlib_progress_func_t progfunc,
2745 * @ingroup G_extracting_wims
2747 * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to
2748 * extract from the WIM image are specified in the ASCII, UTF-8, or UTF-16LE
2749 * text file named by @p path_list_file which itself contains the list of paths
2750 * to use, one per line. Leading and trailing whitespace, and otherwise empty
2751 * lines and lines beginning with the ';' character are ignored. No quotes are
2752 * needed as paths are otherwise delimited by the newline character.
2754 * The error codes are the same as those returned by wimlib_extract_paths(),
2755 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2756 * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2757 * ::WIMLIB_ERR_READ).
2760 wimlib_extract_pathlist(WIMStruct *wim, int image,
2761 const wimlib_tchar *target,
2762 const wimlib_tchar *path_list_file,
2766 * @ingroup G_extracting_wims
2768 * Since wimlib v1.6.0: Extract zero or more paths (files or directory trees)
2769 * from the specified WIM image.
2771 * By default, each path will be extracted to a corresponding subdirectory of
2772 * the target based on its location in the WIM image. For example, if one of
2773 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2774 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2775 * can be changed by providing the flag
2776 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2777 * or directory tree to be placed directly in the target directory --- so the
2778 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2780 * Symbolic links will not be dereferenced when paths in the WIM image are
2784 * WIM from which to extract the paths, specified as a pointer to the
2785 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2786 * split WIM. In the case of a WIM file that is not standalone, this
2787 * ::WIMStruct must have had any needed external resources previously
2788 * referenced using wimlib_reference_resources() or
2789 * wimlib_reference_resource_files().
2791 * 1-based index of the WIM image from which to extract the paths.
2793 * Array of paths to extract. Each element must be the absolute path to a
2794 * file or directory within the WIM image. Separators may be either
2795 * forwards or backwards slashes, and leading path separators are optional.
2796 * The paths will be interpreted either case-sensitively (UNIX default) or
2797 * case-insensitively (Windows default); this can be changed by
2798 * wimlib_global_init().
2800 * By default, the characters @c * and @c ? are interpreted literally.
2801 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2804 * By default, if any paths to extract do not exist, the error code
2805 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2806 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2808 * Number of paths specified in @p paths.
2810 * Directory to which to extract the paths; or with
2811 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2812 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2813 * paths being extracted, the @p target must be native path. On UNIX-like
2814 * systems it may not contain backslashes, for example.
2815 * @param extract_flags
2816 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2818 * @return 0 on success; nonzero on error. Most of the error codes are the same
2819 * as those returned by wimlib_extract_image(). Below, some of the error codes
2820 * returned in situations specific to path-mode extraction are documented:
2822 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2823 * @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2825 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2826 * One of the paths to extract did not exist in the WIM image. This error
2827 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2828 * specified in @p extract_flags, or if both
2829 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2830 * were specified in @p extract_flags.
2831 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2832 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2833 * one of the paths to extract did not name a regular file.
2835 * If a progress function is registered with @p wim, it will receive
2836 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. Note that because the extraction code
2837 * is stream-based and not file-based, there is no way to get information about
2838 * which path is currently being extracted, but based on byte count you can
2839 * still calculate an approximate percentage complete for the extraction overall
2840 * which may be all you really need anyway.
2843 wimlib_extract_paths(WIMStruct *wim,
2845 const wimlib_tchar *target,
2846 const wimlib_tchar * const *paths,
2851 * @ingroup G_wim_information
2853 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2854 * includes a string of XML that describes the images contained in the WIM.
2856 * See wimlib_get_xml_data() to read the XML data into memory instead.
2859 * Pointer to the ::WIMStruct to query. This need not represent a
2860 * standalone WIM (e.g. it could represent part of a split WIM).
2862 * @c stdout, or a FILE* opened for writing, to extract the data to.
2864 * @return 0 on success; nonzero on error.
2865 * @retval ::WIMLIB_ERR_INVALID_PARAM
2866 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2867 * @retval ::WIMLIB_ERR_NOMEM
2868 * Failed to allocate needed memory.
2869 * @retval ::WIMLIB_ERR_READ
2870 * Error reading the XML data from the WIM file.
2871 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2872 * Error reading the XML data from the WIM file.
2873 * @retval ::WIMLIB_ERR_WRITE
2874 * Failed to completely write the XML data to @p fp.
2877 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2880 * @ingroup G_general
2882 * Frees all memory allocated for a WIMStruct and closes all files associated
2886 * Pointer to the ::WIMStruct to free.
2888 * @return This function has no return value.
2891 wimlib_free(WIMStruct *wim);
2894 * @ingroup G_general
2896 * Converts a ::wimlib_compression_type value into a string.
2899 * The ::wimlib_compression_type value to convert.
2902 * A statically allocated string naming the compression algorithm,
2903 * such as "None", "LZX", "XPRESS", or "Invalid".
2905 extern const wimlib_tchar *
2906 wimlib_get_compression_type_string(int ctype);
2909 * @ingroup G_general
2911 * Converts an error code into a string describing it.
2914 * The error code returned by one of wimlib's functions.
2917 * Pointer to a statically allocated string describing the error code. If
2918 * the error code is for some reason not recognized by the library, the
2919 * string will be "Unknown error".
2921 extern const wimlib_tchar *
2922 wimlib_get_error_string(enum wimlib_error_code code);
2925 * @ingroup G_wim_information
2927 * Returns the description of the specified image.
2930 * Pointer to the ::WIMStruct to query. This need not represent a
2931 * standalone WIM (e.g. it could represent part of a split WIM).
2933 * The number of the image, numbered starting at 1.
2936 * The description of the image, or @c NULL if there is no such image, or
2937 * @c NULL if the specified image has no description. The description
2938 * string is in library-internal memory and may not be modified or freed;
2939 * in addition, the string will become invalid if the description of the
2940 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2942 extern const wimlib_tchar *
2943 wimlib_get_image_description(const WIMStruct *wim, int image);
2946 * @ingroup G_wim_information
2948 * Returns the name of the specified image.
2951 * Pointer to the ::WIMStruct to query. This need not represent a
2952 * standalone WIM (e.g. it could represent part of a split WIM).
2954 * The number of the image, numbered starting at 1.
2957 * The name of the image, or @c NULL if there is no such image, or an empty
2958 * string if the image is unnamed. The name string is in
2959 * library-internal memory and may not be modified or freed; in addition,
2960 * the string will become invalid if the name of the image is changed, the
2961 * image is deleted, or the ::WIMStruct is destroyed.
2963 extern const wimlib_tchar *
2964 wimlib_get_image_name(const WIMStruct *wim, int image);
2967 * @ingroup G_general
2969 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2970 * the major version, the next 10 bits contain the minor version, and the low 10
2971 * bits contain the patch version.
2973 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2974 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2975 * corresponding header file.
2978 wimlib_get_version(void);
2981 * @ingroup G_wim_information
2983 * Get basic information about a WIM file.
2986 * Pointer to the ::WIMStruct to query. This need not represent a
2987 * standalone WIM (e.g. it could represent part of a split WIM).
2989 * A ::wimlib_wim_info structure that will be filled in with information
2990 * about the WIM file.
2995 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2998 * @ingroup G_wim_information
3000 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
3001 * includes a string of XML that describes the images contained in the WIM.
3003 * See wimlib_extract_xml_data() to extract the XML data to a file stream
3007 * Pointer to the ::WIMStruct to query. This need not represent a
3008 * standalone WIM (e.g. it could represent part of a split WIM).
3010 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
3011 * XML data is written to this location.
3012 * @param bufsize_ret
3013 * The size of the XML data in bytes is written to this location.
3015 * @return 0 on success; nonzero on error.
3016 * @retval ::WIMLIB_ERR_INVALID_PARAM
3017 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
3018 * @p buf_ret or @p bufsize_ret was @c NULL.
3019 * @retval ::WIMLIB_ERR_NOMEM
3020 * @retval ::WIMLIB_ERR_READ
3021 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3022 * Failed to read the XML data from the WIM.
3025 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3028 * @ingroup G_general
3030 * Initialization function for wimlib. Call before using any other wimlib
3031 * function except wimlib_set_print_errors(). If not done manually, this
3032 * function will be called automatically with @p init_flags set to
3033 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
3034 * after it has already successfully run.
3037 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3039 * @return 0 on success; nonzero on failure. Currently, only the following
3040 * error code is defined:
3042 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3043 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3044 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3045 * init_flags, but the corresponding privileges could not be acquired.
3048 wimlib_global_init(int init_flags);
3051 * @ingroup G_general
3053 * Cleanup function for wimlib. You are not required to call this function, but
3054 * it will release any global resources allocated by the library.
3057 wimlib_global_cleanup(void);
3060 * @ingroup G_wim_information
3062 * Determines if an image name is already used by some image in the WIM.
3065 * Pointer to the ::WIMStruct to query. This need not represent a
3066 * standalone WIM (e.g. it could represent part of a split WIM).
3068 * The name to check.
3071 * @c true if there is already an image in @p wim named @p name; @c false
3072 * if there is no image named @p name in @p wim. If @p name is @c NULL or
3073 * the empty string, @c false is returned.
3076 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3079 * @ingroup G_wim_information
3081 * Iterate through a file or directory tree in the WIM image. By specifying
3082 * appropriate flags and a callback function, you can get the attributes of a
3083 * file in the WIM, get a directory listing, or even get a listing of the entire
3087 * The WIM containing the image(s) over which to iterate, specified as a
3088 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3089 * or part 1 of a split WIM. In the case of a WIM file that is not
3090 * standalone, this ::WIMStruct should have had any needed external
3091 * resources previously referenced using wimlib_reference_resources() or
3092 * wimlib_reference_resource_files(). If not, see
3093 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3094 * the behavior when resources are missing.
3097 * The 1-based number of the image in @p wim that contains the files or
3098 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3099 * iteration on all images in the WIM.
3102 * Path in the WIM image at which to do the iteration.
3105 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3108 * A callback function that will receive each directory entry.
3111 * An extra parameter that will always be passed to the callback function
3114 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3115 * first nonzero value that was returned from @p cb. However, additional error
3116 * codes may be returned, including the following:
3118 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3119 * @p path did not exist in the WIM image.
3120 * @retval ::WIMLIB_ERR_NOMEM
3121 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
3123 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3124 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3125 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3126 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3127 * different reasons) to read the metadata resource for an image over which
3128 * iteration needed to be done.
3131 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3133 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3136 * @ingroup G_wim_information
3138 * Iterate through the lookup table of a WIM file. This can be used to directly
3139 * get a listing of the unique resources contained in a WIM file over all
3140 * images. Both file resources and metadata resources are included. However,
3141 * only resources actually included in the file represented by @a wim, plus
3142 * explicitly referenced external resources (via wimlib_reference_resources() or
3143 * wimlib_reference_resource_files()) are included in the iteration. For
3144 * example, if @p wim represents just one part of a split WIM, then only
3145 * resources in that part will be included, unless other resources were
3146 * explicitly referenced.
3149 * Pointer to the ::WIMStruct to query. This need not represent a
3150 * standalone WIM (e.g. it could represent part of a split WIM).
3153 * Reserved; set to 0.
3156 * A callback function that will receive each resource.
3159 * An extra parameter that will always be passed to the callback function
3162 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3163 * that was returned from @p cb.
3166 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3167 wimlib_iterate_lookup_table_callback_t cb,
3171 * @ingroup G_nonstandalone_wims
3173 * Joins a split WIM into a stand-alone one-part WIM.
3176 * An array of strings that gives the filenames of all parts of the split
3177 * WIM. No specific order is required, but all parts must be included with
3180 * Number of filenames in @p swms.
3181 * @param swm_open_flags
3182 * Open flags for the split WIM parts (e.g.
3183 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3184 * @param wim_write_flags
3185 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3186 * be used to write the joined WIM.
3187 * @param output_path
3188 * The path to write the joined WIM file to.
3190 * @return 0 on success; nonzero on error. This function may return most error
3191 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3192 * as the following error code:
3194 * @retval ::WIMLIB_ERR_SPLIT_INVALID
3195 * The split WIMs do not form a valid WIM because they do not include all
3196 * the parts of the original WIM, there are duplicate parts, or not all the
3197 * parts have the same GUID and compression type.
3199 * Note: wimlib is generalized enough that this function is not actually needed
3200 * to join a split WIM; instead, you could open the first part of the split WIM,
3201 * then reference the other parts with wimlib_reference_resource_files(), then
3202 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
3203 * an easy-to-use wrapper around this that has some advantages (e.g. extra
3207 wimlib_join(const wimlib_tchar * const *swms,
3209 const wimlib_tchar *output_path,
3211 int wim_write_flags);
3214 * @ingroup G_nonstandalone_wims
3216 * Same as wimlib_join(), but allows specifying a progress function. The
3217 * progress function will receive the write progress messages, such as
3218 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM. In
3219 * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3220 * swm_open_flags, the progress function will receive a series of
3221 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3225 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3227 const wimlib_tchar *output_path,
3229 int wim_write_flags,
3230 wimlib_progress_func_t progfunc,
3235 * @ingroup G_mounting_wim_images
3237 * Mounts an image from a WIM file on a directory read-only or read-write.
3240 * Pointer to the ::WIMStruct containing the image to be mounted.
3242 * The 1-based index of the image to mount.
3244 * The path to an existing empty directory on which to mount the WIM image.
3245 * @param mount_flags
3246 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG. Use
3247 * ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3249 * @param staging_dir
3250 * If non-NULL, the name of a directory in which a temporary directory for
3251 * storing modified or added files will be created. Ignored if
3252 * ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags. If
3253 * left @c NULL, the staging directory is created in the same directory as
3254 * the WIM file that @p wim was originally read from. The staging
3255 * directory is deleted when the image is unmounted.
3257 * @return 0 on success; nonzero on error. The possible error codes include:
3259 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3260 * An image from the WIM file is already mounted read-write, or another
3261 * process is currently appending data to the WIM file.
3262 * @retval ::WIMLIB_ERR_FUSE
3263 * A non-zero status code was returned by @c fuse_main().
3264 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3265 * @p image does not specify an existing, single image in @p wim.
3266 * @retval ::WIMLIB_ERR_INVALID_PARAM
3267 * @p wim was @c NULL; or @p dir was NULL or the empty string; or an
3268 * unrecognized flag was specified in @p mount_flags; or the WIM image has
3269 * already been modified in memory (e.g. by wimlib_update_image()).
3270 * @retval ::WIMLIB_ERR_MKDIR
3271 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3272 * staging directory could not be created.
3273 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3274 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3275 * WIM file is considered read-only because of any of the reasons mentioned
3276 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3277 * @retval ::WIMLIB_ERR_UNSUPPORTED
3278 * Mounting is not supported, either because the platform is Windows, or
3279 * because the platform is UNIX-like and wimlib was compiled using
3280 * <code>--without-fuse</code>.
3282 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3283 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3284 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3285 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3286 * different reasons) to read the metadata resource for the image to mount.
3288 * The ability to mount WIM image is implemented using FUSE (Filesystem in
3289 * UserSpacE). Depending on how FUSE is set up on your system, this function
3290 * may work as normal users in addition to the root user.
3292 * Mounting WIM images is not supported if wimlib was configured
3293 * <code>--without-fuse</code>. This includes Windows builds of wimlib;
3294 * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3296 * Calling this function daemonizes the process, unless
3297 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3299 * It is safe to mount multiple images from the same underlying WIM file
3300 * read-only at the same time, but only if different ::WIMStruct's are used. It
3301 * is @b not safe to mount multiple images from the same WIM file read-write at
3304 * To unmount the image, call wimlib_unmount_image(). This may be done in a
3305 * different process.
3308 wimlib_mount_image(WIMStruct *wim,
3310 const wimlib_tchar *dir,
3312 const wimlib_tchar *staging_dir);
3315 * @ingroup G_creating_and_opening_wims
3317 * Opens a WIM file and creates a ::WIMStruct for it.
3320 * The path to the WIM file to open.
3323 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3326 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3327 * is written to the memory location pointed to by this parameter. The
3328 * ::WIMStruct must be freed using using wimlib_free() when finished with
3331 * @return 0 on success; nonzero on error.
3332 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3333 * The number of metadata resources found in the WIM did not match the
3334 * image count specified in the WIM header, or the number of <IMAGE>
3335 * elements in the XML data of the WIM did not match the image count
3336 * specified in the WIM header.
3337 * @retval ::WIMLIB_ERR_INTEGRITY
3338 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3339 * the WIM contained an integrity table, but the SHA1 message digest for a
3340 * chunk of the WIM did not match the corresponding value in the integrity
3342 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3343 * The library did not recognize the compression chunk size of the WIM as
3344 * valid for its compression type.
3345 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3346 * The library did not recognize the compression type of the WIM.
3347 * @retval ::WIMLIB_ERR_INVALID_HEADER
3348 * The header of the WIM was otherwise invalid.
3349 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3350 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3351 * the WIM contained an integrity table, but the integrity table was
3353 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3354 * The lookup table of the WIM was invalid.
3355 * @retval ::WIMLIB_ERR_INVALID_PARAM
3356 * @p wim_ret was @c NULL.
3357 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3358 * The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3359 * specified in @p open_flags.
3360 * @retval ::WIMLIB_ERR_NOMEM
3361 * Failed to allocated needed memory.
3362 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3363 * The file did not begin with the magic characters that identify a WIM
3365 * @retval ::WIMLIB_ERR_OPEN
3366 * Failed to open the file for reading.
3367 * @retval ::WIMLIB_ERR_READ
3368 * Failed to read data from the file.
3369 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3370 * Unexpected end-of-file while reading data from the file.
3371 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3372 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3373 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3374 * The WIM cannot be opened because it contains encrypted segments. (It
3375 * may be a Windows 8 "ESD" file.)
3376 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3377 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3378 * considered read-only because of any of the reasons mentioned in the
3379 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3380 * @retval ::WIMLIB_ERR_XML
3381 * The XML data of the WIM was invalid.
3384 wimlib_open_wim(const wimlib_tchar *wim_file,
3386 WIMStruct **wim_ret);
3389 * @ingroup G_creating_and_opening_wims
3391 * Same as wimlib_open_wim(), but allows specifying a progress function and
3392 * progress context. If successful, the progress function will be registered in
3393 * the newly open ::WIMStruct, as if by an automatic call to
3394 * wimlib_register_progress_function(). In addition, if
3395 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the
3396 * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3397 * messages while checking the WIM's integrity.
3400 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3402 WIMStruct **wim_ret,
3403 wimlib_progress_func_t progfunc,
3407 * @ingroup G_writing_and_overwriting_wims
3409 * Overwrites the file that the WIM was originally read from, with changes made.
3410 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3411 * rather than wimlib_create_new_wim().
3413 * There are two ways that a WIM may be overwritten. The first is to do a full
3414 * rebuild. In this mode, the new WIM is written to a temporary file and then
3415 * renamed to the original file after it is has been completely written. The
3416 * temporary file is made in the same directory as the original WIM file. A
3417 * full rebuild may take a while, but it will save space by producing a WIM with
3420 * The second way to overwrite a WIM is by appending to the end of it and
3421 * overwriting the header. This can be much faster than a full rebuild, but the
3422 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3423 * begins with writing any new file resources *after* everything in the old WIM,
3424 * even though this will leave a hole where the old lookup table, XML data, and
3425 * integrity were. This is done so that the WIM remains valid even if the
3426 * operation is aborted mid-write. The WIM header is only overwritten at the
3427 * very last moment, and up until that point the WIM will be seen as the old
3430 * By default, wimlib_overwrite() does the append-style overwrite described
3431 * above, unless resources in the WIM are arranged in an unusual way or if
3432 * images have been deleted from the WIM. Use the flag
3433 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3434 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3435 * images have been deleted from the WIM.
3437 * If this function completes successfully, no more functions should be called
3438 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3439 * the WIM file anew.
3442 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3443 * been in-memory changes made to it, which are then reflected in the
3445 * @param write_flags
3446 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3447 * @param num_threads
3448 * Number of threads to use for compression (see wimlib_write()).
3450 * @return 0 on success; nonzero on error. This function may return most error
3451 * codes returned by wimlib_write() as well as the following error codes:
3453 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3454 * The WIM was going to be modified in-place (with no temporary file), but
3455 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3456 * because another thread or process has mounted an image from the WIM
3457 * read-write or is currently modifying the WIM in-place.
3458 * @retval ::WIMLIB_ERR_NO_FILENAME
3459 * @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim()
3460 * rather than a WIM read with wimlib_open_wim().
3461 * @retval ::WIMLIB_ERR_RENAME
3462 * The temporary file that the WIM was written to could not be renamed to
3463 * the original filename of @p wim.
3464 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3465 * The WIM file is considered read-only because of any of the reasons
3466 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3469 * If a progress function is registered with @p wim, it will receive the
3470 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3471 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3472 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3475 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3478 * @ingroup G_wim_information
3480 * Prints information about one image, or all images, contained in a WIM.
3483 * Pointer to the ::WIMStruct to query. This need not represent a
3484 * standalone WIM (e.g. it could represent part of a split WIM).
3486 * The image about which to print information. Can be the number of an
3487 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3490 * @return This function has no return value. No error checking is done when
3491 * printing the information. If @p image is invalid, an error message is
3495 wimlib_print_available_images(const WIMStruct *wim, int image);
3498 * @ingroup G_wim_information
3500 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3501 * in a way that can be accessed programatically.
3504 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3507 * @ingroup G_nonstandalone_wims
3509 * Reference resources from other WIM files or split WIM parts. This function
3510 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3511 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3512 * from other files, before calling a function such as wimlib_extract_image()
3513 * that requires the resources to be present.
3516 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3517 * necessarily "standalone". In the case of split WIMs, this should be the
3518 * first part, since only the first part contains the metadata resources.
3519 * In the case of delta WIMs, this should be the delta WIM rather than the
3520 * WIM on which it is based.
3521 * @param resource_wimfiles_or_globs
3522 * Array of paths to WIM files and/or split WIM parts to reference.
3523 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3524 * ref_flags, these are treated as globs rather than literal paths. That
3525 * is, using this function you can specify zero or more globs, each of
3526 * which expands to one or more literal paths.
3528 * Number of entries in @p resource_wimfiles_or_globs.
3530 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3531 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3533 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3534 * pass to internal calls to wimlib_open_wim() on the reference files.
3536 * @return 0 on success; nonzero on error.
3538 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3539 * One of the specified globs did not match any paths (only with both
3540 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3541 * specified in @p ref_flags).
3542 * @retval ::WIMLIB_ERR_NOMEM
3543 * Failed to allocate memory.
3544 * @retval ::WIMLIB_ERR_READ
3545 * I/O or permissions error while processing a file glob.
3547 * This function can additionally return most values that can be returned by
3548 * wimlib_open_wim().
3551 wimlib_reference_resource_files(WIMStruct *wim,
3552 const wimlib_tchar * const *resource_wimfiles_or_globs,
3558 * @ingroup G_nonstandalone_wims
3560 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3561 * where the caller must open the ::WIMStruct for each referenced file itself.
3564 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3565 * necessarily "standalone". In the case of split WIMs, this should be the
3566 * first part, since only the first part contains the metadata resources.
3567 * @param resource_wims
3568 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3569 * split WIM parts to reference.
3570 * @param num_resource_wims
3571 * Number of entries in @p resource_wims.
3573 * Currently ignored (set to 0).
3575 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3576 * @p resource_wims are referenced internally by @p wim and must not be freed
3577 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3578 * been freed with wimlib_free(), or immediately before freeing @p wim with
3581 * @retval ::WIMLIB_ERR_INVALID_PARAM
3582 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3583 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3584 * @retval ::WIMLIB_ERR_NOMEM
3585 * Failed to allocate memory.
3588 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3589 unsigned num_resource_wims, int ref_flags);
3592 * @ingroup G_modifying_wims
3594 * Declares that a newly added image is mostly the same as a prior image, but
3595 * captured at a later point in time, possibly with some modifications in the
3596 * intervening time. This is designed to be used in incremental backups of the
3597 * same filesystem or directory tree.
3599 * This function compares the metadata of the directory tree of the newly added
3600 * image against that of the old image. Any files that are present in both the
3601 * newly added image and the old image and have timestamps that indicate they
3602 * haven't been modified are deemed not to have been modified and have their
3603 * SHA1 message digest copied from the old image. Because of this and because
3604 * WIM uses single-instance streams, such files need not be read from the
3605 * filesystem when the WIM is being written or overwritten. Note that these
3606 * unchanged files will still be "archived" and will be logically present in the
3607 * new image; the optimization is that they don't need to actually be read from
3608 * the filesystem because the WIM already contains them.
3610 * This function is provided to optimize incremental backups. The resulting WIM
3611 * file will still be the same regardless of whether this function is called.
3612 * (This is, however, assuming that timestamps have not been manipulated or
3613 * unmaintained as to trick this function into thinking a file has not been
3614 * modified when really it has. To partly guard against such cases, other
3615 * metadata such as file sizes will be checked as well.)
3617 * This function must be called after adding the new image (e.g. with
3618 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3619 * wimlib_overwrite()).
3622 * Pointer to the ::WIMStruct for a WIM.
3624 * 1-based index in the WIM of the newly added image. This image can have
3625 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3626 * wimlib_add_empty_image() followed by wimlib_update_image().
3627 * @param template_wim
3628 * The ::WIMStruct for the WIM containing the template image. This can be
3629 * the same as @p wim, or it can be a different ::WIMStruct.
3630 * @param template_image
3631 * 1-based index in the WIM of a template image that reflects a prior state
3632 * of the directory tree being captured.
3634 * Reserved; must be 0.
3636 * @return 0 on success; nonzero on error.
3638 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3639 * @p new_image and/or @p template_image were not a valid image indices in
3641 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3642 * The specified ::WIMStruct did not actually contain the metadata resource
3643 * for the new or template image; for example, it was a non-first part of a
3645 * @retval ::WIMLIB_ERR_NOMEM
3646 * Failed to allocate needed memory.
3647 * @retval ::WIMLIB_ERR_INVALID_PARAM
3648 * @p new_image was equal to @p template_image, or @p new_image specified
3649 * an image that had not been modified since opening the WIM.
3651 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3652 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3653 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3654 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3655 * different reasons) to read the metadata resource for the template image.
3658 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3659 WIMStruct *template_wim, int template_image,
3663 * @ingroup G_general
3665 * Registers a progress function with a ::WIMStruct.
3668 * The ::WIMStruct for which to register the progress function.
3670 * Pointer to the progress function to register. If the WIM already has a
3671 * progress function registered, it will be replaced with this one. If @p
3672 * NULL, the current progress function (if any) will be unregistered.
3674 * The value which will be passed as the third argument to calls to @p
3678 wimlib_register_progress_function(WIMStruct *wim,
3679 wimlib_progress_func_t progfunc,
3683 * @ingroup G_modifying_wims
3685 * Rename the @p source_path to the @p dest_path in the specified @p image of
3688 * This just builds an appropriate ::wimlib_rename_command and passes it to
3689 * wimlib_update_image().
3692 wimlib_rename_path(WIMStruct *wim, int image,
3693 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3696 * @ingroup G_wim_information
3698 * Translates a string specifying the name or number of an image in the WIM into
3699 * the number of the image. The images are numbered starting at 1.
3702 * Pointer to the ::WIMStruct for a WIM.
3703 * @param image_name_or_num
3704 * A string specifying the name or number of an image in the WIM. If it
3705 * parses to a positive integer, this integer is taken to specify the
3706 * number of the image, indexed starting at 1. Otherwise, it is taken to
3707 * be the name of an image, as given in the XML data for the WIM file. It
3708 * also may be the keyword "all" or the string "*", both of which will
3709 * resolve to ::WIMLIB_ALL_IMAGES.
3711 * There is no way to search for an image actually named "all", "*", or an
3712 * integer number, or an image that has no name. However, you can use
3713 * wimlib_get_image_name() to get the name of any image.
3716 * If the string resolved to a single existing image, the number of that
3717 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3718 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3719 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3720 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3721 * images in @p wim has no name.
3724 wimlib_resolve_image(WIMStruct *wim,
3725 const wimlib_tchar *image_name_or_num);
3728 * @ingroup G_general
3730 * Sets the file to which the library will print error and warning messages.
3732 * This version of the function takes a C library <c>FILE *</c> opened for
3733 * writing (or appending). Use wimlib_set_error_file_by_name() to specify the
3734 * file by name instead.
3736 * This also enables error messages, as if by a call to
3737 * wimlib_set_print_errors(true).
3739 * @return 0 on success; nonzero on error.
3740 * @retval ::WIMLIB_ERR_UNSUPPORTED
3741 * wimlib was compiled using the <c>--without-error-messages</c> option.
3744 wimlib_set_error_file(FILE *fp);
3747 * @ingroup G_general
3749 * Sets the path to the file to which the library will print error and warning
3750 * messages. The library will open this file for appending.
3752 * This also enables error messages, as if by a call to
3753 * wimlib_set_print_errors(true).
3755 * @return 0 on success; nonzero on error.
3756 * @retval ::WIMLIB_ERR_OPEN
3757 * The file named by @p path could not be opened for appending.
3758 * @retval ::WIMLIB_ERR_UNSUPPORTED
3759 * wimlib was compiled using the <c>--without-error-messages</c> option.
3762 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3765 * @ingroup G_modifying_wims
3767 * Changes the description of an image in the WIM.
3770 * Pointer to the ::WIMStruct for a WIM.
3772 * The number of the image for which to change the description.
3773 * @param description
3774 * The new description to give the image. It may be @c NULL, which
3775 * indicates that the image is to be given no description.
3777 * @return 0 on success; nonzero on error.
3778 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3779 * @p image does not specify a single existing image in @p wim.
3780 * @retval ::WIMLIB_ERR_NOMEM
3781 * Failed to allocate the memory needed to duplicate the @p description
3783 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3784 * @p wim is considered read-only because of any of the reasons mentioned
3785 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3788 wimlib_set_image_descripton(WIMStruct *wim, int image,
3789 const wimlib_tchar *description);
3792 * @ingroup G_writing_and_overwriting_wims
3794 * Set the compression chunk size of a WIM to use in subsequent calls to
3795 * wimlib_write() or wimlib_overwrite().
3797 * A larger compression chunk size will likely result in a better compression
3798 * ratio, but the speed of random access to the WIM will be reduced.
3799 * Furthermore, the effect of a larger compression chunk size is limited by the
3800 * size of each stream ("file") being compressed.
3803 * ::WIMStruct for a WIM.
3805 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3806 * on the compression format. See the documentation for each
3807 * ::wimlib_compression_type constant for more information. As a special
3808 * case, if @p chunk_size is specified as 0, the chunk size is set to the
3809 * default for the currently selected output compression type.
3811 * @return 0 on success; nonzero on error.
3813 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3814 * @p chunk_size is not a supported chunk size for the currently selected
3815 * output compression type.
3818 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3821 * @ingroup G_writing_and_overwriting_wims
3823 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3824 * packed streams (solid blocks).
3827 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3830 * @ingroup G_writing_and_overwriting_wims
3832 * Set the compression type of a WIM to use in subsequent calls to
3833 * wimlib_write() or wimlib_overwrite().
3836 * ::WIMStruct for a WIM.
3838 * The compression type to set (one of ::wimlib_compression_type). If this
3839 * compression type is incompatible with the current output chunk size
3840 * (either the default or as set with wimlib_set_output_chunk_size()), the
3841 * output chunk size is reset to the default for that compression type.
3843 * @return 0 on success; nonzero on error.
3845 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3846 * @p ctype did not specify a valid compression type.
3849 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3852 * @ingroup G_writing_and_overwriting_wims
3854 * Similar to wimlib_set_output_compression_type(), but set the compression type
3855 * for writing packed streams (solid blocks).
3858 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3861 * @ingroup G_modifying_wims
3863 * Set basic information about a WIM.
3866 * Pointer to the ::WIMStruct for a WIM.
3868 * A struct ::wimlib_wim_info that contains the information to set. Only
3869 * the information explicitly specified in the @p which flags need be
3872 * Flags that specify which information to set. This is a bitwise OR of
3873 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3874 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3876 * @return 0 on success; nonzero on failure.
3877 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3878 * The WIM file is considered read-only because of any of the reasons
3879 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3880 * flag. However, as a special case, if you are using
3881 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3882 * function will not fail due to the readonly flag being previously set.
3883 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3884 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3885 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3889 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3893 * @ingroup G_modifying_wims
3895 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3896 * (something like "Core" or "Ultimate")
3899 * Pointer to the ::WIMStruct for a WIM.
3901 * The number of the image for which to change the description.
3903 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3904 * indicates that the image is to be given no \<FLAGS\> element.
3906 * @return 0 on success; nonzero on error.
3907 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3908 * @p image does not specify a single existing image in @p wim.
3909 * @retval ::WIMLIB_ERR_NOMEM
3910 * Failed to allocate the memory needed to duplicate the @p flags string.
3911 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3912 * @p wim is considered read-only because of any of the reasons mentioned
3913 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3916 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3919 * @ingroup G_modifying_wims
3921 * Changes the name of an image in the WIM.
3924 * Pointer to the ::WIMStruct for a WIM.
3926 * The number of the image for which to change the name.
3928 * New name to give the new image. If @c NULL or empty, the new image is
3929 * given no name. If nonempty, it must specify a name that does not
3930 * already exist in @p wim.
3932 * @return 0 on success; nonzero on error.
3933 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3934 * There is already an image named @p name in @p wim.
3935 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3936 * @p image does not specify a single existing image in @p wim.
3937 * @retval ::WIMLIB_ERR_NOMEM
3938 * Failed to allocate the memory needed to duplicate the @p name string.
3939 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3940 * @p wim is considered read-only because of any of the reasons mentioned
3941 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3944 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3947 * @ingroup G_general
3949 * Set the functions that wimlib uses to allocate and free memory.
3951 * These settings are global and not per-WIM.
3953 * The default is to use the default @c malloc() and @c free() from the C
3956 * Please note that some external functions, such as those in @c libntfs-3g, may
3957 * use the standard memory allocation functions regardless of this setting.
3959 * @param malloc_func
3960 * A function equivalent to @c malloc() that wimlib will use to allocate
3961 * memory. If @c NULL, the allocator function is set back to the default
3962 * @c malloc() from the C library.
3964 * A function equivalent to @c free() that wimlib will use to free memory.
3965 * If @c NULL, the free function is set back to the default @c free() from
3967 * @param realloc_func
3968 * A function equivalent to @c realloc() that wimlib will use to reallocate
3969 * memory. If @c NULL, the free function is set back to the default @c
3970 * realloc() from the C library.
3974 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3975 void (*free_func)(void *),
3976 void *(*realloc_func)(void *, size_t));
3979 * @ingroup G_general
3981 * Sets whether wimlib is to print error messages to @c stderr when a function
3982 * fails. These error messages may provide information that cannot be
3983 * determined only from the error code that is returned. Not every error will
3984 * result in an error message being printed.
3986 * This setting is global and not per-WIM.
3988 * By default, error messages are not printed.
3990 * This can be called before wimlib_global_init().
3992 * @param show_messages
3993 * @c true if error messages are to be printed; @c false if error messages
3994 * are not to be printed.
3996 * @return 0 on success; nonzero on error.
3997 * @retval ::WIMLIB_ERR_UNSUPPORTED
3998 * @p show_messages was @c true, but wimlib was compiled with the @c
3999 * --without-error-messages option. Therefore, error messages cannot be
4003 wimlib_set_print_errors(bool show_messages);
4006 * @ingroup G_nonstandalone_wims
4008 * Splits a WIM into multiple parts.
4011 * The ::WIMStruct for the WIM to split.
4013 * Name of the SWM file to create. This will be the name of the first
4014 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
4015 * appended before the suffix.
4017 * The maximum size per part, in bytes. Unfortunately, it is not
4018 * guaranteed that this will really be the maximum size per part, because
4019 * some file resources in the WIM may be larger than this size, and the WIM
4020 * file format provides no way to split up file resources among multiple
4022 * @param write_flags
4023 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
4024 * flags will be used to write each split WIM part. Specify 0 here to get
4025 * the default behavior.
4027 * @return 0 on success; nonzero on error. This function may return most error
4028 * codes that can be returned by wimlib_write() as well as the following error
4031 * @retval ::WIMLIB_ERR_INVALID_PARAM
4032 * @p swm_name was not a nonempty string, or @p part_size was 0.
4034 * If a progress function is registered with @p wim, for each split WIM part
4035 * that is written it will receive the messages
4036 * ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
4037 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART.
4040 wimlib_split(WIMStruct *wim,
4041 const wimlib_tchar *swm_name,
4046 * @ingroup G_general
4048 * Perform verification checks on a WIM file.
4051 * The ::WIMStruct for the WIM file to verify. Note: for an extra layer of
4052 * verification, it is a good idea to have used
4053 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY when you opened the file.
4055 * If verifying a split WIM, specify the first part of the split WIM here,
4056 * and reference the other parts using wimlib_reference_resource_files()
4057 * before calling this function.
4059 * @param verify_flags
4060 * Reserved; must be 0.
4062 * @retval 0 if the WIM file was successfully verified; nonzero if it failed
4063 * verification or another error occurred. Some of the possible error codes
4066 * @retval ::WIMLIB_ERR_DECOMPRESSION
4067 * A compressed resource could not be decompressed.
4068 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
4069 * The metadata resource for an image is invalid.
4070 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4071 * One of the files did not decompress to its original data, as given by a
4072 * cryptographic checksum.
4073 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4074 * One of the files referenced by an image could not be located.
4076 * If a progress function is registered with @p wim, it will receive the
4077 * following progress messages: ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE,
4078 * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE, and
4079 * ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.
4082 wimlib_verify_wim(WIMStruct *wim, int verify_flags);
4085 * @ingroup G_mounting_wim_images
4087 * Unmounts a WIM image that was mounted using wimlib_mount_image().
4089 * When unmounting a read-write mounted image, the default behavior is to
4090 * discard changes to the image. Use ::WIMLIB_UNMOUNT_FLAG_COMMIT to cause the
4091 * WIM image to be committed.
4094 * The directory the WIM image was mounted on.
4095 * @param unmount_flags
4096 * Bitwise OR of flags prefixed with @p WIMLIB_UNMOUNT_FLAG.
4098 * @return 0 on success; nonzero on error. The possible error codes include:
4100 * @retval ::WIMLIB_ERR_NOT_A_MOUNTPOINT
4101 * There is no WIM image mounted on the specified directory.
4102 * @retval ::WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY
4103 * The read-write mounted WIM image cannot be committed because there are
4104 * file descriptors open to it, and ::WIMLIB_UNMOUNT_FLAG_FORCE was not
4106 * @retval ::WIMLIB_ERR_MQUEUE
4107 * Could not create a POSIX message queue.
4108 * @retval ::WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT
4109 * The WIM image was mounted by a different user.
4110 * @retval ::WIMLIB_ERR_UNSUPPORTED
4111 * Mounting is not supported, either because the platform is Windows, or
4112 * because the platform is UNIX-like and wimlib was compiled using @c
4115 * Note: you can also unmount the image by using the @c umount() system call, or
4116 * by using the @c umount or @c fusermount programs. However, you need to call
4117 * this function if you want changes to be committed.
4120 wimlib_unmount_image(const wimlib_tchar *dir, int unmount_flags);
4123 * @ingroup G_mounting_wim_images
4125 * Same as wimlib_unmount_image(), but allows specifying a progress function.
4126 * If changes are committed from a read-write mount, the progress function will
4127 * receive ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages.
4130 wimlib_unmount_image_with_progress(const wimlib_tchar *dir,
4132 wimlib_progress_func_t progfunc,
4136 * @ingroup G_modifying_wims
4138 * Update a WIM image by adding, deleting, and/or renaming files or directories.
4141 * Pointer to the ::WIMStruct for the WIM file to update.
4143 * The 1-based index of the image in the WIM to update. It cannot be
4144 * ::WIMLIB_ALL_IMAGES.
4146 * An array of ::wimlib_update_command's that specify the update operations
4149 * Number of commands in @p cmds.
4150 * @param update_flags
4151 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
4153 * @return 0 on success; nonzero on error. On failure, all update commands will
4154 * be rolled back, and no visible changes shall have been made to @p wim.
4155 * Possible error codes include:
4157 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
4158 * The capture configuration structure specified for an add command was
4160 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4161 * @p image did not specify a single, existing image in @p wim.
4162 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
4163 * Attempted to perform an add command that conflicted with previously
4164 * existing files in the WIM when an overlay was attempted.
4165 * @retval ::WIMLIB_ERR_INVALID_PARAM
4166 * An unknown operation type was specified in the update commands; or,
4167 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
4168 * in the @p add_flags, but the same image had previously already been
4169 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
4170 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
4171 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
4172 * specified in the @p add_flags for an add command in which @p
4173 * wim_target_path was not the root directory of the WIM image.
4174 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
4175 * (Windows only): While executing an add command, tried to capture a
4176 * reparse point with invalid data.
4177 * @retval ::WIMLIB_ERR_IS_DIRECTORY
4178 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
4179 * for a WIM path that corresponded to a directory; or, a rename command
4180 * attempted to rename a directory to a non-directory.
4181 * @retval ::WIMLIB_ERR_NOMEM
4182 * Failed to allocate needed memory.
4183 * @retval ::WIMLIB_ERR_NOTDIR
4184 * A rename command attempted to rename a directory to a non-directory; or,
4185 * an add command was executed that attempted to set the root of the WIM
4186 * image as a non-directory; or, a path component used as a directory in a
4187 * rename command was not, in fact, a directory.
4188 * @retval ::WIMLIB_ERR_NOTEMPTY
4189 * A rename command attempted to rename a directory to a non-empty
4191 * @retval ::WIMLIB_ERR_NTFS_3G
4192 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
4193 * error occurred while reading data from the NTFS volume using libntfs-3g.
4194 * @retval ::WIMLIB_ERR_OPEN
4195 * Failed to open a file to be captured while executing an add command.
4196 * @retval ::WIMLIB_ERR_OPENDIR
4197 * Failed to open a directory to be captured while executing an add command.
4198 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
4199 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
4200 * WIM path that did not exist; or, a rename command attempted to rename a
4201 * file that does not exist.
4202 * @retval ::WIMLIB_ERR_READ
4203 * While executing an add command, failed to read data from a file or
4204 * directory to be captured.
4205 * @retval ::WIMLIB_ERR_READLINK
4206 * While executing an add command, failed to read the target of a symbolic
4207 * link or junction point.
4208 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
4209 * (Windows only) Failed to perform a reparse point fixup because of
4210 * problems with the data of a reparse point.
4211 * @retval ::WIMLIB_ERR_STAT
4212 * While executing an add command, failed to get attributes for a file or
4214 * @retval ::WIMLIB_ERR_UNSUPPORTED
4215 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
4216 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
4217 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
4218 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
4219 * add_flags for an update command.
4220 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
4221 * While executing an add command, attempted to capture a file that was not
4222 * a supported file type (e.g. a device file). Only if
4223 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
4224 * for an update command.
4225 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4226 * The WIM file is considered read-only because of any of the reasons
4227 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
4230 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4231 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4232 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4233 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4234 * different reasons) to read the metadata resource for an image that needed to
4238 wimlib_update_image(WIMStruct *wim,
4240 const struct wimlib_update_command *cmds,
4245 * @ingroup G_writing_and_overwriting_wims
4247 * Writes a WIM to a file.
4249 * This brings in resources from any external locations, such as directory trees
4250 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
4251 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
4253 * By default, the new WIM file is written as stand-alone. Using the
4254 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
4255 * instead. However, this function cannot directly write a "split" WIM; use
4256 * wimlib_split() for that.
4259 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
4260 * changes made to it, which are then reflected in the output file.
4262 * The path to the file to write the WIM to.
4264 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
4265 * images are to be included in the new on-disk WIM file. If for some
4266 * reason you only want to include a single image, specify the index of
4267 * that image instead.
4268 * @param write_flags
4269 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
4270 * @param num_threads
4271 * Number of threads to use for compressing data. If 0, the number of
4272 * threads is taken to be the number of online processors. Note: if no
4273 * data compression needs to be done, no additional threads will be created
4274 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
4275 * exporting an image from a compressed WIM to another WIM of the same
4276 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
4279 * @return 0 on success; nonzero on error.
4281 * @retval ::WIMLIB_ERR_INVALID_IMAGE
4282 * @p image does not specify a single existing image in @p wim, and is not
4283 * ::WIMLIB_ALL_IMAGES.
4284 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
4285 * A file that had previously been scanned for inclusion in the WIM by
4286 * wimlib_add_image() was concurrently modified, so it failed the SHA1
4287 * message digest check.
4288 * @retval ::WIMLIB_ERR_INVALID_PARAM
4289 * @p path was @c NULL.
4290 * @retval ::WIMLIB_ERR_NOMEM
4291 * Failed to allocate needed memory.
4292 * @retval ::WIMLIB_ERR_OPEN
4293 * Failed to open @p path for writing, or some file resources in @p wim
4294 * refer to files in the outside filesystem, and one of these files could
4295 * not be opened for reading.
4296 * @retval ::WIMLIB_ERR_READ
4297 * An error occurred when trying to read data from the WIM file associated
4298 * with @p wim, or some file resources in @p wim refer to files in the
4299 * outside filesystem, and a read error occurred when reading one of these
4301 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
4302 * A stream that needed to be written could not be found in the stream
4303 * lookup table of @p wim. This error can occur if, for example, @p wim is
4304 * part of a split WIM but needed resources from the other split WIM parts
4305 * were not referenced with wimlib_reference_resources() or
4306 * wimlib_reference_resource_files() before the call to wimlib_write().
4307 * @retval ::WIMLIB_ERR_WRITE
4308 * An error occurred when trying to write data to the new WIM file.
4310 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4311 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4312 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4313 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4314 * different reasons) to read the metadata resource for an image that needed to
4317 * If a progress function is registered with @p wim, it will receive the
4318 * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
4319 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
4320 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
4323 wimlib_write(WIMStruct *wim,
4324 const wimlib_tchar *path,
4327 unsigned num_threads);
4330 * @ingroup G_writing_and_overwriting_wims
4332 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
4333 * file descriptor, which need not be seekable if the write is done in a special
4334 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
4335 * write_flags. This can, for example, allow capturing a WIM image and
4336 * streaming it over the network. See the documentation for
4337 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
4339 * The file descriptor @p fd will @b not be closed when the write is complete;
4340 * the calling code is responsible for this.
4342 * Returns 0 on success; nonzero on failure. The possible error codes include
4343 * those that can be returned by wimlib_write() as well as the following:
4345 * @retval ::WIMLIB_ERR_INVALID_PARAM
4346 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4347 * specified in @p write_flags.
4350 wimlib_write_to_fd(WIMStruct *wim,
4354 unsigned num_threads);
4357 * @defgroup G_compression Compression and decompression functions
4359 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
4360 * exported for convenience only, as they are already used by wimlib internally
4363 * These functions can be used for general-purpose lossless data compression,
4364 * but some limitations apply; for example, none of the compressors or
4365 * decompressors currently support sliding windows, and there also exist
4366 * slightly different variants of these formats that are not supported
4372 /** Opaque compressor handle. */
4373 struct wimlib_compressor;
4375 /** Opaque decompressor handle. */
4376 struct wimlib_decompressor;
4379 * Set the default compression level for the specified compression type. This
4380 * will affect both explicit and library-internal calls to
4381 * wimlib_create_compressor().
4384 * Compression type for which to set the default compression level, as one
4385 * of the ::wimlib_compression_type constants. Or, if this is the special
4386 * value -1, the default compression levels for all known compression types
4388 * @param compression_level
4389 * The default compression level to set. If 0, the "default default" level
4390 * is restored. Otherwise, a higher value indicates higher compression.
4391 * The values are scaled so that 10 is low compression, 50 is medium
4392 * compression, and 100 is high compression.
4394 * @return 0 on success; nonzero on error.
4396 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4397 * @p ctype was neither a supported compression type nor -1.
4400 wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
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 compression level. @p compression_level may be 0, in which case the
4406 * current default compression level for @p ctype is used. Returns 0 if the
4407 * compression type is invalid.
4410 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4411 size_t max_block_size,
4412 unsigned int compression_level);
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 compression_level
4426 * The compression level to use. If 0, the default compression level is
4427 * used. Otherwise, a higher value indicates higher compression. The
4428 * values are scaled so that 10 is low compression, 50 is medium
4429 * compression, and 100 is high compression.
4430 * @param compressor_ret
4431 * A location into which to return the pointer to the allocated compressor,
4432 * which can be used for any number of calls to wimlib_compress() before
4433 * being freed with wimlib_free_compressor().
4435 * @return 0 on success; nonzero on error.
4437 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4438 * @p ctype was not a supported compression type.
4439 * @retval ::WIMLIB_ERR_INVALID_PARAM
4440 * The compressor does not support the specified maximum block size.
4441 * @retval ::WIMLIB_ERR_NOMEM
4442 * Insufficient memory to allocate the compressor.
4445 wimlib_create_compressor(enum wimlib_compression_type ctype,
4446 size_t max_block_size,
4447 unsigned int compression_level,
4448 struct wimlib_compressor **compressor_ret);
4451 * Losslessly compress a block of data using a compressor previously created
4452 * with wimlib_create_compressor().
4454 * @param uncompressed_data
4455 * Buffer containing the data to compress.
4456 * @param uncompressed_size
4457 * Size, in bytes, of the data to compress.
4458 * @param compressed_data
4459 * Buffer into which to write the compressed data.
4460 * @param compressed_size_avail
4461 * Number of bytes available in @p compressed_data.
4463 * A compressor previously allocated with wimlib_create_compressor().
4466 * The size of the compressed data, in bytes, or 0 if the input data could
4467 * not be compressed to @p compressed_size_avail or fewer bytes.
4470 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4471 void *compressed_data, size_t compressed_size_avail,
4472 struct wimlib_compressor *compressor);
4475 * Free a compressor previously allocated with wimlib_create_compressor().
4478 * The compressor to free.
4481 wimlib_free_compressor(struct wimlib_compressor *compressor);
4484 * Allocate a decompressor for the specified compression type using the
4485 * specified parameters. This function is part of wimlib's compression API; it
4486 * is not necessary to call this to process a WIM file.
4489 * Compression type for which to create the decompressor.
4490 * @param max_block_size
4491 * Maximum block size to support. The exact meaning and allowed values for
4492 * this parameter depend on the compression type, but it at least specifies
4493 * the maximum allowed value for @p uncompressed_size to
4494 * wimlib_decompress().
4495 * @param decompressor_ret
4496 * A location into which to return the pointer to the allocated
4497 * decompressor, which can be used for any number of calls to
4498 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4500 * @return 0 on success; nonzero on error.
4502 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4503 * @p ctype was not a supported compression type.
4504 * @retval ::WIMLIB_ERR_INVALID_PARAM
4505 * @p decompressor_ret was @c NULL, or @p max_block_size is not valid for
4506 * the compression type.
4507 * @retval ::WIMLIB_ERR_NOMEM
4508 * Insufficient memory to allocate the decompressor.
4511 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4512 size_t max_block_size,
4513 struct wimlib_decompressor **decompressor_ret);
4516 * Decompress a block of data using a decompressor previously created with
4517 * wimlib_create_decompressor().
4519 * @param compressed_data
4520 * Buffer containing the data to decompress.
4521 * @param compressed_size
4522 * Size, in bytes, of the data to decompress.
4523 * @param uncompressed_data
4524 * Buffer into which to write the uncompressed data.
4525 * @param uncompressed_size
4526 * Size, in bytes, of the data when uncompressed.
4527 * @param decompressor
4528 * A decompressor previously allocated with wimlib_create_decompressor().
4530 * @return 0 on success; nonzero on error.
4533 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4534 void *uncompressed_data, size_t uncompressed_size,
4535 struct wimlib_decompressor *decompressor);
4538 * Free a decompressor previously allocated with wimlib_create_decompressor().
4540 * @param decompressor
4541 * The decompressor to free.
4544 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4556 #endif /* _WIMLIB_H */