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 * @section sec_intro Introduction
36 * This is the documentation for the library interface of wimlib 1.6.3, a C
37 * library for creating, modifying, extracting, and mounting files in the
38 * Windows Imaging Format. This documentation is intended for developers only.
39 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
40 * program, please see the README file or manual pages.
42 * @section sec_installing_and_compiling Installing and Compiling
44 * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
45 * install with <code>configure && make && sudo make install</code>; however,
46 * please see the README for more information about installing it.
48 * To use wimlib in your program after installing it, include wimlib.h and link
49 * your program with @c -lwim.
51 * As of wimlib 1.5.0, wimlib.h is also compatible with C++.
53 * Note: before calling any other function declared in wimlib.h,
54 * wimlib_global_init() can (and in some cases, must) be called. See its
55 * documentation for more details.
57 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
59 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
60 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
61 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
62 * which creates a new ::WIMStruct that initially contains no images and does
63 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
66 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
67 * Images can be extracted (or "applied") using wimlib_extract_image(), added
68 * (or "captured" or "appended") using wimlib_add_image(), deleted using
69 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
70 * modified using wimlib_update_image(). However, changes made to a WIM
71 * represented by a ::WIMStruct have no persistent effect until the WIM is
72 * actually written to an on-disk file. This can be done using wimlib_write(),
73 * but if the WIM was originally opened using wimlib_open_wim(), then
74 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
75 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
77 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
78 * files is a multi-step process. For example, to add, or "append" an image to
79 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
80 * append</b>, you must call the following functions:
82 * 1. wimlib_open_wim()
83 * 2. wimlib_add_image()
84 * 3. wimlib_overwrite()
86 * This design is very much on purpose as it makes the library more useful in
87 * general by allowing functions to be composed in different ways. For example,
88 * you can make multiple changes to a WIM and commit them all to the underlying
89 * file in only one overwrite operation, which is more efficient.
91 * @section sec_cleaning_up Cleaning up
93 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
94 * all resources associated with it. Also, when you are completely done with
95 * using wimlib in your program, you can call wimlib_global_cleanup() to free
96 * any other resources allocated by the library.
98 * @section sec_error_handling Error Handling
100 * Most functions in wimlib return 0 on success and a positive error code on
101 * failure. Use wimlib_get_error_string() to get a string that describes an
102 * error code. wimlib also can print error messages to standard error itself
103 * when an error happens, and these may be more informative than the error code;
104 * to enable this, call wimlib_set_print_errors(). Please note that this is for
105 * convenience only, and some errors can occur without a message being printed.
106 * Currently, error messages and strings (as well as all documentation, for that
107 * matter) are only available in English.
109 * @section sec_encodings Locales and character encodings
111 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
112 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
115 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
116 * and the encoding is UTF-16LE.
118 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
119 * and the encoding is the locale-dependent multibyte encoding. I recommend you
120 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
121 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
122 * call wimlib_global_init() after having set your desired locale.
124 * @section sec_advanced Additional information and features
127 * @subsection subsec_mounting_wim_images Mounting WIM images
129 * See @ref G_mounting_wim_images.
131 * @subsection subsec_progress_functions Progress Messages
133 * See @ref G_progress.
135 * @subsection subsec_non_standalone_wims Non-standalone WIMs
137 * See @ref G_nonstandalone_wims.
139 * @subsection subsec_pipable_wims Pipable WIMs
141 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
142 * compatible with Microsoft's software. To create a pipable WIM, call
143 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
144 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
145 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
146 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
147 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
148 * s using a seekable file descriptor using the regular function calls (e.g.
149 * wimlib_open_wim(), wimlib_extract_image()).
151 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
152 * capture</b> for more information about pipable WIMs.
154 * @subsection subsec_thread_safety Thread Safety
156 * wimlib is thread-safe, with the following exceptions:
157 * - Different threads cannot operate on the same ::WIMStruct at the same time;
158 * they must use different ::WIMStruct's.
159 * - You must call wimlib_global_init() in one thread before calling any other
161 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
162 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
163 * concurrently in the same process, will daemonize the entire process when it
164 * does so for the first time. This includes changing the working directory
165 * to the root directory.
167 * @subsection subsec_limitations Limitations
169 * This section documents some technical limitations of wimlib not already
170 * documented in the man page for @b wimlib-imagex.
172 * - The old WIM format from Vista pre-releases is not supported.
173 * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
174 * functionality other than that already present in @b ImageX, that allows you
175 * to make certain Windows-specific modifications to a Windows PE image, such
176 * as adding a driver or Windows component. Such a tool could be implemented
179 * @subsection more_info More information
181 * You are advised to read the README as well as the manual pages for
182 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
183 * the API documentation.
186 /** @defgroup G_general General
188 * @brief Declarations and structures shared across the library.
191 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
193 * @brief Create new WIMs and open existing WIMs.
196 /** @defgroup G_wim_information Retrieving WIM information and directory listings
198 * @brief Retrieve information about a WIM or WIM image.
201 /** @defgroup G_modifying_wims Modifying WIMs
203 * @brief Make changes to a WIM.
205 * @section sec_adding_images Capturing and adding WIM images
207 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
208 * appending an image to an existing WIM is a multi-step process, but at its
209 * core is wimlib_add_image() or an equivalent function. Normally,
210 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
211 * ::WIMStruct as a new image. However, when supported by the build of the
212 * library, there is also a special NTFS volume capture mode (entered when
213 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
214 * from an unmounted NTFS volume.
216 * Another function, wimlib_add_image_multisource() is also provided. It
217 * generalizes wimlib_add_image() to allow combining multiple files or directory
218 * trees into a single WIM image in a configurable way.
220 * For maximum customization of WIM image creation, it is also possible to add a
221 * completely empty WIM image with wimlib_add_empty_image(), then update it with
222 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
223 * wimlib_add_image_multisource() do internally.)
225 * Note that some details of how image addition/capture works are documented
226 * more fully in the manual page for <b>wimlib-imagex capture</b>.
228 * @section sec_deleting_images Deleting WIM images
230 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
231 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
232 * be made persistent in an on-disk WIM file.
234 * @section sec_exporting_images Exporting WIM images
236 * wimlib_export_image() can copy, or "export", an image from one WIM to
239 * @section sec_other_modifications Other modifications
241 * wimlib_update_image() can add, delete, and rename files in a WIM image.
243 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
244 * wimlib_set_image_flags() can change other image metadata.
246 * wimlib_set_wim_info() can change information about the WIM file itself, such
250 /** @defgroup G_extracting_wims Extracting WIMs
252 * @brief Extract files, directories, and images from a WIM.
254 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
255 * represented by a ::WIMStruct. This normally extracts the image to a
256 * directory, but when supported by the build of the library there is also a
257 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
258 * is specified) that allows extracting a WIM image directly to an unmounted
259 * NTFS volume. Various other flags allow further customization of image
262 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
263 * of (possibly wildcard) paths from a WIM image.
265 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
266 * over a pipe; see @ref subsec_pipable_wims.
268 * Some details of how WIM extraction works are documented more fully in the
269 * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
272 /** @defgroup G_mounting_wim_images Mounting WIM images
274 * @brief Mount and unmount WIM images.
276 * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
277 * mounting images from WIM files either read-only or read-write. To mount an
278 * image, call wimlib_mount_image(). To unmount an image, call
279 * wimlib_unmount_image(). Mounting can be done without root privileges because
280 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
281 * compiled with the <code>--without-fuse</code> flag, these functions will be
282 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED. Note that mounting an
283 * image read-write is an alternative to calling wimlib_update_image().
286 /** @defgroup G_progress Progress Messages
288 * @brief Track the progress of long WIM operations.
290 * When operating on large archives, operations such as extraction will
291 * naturally take a while to complete. Because of this and to improve the
292 * potential user-friendliness of library clients, a number of functions take a
293 * pointer to a progress function of type ::wimlib_progress_func_t. This
294 * function will be called periodically during the WIM operation(s) to report on
295 * the progress of the operation (for example, how many bytes have been written
299 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
301 * @brief Write and overwrite on-disk WIM files.
303 * As described in @ref sec_basic_wim_handling_concepts, these functions are
304 * critical to the design of the library as they allow new or modified WIMs to
305 * actually be written to on-disk files. Generally, wimlib_write() is the
306 * function you need to call to write a new WIM file, and wimlib_overwrite() is
307 * the function you need to call to persistently update an existing WIM file.
310 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
312 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
314 * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it
315 * than that. Normally, WIM files are "standalone". However, WIM files can
316 * also be arranged in non-standalone ways, such as a set of on-disk files that
317 * together form a single "split WIM" or "delta WIM". Such arrangements are
318 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
319 * created from one of these on-disk files initially only partially represents
320 * the full WIM and needs to, in effect, be logically combined with other
321 * ::WIMStruct's before performing certain operations, such as extracting files
322 * with wimlib_extract_image() or wimlib_extract_paths(). This is done by
323 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
325 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
326 * specialized function (wimlib_split()) is needed to create a split WIM.
335 #include <inttypes.h>
338 /** @ingroup G_general
341 /** Major version of the library (for example, the 1 in 1.2.5). */
342 #define WIMLIB_MAJOR_VERSION 1
344 /** Minor version of the library (for example, the 2 in 1.2.5). */
345 #define WIMLIB_MINOR_VERSION 6
347 /** Patch version of the library (for example, the 5 in 1.2.5). */
348 #define WIMLIB_PATCH_VERSION 3
355 /** @ingroup G_general
359 * Opaque structure that represents a WIM file. This is an in-memory structure
360 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
361 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
362 * continuing to exist so that data can be read from it as needed.
364 * Most functions in this library will work the same way regardless of whether a
365 * given ::WIMStruct was obtained through wimlib_open_wim() or
366 * wimlib_create_new_wim(). Exceptions are documented.
368 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
369 * file from a ::WIMStruct.
371 * See @ref sec_basic_wim_handling_concepts for more information.
373 #ifndef WIMLIB_WIMSTRUCT_DECLARED
374 typedef struct WIMStruct WIMStruct;
375 #define WIMLIB_WIMSTRUCT_DECLARED
379 typedef wchar_t wimlib_tchar;
381 /** See @ref sec_encodings */
382 typedef char wimlib_tchar;
386 /** Path separator for WIM paths passed back to progress callbacks. */
387 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
388 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
390 /** Path separator for WIM paths passed back to progress callbacks. */
391 # define WIMLIB_WIM_PATH_SEPARATOR '/'
392 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
395 /** Use this to specify the root directory of the WIM image. */
396 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
398 /** Use this to test if the specified path refers to the root directory of the
400 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
401 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR && \
405 # define _wimlib_deprecated __attribute__((deprecated))
407 # define _wimlib_deprecated
410 #define WIMLIB_GUID_LEN 16
413 * Specifies the compression type of a WIM file.
415 enum wimlib_compression_type {
416 /** An invalid compression type. */
417 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
419 /** The WIM does not include any compressed resources. */
420 WIMLIB_COMPRESSION_TYPE_NONE = 0,
422 /** Compressed resources in the WIM use XPRESS compression. */
423 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
425 /** Compressed resources in the WIM use LZX compression. */
426 WIMLIB_COMPRESSION_TYPE_LZX = 2,
428 /** Compressed resources in the WIM use LZMS compression. Note: LZMS
429 * compression is only compatible with wimlib v1.6.0 and later and with
430 * WIMGAPI Windows 8 and later (and some restrictions apply on the
432 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
436 /** @ingroup G_progress
439 /** Possible values of the first parameter to the user-supplied
440 * ::wimlib_progress_func_t progress function */
441 enum wimlib_progress_msg {
443 /** A WIM image is about to be extracted. @p info will point to
444 * ::wimlib_progress_info.extract. This message is received once per
445 * image for calls to wimlib_extract_image() and
446 * wimlib_extract_image_from_pipe(). */
447 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
449 /** One or more file or directory trees within a WIM image is about to
450 * be extracted. @p info will point to ::wimlib_progress_info.extract.
451 * This message is received only once per wimlib_extract_paths() and
452 * wimlib_extract_pathlist(), since wimlib combines all paths into a
453 * single extraction operation for optimization purposes. */
454 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
456 /** File data is currently being extracted. @p info will point to
457 * ::wimlib_progress_info.extract. This is the main message to track
458 * the progress of an extraction operation. */
459 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
461 /** Starting to read a new part of a split pipable WIM over the pipe.
462 * @p info will point to ::wimlib_progress_info.extract. */
463 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
465 /** Confirms that the image has been successfully extracted. @p info
466 * will point to ::wimlib_progress_info.extract. This is paired with
467 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
468 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
470 /** Confirms that the files or directory trees have been successfully
471 * extracted. @p info will point to ::wimlib_progress_info.extract.
472 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
473 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
475 /** The directory or NTFS volume is about to be scanned for metadata.
476 * @p info will point to ::wimlib_progress_info.scan. This message is
477 * received once per call to wimlib_add_image(), or once per capture
478 * source passed to wimlib_add_image_multisource(), or once per add
479 * command passed to wimlib_update_image(). */
480 WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
482 /** A directory or file has been scanned. @p info will point to
483 * ::wimlib_progress_info.scan, and its @p cur_path member will be
484 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
486 WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
488 /** Confirms that the directory or NTFS volume has been successfully
489 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
490 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
491 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
493 WIMLIB_PROGRESS_MSG_SCAN_END = 11,
495 /** File resources ("streams") are currently being written to the WIM.
496 * @p info will point to ::wimlib_progress_info.write_streams. This
497 * message may be received many times while the WIM file is being
498 * written or appended to with wimlib_write(), wimlib_overwrite(), or
499 * wimlib_write_to_fd(). */
500 WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
502 /** Per-image metadata is about to be written to the WIM file. @p info
503 * will not be valid. */
504 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
506 /** Confirms that per-image metadata has been successfully been written
507 * to the WIM file. @p info will not be valid. This message is paired
508 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
510 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
512 /** wimlib_overwrite() has successfully renamed the temporary file to
513 * the original WIM file, thereby committing the update. @p info will
514 * point to ::wimlib_progress_info.rename. Note: this message is not
515 * received if wimlib_overwrite() chose to append to the WIM file
517 WIMLIB_PROGRESS_MSG_RENAME = 15,
519 /** The contents of the WIM file are being checked against the integrity
520 * table. @p info will point to ::wimlib_progress_info.integrity. This
521 * message is only received (and may be received many times) when
522 * wimlib_open_wim() is called with the
523 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
524 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
526 /** An integrity table is being calculated for the WIM being written.
527 * @p info will point to ::wimlib_progress_info.integrity. This message
528 * is only received (and may be received many times) when a WIM file is
529 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
530 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
532 /** A wimlib_split() operation is in progress, and a new split part is
533 * about to be started. @p info will point to
534 * ::wimlib_progress_info.split. */
535 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
537 /** A wimlib_split() operation is in progress, and a split part has been
538 * finished. @p info will point to ::wimlib_progress_info.split. */
539 WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
541 /** A WIM update command is just about to be executed. @p info will
542 * point to ::wimlib_progress_info.update. This message is received
543 * once per update command when wimlib_update_image() is called with the
544 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
545 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
547 /** A WIM update command has just been executed. @p info will point to
548 * ::wimlib_progress_info.update. This message is received once per
549 * update command when wimlib_update_image() is called with the flag
550 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
551 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
553 /** A file in the WIM image is being replaced as a result of a
554 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
555 * @p info will point to ::wimlib_progress_info.replace. This is only
556 * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
558 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
560 /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
561 * a file is being extracted normally (not as a WIMBoot "pointer file")
562 * due to it matching a pattern in the [PrepopulateList] section of the
563 * configuration file \Windows\System32\WimBootCompress.ini in the WIM
564 * image. @info will point to ::wimlib_progress_info.wimboot_exclude.
566 WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
569 /** A pointer to this union is passed to the user-supplied
570 * ::wimlib_progress_func_t progress function. One (or none) of the structures
571 * contained in this union will be applicable for the operation
572 * (::wimlib_progress_msg) indicated in the first argument to the progress
574 union wimlib_progress_info {
576 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
577 * document them if they aren't given a name... */
579 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
580 * the primary message for tracking the progress of writing a WIM file.
582 struct wimlib_progress_info_write_streams {
583 /** Total number of uncompressed bytes of stream data being
584 * written. This can be thought of as the total uncompressed
585 * size of the files being archived, with some caveats. WIM
586 * files use single-instance streams, so the size provided here
587 * only counts distinct streams, except for the following
588 * exception: the size provided here may include the sizes of
589 * all newly added (e.g. with wimlib_add_image() streams,
590 * pending automatic de-duplication during the write operation
591 * itself. When each such stream de-duplication occurs, this
592 * number will be decreased by the size of the duplicate stream
593 * that need not be written.
595 * In the case of a wimlib_overwrite() that the library opted to
596 * perform in-place, both @p total_streams and @p total_bytes
597 * will only count the streams actually being written and not
598 * pre-existing streams in the WIM file. */
599 uint64_t total_bytes;
601 /** Total number of streams being written. This can be thought
602 * of as the total number of files being archived, with some
603 * caveats. In general, a single file or directory may contain
604 * multiple data streams, each of which will be represented
605 * separately in this number. Furthermore, WIM files use
606 * single-instance streams, so the stream count provided here
607 * only counts distinct streams, except for the following
608 * exception: the stream count provided here may include newly
609 * added (e.g. with wimlib_add_image() streams, pending
610 * automatic de-duplication during the write operation itself.
611 * When each such stream de-duplication occurs, this number will
612 * be decreased by 1 to account for the duplicate stream that
613 * need not be written. */
614 uint64_t total_streams;
616 /** Number of uncompressed bytes of stream data that have been
617 * written so far. This number be 0 initially, and will be
618 * equal to @p total_bytes at the end of the write operation.
619 * Note that @p total_bytes (but not @p completed_bytes) may
620 * decrease throughout the write operation due to the discovery
621 * of stream duplications. */
622 uint64_t completed_bytes;
624 /** Number of streams that have been written so far. This
625 * number will be 0 initially, and will be equal to @p
626 * total_streams at the end of the write operation. Note that
627 * @p total_streams (but not @p completed_streams) may decrease
628 * throughout the write operation due to the discovery of stream
631 * For applications that wish to calculate a simple "percent
632 * complete" for the write operation, it will likely be more
633 * accurate to calculate the percentage from @p completed_bytes
634 * and @p total_bytes rather than @p completed_streams and
635 * @p total_streams because the time for the operation to
636 * complete is mainly determined by the number of bytes that
637 * need to be read, compressed, and written, not just the number
638 * of files being archived. */
639 uint64_t completed_streams;
641 /** Number of threads that are being used to compress streams,
642 * or 1 if streams are being written uncompressed. */
643 uint32_t num_threads;
645 /** The compression type being used to write the streams, as one
646 * of the ::wimlib_compression_type constants. */
647 int32_t compression_type;
649 /** Number of split WIM parts from which streams are being
650 * written (may be 0 if irrelevant). */
651 uint32_t total_parts;
653 /** This is currently broken and will always be 0. */
654 uint32_t completed_parts;
657 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
658 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
659 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
660 struct wimlib_progress_info_scan {
661 /** Top-level directory being scanned; or, when capturing an NTFS
662 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
663 * to the file or block device that contains the NTFS volume
665 const wimlib_tchar *source;
667 /** Path to the file (or directory) that has been scanned, valid
668 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing an NTFS
669 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
670 * relative to the root of the NTFS volume. */
671 const wimlib_tchar *cur_path;
673 /** Dentry scan status, valid on
674 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
676 /** The file looks okay and will be captured. */
677 WIMLIB_SCAN_DENTRY_OK = 0,
679 /** File is being excluded from capture due to the
680 * capture configuration. */
681 WIMLIB_SCAN_DENTRY_EXCLUDED,
683 /** File is being excluded from capture due to being
684 * unsupported (e.g. an encrypted or device file). */
685 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
687 /** The file is an absolute symbolic link or junction
688 * point and it is being excluded from capture because
689 * it points outside of the capture directory and
690 * reparse-point fixups are enabled. (Reparse point
691 * fixups can be disabled by using the flag
692 * ::WIMLIB_ADD_FLAG_NORPFIX.) */
693 WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
697 /** Target path in the WIM image. Only valid on
698 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
699 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
700 const wimlib_tchar *wim_target_path;
702 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
703 * of @p WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, this is
704 * the target of the absolute symbolic link or junction
706 const wimlib_tchar *symlink_target;
709 /** Number of directories scanned so far, including the root
710 * directory but excluding any unsupported/excluded directories.
712 * Details: On Windows and in NTFS capture mode, a reparse point
713 * counts as a directory if and only if it has
714 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
715 * counts as a directory if and only if when fully dereferenced
716 * it points to an accessible directory. If a file has multiple
717 * names (hard links), it is only counted one time. */
718 uint64_t num_dirs_scanned;
720 /** Number of non-directories scanned so far, excluding any
721 * unsupported/excluded files.
723 * Details: On Windows and in NTFS capture mode, a reparse point
724 * counts as a non-directory if and only if it does not have
725 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
726 * counts as a non-directory if and only if when fully
727 * dereferenced it points to a non-directory or its target is
728 * inaccessible. If a file has multiple names (hard links), it
729 * is only counted one time. */
730 uint64_t num_nondirs_scanned;
732 /** Number of bytes of file data that have been detected so far.
734 * Details: This data may not actually have been read yet, and
735 * it will not actually be written to the WIM file until
736 * wimlib_write() or wimlib_overwrite() has been called. Data
737 * from excluded files is not counted. This number includes
738 * default file contents as well as named data streams and
739 * reparse point data. The size of reparse point data is
740 * tallied after any reparse-point fixups, and in the case of
741 * capturing a symbolic link on a UNIX-like system, the creation
742 * of the reparse point data itself. If a file has multiple
743 * names (hard links), its size(s) are only counted one time.
744 * On Windows, encrypted files have their encrypted size
745 * counted, not their unencrypted size; however, compressed
746 * files have their uncompressed size counted. */
747 uint64_t num_bytes_scanned;
750 /** Valid on messages
751 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
752 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
753 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
754 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
755 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
756 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
758 * Note: most of the time of an extraction operation will be spent
759 * extracting streams, and the application will receive
760 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
761 * completed_bytes and @p total_bytes, the application can calculate a
762 * percentage complete. However, note that this message does not, in
763 * general, actually provide information about which "file" is currently
764 * being extracted. This is because wimlib, by default, extracts the
765 * individual data streams in whichever order it determines to be the
768 struct wimlib_progress_info_extract {
769 /** Number of the image from which files are being extracted
773 /** Extraction flags being used. */
774 uint32_t extract_flags;
776 /** Full path to the WIM file from which files are being
777 * extracted, or @c NULL if the WIMStruct has no associated
779 const wimlib_tchar *wimfile_name;
781 /** Name of the image from which files are being extracted, or
782 * the empty string if the image is unnamed. */
783 const wimlib_tchar *image_name;
785 /** Path to the directory or NTFS volume to which the files are
786 * being extracted. */
787 const wimlib_tchar *target;
790 const wimlib_tchar *reserved;
792 /** Number of bytes of uncompressed data that will be extracted.
793 * If a file has multiple names (hard links), its size (or
794 * sizes, in the case of named data streams) is only counted one
795 * time. For "reparse points" and symbolic links, the size to
796 * be extracted is the size of the reparse data buffer.
798 * This number will stay constant throughout the extraction. */
799 uint64_t total_bytes;
801 /** Number of bytes of uncompressed data that have been
802 * extracted so far. This initially be 0 and will equal to @p
803 * total_bytes at the end of the extraction. */
804 uint64_t completed_bytes;
806 /** Number of (not necessarily unique) streams that will be
807 * extracted. This may be more or less than the number of
808 * "files" to be extracted due to hard links as well as
809 * potentially multiple streams per file (named data streams).
810 * A "stream" may be the default contents of a file, a named
811 * data stream, or a reparse data buffer. */
812 uint64_t num_streams;
815 const wimlib_tchar *reserved_2;
817 /** Currently only used for
818 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
819 uint32_t part_number;
821 /** Currently only used for
822 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
823 uint32_t total_parts;
825 /** Currently only used for
826 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
827 uint8_t guid[WIMLIB_GUID_LEN];
830 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
831 struct wimlib_progress_info_rename {
832 /** Name of the temporary file that the WIM was written to. */
833 const wimlib_tchar *from;
835 /** Name of the original WIM file to which the temporary file is
837 const wimlib_tchar *to;
840 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
841 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
842 struct wimlib_progress_info_update {
843 /** Pointer to the update command that will be executed or has
844 * just been executed. */
845 const struct wimlib_update_command *command;
847 /** Number of update commands that have been completed so far.
849 size_t completed_commands;
851 /** Number of update commands that are being executed as part of
852 * this call to wimlib_update_image(). */
853 size_t total_commands;
856 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
857 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
858 struct wimlib_progress_info_integrity {
859 /** Number of bytes from the end of the WIM header to the end of
860 * the lookup table (the area that is covered by the SHA1
861 * integrity checks.) */
862 uint64_t total_bytes;
864 /** Number of bytes that have been SHA1-summed so far. Will be
865 * 0 initially, and equal @p total_bytes at the end. */
866 uint64_t completed_bytes;
868 /** Number of chunks that the checksummed region is divided
870 uint32_t total_chunks;
872 /** Number of chunks that have been SHA1-summed so far. Will
873 * be 0 initially, and equal to @p total_chunks at the end. */
874 uint32_t completed_chunks;
876 /** Size of the chunks used for the integrity calculation. */
879 /** Filename of the WIM (only valid if the message is
880 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
881 const wimlib_tchar *filename;
884 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
885 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
886 struct wimlib_progress_info_split {
887 /** Total size of the original WIM's file and metadata resources
889 uint64_t total_bytes;
891 /** Number of bytes of file and metadata resources that have
892 * been copied out of the original WIM so far. Will be 0
893 * initially, and equal to @p total_bytes at the end. */
894 uint64_t completed_bytes;
896 /** Number of the split WIM part that is about to be started
897 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
898 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
899 unsigned cur_part_number;
901 /** Total number of split WIM parts that are being written. */
902 unsigned total_parts;
904 /** Name of the split WIM part that is about to be started
905 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
906 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
907 const wimlib_tchar *part_name;
910 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
911 struct wimlib_progress_info_replace {
912 /** Path to the file in the WIM image that is being replaced */
913 const wimlib_tchar *path_in_wim;
916 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE */
917 struct wimlib_progress_info_wimboot_exclude {
918 /** Path to the file in the WIM image */
919 const wimlib_tchar *path_in_wim;
921 /** Path to which the file is being extracted */
922 const wimlib_tchar *extraction_path;
926 /** A user-supplied function that will be called periodically during certain WIM
927 * operations. The first argument will be the type of operation that is being
928 * performed or is about to be started or has been completed. The second
929 * argument will be a pointer to one of a number of structures depending on the
930 * first argument. It may be @c NULL for some message types.
932 * The return value of the progress function is currently ignored, but it may do
933 * something in the future. (Set it to 0 for now.)
935 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
936 const union wimlib_progress_info *info);
939 /** @ingroup G_modifying_wims
942 /** An array of these structures is passed to wimlib_add_image_multisource() to
943 * specify the sources from which to create a WIM image. */
944 struct wimlib_capture_source {
945 /** Absolute or relative path to a file or directory on the external
946 * filesystem to be included in the WIM image. */
947 wimlib_tchar *fs_source_path;
949 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
950 * specify the root directory of the WIM image. */
951 wimlib_tchar *wim_target_path;
953 /** Reserved; set to 0. */
957 /** Set or unset the WIM header flag that marks it read-only
958 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
959 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
960 * is distinct from basic file permissions; this flag can be set on a WIM file
961 * that is physically writable. If this flag is set, all further operations to
962 * modify the WIM will fail, except calling wimlib_overwrite() with
963 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
964 * allows you to set this flag persistently on the underlying WIM file.
966 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
968 /** Set the GUID (globally unique identifier) of the WIM file to the value
969 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
970 #define WIMLIB_CHANGE_GUID 0x00000002
972 /** Change the bootable image of the WIM to the value specified in
973 * ::wimlib_wim_info.boot_index of the @p info parameter. */
974 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
976 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
977 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
978 * indicates whether an image in the WIM has been captured with reparse-point
979 * fixups enabled. wimlib also treats this flag as specifying whether to do
980 * reparse-point fixups by default when capturing or applying WIM images. */
981 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
984 /** @ingroup G_wim_information
987 /** General information about a WIM file. */
988 struct wimlib_wim_info {
990 /** Globally unique identifier for the WIM file. Note: all parts of a
991 * split WIM should have an identical value in this field. */
992 uint8_t guid[WIMLIB_GUID_LEN];
994 /** Number of images in the WIM. */
995 uint32_t image_count;
997 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1001 /** Version of the WIM file. */
1002 uint32_t wim_version;
1004 /** Chunk size used for compression. */
1005 uint32_t chunk_size;
1007 /** For split WIMs, the 1-based index of this part within the split WIM;
1009 uint16_t part_number;
1011 /** For split WIMs, the total number of parts in the split WIM;
1013 uint16_t total_parts;
1015 /** One of the ::wimlib_compression_type values that specifies the
1016 * method used to compress resources in the WIM. */
1017 int32_t compression_type;
1019 /** Size of the WIM file in bytes, excluding the XML data and integrity
1021 uint64_t total_bytes;
1023 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1024 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1025 * this will always be 0, even if the ::WIMStruct was written to
1026 * somewhere by calling wimlib_write() with the
1027 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1028 uint32_t has_integrity_table : 1;
1030 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1031 * wimlib_create_new_wim(). */
1032 uint32_t opened_from_file : 1;
1034 /** 1 if the WIM is considered readonly for any reason. */
1035 uint32_t is_readonly : 1;
1037 /** 1 if reparse-point fixups are supposedly enabled for one or more
1038 * images in the WIM. */
1039 uint32_t has_rpfix : 1;
1041 /** 1 if the WIM is marked as read-only. */
1042 uint32_t is_marked_readonly : 1;
1044 /** 1 if the WIM is part of a spanned set. */
1045 uint32_t spanned : 1;
1047 uint32_t write_in_progress : 1;
1048 uint32_t metadata_only : 1;
1049 uint32_t resource_only : 1;
1051 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1052 uint32_t pipable : 1;
1053 uint32_t reserved_flags : 22;
1054 uint32_t reserved[9];
1057 /** Information about a unique stream in the WIM file. (A stream is the same
1058 * thing as a "resource", except in the case of packed resources.) */
1059 struct wimlib_resource_entry {
1060 /** Uncompressed size of the stream in bytes. */
1061 uint64_t uncompressed_size;
1063 /** Compressed size of the stream in bytes. This will be the same as @p
1064 * uncompressed_size if the stream is uncompressed. Or, if @p
1065 * is_packed_streams is 1, this will be 0. */
1066 uint64_t compressed_size;
1068 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1069 * if @p packed is 1, then this is actually the offset at which this
1070 * stream begins in the uncompressed contents of the packed resource.
1074 /** SHA1 message digest of the stream's uncompressed contents. */
1075 uint8_t sha1_hash[20];
1077 /** Which part number of the split WIM this stream is in. This should
1078 * be the same as the part number provided by wimlib_get_wim_info(). */
1079 uint32_t part_number;
1081 /** Number of times this stream is referenced over all WIM images. */
1082 uint32_t reference_count;
1084 /** 1 if this stream is compressed. */
1085 uint32_t is_compressed : 1;
1087 /** 1 if this stream is a metadata resource rather than a file resource.
1089 uint32_t is_metadata : 1;
1091 uint32_t is_free : 1;
1092 uint32_t is_spanned : 1;
1094 /** 1 if this stream was not found in the lookup table of the
1095 * ::WIMStruct. This normally implies a missing call to
1096 * wimlib_reference_resource_files() or wimlib_reference_resources().
1098 uint32_t is_missing : 1;
1100 /** 1 if this stream is located in a packed resource which may contain
1101 * other streams (all compressed together) as well. */
1102 uint32_t packed : 1;
1104 uint32_t reserved_flags : 26;
1106 /** If @p packed is 1, then this will specify the offset of the packed
1107 * resource in the WIM. */
1108 uint64_t raw_resource_offset_in_wim;
1110 /** If @p is_packed_streams is 1, then this will specify the compressed
1111 * size of the packed resource in the WIM. */
1112 uint64_t raw_resource_compressed_size;
1114 uint64_t reserved[2];
1117 /** A stream of a file in the WIM. */
1118 struct wimlib_stream_entry {
1119 /** Name of the stream, or NULL if the stream is unnamed. */
1120 const wimlib_tchar *stream_name;
1121 /** Location, size, etc. of the stream within the WIM file. */
1122 struct wimlib_resource_entry resource;
1123 uint64_t reserved[4];
1126 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1127 * Roughly, the information about a "file" in the WIM--- but really a directory
1128 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1129 * field can be used to distinguish actual file inodes. */
1130 struct wimlib_dir_entry {
1131 /** Name of the file, or NULL if this file is unnamed (only possible for
1132 * the root directory) */
1133 const wimlib_tchar *filename;
1135 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1137 const wimlib_tchar *dos_name;
1139 /** Full path to this file within the WIM image. */
1140 const wimlib_tchar *full_path;
1142 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1143 * children, ..., etc. */
1146 /** Pointer to the security descriptor for this file, in Windows
1147 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1148 * security descriptor. */
1149 const char *security_descriptor;
1151 /** Length of the above security descriptor. */
1152 size_t security_descriptor_size;
1154 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1155 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1156 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1157 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1158 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1159 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1160 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1161 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1162 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1163 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1164 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1165 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1166 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1167 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1168 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1169 /** File attributes, such as whether the file is a directory or not.
1170 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1171 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1172 * on other platforms. */
1173 uint32_t attributes;
1175 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1176 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1177 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1178 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1179 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1180 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1181 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1182 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1183 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1184 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1185 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1186 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1187 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1188 * attributes), this will give the reparse tag. This tells you whether
1189 * the reparse point is a symbolic link, junction point, or some other,
1190 * more unusual kind of reparse point. */
1191 uint32_t reparse_tag;
1193 /* Number of (hard) links to this file. */
1196 /** Number of named data streams that this file has. Normally 0. */
1197 uint32_t num_named_streams;
1199 /** Roughly, the inode number of this file. However, it may be 0 if
1200 * @p num_links == 1. */
1201 uint64_t hard_link_group_id;
1203 /** Time this file was created. */
1204 struct timespec creation_time;
1206 /** Time this file was last written to. */
1207 struct timespec last_write_time;
1209 /** Time this file was last accessed. */
1210 struct timespec last_access_time;
1211 uint64_t reserved[16];
1213 /** Array of streams that make up this file. The first entry will
1214 * always exist and will correspond to the unnamed data stream (default
1215 * file contents), so it will have @p stream_name == @c NULL. There
1216 * will then be @p num_named_streams additional entries that specify the
1217 * named data streams, if any, each of which will have @p stream_name !=
1219 struct wimlib_stream_entry streams[];
1223 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1226 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1230 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1233 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1236 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1237 * just on the specified path. */
1238 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1240 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1241 * itself; only its children (in the case of a non-empty directory) */
1242 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1244 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1245 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1246 * table of the ::WIMStruct. The default behavior without this flag is to fill
1247 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1248 * wimlib_resource_entry::is_missing "is_missing" flag. */
1249 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1253 /** @ingroup G_modifying_wims
1256 /** Directly capture an NTFS volume rather than a generic directory. This flag
1257 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1258 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1259 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1261 /** Follow symlinks; archive and dump the files they point to. Currently only
1262 * supported on UNIX-like systems. */
1263 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1265 /** Call the progress function with the message
1266 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1268 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1270 /** Mark the image being added as the bootable image of the WIM. Not valid for
1271 * wimlib_update_image(). */
1272 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1274 /** Store the UNIX owner, group, and mode. This is done by adding a special
1275 * alternate data stream to each regular file, symbolic link, and directory to
1276 * contain this information. Please note that this flag is for convenience
1277 * only; Microsoft's implementation will not understand this special
1279 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1281 /** Do not capture security descriptors. Only has an effect in NTFS capture
1282 * mode, or in Windows native builds. */
1283 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1285 /** Fail immediately if the full security descriptor of any file or directory
1286 * cannot be accessed. Only has an effect in Windows native builds. The
1287 * default behavior without this flag is to first try omitting the SACL from the
1288 * security descriptor, then to try omitting the security descriptor entirely.
1290 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1292 /** Call the progress function with the message
1293 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1294 * capture. This is a subset of the messages provided by
1295 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1296 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1298 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1299 * in the case of Windows) that point inside the directory being captured to
1300 * instead be absolute relative to the directory being captured, rather than the
1301 * current root; also exclude absolute symbolic links that point outside the
1302 * directory tree being captured.
1304 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1305 * the WIM header or if this is the first image being added.
1306 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1307 * reparse point fixups enabled and currently cannot be unset. */
1308 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1310 /** Don't do reparse point fixups. The default behavior is described in the
1311 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1312 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1314 /** Do not automatically exclude unsupported files or directories from capture;
1315 * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1316 * UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1317 * such a file is encountered. */
1318 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1321 * Automatically select a capture configuration appropriate for capturing
1322 * filesystems containing Windows operating systems. For example,
1323 * "pagefile.sys" and "System Volume Information" will be excluded.
1325 * When this flag is specified, the corresponding @p config parameter or member
1328 * Note that the default behavior--- that is, when this flag is not specified
1329 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1330 * no files are excluded from capture.
1332 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1335 * Capture image as WIMBoot compatible. In addition, if no capture
1336 * configuration file is explicitly specified use the capture configuration file
1337 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1338 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1339 * configuration file is explicitly specified, use it and also place it at
1340 * /Windows/System32/WimBootCompress.ini in the WIM image.
1342 * Note: this will not by itself change the compression type. Before writing
1343 * the WIM file, it's recommended to also do:
1346 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1347 * wimlib_set_output_chunk_size(wim, 4096);
1350 * since that makes access to the data faster (at the cost of a worse
1351 * compression ratio compared to the 32768-byte LZX chunks usually used).
1353 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1356 * If the add command involves adding a non-directory file to a location at
1357 * which there already exists a nondirectory file in the WIM image, issue
1358 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1359 * effect when updating an existing image with wimlib_update_image().
1360 * This was the default behavior in wimlib v1.6.2 and earlier.
1362 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1364 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1365 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1366 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1367 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1368 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1369 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1370 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1371 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1372 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1373 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1374 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1375 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1376 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1377 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1381 /** @ingroup G_modifying_wims
1384 /** Do not issue an error if the path to delete does not exist. */
1385 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1387 /** Delete the file or directory tree recursively; if not specified, an error is
1388 * issued if the path to delete is a directory. */
1389 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1392 /** @ingroup G_modifying_wims
1396 * If a single image is being exported, mark it bootable in the destination WIM.
1397 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1398 * the image in the source WIM (if any) that is marked as bootable is also
1399 * marked as bootable in the destination WIM.
1401 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1403 /** Give the exported image(s) no names. Avoids problems with image name
1406 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1408 /** Give the exported image(s) no descriptions. */
1409 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1411 /** This advises the library that the program is finished with the source
1412 * WIMStruct and will not attempt to access it after the call to
1413 * wimlib_export_image(), with the exception of the call to wimlib_free(). */
1414 #define WIMLIB_EXPORT_FLAG_GIFT 0x00000008
1417 /** @ingroup G_extracting_wims
1420 /** Extract the image directly to an NTFS volume rather than a generic directory.
1421 * This mode is only available if wimlib was compiled with libntfs-3g support;
1422 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1423 * extraction target will be interpreted as the path to an NTFS volume image (as
1424 * a regular file or block device) rather than a directory. It will be opened
1425 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1426 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1427 * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1428 * wimlib_extract_paths() when passed multiple paths. */
1429 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1431 /** UNIX-like systems only: Extract special UNIX data captured with
1432 * ::WIMLIB_ADD_FLAG_UNIX_DATA. This flag cannot be combined with
1433 * ::WIMLIB_EXTRACT_FLAG_NTFS. */
1434 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1436 /** Do not extract security descriptors. This flag cannot be combined with
1437 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1438 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1440 /** Fail immediately if the full security descriptor of any file or directory
1441 * cannot be set exactly as specified in the WIM file. On Windows, the default
1442 * behavior without this flag when wimlib does not have permission to set the
1443 * correct security descriptor is to fall back to setting the security
1444 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1445 * owner omitted, then not at all. This flag cannot be combined with
1446 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1447 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1449 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1450 * reparse-point fixups on, so absolute symbolic links or junction points will
1451 * be fixed to be absolute relative to the actual extraction root. Reparse-
1452 * point fixups are done by default for wimlib_extract_image() and
1453 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1454 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1455 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1457 /** Force reparse-point fixups on extraction off, regardless of the state of the
1458 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1459 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1460 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1462 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Extract the
1463 * paths, each of which must name a regular file, to standard output. */
1464 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1466 /** Instead of ignoring files and directories with names that cannot be
1467 * represented on the current platform (note: Windows has more restrictions on
1468 * filenames than POSIX-compliant systems), try to replace characters or append
1469 * junk to the names so that they can be extracted in some form. */
1470 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1472 /** On Windows, when there exist two or more files with the same case
1473 * insensitive name but different case sensitive names, try to extract them all
1474 * by appending junk to the end of them, rather than arbitrarily extracting only
1476 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1478 /** Do not ignore failure to set timestamps on extracted files. */
1479 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1481 /** Do not ignore failure to set short names on extracted files. */
1482 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1484 /** On Windows, do not ignore failure to extract symbolic links and junctions
1485 * due to permissions problems. By default, such failures are ignored since the
1486 * default configuration of Windows only allows the Administrator to create
1487 * symbolic links. */
1488 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1490 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1491 * behavior is currently less than satisfactory. Do not use (yet). */
1492 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1494 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1495 * paths to extract as wildcard patterns ("globs") which may contain the
1496 * wildcard characters @c ? and @c *. The @c ? character matches any
1497 * non-path-separator character, whereas the @c * character matches zero or more
1498 * non-path-separator characters. Consequently, each glob may match zero or
1499 * more actual paths in the WIM image. By default, if a glob does not match any
1500 * files, a warning but not an error will be issued, even if the glob did not
1501 * actually contain wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1502 * to get an error instead. */
1503 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1505 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1506 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1507 * one of the provided globs did not match a file. */
1508 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1510 /** Do not extract Windows file attributes such as readonly, hidden, etc. */
1511 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1513 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1514 * preserve the directory structure of the archive when extracting --- that is,
1515 * place each extracted file or directory tree directly in the target directory.
1517 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1519 /** Windows only: Extract files as "pointers" back to the WIM archive. See the
1520 * documentation for the <b>--wimboot</b> option of <b>wimlib-imagex apply</b>
1521 * for more information. */
1522 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1525 /** @ingroup G_mounting_wim_images
1528 /** Mount the WIM image read-write rather than the default of read-only. */
1529 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1531 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1532 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1534 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1535 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1537 /** Access alternate data streams in the mounted WIM image through extended file
1538 * attributes. This is the default mode. */
1539 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1541 /** Access alternate data streams in the mounted WIM image by specifying the
1542 * file name, a colon, then the alternate file stream name. */
1543 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1545 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1546 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1547 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1549 /** Allow other users to see the mounted filesystem. (this passes the @c
1550 * allow_other option to FUSE mount) */
1551 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1554 /** @ingroup G_creating_and_opening_wims
1557 /** Verify the WIM contents against the WIM's integrity table, if present. This
1558 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1559 * checksummed and checked against the SHA1 message digests specified in the
1560 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1561 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1562 * integrity table is invalid). */
1563 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1565 /** Issue an error if the WIM is part of a split WIM. Software can provide
1566 * this flag for convenience if it explicitly does not want to support split
1568 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1570 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1571 * is not. A WIM is considered writable only if it is writable at the
1572 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1573 * header, and is not part of a spanned set. It is not required to provide this
1574 * flag before attempting to make changes to the WIM, but with this flag you get
1575 * an error sooner rather than later. */
1576 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1579 /** @ingroup G_mounting_wim_images
1582 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1583 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1585 /** Unless this flag is given, changes to a read-write mounted WIM are
1586 * discarded. Ignored for read-only mounts. */
1587 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1589 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1590 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1592 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1593 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1595 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1596 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1598 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1599 * image, causes the modified image to be committed as a new, unnamed image
1600 * appended to the archive. The original image will be unmodified. */
1601 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
1604 /** @ingroup G_modifying_wims
1607 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1608 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1609 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1612 /** @ingroup G_writing_and_overwriting_wims
1616 * Include an integrity table in the resulting WIM file.
1618 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1619 * include an integrity table if and only if one was present before. For
1620 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1621 * to not include an integrity table.
1623 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1626 * Do not include an integrity table in the resulting WIM file. This is the
1627 * default behavior, unless the ::WIMStruct was created by opening a WIM with an
1630 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1633 * Write the WIM as "pipable". After writing a WIM with this flag specified,
1634 * images from it can be applied directly from a pipe using
1635 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1636 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1637 * with this flag will not be compatible with Microsoft's software.
1639 * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
1640 * write the WIM as pipable if and only if it was pipable before. For
1641 * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
1642 * to write the WIM as non-pipable.
1644 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1647 * Do not write the WIM as "pipable". This is the default behavior, unless the
1648 * ::WIMStruct was created by opening a pipable WIM.
1650 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1653 * When writing streams to the WIM file, recompress them, even if their data is
1654 * already available in the desired compressed form (for example, in a WIM file
1655 * from which an image has been exported using wimlib_export_image()).
1657 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
1658 * compression ratio for the same compression type and chunk size. wimlib's LZX
1659 * compressor currently can be given different parameters in order to achieve
1660 * different balances between compression ratio and time. In its default mode
1661 * as of v1.5.3, it usually compresses slightly better than the competing
1662 * Microsoft implementation.
1664 * ::WIMLIB_WRITE_FLAG_RECOMPRESS can also be used in combination with
1665 * ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any solid blocks from being
1666 * re-used. (Otherwise, solid blocks are re-used somewhat more liberally than
1667 * normal compressed blocks.)
1669 * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
1670 * that would not otherwise be written. For example, a call to
1671 * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
1672 * cause already-existing streams in the WIM file to be recompressed. To force
1673 * the WIM file to be fully rebuilt and recompressed, combine
1674 * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
1676 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1679 * Immediately before closing the WIM file, sync its data to disk.
1681 * wimlib_overwrite() will set this flag automatically if it decides to
1682 * overwrite the WIM file via a temporary file instead of in-place.
1684 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1687 * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
1688 * could be updated merely be appending to it.
1690 * When rebuilding the WIM file, stream reference counts will be recomputed, and
1691 * any streams with 0 reference count (e.g. from deleted files or images) will
1692 * not be included in the resulting WIM file.
1694 * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
1695 * data to be recompressed. Otherwise, compressed data is re-used if possible.
1697 * wimlib_write() ignores this flag.
1699 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1702 * For wimlib_overwrite(), override the default behavior after one or more calls
1703 * to wimlib_delete_image(), which is to rebuild the entire WIM file. With this
1704 * flag, only minimal changes to correctly remove the image from the WIM file
1705 * will be taken. In particular, all streams will be retained, even if they are
1706 * no longer referenced. This may not be what you want, because no space will
1707 * be saved by deleting an image in this way.
1709 * wimlib_write() ignores this flag.
1711 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1714 * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
1715 * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header. This can be used
1716 * following a call to wimlib_set_wim_info() with the
1717 * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
1720 * wimlib_write() ignores this flag.
1722 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1725 * Do not include streams already present in other WIMs. This flag can be used
1726 * to write a "delta" WIM after resources from the WIM on which the delta is to
1727 * be based were referenced with wimlib_reference_resource_files() or
1728 * wimlib_reference_resources().
1730 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1733 * Advises the library that for writes of all WIM images, all streams needed for
1734 * the WIM are already present (not in external resource WIMs) and their
1735 * reference counts are correct, so the code does not need to recalculate which
1736 * streams are referenced. This is for optimization purposes only, since with
1737 * this flag specified, the metadata resources may not need to be decompressed
1740 * wimlib_overwrite() will set this flag automatically.
1742 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1745 * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
1747 * wimlib_overwrite() sets this by default, since the WIM remains, logically,
1750 #define WIMLIB_WRITE_FLAG_RETAIN_GUID 0x00000800
1753 * When writing streams in the resulting WIM file, pack multiple streams into a
1754 * single compressed resource instead of compressing them independently. This
1755 * is also known as creating a "solid archive". This tends to produce a better
1756 * compression ratio at the cost of much slower random access.
1758 * WIM files created with this flag are only compatible with wimlib v1.6.0 or
1759 * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later. WIM files
1760 * created with this flag use a different version number in their header (3584
1761 * instead of 68864) and are also called "ESD files".
1763 * If this flag is passed to wimlib_overwrite(), any new data streams will be
1764 * written in solid mode. Use both ::WIMLIB_WRITE_FLAG_REBUILD and
1765 * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
1766 * all streams recompressed in solid mode.
1768 * Currently, new solid blocks will, by default, be written using LZMS
1769 * compression with 32 MiB (33554432 byte) chunks. Use
1770 * wimlib_set_output_pack_compression_type() and/or
1771 * wimlib_set_output_pack_chunk_size() to change this. This is independent of
1772 * the WIM's main compression type and chunk size; you can have a WIM that
1773 * nominally uses LZX compression and 32768 byte chunks but actually contains
1774 * LZMS-compressed solid blocks, for example. However, if including solid
1775 * blocks, I suggest that you set the WIM's main compression type to LZMS as
1776 * well, either by creating the WIM with
1777 * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
1778 * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
1780 * This flag will be set by default when writing or overwriting a WIM file that
1781 * either already contains packed streams, or has had packed streams exported
1782 * into it and the WIM's main compression type is LZMS.
1784 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1787 /** @ingroup G_general
1790 /** Assume that strings are represented in UTF-8, even if this is not the
1791 * locale's character encoding. This flag is ignored on Windows, where wimlib
1792 * always uses UTF-16LE. */
1793 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1795 /** Windows-only: do not attempt to acquire additional privileges (currently
1796 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1797 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1798 * for the case where the calling program manages these privileges itself.
1799 * Note: no error is issued if privileges cannot be acquired, although related
1800 * errors may be reported later, depending on if the operations performed
1801 * actually require additional privileges or not. */
1802 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1804 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1805 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1806 * to read all possible data and metadata for a capture operation could not be
1807 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1809 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1811 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1812 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1813 * to restore all possible data and metadata for an apply operation could not be
1814 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1816 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1818 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
1820 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
1822 /** Default to interpreting WIM paths case insensitively (default on Windows).
1823 * This does not apply to mounted images. */
1824 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
1827 /** @ingroup G_nonstandalone_wims
1830 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
1831 * Ignored by wimlib_reference_resources(). */
1832 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1834 /** For wimlib_reference_resource_files(), issue an error
1835 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1836 * default behavior without this flag is to issue no error at that point, but
1837 * then attempt to open the glob as a literal path, which of course will fail
1838 * anyway if no file exists at that path. No effect if
1839 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
1840 * wimlib_reference_resources(). */
1841 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1844 /** @ingroup G_modifying_wims
1847 /** The specific type of update to perform. */
1848 enum wimlib_update_op {
1849 /** Add a new file or directory tree to the WIM image in a
1850 * certain location. */
1851 WIMLIB_UPDATE_OP_ADD = 0,
1853 /** Delete a file or directory tree from the WIM image. */
1854 WIMLIB_UPDATE_OP_DELETE,
1856 /** Rename a file or directory tree in the WIM image. */
1857 WIMLIB_UPDATE_OP_RENAME,
1860 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1861 struct wimlib_add_command {
1862 /** Filesystem path to the file or directory tree to add. */
1863 wimlib_tchar *fs_source_path;
1865 /** Destination path in the WIM image. Use ::WIMLIB_WIM_ROOT_PATH to
1866 * specify the root directory of the WIM image. */
1867 wimlib_tchar *wim_target_path;
1869 /** Path to capture configuration file to use, or @c NULL for default.
1871 wimlib_tchar *config_file;
1873 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1877 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1878 struct wimlib_delete_command {
1880 /** Path, specified from the root of the WIM image, for the file or
1881 * directory tree within the WIM image to be deleted. */
1882 wimlib_tchar *wim_path;
1884 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1888 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1889 struct wimlib_rename_command {
1891 /** Path, specified from the root of the WIM image, for the source file
1892 * or directory tree within the WIM image. */
1893 wimlib_tchar *wim_source_path;
1895 /** Path, specified from the root of the WIM image, for the destination
1896 * file or directory tree within the WIM image. */
1897 wimlib_tchar *wim_target_path;
1899 /** Reserved; set to 0. */
1903 /** Specification of an update to perform on a WIM image. */
1904 struct wimlib_update_command {
1906 enum wimlib_update_op op;
1909 struct wimlib_add_command add;
1910 struct wimlib_delete_command delete_; /* Underscore is for C++
1912 struct wimlib_rename_command rename;
1917 /** @ingroup G_general
1921 * Possible values of the error code returned by many functions in wimlib.
1923 * See the documentation for each wimlib function to see specifically what error
1924 * codes can be returned by a given function, and what they mean.
1926 enum wimlib_error_code {
1927 WIMLIB_ERR_SUCCESS = 0,
1928 WIMLIB_ERR_ALREADY_LOCKED,
1929 WIMLIB_ERR_DECOMPRESSION,
1930 WIMLIB_ERR_DELETE_STAGING_DIR,
1931 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1934 WIMLIB_ERR_FUSERMOUNT,
1935 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1936 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1937 WIMLIB_ERR_IMAGE_COUNT,
1938 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1939 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1940 WIMLIB_ERR_INTEGRITY,
1941 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1942 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1943 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1944 WIMLIB_ERR_INVALID_HEADER,
1945 WIMLIB_ERR_INVALID_IMAGE,
1946 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1947 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1948 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1949 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1950 WIMLIB_ERR_INVALID_OVERLAY,
1951 WIMLIB_ERR_INVALID_PARAM,
1952 WIMLIB_ERR_INVALID_PART_NUMBER,
1953 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1954 WIMLIB_ERR_INVALID_REPARSE_DATA,
1955 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1956 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1957 WIMLIB_ERR_INVALID_UTF16_STRING,
1958 WIMLIB_ERR_INVALID_UTF8_STRING,
1959 WIMLIB_ERR_IS_DIRECTORY,
1960 WIMLIB_ERR_IS_SPLIT_WIM,
1961 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1963 WIMLIB_ERR_METADATA_NOT_FOUND,
1968 WIMLIB_ERR_NOTEMPTY,
1969 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1970 WIMLIB_ERR_NOT_A_WIM_FILE,
1971 WIMLIB_ERR_NOT_PIPABLE,
1972 WIMLIB_ERR_NO_FILENAME,
1976 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1978 WIMLIB_ERR_READLINK,
1981 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1982 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1983 WIMLIB_ERR_RESOURCE_ORDER,
1984 WIMLIB_ERR_SET_ATTRIBUTES,
1985 WIMLIB_ERR_SET_REPARSE_DATA,
1986 WIMLIB_ERR_SET_SECURITY,
1987 WIMLIB_ERR_SET_SHORT_NAME,
1988 WIMLIB_ERR_SET_TIMESTAMPS,
1989 WIMLIB_ERR_SPLIT_INVALID,
1992 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1993 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1994 WIMLIB_ERR_UNKNOWN_VERSION,
1995 WIMLIB_ERR_UNSUPPORTED,
1996 WIMLIB_ERR_UNSUPPORTED_FILE,
1997 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1998 WIMLIB_ERR_WIM_IS_READONLY,
2001 WIMLIB_ERR_WIM_IS_ENCRYPTED,
2006 /** Used to indicate no WIM image or an invalid WIM image. */
2007 #define WIMLIB_NO_IMAGE 0
2009 /** Used to specify all images in the WIM. */
2010 #define WIMLIB_ALL_IMAGES (-1)
2015 * @ingroup G_modifying_wims
2017 * Appends an empty image to a WIM file. This empty image will initially
2018 * contain no files or directories, although if written without further
2019 * modifications, a root directory will be created automatically for it. After
2020 * calling this function, you can use wimlib_update_image() to add files to the
2021 * new WIM image. This gives you slightly more control over making the new
2022 * image compared to calling wimlib_add_image() or
2023 * wimlib_add_image_multisource() directly.
2026 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
2029 * Name to give the new image. If @c NULL or empty, the new image is given
2030 * no name. If nonempty, it must specify a name that does not already
2032 * @param new_idx_ret
2033 * If non-<code>NULL</code>, the index of the newly added image is returned
2036 * @return 0 on success; nonzero on failure. The possible error codes are:
2038 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2039 * There is already an image in @p wim named @p name.
2040 * @retval ::WIMLIB_ERR_NOMEM
2041 * Failed to allocate the memory needed to add the new image.
2042 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2043 * The WIM file is considered read-only because of any of the reasons
2044 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2048 wimlib_add_empty_image(WIMStruct *wim,
2049 const wimlib_tchar *name,
2053 * @ingroup G_modifying_wims
2055 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2057 * The directory tree or NTFS volume is scanned immediately to load the dentry
2058 * tree into memory, and file attributes and symbolic links are read. However,
2059 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2062 * See the manual page for the @b wimlib-imagex program for more information
2063 * about the "normal" capture mode versus the NTFS capture mode (entered by
2064 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2066 * Note that @b no changes are committed to the underlying WIM file (if
2067 * any) until wimlib_write() or wimlib_overwrite() is called.
2070 * Pointer to the ::WIMStruct for a WIM file to which the image will be
2073 * A path to a directory or unmounted NTFS volume that will be captured as
2076 * Name to give the new image. If @c NULL or empty, the new image is given
2077 * no name. If nonempty, it must specify a name that does not already
2079 * @param config_file
2080 * Path to capture configuration file, or @c NULL. This file may specify,
2081 * among other things, which files to exclude from capture. See the man
2082 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2083 * details of the file format. If @c NULL, the default capture
2084 * configuration shall be used. Ordinarily, the default capture
2085 * configuration will result in no files being excluded from capture purely
2086 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2087 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2089 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2090 * @param progress_func
2091 * If non-NULL, a function that will be called periodically with the
2092 * progress of the current operation. The progress messages that will be
2093 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
2094 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
2095 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2097 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2098 * discarded so that it appears to be in the same state as when this function
2101 * This function is implemented by calling wimlib_add_empty_image(), then
2102 * calling wimlib_update_image() with a single "add" command, so any error code
2103 * returned by wimlib_add_empty_image() may be returned, as well as any error
2104 * codes returned by wimlib_update_image() other than ones documented as only
2105 * being returned specifically by an update involving delete or rename commands.
2108 wimlib_add_image(WIMStruct *wim,
2109 const wimlib_tchar *source,
2110 const wimlib_tchar *name,
2111 const wimlib_tchar *config_file,
2113 wimlib_progress_func_t progress_func);
2116 * @ingroup G_modifying_wims
2118 * This function is equivalent to wimlib_add_image() except it allows for
2119 * multiple sources to be combined into a single WIM image. This is done by
2120 * specifying the @p sources and @p num_sources parameters instead of the @p
2121 * source parameter of wimlib_add_image(). The rest of the parameters are the
2122 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2123 * capture</b> for full details on how this mode works.
2125 * In addition to the error codes that wimlib_add_image() can return,
2126 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2127 * when trying to overlay a non-directory on a directory or when otherwise
2128 * trying to overlay multiple conflicting files to the same location in the WIM
2129 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2130 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2131 * was not exactly one capture source with the target being the root directory.
2132 * (In this respect, there is no advantage to using
2133 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2136 wimlib_add_image_multisource(WIMStruct *wim,
2137 const struct wimlib_capture_source *sources,
2139 const wimlib_tchar *name,
2140 const wimlib_tchar *config_file,
2142 wimlib_progress_func_t progress_func);
2145 * @ingroup G_modifying_wims
2147 * Add the file or directory tree at @p fs_source_path on the filesystem to the
2148 * location @p wim_target_path within the specified @p image of the @p wim.
2150 * This just builds an appropriate ::wimlib_add_command and passes it to
2151 * wimlib_update_image().
2154 wimlib_add_tree(WIMStruct *wim, int image,
2155 const wimlib_tchar *fs_source_path,
2156 const wimlib_tchar *wim_target_path, int add_flags);
2159 * @ingroup G_creating_and_opening_wims
2161 * Creates a ::WIMStruct for a new WIM file.
2163 * This only creates an in-memory structure for a WIM that initially contains no
2164 * images. No on-disk file is created until wimlib_write() is called.
2167 * The type of compression to be used in the new WIM file, as one of the
2168 * ::wimlib_compression_type constants.
2170 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2171 * written to the memory location pointed to by this paramater. The
2172 * ::WIMStruct must be freed using using wimlib_free() when finished with
2174 * @return 0 on success; nonzero on error.
2175 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2176 * @p ctype was not a supported compression type.
2177 * @retval ::WIMLIB_ERR_NOMEM
2178 * Failed to allocate needed memory.
2181 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2184 * @ingroup G_modifying_wims
2186 * Deletes an image, or all images, from a WIM file.
2188 * All streams referenced by the image(s) being deleted are removed from the
2189 * lookup table of the WIM if they are not referenced by any other images in the
2192 * Please note that @b no changes are committed to the underlying WIM file (if
2193 * any) until wimlib_write() or wimlib_overwrite() is called.
2196 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2199 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2201 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2202 * to be left unmodified only if @p image specified a single image. If instead
2203 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2204 * possible for some but not all of the images to have been deleted when a
2205 * failure status is returned.
2207 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2208 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2209 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2210 * The WIM file is considered read-only because of any of the reasons
2211 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2214 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2215 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2216 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2217 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2218 * different reasons) to read the metadata resource for an image that needed to
2222 wimlib_delete_image(WIMStruct *wim, int image);
2225 * @ingroup G_modifying_wims
2227 * Delete the @p path from the specified @p image of the @p wim.
2229 * This just builds an appropriate ::wimlib_delete_command and passes it to
2230 * wimlib_update_image().
2233 wimlib_delete_path(WIMStruct *wim, int image,
2234 const wimlib_tchar *path, int delete_flags);
2237 * @ingroup G_modifying_wims
2239 * Exports an image, or all the images, from a WIM file, into another WIM file.
2241 * The destination image is made to share the same dentry tree and security data
2242 * structure as the source image. This places some restrictions on additional
2243 * functions that may be called. wimlib_mount_image() may not be called on
2244 * either the source image or the destination image without an intervening call
2245 * to a function that un-shares the images, such as wimlib_free() on @p
2246 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2247 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2248 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2249 * have references back to @p src_wim.
2251 * If this function fails, all changes to @p dest_wim are rolled back.
2253 * Please note that no changes are committed to the underlying WIM file of @p
2254 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2257 * The WIM from which to export the images, specified as a pointer to the
2258 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2259 * split WIM. In the case of a WIM file that is not standalone, this
2260 * ::WIMStruct must have had any needed external resources previously
2261 * referenced using wimlib_reference_resources() or
2262 * wimlib_reference_resource_files().
2264 * The image to export from @p src_wim, as either a 1-based image index to
2265 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2267 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2270 * For single-image exports, the name to give the exported image in @p
2271 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2272 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2273 * that case, the names are all taken from @p src_wim. This parameter is
2274 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2275 * @param dest_description
2276 * For single-image exports, the description to give the exported image in
2277 * the new WIM file. If left @c NULL, the description from @p src_wim is
2278 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2279 * NULL; in that case, the description are all taken from @p src_wim. This
2280 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2281 * @param export_flags
2282 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2283 * @param progress_func
2284 * Currently ignored, but reserved for a function that will be called with
2285 * information about the operation. Use NULL if no additional information
2288 * @return 0 on success; nonzero on error.
2289 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2290 * One or more of the names being given to an exported image was already in
2291 * use in the destination WIM.
2292 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2293 * @p src_image does not exist in @p src_wim and was not
2294 * ::WIMLIB_ALL_IMAGES.
2295 * @retval ::WIMLIB_ERR_INVALID_PARAM
2296 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2297 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2299 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2300 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2301 * example, one of them was a non-first part of a split WIM.
2302 * @retval ::WIMLIB_ERR_NOMEM
2303 * Failed to allocate needed memory.
2304 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2305 * A resource that needed to be exported could not be found in either the
2306 * source or destination WIMs. This error can occur if, for example, @p
2307 * src_wim is part of a split WIM but needed resources from the other split
2308 * WIM parts were not referenced with wimlib_reference_resources() or
2309 * wimlib_reference_resource_files() before the call to
2310 * wimlib_export_image().
2311 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2312 * @p dest_wim is considered read-only because of any of the reasons
2313 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2316 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2317 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2318 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2319 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2320 * different reasons) to read the metadata resource for an image in @p src_wim
2321 * that needed to be exported.
2324 wimlib_export_image(WIMStruct *src_wim, int src_image,
2325 WIMStruct *dest_wim,
2326 const wimlib_tchar *dest_name,
2327 const wimlib_tchar *dest_description,
2329 wimlib_progress_func_t progress_func);
2333 * @ingroup G_extracting_wims
2335 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2338 * The exact behavior of how wimlib extracts files from a WIM image is
2339 * controllable by the @p extract_flags parameter, but there also are
2340 * differences depending on the platform (UNIX-like vs Windows). See the manual
2341 * page for <b>wimlib-imagex apply</b> for more information, including about the
2342 * special "NTFS volume extraction mode" entered by providing
2343 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2346 * The WIM from which to extract the image(s), specified as a pointer to
2347 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2348 * of a split WIM. In the case of a WIM file that is not standalone, this
2349 * ::WIMStruct must have had any needed external resources previously
2350 * referenced using wimlib_reference_resources() or
2351 * wimlib_reference_resource_files().
2353 * The image to extract, specified as either the 1-based index of a single
2354 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2355 * to be extracted. ::WIMLIB_ALL_IMAGES cannot be used if
2356 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2358 * Directory to extract the WIM image(s) to; or, with
2359 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2360 * the unmounted NTFS volume to which to extract the image.
2361 * @param extract_flags
2362 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2363 * @param progress_func
2364 * If non-NULL, a function that will be called periodically with the
2365 * progress of the current operation. The main message to look for is
2366 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2369 * @return 0 on success; nonzero on error.
2370 * @retval ::WIMLIB_ERR_DECOMPRESSION
2371 * Failed to decompress data contained in the WIM.
2372 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2373 * The metadata for one of the images to extract was invalid.
2374 * @retval ::WIMLIB_ERR_INVALID_PARAM
2375 * The extraction flags were invalid; more details may be found in the
2376 * documentation for the specific extraction flags that were specified. Or
2377 * @p target was @c NULL or the empty string, or @p wim was @c NULL.
2378 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2379 * The SHA1 message digest of an extracted stream did not match the SHA1
2380 * message digest given in the WIM.
2381 * @retval ::WIMLIB_ERR_LINK
2382 * Failed to create a symbolic link or a hard link.
2383 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2384 * The metadata resource for one of the images to extract was not found.
2385 * This can happen if @p wim represents a non-first part of a split WIM.
2386 * @retval ::WIMLIB_ERR_MKDIR
2387 * Failed create a directory.
2388 * @retval ::WIMLIB_ERR_NOMEM
2389 * Failed to allocate needed memory.
2390 * @retval ::WIMLIB_ERR_OPEN
2391 * Could not create a file, or failed to open an already-extracted file.
2392 * @retval ::WIMLIB_ERR_READ
2393 * Failed to read data from the WIM.
2394 * @retval ::WIMLIB_ERR_READLINK
2395 * Failed to determine the target of a symbolic link in the WIM.
2396 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2397 * Failed to fix the target of an absolute symbolic link (e.g. if the
2398 * target would have exceeded the maximum allowed length). (Only if
2399 * reparse data was supported by the extraction mode and
2400 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2402 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2403 * One of the files or directories that needed to be extracted referenced a
2404 * stream not present in the WIM's lookup table (or in any of the lookup
2405 * tables of the split WIM parts).
2406 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2407 * Failed to set attributes on a file.
2408 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2409 * Failed to set reparse data on a file (only if reparse data was supported
2410 * by the extraction mode).
2411 * @retval ::WIMLIB_ERR_SET_SECURITY
2412 * Failed to set security descriptor on a file
2413 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2415 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2416 * Failed to set the short name of a file (only if
2417 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2418 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2419 * Failed to set timestamps on a file (only if
2420 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2421 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2422 * Unexpected end-of-file occurred when reading data from the WIM.
2423 * @retval ::WIMLIB_ERR_UNSUPPORTED
2424 * A requested extraction flag, or the data or metadata that must be
2425 * extracted to support it, is unsupported in the build and configuration
2426 * of wimlib, or on the current platform or extraction mode or target
2427 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2428 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2429 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2430 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2431 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS. For example, if
2432 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2433 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2434 * image contains one or more files with short names, but extracting short
2435 * names is not supported --- on Windows, this occurs if the target volume
2436 * does not support short names, while on non-Windows, this occurs if
2437 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2438 * @retval ::WIMLIB_ERR_WIMBOOT
2439 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2440 * there was a problem creating WIMBoot pointer files.
2441 * @retval ::WIMLIB_ERR_WRITE
2442 * Failed to write data to a file being extracted.
2445 wimlib_extract_image(WIMStruct *wim, int image,
2446 const wimlib_tchar *target,
2448 wimlib_progress_func_t progress_func);
2451 * @ingroup G_extracting_wims
2453 * Since wimlib v1.5.0: Extract one image from a pipe on which a pipable WIM is
2456 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2457 * about pipable WIMs.
2459 * This function operates in a special way to read the WIM fully sequentially.
2460 * As a result, there is no ::WIMStruct is made visible to library users, and
2461 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2462 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2463 * seekable file, not a pipe.)
2466 * File descriptor, which may be a pipe, opened for reading and positioned
2467 * at the start of the pipable WIM.
2468 * @param image_num_or_name
2469 * String that specifies the 1-based index or name of the image to extract.
2470 * It is translated to an image index using the same rules that
2471 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2472 * only a single image (not all images) can be specified. Alternatively,
2473 * specify @p NULL here to use the first image in the WIM if it contains
2474 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2476 * Same as the corresponding parameter to wimlib_extract_image().
2477 * @param extract_flags
2478 * Same as the corresponding parameter to wimlib_extract_image().
2479 * @param progress_func
2480 * Same as the corresponding parameter to wimlib_extract_image(), except
2481 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2482 * received by the progress function.
2484 * @return 0 on success; nonzero on error. The possible error codes include
2485 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2488 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2489 * Data read from the pipable WIM was invalid.
2490 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2491 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2494 wimlib_extract_image_from_pipe(int pipe_fd,
2495 const wimlib_tchar *image_num_or_name,
2496 const wimlib_tchar *target, int extract_flags,
2497 wimlib_progress_func_t progress_func);
2500 * @ingroup G_extracting_wims
2502 * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to
2503 * extract from the WIM image are specified in the UTF-8 text file named by @p
2504 * path_list_file which itself contains the list of paths to use, one per line.
2505 * Leading and trailing whitespace, and otherwise empty lines and lines
2506 * beginning with the ';' character are ignored. No quotes are needed as paths
2507 * are otherwise delimited by the newline character.
2509 * The error codes are the same as those returned by wimlib_extract_paths(),
2510 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2511 * cannot read the path list file (::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2512 * ::WIMLIB_ERR_READ, ::WIMLIB_ERR_NOMEM, or ::WIMLIB_ERR_INVALID_UTF8_STRING).
2515 wimlib_extract_pathlist(WIMStruct *wim, int image,
2516 const wimlib_tchar *target,
2517 const wimlib_tchar *path_list_file,
2519 wimlib_progress_func_t progress_func);
2522 * @ingroup G_extracting_wims
2524 * Since wimlib v1.6.0: Extract zero or more paths (files or directory trees)
2525 * from the specified WIM image.
2527 * By default, each path will be extracted to a corresponding subdirectory of
2528 * the target based on its location in the WIM image. For example, if one of
2529 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2530 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2531 * can be changed by providing the flag
2532 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2533 * or directory tree to be placed directly in the target directory --- so the
2534 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2536 * Symbolic links will not be dereferenced when paths in the WIM image are
2540 * WIM from which to extract the paths, specified as a pointer to the
2541 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2542 * split WIM. In the case of a WIM file that is not standalone, this
2543 * ::WIMStruct must have had any needed external resources previously
2544 * referenced using wimlib_reference_resources() or
2545 * wimlib_reference_resource_files().
2547 * 1-based index of the WIM image from which to extract the paths.
2549 * Array of paths to extract. Each element must be the absolute path to a
2550 * file or directory within the WIM image. Separators may be either
2551 * forwards or backwards slashes, and leading path separators are optional.
2552 * The paths will be interpreted either case-sensitively (UNIX default) or
2553 * case-insensitively (Windows default); this can be changed by
2554 * wimlib_global_init().
2556 * By default, the characters @c * and @c ? are interpreted literally.
2557 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2560 * By default, if any paths to extract do not exist, the error code
2561 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2562 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2564 * Number of paths specified in @p paths.
2566 * Directory to which to extract the paths; or with
2567 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2568 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2569 * paths being extracted, the @p target must be native path. On UNIX-like
2570 * systems it may not contain backslashes, for example.
2571 * @param extract_flags
2572 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2573 * @param progress_func
2574 * If non-NULL, a function that will be called periodically with the
2575 * progress of the current operation. The main message to look for is
2576 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2577 * well. Note: because the extraction code is stream-based and not
2578 * file-based, there is no way to get information about which path is
2579 * currently being extracted, but based on byte count you can still
2580 * calculate an approximate percentage complete for the extraction overall
2581 * which may be all you really need anyway.
2583 * @return 0 on success; nonzero on error. Most of the error codes are the same
2584 * as those returned by wimlib_extract_image(). Below, some of the error codes
2585 * returned in situations specific to path-mode extraction are documented:
2587 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2588 * @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2590 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2591 * One of the paths to extract did not exist in the WIM image. This error
2592 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2593 * specified in @p extract_flags, or if both
2594 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2595 * were specified in @p extract_flags.
2596 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2597 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2598 * one of the paths to extract did not name a regular file.
2601 wimlib_extract_paths(WIMStruct *wim,
2603 const wimlib_tchar *target,
2604 const wimlib_tchar * const *paths,
2607 wimlib_progress_func_t progress_func);
2610 * @ingroup G_wim_information
2612 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2613 * includes a string of XML that describes the images contained in the WIM.
2615 * See wimlib_get_xml_data() to read the XML data into memory instead.
2618 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2619 * have to be standalone (e.g. it could be part of a split WIM).
2621 * @c stdout, or a FILE* opened for writing, to extract the data to.
2623 * @return 0 on success; nonzero on error.
2624 * @retval ::WIMLIB_ERR_INVALID_PARAM
2625 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2626 * @retval ::WIMLIB_ERR_NOMEM
2627 * @retval ::WIMLIB_ERR_READ
2628 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2629 * Failed to read the XML data from the WIM.
2630 * @retval ::WIMLIB_ERR_WRITE
2631 * Failed to completely write the XML data to @p fp.
2634 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2637 * @ingroup G_general
2639 * Frees all memory allocated for a WIMStruct and closes all files associated
2643 * Pointer to the ::WIMStruct for a WIM file.
2645 * @return This function has no return value.
2648 wimlib_free(WIMStruct *wim);
2651 * @ingroup G_general
2653 * Converts a ::wimlib_compression_type value into a string.
2656 * The ::wimlib_compression_type value to convert.
2659 * A statically allocated string naming the compression algorithm,
2660 * such as "None", "LZX", "XPRESS", or "Invalid".
2662 extern const wimlib_tchar *
2663 wimlib_get_compression_type_string(int ctype);
2666 * @ingroup G_general
2668 * Converts an error code into a string describing it.
2671 * The error code returned by one of wimlib's functions.
2674 * Pointer to a statically allocated string describing the error code,
2675 * or @c NULL if the error code is not valid.
2677 extern const wimlib_tchar *
2678 wimlib_get_error_string(enum wimlib_error_code code);
2681 * @ingroup G_wim_information
2683 * Returns the description of the specified image.
2686 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2687 * to be standalone (e.g. it could be part of a split WIM).
2689 * The number of the image, numbered starting at 1.
2692 * The description of the image, or @c NULL if there is no such image, or
2693 * @c NULL if the specified image has no description. The description
2694 * string is in library-internal memory and may not be modified or freed;
2695 * in addition, the string will become invalid if the description of the
2696 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2698 extern const wimlib_tchar *
2699 wimlib_get_image_description(const WIMStruct *wim, int image);
2702 * @ingroup G_wim_information
2704 * Returns the name of the specified image.
2707 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2708 * to be standalone (e.g. it could be part of a split WIM).
2710 * The number of the image, numbered starting at 1.
2713 * The name of the image, or @c NULL if there is no such image, or an empty
2714 * string if the image is unnamed. The name string is in
2715 * library-internal memory and may not be modified or freed; in addition,
2716 * the string will become invalid if the name of the image is changed, the
2717 * image is deleted, or the ::WIMStruct is destroyed.
2719 extern const wimlib_tchar *
2720 wimlib_get_image_name(const WIMStruct *wim, int image);
2723 * @ingroup G_general
2725 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2726 * the major version, the next 10 bits contain the minor version, and the low 10
2727 * bits contain the patch version.
2729 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2730 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2731 * corresponding header file.
2734 wimlib_get_version(void);
2737 * @ingroup G_wim_information
2739 * Get basic information about a WIM file.
2742 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2743 * to be standalone (e.g. it could be part of a split WIM).
2745 * A ::wimlib_wim_info structure that will be filled in with information
2746 * about the WIM file.
2751 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2754 * @ingroup G_wim_information
2756 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2757 * includes a string of XML that describes the images contained in the WIM.
2759 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2763 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2764 * have to be standalone (e.g. it could be part of a split WIM).
2766 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2767 * XML data is written to this location.
2768 * @param bufsize_ret
2769 * The size of the XML data in bytes is written to this location.
2771 * @return 0 on success; nonzero on error.
2772 * @retval ::WIMLIB_ERR_INVALID_PARAM
2773 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2774 * @p buf_ret or @p bufsize_ret was @c NULL.
2775 * @retval ::WIMLIB_ERR_NOMEM
2776 * @retval ::WIMLIB_ERR_READ
2777 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2778 * Failed to read the XML data from the WIM.
2781 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2784 * @ingroup G_general
2786 * Initialization function for wimlib. Call before using any other wimlib
2787 * function except wimlib_set_print_errors(). If not done manually, this
2788 * function will be called automatically with @p init_flags set to
2789 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
2790 * after it has already successfully run.
2793 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2795 * @return 0 on success; nonzero on failure. Currently, only the following
2796 * error code is defined:
2798 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2799 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2800 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2801 * init_flags, but the corresponding privileges could not be acquired.
2804 wimlib_global_init(int init_flags);
2807 * @ingroup G_general
2809 * Cleanup function for wimlib. You are not required to call this function, but
2810 * it will release any global resources allocated by the library.
2813 wimlib_global_cleanup(void);
2816 * @ingroup G_wim_information
2818 * Determines if an image name is already used by some image in the WIM.
2821 * Pointer to the ::WIMStruct for a WIM file.
2823 * The name to check.
2826 * @c true if there is already an image in @p wim named @p name; @c false
2827 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2828 * the empty string, @c false is returned.
2831 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2834 * @ingroup G_wim_information
2836 * Iterate through a file or directory tree in the WIM image. By specifying
2837 * appropriate flags and a callback function, you can get the attributes of a
2838 * file in the WIM, get a directory listing, or even get a listing of the entire
2842 * The WIM containing the image(s) over which to iterate, specified as a
2843 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2844 * or part 1 of a split WIM. In the case of a WIM file that is not
2845 * standalone, this ::WIMStruct should have had any needed external
2846 * resources previously referenced using wimlib_reference_resources() or
2847 * wimlib_reference_resource_files(). If not, see
2848 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2849 * the behavior when resources are missing.
2852 * The 1-based number of the image in @p wim that contains the files or
2853 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2854 * iteration on all images in the WIM.
2857 * Path in the WIM image at which to do the iteration.
2860 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2863 * A callback function that will receive each directory entry.
2866 * An extra parameter that will always be passed to the callback function
2869 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2870 * first nonzero value that was returned from @p cb. However, additional error
2871 * codes may be returned, including the following:
2873 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2874 * @p path did not exist in the WIM image.
2875 * @retval ::WIMLIB_ERR_NOMEM
2876 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2878 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2879 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2880 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2881 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2882 * different reasons) to read the metadata resource for an image over which
2883 * iteration needed to be done.
2886 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2888 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2891 * @ingroup G_wim_information
2893 * Iterate through the lookup table of a WIM file. This can be used to directly
2894 * get a listing of the unique resources contained in a WIM file over all
2895 * images. Both file resources and metadata resources are included. However,
2896 * only resources actually included in the file represented by @a wim, plus
2897 * explicitly referenced external resources (via wimlib_reference_resources() or
2898 * wimlib_reference_resource_files()) are included in the iteration. For
2899 * example, if @p wim represents just one part of a split WIM, then only
2900 * resources in that part will be included, unless other resources were
2901 * explicitly referenced.
2904 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2905 * to be standalone (e.g. it could be part of a split WIM).
2908 * Reserved; set to 0.
2911 * A callback function that will receive each resource.
2914 * An extra parameter that will always be passed to the callback function
2917 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2918 * that was returned from @p cb.
2921 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2922 wimlib_iterate_lookup_table_callback_t cb,
2926 * @ingroup G_nonstandalone_wims
2928 * Joins a split WIM into a stand-alone one-part WIM.
2931 * An array of strings that gives the filenames of all parts of the split
2932 * WIM. No specific order is required, but all parts must be included with
2935 * Number of filenames in @p swms.
2936 * @param swm_open_flags
2937 * Open flags for the split WIM parts (e.g.
2938 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2939 * @param wim_write_flags
2940 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2941 * be used to write the joined WIM.
2942 * @param output_path
2943 * The path to write the joined WIM file to.
2944 * @param progress_func
2945 * If non-NULL, a function that will be called periodically with the
2946 * progress of the current operation.
2948 * @return 0 on success; nonzero on error. This function may return most error
2949 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2950 * as the following error code:
2952 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2953 * The split WIMs do not form a valid WIM because they do not include all
2954 * the parts of the original WIM, there are duplicate parts, or not all the
2955 * parts have the same GUID and compression type.
2957 * Note: wimlib is generalized enough that this function is not actually needed
2958 * to join a split WIM; instead, you could open the first part of the split WIM,
2959 * then reference the other parts with wimlib_reference_resource_files(), then
2960 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2961 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2965 wimlib_join(const wimlib_tchar * const *swms,
2967 const wimlib_tchar *output_path,
2969 int wim_write_flags,
2970 wimlib_progress_func_t progress_func);
2974 * @ingroup G_mounting_wim_images
2976 * Mounts an image in a WIM file on a directory read-only or read-write.
2978 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2979 * supported if wimlib was configured with @c --without-fuse. This includes
2980 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2983 * Calling this function daemonizes the process, unless
2984 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2985 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2986 * to the WIM are staged in a temporary directory.
2988 * It is safe to mount multiple images from the same underlying WIM file
2989 * read-only at the same time, but only if different ::WIMStruct's are used. It
2990 * is @b not safe to mount multiple images from the same WIM file read-write at
2993 * wimlib_mount_image() cannot be used on an image that was exported with
2994 * wimlib_export_image() while the dentry trees for both images are still in
2995 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2996 * that already has modifications pending (e.g. an image added with
2997 * wimlib_add_image()).
3000 * Pointer to the ::WIMStruct containing the image to be mounted.
3002 * The number of the image to mount, indexed starting from it. It must be
3003 * an existing, single image.
3005 * The path to an existing empty directory to mount the image on.
3006 * @param mount_flags
3007 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.
3008 * @param staging_dir
3009 * If non-NULL, the name of a directory in which the staging directory will
3010 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
3011 * in @p mount_flags. If left @c NULL, the staging directory is created in
3012 * the same directory as the WIM file that @p wim was originally read from.
3014 * @return 0 on success; nonzero on error.
3016 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3017 * A read-write mount was requested, but an exclusive advisory lock on
3018 * the on-disk WIM file could not be acquired because another thread or
3019 * process has mounted an image from the WIM read-write or is currently
3020 * modifying the WIM in-place.
3021 * @retval ::WIMLIB_ERR_FUSE
3022 * A non-zero status was returned by @c fuse_main().
3023 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3024 * @p image does not specify an existing, single image in @p wim.
3025 * @retval ::WIMLIB_ERR_INVALID_PARAM
3026 * @p image is shared among multiple ::WIMStruct's as a result of a call to
3027 * wimlib_export_image(), or @p image has been added with
3028 * wimlib_add_image().
3029 * @retval ::WIMLIB_ERR_MKDIR
3030 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3031 * staging directory could not be created.
3032 * @retval ::WIMLIB_ERR_NOTDIR
3033 * Could not determine the current working directory.
3034 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3035 * One of the dentries in the image referenced a stream not present in the
3036 * WIM's lookup table (or in any of the lookup tables of the split WIM
3038 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3039 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
3040 * wim is considered read-only because of any of the reasons mentioned in
3041 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3042 * @retval ::WIMLIB_ERR_UNSUPPORTED
3043 * Mounting is not supported, either because the platform is Windows, or
3044 * because the platform is UNIX-like and wimlib was compiled with @c
3047 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3048 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3049 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3050 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3051 * different reasons) to read the metadata resource for the image to mount.
3054 wimlib_mount_image(WIMStruct *wim,
3056 const wimlib_tchar *dir,
3058 const wimlib_tchar *staging_dir);
3061 * @ingroup G_creating_and_opening_wims
3063 * Opens a WIM file and creates a ::WIMStruct for it.
3066 * The path to the WIM file to open.
3069 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3071 * @param progress_func
3072 * If non-NULL, a function that will be called periodically with the
3073 * progress of the current operation. Currently, the only messages sent
3074 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
3075 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
3078 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3079 * is written to the memory location pointed to by this parameter. The
3080 * ::WIMStruct can be freed using using wimlib_free() when finished with
3083 * @return 0 on success; nonzero on error.
3084 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3085 * The WIM is not the non-first part of a split WIM, and the number of
3086 * metadata resources found in the WIM did not match the image count given
3087 * in the WIM header, or the number of <IMAGE> elements in the XML
3088 * data for the WIM did not match the image count given in the WIM header.
3089 * @retval ::WIMLIB_ERR_INTEGRITY
3090 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3091 * wim_file contains an integrity table, but the SHA1 message digest for a
3092 * chunk of the WIM does not match the corresponding message digest given
3093 * in the integrity table.
3094 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3095 * Resources in @p wim_file are compressed, but the chunk size was invalid
3096 * for the WIM's compression type.
3097 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3098 * The header of @p wim_file says that resources in the WIM are compressed,
3099 * but the header flag for a recognized compression type is not set.
3100 * @retval ::WIMLIB_ERR_INVALID_HEADER
3101 * The header of @p wim_file was otherwise invalid.
3102 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3103 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3104 * wim_file contains an integrity table, but the integrity table is
3106 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3107 * The lookup table for the WIM was invalid.
3108 * @retval ::WIMLIB_ERR_INVALID_PARAM
3109 * @p wim_ret was @c NULL.
3110 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3111 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3112 * specified in @p open_flags.
3113 * @retval ::WIMLIB_ERR_NOMEM
3114 * Failed to allocated needed memory.
3115 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3116 * @p wim_file does not begin with the expected magic characters.
3117 * @retval ::WIMLIB_ERR_OPEN
3118 * Failed to open the file @p wim_file for reading.
3119 * @retval ::WIMLIB_ERR_READ
3120 * Failed to read data from @p wim_file.
3121 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3122 * Unexpected end-of-file while reading data from @p wim_file.
3123 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3124 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3125 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3126 * The WIM cannot be opened because it contains encrypted segments. (It
3127 * may be a Windows 8 "ESD" file).
3128 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3129 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3130 * considered read-only because of any of the reasons mentioned in the
3131 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3132 * @retval ::WIMLIB_ERR_XML
3133 * The XML data for @p wim_file is invalid.
3136 wimlib_open_wim(const wimlib_tchar *wim_file,
3138 WIMStruct **wim_ret,
3139 wimlib_progress_func_t progress_func);
3142 * @ingroup G_writing_and_overwriting_wims
3144 * Overwrites the file that the WIM was originally read from, with changes made.
3145 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3146 * rather than wimlib_create_new_wim().
3148 * There are two ways that a WIM may be overwritten. The first is to do a full
3149 * rebuild. In this mode, the new WIM is written to a temporary file and then
3150 * renamed to the original file after it is has been completely written. The
3151 * temporary file is made in the same directory as the original WIM file. A
3152 * full rebuild may take a while, but can be used even if images have been
3153 * modified or deleted, will produce a WIM with no holes, and has little chance
3154 * of unintentional data loss because the temporary WIM is fsync()ed before
3155 * being renamed to the original WIM.
3157 * The second way to overwrite a WIM is by appending to the end of it and
3158 * overwriting the header. This can be much faster than a full rebuild, but the
3159 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3160 * begins with writing any new file resources *after* everything in the old WIM,
3161 * even though this will leave a hole where the old lookup table, XML data, and
3162 * integrity were. This is done so that the WIM remains valid even if the
3163 * operation is aborted mid-write. The WIM header is only overwritten at the
3164 * very last moment, and up until that point the WIM will be seen as the old
3167 * By default, wimlib_overwrite() does the append-style overwrite described
3168 * above, unless resources in the WIM are arranged in an unusual way or if
3169 * images have been deleted from the WIM. Use the flag
3170 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3171 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3172 * images have been deleted from the WIM.
3174 * In the temporary-file overwrite mode, no changes are made to the WIM on
3175 * failure, and the temporary file is deleted if possible. Abnormal termination
3176 * of the program will result in the temporary file being orphaned. In the
3177 * direct append mode, the WIM is truncated to the original length on failure;
3178 * and while abnormal termination of the program will result in extra data
3179 * appended to the original WIM, it should still be a valid WIM.
3181 * If this function completes successfully, no more functions should be called
3182 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3183 * the WIM file anew.
3186 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3187 * been in-memory changes made to it, which are then reflected in the
3189 * @param write_flags
3190 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3191 * @param num_threads
3192 * Number of threads to use for compression (see wimlib_write()).
3193 * @param progress_func
3194 * If non-NULL, a function that will be called periodically with the
3195 * progress of the current operation.
3197 * @return 0 on success; nonzero on error. This function may return most error
3198 * codes returned by wimlib_write() as well as the following error codes:
3200 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3201 * The WIM was going to be modified in-place (with no temporary file), but
3202 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3203 * because another thread or process has mounted an image from the WIM
3204 * read-write or is currently modifying the WIM in-place.
3205 * @retval ::WIMLIB_ERR_NO_FILENAME
3206 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3207 * than a WIM read with wimlib_open_wim().
3208 * @retval ::WIMLIB_ERR_RENAME
3209 * The temporary file that the WIM was written to could not be renamed to
3210 * the original filename of @p wim.
3211 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3212 * The WIM file is considered read-only because of any of the reasons
3213 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3217 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3218 wimlib_progress_func_t progress_func);
3221 * @ingroup G_wim_information
3223 * Prints information about one image, or all images, contained in a WIM.
3226 * Pointer to the ::WIMStruct for a WIM file.
3228 * The image about which to print information. Can be the number of an
3229 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3232 * @return This function has no return value. No error checking is done when
3233 * printing the information. If @p image is invalid, an error message is
3237 wimlib_print_available_images(const WIMStruct *wim, int image);
3240 * @ingroup G_wim_information
3242 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3243 * in a way that can be accessed programatically.
3246 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3249 * @ingroup G_nonstandalone_wims
3251 * Reference resources from other WIM files or split WIM parts. This function
3252 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3253 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3254 * from other files, before calling a function such as wimlib_extract_image()
3255 * that requires the resources to be present.
3258 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3259 * necessarily "standalone". In the case of split WIMs, this should be the
3260 * first part, since only the first part contains the metadata resources.
3261 * In the case of delta WIMs, this should be the delta WIM rather than the
3262 * WIM on which it is based.
3263 * @param resource_wimfiles_or_globs
3264 * Array of paths to WIM files and/or split WIM parts to reference.
3265 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3266 * ref_flags, these are treated as globs rather than literal paths. That
3267 * is, using this function you can specify zero or more globs, each of
3268 * which expands to one or more literal paths.
3270 * Number of entries in @p resource_wimfiles_or_globs.
3272 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3273 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3275 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3276 * pass to internal calls to wimlib_open_wim() on the reference files.
3277 * @param progress_func
3278 * Passed to internal calls to wimlib_open_wim() on the reference files.
3280 * @return 0 on success; nonzero on error.
3282 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3283 * One of the specified globs did not match any paths (only with both
3284 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3285 * specified in @p ref_flags).
3286 * @retval ::WIMLIB_ERR_NOMEM
3287 * Failed to allocate memory.
3288 * @retval ::WIMLIB_ERR_READ
3289 * I/O or permissions error while processing a file glob.
3291 * This function can additionally return most values that can be returned by
3292 * wimlib_open_wim().
3295 wimlib_reference_resource_files(WIMStruct *wim,
3296 const wimlib_tchar * const *resource_wimfiles_or_globs,
3300 wimlib_progress_func_t progress_func);
3303 * @ingroup G_nonstandalone_wims
3305 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3306 * where the caller must open the ::WIMStruct for each referenced file itself.
3309 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3310 * necessarily "standalone". In the case of split WIMs, this should be the
3311 * first part, since only the first part contains the metadata resources.
3312 * @param resource_wims
3313 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3314 * split WIM parts to reference.
3315 * @param num_resource_wims
3316 * Number of entries in @p resource_wims.
3318 * Currently ignored (set to 0).
3320 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3321 * @p resource_wims are referenced internally by @p wim and must not be freed
3322 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3323 * been freed with wimlib_free(), or immediately before freeing @p wim with
3326 * @retval ::WIMLIB_ERR_INVALID_PARAM
3327 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3328 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3329 * @retval ::WIMLIB_ERR_NOMEM
3330 * Failed to allocate memory.
3333 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3334 unsigned num_resource_wims, int ref_flags);
3337 * @ingroup G_modifying_wims
3339 * Declares that a newly added image is mostly the same as a prior image, but
3340 * captured at a later point in time, possibly with some modifications in the
3341 * intervening time. This is designed to be used in incremental backups of the
3342 * same filesystem or directory tree.
3344 * This function compares the metadata of the directory tree of the newly added
3345 * image against that of the old image. Any files that are present in both the
3346 * newly added image and the old image and have timestamps that indicate they
3347 * haven't been modified are deemed not to have been modified and have their
3348 * SHA1 message digest copied from the old image. Because of this and because
3349 * WIM uses single-instance streams, such files need not be read from the
3350 * filesystem when the WIM is being written or overwritten. Note that these
3351 * unchanged files will still be "archived" and will be logically present in the
3352 * new image; the optimization is that they don't need to actually be read from
3353 * the filesystem because the WIM already contains them.
3355 * This function is provided to optimize incremental backups. The resulting WIM
3356 * file will still be the same regardless of whether this function is called.
3357 * (This is, however, assuming that timestamps have not been manipulated or
3358 * unmaintained as to trick this function into thinking a file has not been
3359 * modified when really it has. To partly guard against such cases, other
3360 * metadata such as file sizes will be checked as well.)
3362 * This function must be called after adding the new image (e.g. with
3363 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3364 * wimlib_overwrite()).
3367 * Pointer to the ::WIMStruct for a WIM.
3369 * 1-based index in the WIM of the newly added image. This image can have
3370 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3371 * wimlib_add_empty_image() followed by wimlib_update_image().
3372 * @param template_wim
3373 * The ::WIMStruct for the WIM containing the template image. This can be
3374 * the same as @p wim, or it can be a different ::WIMStruct.
3375 * @param template_image
3376 * 1-based index in the WIM of a template image that reflects a prior state
3377 * of the directory tree being captured.
3379 * Reserved; must be 0.
3380 * @param progress_func
3381 * Currently ignored, but reserved for a function that will be called with
3382 * information about the operation. Use NULL if no additional information
3385 * @return 0 on success; nonzero on error.
3387 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3388 * @p new_image and/or @p template_image were not a valid image indices in
3390 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3391 * The specified ::WIMStruct did not actually contain the metadata resource
3392 * for the new or template image; for example, it was a non-first part of a
3394 * @retval ::WIMLIB_ERR_NOMEM
3395 * Failed to allocate needed memory.
3396 * @retval ::WIMLIB_ERR_INVALID_PARAM
3397 * @p new_image was equal to @p template_image, or @p new_image specified
3398 * an image that had not been modified since opening the WIM.
3400 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3401 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3402 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3403 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3404 * different reasons) to read the metadata resource for the template image.
3407 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3408 WIMStruct *template_wim, int template_image,
3409 int flags, wimlib_progress_func_t progress_func);
3412 * @ingroup G_modifying_wims
3414 * Rename the @p source_path to the @p dest_path in the specified @p image of
3417 * This just builds an appropriate ::wimlib_rename_command and passes it to
3418 * wimlib_update_image().
3421 wimlib_rename_path(WIMStruct *wim, int image,
3422 const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3425 * @ingroup G_wim_information
3427 * Translates a string specifying the name or number of an image in the WIM into
3428 * the number of the image. The images are numbered starting at 1.
3431 * Pointer to the ::WIMStruct for a WIM.
3432 * @param image_name_or_num
3433 * A string specifying the name or number of an image in the WIM. If it
3434 * parses to a positive integer, this integer is taken to specify the
3435 * number of the image, indexed starting at 1. Otherwise, it is taken to
3436 * be the name of an image, as given in the XML data for the WIM file. It
3437 * also may be the keyword "all" or the string "*", both of which will
3438 * resolve to ::WIMLIB_ALL_IMAGES.
3440 * There is no way to search for an image actually named "all", "*", or an
3441 * integer number, or an image that has no name. However, you can use
3442 * wimlib_get_image_name() to get the name of any image.
3445 * If the string resolved to a single existing image, the number of that
3446 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3447 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3448 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3449 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3450 * images in @p wim has no name.
3453 wimlib_resolve_image(WIMStruct *wim,
3454 const wimlib_tchar *image_name_or_num);
3457 * @ingroup G_modifying_wims
3459 * Changes the description of an image in the WIM.
3462 * Pointer to the ::WIMStruct for a WIM.
3464 * The number of the image for which to change the description.
3465 * @param description
3466 * The new description to give the image. It may be @c NULL, which
3467 * indicates that the image is to be given no description.
3469 * @return 0 on success; nonzero on error.
3470 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3471 * @p image does not specify a single existing image in @p wim.
3472 * @retval ::WIMLIB_ERR_NOMEM
3473 * Failed to allocate the memory needed to duplicate the @p description
3475 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3476 * @p wim is considered read-only because of any of the reasons mentioned
3477 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3480 wimlib_set_image_descripton(WIMStruct *wim, int image,
3481 const wimlib_tchar *description);
3484 * @ingroup G_writing_and_overwriting_wims
3486 * Set the compression chunk size of a WIM to use in subsequent calls to
3487 * wimlib_write() or wimlib_overwrite().
3489 * For compatibility reasons, using this function is not generally recommended.
3490 * See the documentation for the @c --chunk-size option of <b>wimlib-imagex
3491 * capture</b> for more information.
3493 * A larger compression chunk size will likely result in a better compression
3494 * ratio, but the speed of random access to the WIM will be reduced.
3495 * Furthermore, the effect of a larger compression chunk size is limited by the
3496 * size of each stream ("file") being compressed.
3499 * ::WIMStruct for a WIM.
3501 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3502 * on the compression format; see the documentation for the @c --chunk-size
3503 * option of <b>wimlib-imagex capture</b> for more information. As a
3504 * special case, if @p chunk_size is specified as 0, the chunk size is set
3505 * to the default for the currently selected output compression type.
3507 * @return 0 on success; nonzero on error.
3509 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3510 * @p chunk_size is not a supported chunk size for the currently selected
3511 * output compression type.
3514 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3517 * @ingroup G_writing_and_overwriting_wims
3519 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3520 * packed streams (solid blocks).
3523 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3526 * @ingroup G_writing_and_overwriting_wims
3528 * Set the compression type of a WIM to use in subsequent calls to
3529 * wimlib_write() or wimlib_overwrite().
3532 * ::WIMStruct for a WIM.
3534 * The compression type to set (one of ::wimlib_compression_type). If this
3535 * compression type is incompatible with the current output chunk size
3536 * (either the default or as set with wimlib_set_output_chunk_size()), the
3537 * output chunk size is reset to the default for that compression type.
3539 * @return 0 on success; nonzero on error.
3541 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3542 * @p ctype did not specify a valid compression type.
3545 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3548 * @ingroup G_writing_and_overwriting_wims
3550 * Similar to wimlib_set_output_compression_type(), but set the compression type
3551 * for writing packed streams (solid blocks).
3554 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3557 * @ingroup G_modifying_wims
3559 * Set basic information about a WIM.
3562 * Pointer to the ::WIMStruct for a WIM.
3564 * A struct ::wimlib_wim_info that contains the information to set. Only
3565 * the information explicitly specified in the @p which flags need be
3568 * Flags that specify which information to set. This is a bitwise OR of
3569 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3570 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3572 * @return 0 on success; nonzero on failure.
3573 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3574 * The WIM file is considered read-only because of any of the reasons
3575 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3576 * flag. However, as a special case, if you are using
3577 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3578 * function will not fail due to the readonly flag being previously set.
3579 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3580 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3581 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3585 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3589 * @ingroup G_modifying_wims
3591 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3592 * (something like "Core" or "Ultimate")
3595 * Pointer to the ::WIMStruct for a WIM.
3597 * The number of the image for which to change the description.
3599 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3600 * indicates that the image is to be given no \<FLAGS\> element.
3602 * @return 0 on success; nonzero on error.
3603 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3604 * @p image does not specify a single existing image in @p wim.
3605 * @retval ::WIMLIB_ERR_NOMEM
3606 * Failed to allocate the memory needed to duplicate the @p flags string.
3607 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3608 * @p wim is considered read-only because of any of the reasons mentioned
3609 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3612 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3615 * @ingroup G_modifying_wims
3617 * Changes the name of an image in the WIM.
3620 * Pointer to the ::WIMStruct for a WIM.
3622 * The number of the image for which to change the name.
3624 * New name to give the new image. If @c NULL or empty, the new image is
3625 * given no name. If nonempty, it must specify a name that does not
3626 * already exist in @p wim.
3628 * @return 0 on success; nonzero on error.
3629 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3630 * There is already an image named @p name in @p wim.
3631 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3632 * @p image does not specify a single existing image in @p wim.
3633 * @retval ::WIMLIB_ERR_NOMEM
3634 * Failed to allocate the memory needed to duplicate the @p name string.
3635 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3636 * @p wim is considered read-only because of any of the reasons mentioned
3637 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3640 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3643 * @ingroup G_general
3645 * Set the functions that wimlib uses to allocate and free memory.
3647 * These settings are global and not per-WIM.
3649 * The default is to use the default @c malloc() and @c free() from the C
3652 * Please note that some external functions, such as those in @c libntfs-3g, may
3653 * use the standard memory allocation functions.
3655 * @param malloc_func
3656 * A function equivalent to @c malloc() that wimlib will use to allocate
3657 * memory. If @c NULL, the allocator function is set back to the default
3658 * @c malloc() from the C library.
3660 * A function equivalent to @c free() that wimlib will use to free memory.
3661 * If @c NULL, the free function is set back to the default @c free() from
3663 * @param realloc_func
3664 * A function equivalent to @c realloc() that wimlib will use to reallocate
3665 * memory. If @c NULL, the free function is set back to the default @c
3666 * realloc() from the C library.
3670 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3671 void (*free_func)(void *),
3672 void *(*realloc_func)(void *, size_t));
3675 * @ingroup G_general
3677 * Sets whether wimlib is to print error messages to @c stderr when a function
3678 * fails. These error messages may provide information that cannot be
3679 * determined only from the error code that is returned. Not every error will
3680 * result in an error message being printed.
3682 * This setting is global and not per-WIM.
3684 * By default, error messages are not printed.
3686 * This can be called before wimlib_global_init().
3688 * @param show_messages
3689 * @c true if error messages are to be printed; @c false if error messages
3690 * are not to be printed.
3692 * @return 0 on success; nonzero on error.
3693 * @retval ::WIMLIB_ERR_UNSUPPORTED
3694 * @p show_messages was @c true, but wimlib was compiled with the @c
3695 * --without-error-messages option. Therefore, error messages cannot be
3699 wimlib_set_print_errors(bool show_messages);
3702 * @ingroup G_nonstandalone_wims
3704 * Splits a WIM into multiple parts.
3707 * The ::WIMStruct for the WIM to split.
3709 * Name of the SWM file to create. This will be the name of the first
3710 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3711 * appended before the suffix.
3713 * The maximum size per part, in bytes. Unfortunately, it is not
3714 * guaranteed that this will really be the maximum size per part, because
3715 * some file resources in the WIM may be larger than this size, and the WIM
3716 * file format provides no way to split up file resources among multiple
3718 * @param write_flags
3719 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3720 * flags will be used to write each split WIM part. Specify 0 here to get
3721 * the default behavior.
3722 * @param progress_func
3723 * If non-NULL, a function that will be called periodically with the
3724 * progress of the current operation
3725 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3726 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3728 * @return 0 on success; nonzero on error. This function may return most error
3729 * codes that can be returned by wimlib_write() as well as the following error
3732 * @retval ::WIMLIB_ERR_INVALID_PARAM
3733 * @p swm_name was not a nonempty string, or @p part_size was 0.
3735 * Note: the WIM's uncompressed and compressed resources are not checksummed
3736 * when they are copied from the joined WIM to the split WIM parts, nor are
3737 * compressed resources re-compressed (unless explicitly requested with
3738 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3741 wimlib_split(WIMStruct *wim,
3742 const wimlib_tchar *swm_name,
3745 wimlib_progress_func_t progress_func);
3748 * @ingroup G_mounting_wim_images
3750 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3752 * The image to unmount is specified by the path to the mountpoint, not the
3753 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3754 * touched and also may have been allocated in a different process.
3756 * To unmount the image, the process calling this function communicates with the
3757 * process that is managing the mounted WIM image. This function blocks until it
3758 * is known whether the unmount succeeded or failed. In the case of a
3759 * read-write mounted WIM, the unmount is not considered to have succeeded until
3760 * all changes have been saved to the underlying WIM file.
3763 * The directory that the WIM image was mounted on.
3764 * @param unmount_flags
3765 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3766 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3767 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3769 * @param progress_func
3770 * If non-NULL, a function that will be called periodically with the
3771 * progress of the current operation. Currently, only
3772 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3774 * @return 0 on success; nonzero on error.
3776 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3777 * The filesystem daemon was unable to remove the staging directory and the
3778 * temporary files that it contains.
3779 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3780 * The filesystem daemon appears to have terminated before sending an exit
3782 * @retval ::WIMLIB_ERR_FORK
3783 * Could not @c fork() the process.
3784 * @retval ::WIMLIB_ERR_FUSERMOUNT
3785 * The @b fusermount program could not be executed or exited with a failure
3787 * @retval ::WIMLIB_ERR_MQUEUE
3788 * Could not open a POSIX message queue to communicate with the filesystem
3789 * daemon servicing the mounted filesystem, could not send a message
3790 * through the queue, or could not receive a message through the queue.
3791 * @retval ::WIMLIB_ERR_NOMEM
3792 * Failed to allocate needed memory.
3793 * @retval ::WIMLIB_ERR_OPEN
3794 * The filesystem daemon could not open a temporary file for writing the
3796 * @retval ::WIMLIB_ERR_READ
3797 * A read error occurred when the filesystem daemon tried to a file from
3798 * the staging directory
3799 * @retval ::WIMLIB_ERR_RENAME
3800 * The filesystem daemon failed to rename the newly written WIM file to the
3801 * original WIM file.
3802 * @retval ::WIMLIB_ERR_UNSUPPORTED
3803 * Mounting is not supported, either because the platform is Windows, or
3804 * because the platform is UNIX-like and wimlib was compiled with @c
3806 * @retval ::WIMLIB_ERR_WRITE
3807 * A write error occurred when the filesystem daemon was writing to the new
3808 * WIM file, or the filesystem daemon was unable to flush changes that had
3809 * been made to files in the staging directory.
3812 wimlib_unmount_image(const wimlib_tchar *dir,
3814 wimlib_progress_func_t progress_func);
3817 * @ingroup G_modifying_wims
3819 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3822 * Pointer to the ::WIMStruct for the WIM file to update.
3824 * The 1-based index of the image in the WIM to update. It cannot be
3825 * ::WIMLIB_ALL_IMAGES.
3827 * An array of ::wimlib_update_command's that specify the update operations
3830 * Number of commands in @p cmds.
3831 * @param update_flags
3832 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3833 * @param progress_func
3834 * If non-NULL, a function that will be called periodically with the
3835 * progress of the current operation.
3837 * @return 0 on success; nonzero on error. On failure, all update commands will
3838 * be rolled back, and no visible changes shall have been made to @p wim.
3839 * Possible error codes include:
3841 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3842 * The capture configuration structure specified for an add command was
3844 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3845 * @p image did not specify a single, existing image in @p wim.
3846 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3847 * Attempted to perform an add command that conflicted with previously
3848 * existing files in the WIM when an overlay was attempted.
3849 * @retval ::WIMLIB_ERR_INVALID_PARAM
3850 * An unknown operation type was specified in the update commands; or,
3851 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3852 * in the @p add_flags, but the same image had previously already been
3853 * added from an NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3854 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3855 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3856 * specified in the @p add_flags for an add command in which @p
3857 * wim_target_path was not the root directory of the WIM image.
3858 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3859 * (Windows only): While executing an add command, tried to capture a
3860 * reparse point with invalid data.
3861 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3862 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3863 * for a WIM path that corresponded to a directory; or, a rename command
3864 * attempted to rename a directory to a non-directory.
3865 * @retval ::WIMLIB_ERR_NOMEM
3866 * Failed to allocate needed memory.
3867 * @retval ::WIMLIB_ERR_NOTDIR
3868 * A rename command attempted to rename a directory to a non-directory; or,
3869 * an add command was executed that attempted to set the root of the WIM
3870 * image as a non-directory; or, a path component used as a directory in a
3871 * rename command was not, in fact, a directory.
3872 * @retval ::WIMLIB_ERR_NOTEMPTY
3873 * A rename command attempted to rename a directory to a non-empty
3875 * @retval ::WIMLIB_ERR_NTFS_3G
3876 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3877 * error occurred while reading data from the NTFS volume using libntfs-3g.
3878 * @retval ::WIMLIB_ERR_OPEN
3879 * Failed to open a file to be captured while executing an add command.
3880 * @retval ::WIMLIB_ERR_OPENDIR
3881 * Failed to open a directory to be captured while executing an add command.
3882 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3883 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3884 * WIM path that did not exist; or, a rename command attempted to rename a
3885 * file that does not exist.
3886 * @retval ::WIMLIB_ERR_READ
3887 * While executing an add command, failed to read data from a file or
3888 * directory to be captured.
3889 * @retval ::WIMLIB_ERR_READLINK
3890 * While executing an add command, failed to read the target of a symbolic
3891 * link or junction point.
3892 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3893 * (Windows only) Failed to perform a reparse point fixup because of
3894 * problems with the data of a reparse point.
3895 * @retval ::WIMLIB_ERR_STAT
3896 * While executing an add command, failed to get attributes for a file or
3898 * @retval ::WIMLIB_ERR_UNSUPPORTED
3899 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3900 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3901 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3902 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3903 * add_flags for an update command.
3904 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3905 * While executing an add command, attempted to capture a file that was not
3906 * a supported file type (e.g. a device file). Only if
3907 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3908 * for an update command.
3909 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3910 * The WIM file is considered read-only because of any of the reasons
3911 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3914 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3915 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3916 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3917 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3918 * different reasons) to read the metadata resource for an image that needed to
3922 wimlib_update_image(WIMStruct *wim,
3924 const struct wimlib_update_command *cmds,
3927 wimlib_progress_func_t progress_func);
3930 * @ingroup G_writing_and_overwriting_wims
3932 * Writes a WIM to a file.
3934 * This brings in resources from any external locations, such as directory trees
3935 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3936 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3938 * By default, the new WIM file is written as stand-alone. Using the
3939 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3940 * instead. However, this function cannot directly write a "split" WIM; use
3941 * wimlib_split() for that.
3944 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3945 * changes made to it, which are then reflected in the output file.
3947 * The path to the file to write the WIM to.
3949 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3950 * images are to be included in the new on-disk WIM file. If for some
3951 * reason you only want to include a single image, specify the index of
3952 * that image instead.
3953 * @param write_flags
3954 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3955 * @param num_threads
3956 * Number of threads to use for compressing data. If 0, the number of
3957 * threads is taken to be the number of online processors. Note: if no
3958 * data compression needs to be done, no additional threads will be created
3959 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3960 * exporting an image from a compressed WIM to another WIM of the same
3961 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3963 * @param progress_func
3964 * If non-NULL, a function that will be called periodically with the
3965 * progress of the current operation. The possible messages are
3966 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3967 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3968 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3970 * @return 0 on success; nonzero on error.
3972 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3973 * @p image does not specify a single existing image in @p wim, and is not
3974 * ::WIMLIB_ALL_IMAGES.
3975 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3976 * A file that had previously been scanned for inclusion in the WIM by
3977 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3978 * message digest check.
3979 * @retval ::WIMLIB_ERR_INVALID_PARAM
3980 * @p path was @c NULL.
3981 * @retval ::WIMLIB_ERR_NOMEM
3982 * Failed to allocate needed memory.
3983 * @retval ::WIMLIB_ERR_OPEN
3984 * Failed to open @p path for writing, or some file resources in @p wim
3985 * refer to files in the outside filesystem, and one of these files could
3986 * not be opened for reading.
3987 * @retval ::WIMLIB_ERR_READ
3988 * An error occurred when trying to read data from the WIM file associated
3989 * with @p wim, or some file resources in @p wim refer to files in the
3990 * outside filesystem, and a read error occurred when reading one of these
3992 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3993 * A stream that needed to be written could not be found in the stream
3994 * lookup table of @p wim. This error can occur if, for example, @p wim is
3995 * part of a split WIM but needed resources from the other split WIM parts
3996 * were not referenced with wimlib_reference_resources() or
3997 * wimlib_reference_resource_files() before the call to wimlib_write().
3998 * @retval ::WIMLIB_ERR_WRITE
3999 * An error occurred when trying to write data to the new WIM file.
4001 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
4002 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
4003 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
4004 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
4005 * different reasons) to read the metadata resource for an image that needed to
4009 wimlib_write(WIMStruct *wim,
4010 const wimlib_tchar *path,
4013 unsigned num_threads,
4014 wimlib_progress_func_t progress_func);
4017 * @ingroup G_writing_and_overwriting_wims
4019 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
4020 * file descriptor, which need not be seekable if the write is done in a special
4021 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
4022 * write_flags. This can, for example, allow capturing a WIM image and
4023 * streaming it over the network. See the documentation for
4024 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
4026 * The file descriptor @p fd will @b not be closed when the write is complete;
4027 * the calling code is responsible for this.
4029 * Returns 0 on success; nonzero on failure. The possible error codes include
4030 * those that can be returned by wimlib_write() as well as the following:
4032 * @retval ::WIMLIB_ERR_INVALID_PARAM
4033 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4034 * specified in @p write_flags.
4037 wimlib_write_to_fd(WIMStruct *wim,
4041 unsigned num_threads,
4042 wimlib_progress_func_t progress_func);
4045 * @defgroup G_compression Compression and decompression functions
4047 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
4048 * exported for convenience only, as they are already used by wimlib internally
4051 * These functions can be used for general-purpose lossless data compression,
4052 * but some limitations apply; for example, none of the compressors or
4053 * decompressors currently support sliding windows, and there also exist
4054 * slightly different variants of these formats that are not supported
4060 /** Header for compression parameters to pass to wimlib_create_compressor() or
4061 * wimlib_set_default_compressor_params(). */
4062 struct wimlib_compressor_params_header {
4063 /** Size of the parameters, in bytes. */
4067 /** Header for decompression parameters to pass to wimlib_create_decompressor()
4068 * or wimlib_set_default_decompressor_params() */
4069 struct wimlib_decompressor_params_header {
4070 /** Size of the parameters, in bytes. */
4074 /** LZX compression parameters that can optionally be passed to
4075 * wimlib_create_compressor() with the compression type
4076 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
4077 struct wimlib_lzx_compressor_params {
4078 /** hdr.size Must be set to the size of this structure, in bytes. */
4079 struct wimlib_compressor_params_header hdr;
4081 /** Relatively fast LZX compression algorithm with a decent compression
4082 * ratio; the suggested default. */
4083 #define WIMLIB_LZX_ALGORITHM_FAST 0
4085 /** Slower LZX compression algorithm that provides a better compression
4087 #define WIMLIB_LZX_ALGORITHM_SLOW 1
4089 /** Algorithm to use to perform the compression: either
4090 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
4091 * format is still LZX; this refers to the method the code will use to
4092 * perform LZX-compatible compression. */
4093 uint32_t algorithm : 3;
4095 /** If set to 1, the default parameters for the specified algorithm are
4096 * used rather than the ones specified in the following union. */
4097 uint32_t use_defaults : 1;
4100 /** Parameters for the fast algorithm. */
4101 struct wimlib_lzx_fast_params {
4102 uint32_t fast_reserved1[10];
4105 /** Parameters for the slow algorithm. */
4106 struct wimlib_lzx_slow_params {
4107 /** If set to 1, the compressor can output length 2
4108 * matches. If set 0, the compressor only outputs
4109 * matches of length 3 or greater. Suggested value: 1
4111 uint32_t use_len2_matches : 1;
4113 uint32_t slow_reserved1 : 31;
4115 /** Matches with length (in bytes) greater than or equal
4116 * to this value are immediately taken without spending
4117 * time on minimum-cost measurements. Suggested value:
4119 uint32_t nice_match_length;
4121 /** Number of passes to compute a match/literal sequence
4122 * for each LZX block. This is for an iterative
4123 * algorithm that attempts to minimize the cost of the
4124 * match/literal sequence by using a cost model provided
4125 * by the previous iteration. Must be at least 1.
4126 * Suggested value: 2. */
4127 uint32_t num_optim_passes;
4129 /** Reserved; set to 0. */
4130 uint32_t slow_reserved_blocksplit;
4132 /** Maximum depth to search for matches at each
4133 * position. Suggested value: 50. */
4134 uint32_t max_search_depth;
4136 /** Maximum number of potentially good matches to
4137 * consider for each position. Suggested value: 3. */
4138 uint32_t max_matches_per_pos;
4140 uint32_t slow_reserved2[2];
4142 /** Assumed cost of a main symbol with zero frequency.
4143 * Must be at least 1 and no more than 16. Suggested
4145 uint8_t main_nostat_cost;
4147 /** Assumed cost of a length symbol with zero frequency.
4148 * Must be at least 1 and no more than 16. Suggested
4150 uint8_t len_nostat_cost;
4152 /** Assumed cost of an aligned symbol with zero
4153 * frequency. Must be at least 1 and no more than 8.
4154 * Suggested value: 7. */
4155 uint8_t aligned_nostat_cost;
4157 uint8_t slow_reserved3[5];
4162 /** LZMS compression parameters that can optionally be passed to
4163 * wimlib_create_compressor() with the compression type
4164 * ::WIMLIB_COMPRESSION_TYPE_LZMS. */
4165 struct wimlib_lzms_compressor_params {
4166 /** hdr.size Must be set to the size of this structure, in bytes. */
4167 struct wimlib_compressor_params_header hdr;
4169 /** Minimum match length to output. This must be at least 2. Suggested
4171 uint32_t min_match_length;
4173 /** Maximum match length to output. This must be at least @p
4174 * min_match_length. Suggested value: @p UINT32_MAX. */
4175 uint32_t max_match_length;
4177 /** Matches with length (in bytes) greater than or equal to this value
4178 * are immediately taken without spending time on minimum-cost
4179 * measurements. The minimum of @p max_match_length and @p
4180 * nice_match_length may not exceed 65536. Suggested value: 32. */
4181 uint32_t nice_match_length;
4183 /** Maximum depth to search for matches at each position. Suggested
4185 uint32_t max_search_depth;
4187 /** Maximum number of potentially good matches to consider at each
4188 * position. Suggested value: 3. */
4189 uint32_t max_matches_per_pos;
4191 /** Length of the array for the near-optimal LZ parsing algorithm. This
4192 * must be at least 1. Suggested value: 1024. */
4193 uint32_t optim_array_length;
4195 uint64_t reserved2[4];
4198 /** Opaque compressor handle. */
4199 struct wimlib_compressor;
4201 /** Opaque decompressor handle. */
4202 struct wimlib_decompressor;
4205 * Set the default compression parameters for the specified compression type.
4206 * This will affect both explicit and wimlib-internal calls to
4207 * wimlib_create_compressor().
4210 * Compression type for which to set the default compression parameters.
4212 * Compression-type specific parameters. This may be @c NULL, in which
4213 * case the "default default" parameters are restored.
4215 * @return 0 on success; nonzero on error.
4217 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4218 * @p ctype was not a supported compression type.
4219 * @retval ::WIMLIB_ERR_INVALID_PARAM
4220 * @p params were invalid.
4221 * @retval ::WIMLIB_ERR_NOMEM
4222 * Not enough memory to duplicate the parameters (perhaps @c params->size
4226 wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
4227 const struct wimlib_compressor_params_header *params);
4230 * Returns the approximate number of bytes needed to allocate a compressor with
4231 * wimlib_create_compressor() for the specified compression type, block size,
4232 * and parameters. @p params may be @c NULL, in which case the current default
4233 * parameters for @p ctype are used. Returns 0 if the compression type or
4234 * parameters are invalid.
4237 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4238 size_t max_block_size,
4239 const struct wimlib_compressor_params_header *params);
4242 * Allocate a compressor for the specified compression type using the specified
4246 * Compression type for which to create the compressor.
4247 * @param max_block_size
4248 * Maximum block size to support. The exact meaning and allowed values for
4249 * this parameter depend on the compression type, but it at least specifies
4250 * the maximum allowed value for @p uncompressed_size to wimlib_compress().
4251 * @param extra_params
4252 * An optional pointer to extra compressor parameters for the specified
4253 * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params
4254 * may be specified here. If left @c NULL, the default parameters are
4256 * @param compressor_ret
4257 * A location into which to return the pointer to the allocated compressor,
4258 * which can be used for any number of calls to wimlib_compress() before
4259 * being freed with wimlib_free_compressor().
4261 * @return 0 on success; nonzero on error.
4263 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4264 * @p ctype was not a supported compression type.
4265 * @retval ::WIMLIB_ERR_INVALID_PARAM
4266 * The compression parameters were invalid.
4267 * @retval ::WIMLIB_ERR_NOMEM
4268 * Insufficient memory to allocate the compressor.
4271 wimlib_create_compressor(enum wimlib_compression_type ctype,
4272 size_t max_block_size,
4273 const struct wimlib_compressor_params_header *extra_params,
4274 struct wimlib_compressor **compressor_ret);
4277 * Losslessly compress a block of data using a compressor previously created
4278 * with wimlib_create_compressor().
4280 * @param uncompressed_data
4281 * Buffer containing the data to compress.
4282 * @param uncompressed_size
4283 * Size, in bytes, of the data to compress.
4284 * @param compressed_data
4285 * Buffer into which to write the compressed data.
4286 * @param compressed_size_avail
4287 * Number of bytes available in @p compressed_data.
4289 * A compressor previously allocated with wimlib_create_compressor().
4292 * The size of the compressed data, in bytes, or 0 if the input data could
4293 * not be compressed to @p compressed_size_avail or fewer bytes.
4296 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4297 void *compressed_data, size_t compressed_size_avail,
4298 struct wimlib_compressor *compressor);
4301 * Free a compressor previously allocated with wimlib_create_compressor().
4304 * The compressor to free.
4307 wimlib_free_compressor(struct wimlib_compressor *compressor);
4310 * Set the default decompression parameters for the specified compression type.
4311 * This will affect both explicit and wimlib-internal calls to
4312 * wimlib_create_decompressor().
4315 * Compression type for which to set the default decompression parameters.
4317 * Compression-type specific parameters. This may be @c NULL, in which
4318 * case the "default default" parameters are restored.
4320 * @return 0 on success; nonzero on error.
4322 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4323 * @p ctype was not a supported compression type.
4324 * @retval ::WIMLIB_ERR_NOMEM
4325 * Not enough memory to duplicate the parameters (perhaps @c params->size
4329 wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
4330 const struct wimlib_decompressor_params_header *params);
4333 * Allocate a decompressor for the specified compression type using the
4334 * specified parameters.
4337 * Compression type for which to create the decompressor.
4338 * @param max_block_size
4339 * Maximum block size to support. The exact meaning and allowed values for
4340 * this parameter depend on the compression type, but it at least specifies
4341 * the maximum allowed value for @p uncompressed_size to
4342 * wimlib_decompress().
4343 * @param extra_params
4344 * An optional pointer to extra decompressor parameters for the specified
4345 * compression type. If @c NULL, the default parameters are used.
4346 * @param decompressor_ret
4347 * A location into which to return the pointer to the allocated
4348 * decompressor, which can be used for any number of calls to
4349 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4351 * @return 0 on success; nonzero on error.
4353 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4354 * @p ctype was not a supported compression type.
4355 * @retval ::WIMLIB_ERR_INVALID_PARAM
4356 * The decompression parameters were invalid.
4357 * @retval ::WIMLIB_ERR_NOMEM
4358 * Insufficient memory to allocate the decompressor.
4361 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4362 size_t max_block_size,
4363 const struct wimlib_decompressor_params_header *extra_params,
4364 struct wimlib_decompressor **decompressor_ret);
4367 * Decompress a block of data using a decompressor previously created with
4368 * wimlib_create_decompressor().
4370 * @param compressed_data
4371 * Buffer containing the data to decompress.
4372 * @param compressed_size
4373 * Size, in bytes, of the data to decompress.
4374 * @param uncompressed_data
4375 * Buffer into which to write the uncompressed data.
4376 * @param uncompressed_size
4377 * Size, in bytes, of the data when uncompressed.
4378 * @param decompressor
4379 * A decompressor previously allocated with wimlib_create_decompressor().
4381 * @return 0 on success; nonzero on error.
4384 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4385 void *uncompressed_data, size_t uncompressed_size,
4386 struct wimlib_decompressor *decompressor);
4389 * Free a decompressor previously allocated with wimlib_create_decompressor().
4391 * @param decompressor
4392 * The decompressor to free.
4395 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4407 #endif /* _WIMLIB_H */