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.2, 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 2
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 "/"
396 # define _wimlib_deprecated __attribute__((deprecated))
398 # define _wimlib_deprecated
401 #define WIMLIB_GUID_LEN 16
404 * Specifies the compression type of a WIM file.
406 enum wimlib_compression_type {
407 /** An invalid compression type. */
408 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
410 /** The WIM does not include any compressed resources. */
411 WIMLIB_COMPRESSION_TYPE_NONE = 0,
413 /** Compressed resources in the WIM use XPRESS compression. */
414 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
416 /** Compressed resources in the WIM use LZX compression. */
417 WIMLIB_COMPRESSION_TYPE_LZX = 2,
419 /** Compressed resources in the WIM use LZMS compression. Note: LZMS
420 * compression is only compatible with wimlib v1.6.0 and later and with
421 * WIMGAPI Windows 8 and later (and some restrictions apply on the
423 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
427 /** @ingroup G_progress
430 /** Possible values of the first parameter to the user-supplied
431 * ::wimlib_progress_func_t progress function */
432 enum wimlib_progress_msg {
434 /** A WIM image is about to be extracted. @p info will point to
435 * ::wimlib_progress_info.extract. This message is received once per
436 * image for calls to wimlib_extract_image() and
437 * wimlib_extract_image_from_pipe(). */
438 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
440 /** One or more file or directory trees within a WIM image is about to
441 * be extracted. @p info will point to ::wimlib_progress_info.extract.
442 * This message is received only once per wimlib_extract_paths() and
443 * wimlib_extract_pathlist(), since wimlib combines all paths into a
444 * single extraction operation for optimization purposes. */
445 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
447 /** The directory structure and other preliminary metadata is about to
448 * be extracted. @p info will point to ::wimlib_progress_info.extract.
449 * This message is received once after either
450 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN or
451 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
452 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
454 /** Confirms that the directory structure and other preliminary metadata
455 * has been successfully extracted. @p info will point to
456 * ::wimlib_progress_info.extract. This message is paired with a
457 * preceding ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN message.
459 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
461 /** File data is currently being extracted. @p info will point to
462 * ::wimlib_progress_info.extract. This is the main message to track
463 * the progress of an extraction operation. */
464 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
466 /** Starting to read a new part of a split pipable WIM over the pipe.
467 * @p info will point to ::wimlib_progress_info.extract. */
468 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
470 /** All data for WIM files and directories have been extracted, and
471 * final metadata such as timestamps is about to be extracted. @p info
472 * will point to ::wimlib_progress_info.extract. This message is
473 * received once before ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END or
474 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END. */
475 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
477 /** Confirms that the image has been successfully extracted. @p info
478 * will point to ::wimlib_progress_info.extract. This is paired with
479 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
480 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
482 /** Confirms that the files or directory trees have been successfully
483 * extracted. @p info will point to ::wimlib_progress_info.extract.
484 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
485 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
487 /** The directory or NTFS volume is about to be scanned for metadata.
488 * @p info will point to ::wimlib_progress_info.scan. This message is
489 * received once per call to wimlib_add_image(), or once per capture
490 * source passed to wimlib_add_image_multisource(), or once per add
491 * command passed to wimlib_update_image(). */
492 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
494 /** A directory or file has been scanned. @p info will point to
495 * ::wimlib_progress_info.scan, and its @p cur_path member will be
496 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
498 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
500 /** Confirms that the directory or NTFS volume has been successfully
501 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
502 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
503 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
505 WIMLIB_PROGRESS_MSG_SCAN_END,
507 /** File resources ("streams") are currently being written to the WIM.
508 * @p info will point to ::wimlib_progress_info.write_streams. This
509 * message may be received many times while the WIM file is being
510 * written or appended to with wimlib_write(), wimlib_overwrite(), or
511 * wimlib_write_to_fd(). */
512 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
514 /** Per-image metadata is about to be written to the WIM file. @p info
515 * will not be valid. */
516 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
518 /** Confirms that per-image metadata has been successfully been written
519 * to the WIM file. @p info will not be valid. This message is paired
520 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
522 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
524 /** wimlib_overwrite() has successfully renamed the temporary file to
525 * the original WIM file, thereby committing the update. @p info will
526 * point to ::wimlib_progress_info.rename. Note: this message is not
527 * received if wimlib_overwrite() chose to append to the WIM file
529 WIMLIB_PROGRESS_MSG_RENAME,
531 /** The contents of the WIM file are being checked against the integrity
532 * table. @p info will point to ::wimlib_progress_info.integrity. This
533 * message is only received (and may be received many times) when
534 * wimlib_open_wim() is called with the
535 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
536 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
538 /** An integrity table is being calculated for the WIM being written.
539 * @p info will point to ::wimlib_progress_info.integrity. This message
540 * is only received (and may be received many times) when a WIM file is
541 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
542 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
545 WIMLIB_PROGRESS_MSG_RESERVED,
547 /** A wimlib_split() operation is in progress, and a new split part is
548 * about to be started. @p info will point to
549 * ::wimlib_progress_info.split. */
550 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
552 /** A wimlib_split() operation is in progress, and a split part has been
553 * finished. @p info will point to ::wimlib_progress_info.split. */
554 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
556 /** A WIM update command is just about to be executed. @p info will
557 * point to ::wimlib_progress_info.update. This message is received
558 * once per update command when wimlib_update_image() is called with the
559 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
560 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
562 /** A WIM update command has just been executed. @p info will point to
563 * ::wimlib_progress_info.update. This message is received once per
564 * update command when wimlib_update_image() is called with the flag
565 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
566 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
570 /** A pointer to this union is passed to the user-supplied
571 * ::wimlib_progress_func_t progress function. One (or none) of the structures
572 * contained in this union will be applicable for the operation
573 * (::wimlib_progress_msg) indicated in the first argument to the progress
575 union wimlib_progress_info {
577 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
578 * document them if they aren't given a name... */
580 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
581 * the primary message for tracking the progress of writing a WIM file.
583 struct wimlib_progress_info_write_streams {
584 /** Total number of uncompressed bytes of stream data being
585 * written. This can be thought of as the total uncompressed
586 * size of the files being archived, with some caveats. WIM
587 * files use single-instance streams, so the size provided here
588 * only counts distinct streams, except for the following
589 * exception: the size provided here may include the sizes of
590 * all newly added (e.g. with wimlib_add_image() streams,
591 * pending automatic de-duplication during the write operation
592 * itself. When each such stream de-duplication occurs, this
593 * number will be decreased by the size of the duplicate stream
594 * that need not be written.
596 * In the case of a wimlib_overwrite() that the library opted to
597 * perform in-place, both @p total_streams and @p total_bytes
598 * will only count the streams actually being written and not
599 * pre-existing streams in the WIM file. */
600 uint64_t total_bytes;
602 /** Total number of streams being written. This can be thought
603 * of as the total number of files being archived, with some
604 * caveats. In general, a single file or directory may contain
605 * multiple data streams, each of which will be represented
606 * separately in this number. Furthermore, WIM files use
607 * single-instance streams, so the stream count provided here
608 * only counts distinct streams, except for the following
609 * exception: the stream count provided here may include newly
610 * added (e.g. with wimlib_add_image() streams, pending
611 * automatic de-duplication during the write operation itself.
612 * When each such stream de-duplication occurs, this number will
613 * be decreased by 1 to account for the duplicate stream that
614 * need not be written. */
615 uint64_t total_streams;
617 /** Number of uncompressed bytes of stream data that have been
618 * written so far. This number be 0 initially, and will be
619 * equal to @p total_bytes at the end of the write operation.
620 * Note that @p total_bytes (but not @p completed_bytes) may
621 * decrease throughout the write operation due to the discovery
622 * of stream duplications. */
623 uint64_t completed_bytes;
625 /** Number of streams that have been written so far. This
626 * number will be 0 initially, and will be equal to @p
627 * total_streams at the end of the write operation. Note that
628 * @p total_streams (but not @p completed_streams) may decrease
629 * throughout the write operation due to the discovery of stream
632 * For applications that wish to calculate a simple "percent
633 * complete" for the write operation, it will likely be more
634 * accurate to calculate the percentage from @p completed_bytes
635 * and @p total_bytes rather than @p completed_streams and
636 * @p total_streams because the time for the operation to
637 * complete is mainly determined by the number of bytes that
638 * need to be read, compressed, and written, not just the number
639 * of files being archived. */
640 uint64_t completed_streams;
642 /** Number of threads that are being used to compress streams,
643 * or 1 if streams are being written uncompressed. */
644 uint32_t num_threads;
646 /** The compression type being used to write the streams, as one
647 * of the ::wimlib_compression_type constants. */
648 int32_t compression_type;
650 /** Number of split WIM parts from which streams are being
651 * written (may be 0 if irrelevant). */
652 uint32_t total_parts;
654 /** Number of split WIM parts from which streams have been
655 * written (may be 0 if irrelevant). */
656 uint32_t completed_parts;
659 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
660 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
661 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
662 struct wimlib_progress_info_scan {
663 /** Top-level directory being scanned; or, when capturing a NTFS
664 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
665 * to the file or block device that contains the NTFS volume
667 const wimlib_tchar *source;
669 /** Path to the file (or directory) that has been scanned, valid
670 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing a NTFS
671 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
672 * relative to the root of the NTFS volume. */
673 const wimlib_tchar *cur_path;
675 /** Dentry scan status, valid on
676 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
678 /** The file looks okay and will be captured. */
679 WIMLIB_SCAN_DENTRY_OK = 0,
681 /** File is being excluded from capture due to the
682 * capture configuration. */
683 WIMLIB_SCAN_DENTRY_EXCLUDED,
685 /** File is being excluded from capture due to being
686 * unsupported (e.g. an encrypted or device file). */
687 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
689 /** The file is an absolute symbolic link or junction
690 * point and it is being excluded from capture because
691 * it points outside of the capture directory and
692 * reparse-point fixups are enabled. (Reparse point
693 * fixups can be disabled by using the flag
694 * ::WIMLIB_ADD_FLAG_NORPFIX.) */
695 WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
699 /** Target path in the WIM image. Only valid on
700 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
701 * ::WIMLIB_PROGRESS_MSG_SCAN_END. If capturing a full
702 * image, this will be the empty string; otherwise it
703 * will name the place in the WIM image at which the
704 * directory tree is being added. */
705 const wimlib_tchar *wim_target_path;
707 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
708 * of @p WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, this is
709 * the target of the absolute symbolic link or junction
711 const wimlib_tchar *symlink_target;
714 /** Number of directories scanned so far, including the root
715 * directory but excluding any unsupported/excluded directories.
717 * Details: On Windows and in NTFS capture mode, a reparse point
718 * counts as a directory if and only if it has
719 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
720 * counts as a directory if and only if when fully dereferenced
721 * it points to an accessible directory. If a file has multiple
722 * names (hard links), it is only counted one time. */
723 uint64_t num_dirs_scanned;
725 /** Number of non-directories scanned so far, excluding any
726 * unsupported/excluded files.
728 * Details: On Windows and in NTFS capture mode, a reparse point
729 * counts as a non-directory if and only if it does not have
730 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
731 * counts as a non-directory if and only if when fully
732 * dereferenced it points to a non-directory or its target is
733 * inaccessible. If a file has multiple names (hard links), it
734 * is only counted one time. */
735 uint64_t num_nondirs_scanned;
737 /** Number of bytes of file data that have been detected so far.
739 * Details: This data may not actually have been read yet, and
740 * it will not actually be written to the WIM file until
741 * wimlib_write() or wimlib_overwrite() has been called. Data
742 * from excluded files is not counted. This number includes
743 * default file contents as well as named data streams and
744 * reparse point data. The size of reparse point data is
745 * tallied after any reparse-point fixups, and in the case of
746 * capturing a symbolic link on a UNIX-like system, the creation
747 * of the reparse point data itself. If a file has multiple
748 * names (hard links), its size(s) are only counted one time.
749 * On Windows, encrypted files have their encrypted size
750 * counted, not their unencrypted size; however, compressed
751 * files have their uncompressed size counted. */
752 uint64_t num_bytes_scanned;
755 /** Valid on messages
756 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
757 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
758 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
759 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
760 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
761 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
762 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
763 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END, and
764 * ::WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS.
766 * Note: most of the time of an extraction operation will be spent
767 * extracting streams, and the application will receive
768 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
769 * completed_bytes and @p total_bytes, the application can calculate a
770 * percentage complete. However, note that this message does not, in
771 * general, actually provide information about which "file" is currently
772 * being extracted. This is because wimlib, by default, extracts the
773 * individual data streams in whichever order it determines to be the
776 struct wimlib_progress_info_extract {
777 /** Number of the image from which files are being extracted
781 /** Extraction flags being used. */
782 uint32_t extract_flags;
784 /** Full path to the WIM file from which files are being
785 * extracted, or @c NULL if the WIMStruct has no associated
787 const wimlib_tchar *wimfile_name;
789 /** Name of the image from which files are being extracted, or
790 * the empty string if the image is unnamed. */
791 const wimlib_tchar *image_name;
793 /** Path to the directory or NTFS volume to which the files are
794 * being extracted. */
795 const wimlib_tchar *target;
798 const wimlib_tchar *reserved;
800 /** Number of bytes of uncompressed data that will be extracted.
801 * If a file has multiple names (hard links), its size (or
802 * sizes, in the case of named data streams) is only counted one
803 * time. For "reparse points" and symbolic links, the size to
804 * be extracted is the size of the reparse data buffer.
806 * This number will stay constant throughout the extraction. */
807 uint64_t total_bytes;
809 /** Number of bytes of uncompressed data that have been
810 * extracted so far. This initially be 0 and will equal to @p
811 * total_bytes at the end of the extraction. */
812 uint64_t completed_bytes;
814 /** Number of (not necessarily unique) streams that will be
815 * extracted. This may be more or less than the number of
816 * "files" to be extracted due to hard links as well as
817 * potentially multiple streams per file (named data streams).
818 * A "stream" may be the default contents of a file, a named
819 * data stream, or a reparse data buffer. */
820 uint64_t num_streams;
822 /** This will be the empty string. */
823 const wimlib_tchar *extract_root_wim_source_path;
825 /** Currently only used for
826 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
827 uint32_t part_number;
829 /** Currently only used for
830 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
831 uint32_t total_parts;
833 /** Currently only used for
834 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
835 uint8_t guid[WIMLIB_GUID_LEN];
838 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
839 struct wimlib_progress_info_rename {
840 /** Name of the temporary file that the WIM was written to. */
841 const wimlib_tchar *from;
843 /** Name of the original WIM file to which the temporary file is
845 const wimlib_tchar *to;
848 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
849 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
850 struct wimlib_progress_info_update {
851 /** Pointer to the update command that will be executed or has
852 * just been executed. */
853 const struct wimlib_update_command *command;
855 /** Number of update commands that have been completed so far.
857 size_t completed_commands;
859 /** Number of update commands that are being executed as part of
860 * this call to wimlib_update_image(). */
861 size_t total_commands;
864 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
865 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
866 struct wimlib_progress_info_integrity {
867 /** Number of bytes from the end of the WIM header to the end of
868 * the lookup table (the area that is covered by the SHA1
869 * integrity checks.) */
870 uint64_t total_bytes;
872 /** Number of bytes that have been SHA1-summed so far. Will be
873 * 0 initially, and equal @p total_bytes at the end. */
874 uint64_t completed_bytes;
876 /** Number of chunks that the checksummed region is divided
878 uint32_t total_chunks;
880 /** Number of chunks that have been SHA1-summed so far. Will
881 * be 0 initially, and equal to @p total_chunks at the end. */
882 uint32_t completed_chunks;
884 /** Size of the chunks used for the integrity calculation. */
887 /** Filename of the WIM (only valid if the message is
888 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
889 const wimlib_tchar *filename;
892 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
893 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
894 struct wimlib_progress_info_split {
895 /** Total size of the original WIM's file and metadata resources
897 uint64_t total_bytes;
899 /** Number of bytes of file and metadata resources that have
900 * been copied out of the original WIM so far. Will be 0
901 * initially, and equal to @p total_bytes at the end. */
902 uint64_t completed_bytes;
904 /** Number 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 unsigned cur_part_number;
909 /** Total number of split WIM parts that are being written. */
910 unsigned total_parts;
912 /** Name of the split WIM part that is about to be started
913 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
914 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
915 const wimlib_tchar *part_name;
919 /** A user-supplied function that will be called periodically during certain WIM
920 * operations. The first argument will be the type of operation that is being
921 * performed or is about to be started or has been completed. The second
922 * argument will be a pointer to one of a number of structures depending on the
923 * first argument. It may be @c NULL for some message types.
925 * The return value of the progress function is currently ignored, but it may do
926 * something in the future. (Set it to 0 for now.)
928 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
929 const union wimlib_progress_info *info);
932 /** @ingroup G_modifying_wims
935 /** An array of these structures is passed to wimlib_add_image_multisource() to
936 * specify the sources from which to create a WIM image. */
937 struct wimlib_capture_source {
938 /** Absolute or relative path to a file or directory on the external
939 * filesystem to be included in the WIM image. */
940 wimlib_tchar *fs_source_path;
942 /** Destination path in the WIM image. Leading and trailing slashes are
943 * ignored. The empty string or @c NULL means the root directory of the
945 wimlib_tchar *wim_target_path;
947 /** Reserved; set to 0. */
951 /** Set or unset the WIM header flag that marks it read-only
952 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
953 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
954 * is distinct from basic file permissions; this flag can be set on a WIM file
955 * that is physically writable. If this flag is set, all further operations to
956 * modify the WIM will fail, except calling wimlib_overwrite() with
957 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
958 * allows you to set this flag persistently on the underlying WIM file.
960 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
962 /** Set the GUID (globally unique identifier) of the WIM file to the value
963 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
964 #define WIMLIB_CHANGE_GUID 0x00000002
966 /** Change the bootable image of the WIM to the value specified in
967 * ::wimlib_wim_info.boot_index of the @p info parameter. */
968 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
970 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
971 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
972 * indicates whether an image in the WIM has been captured with reparse-point
973 * fixups enabled. wimlib also treats this flag as specifying whether to do
974 * reparse-point fixups by default when capturing or applying WIM images. */
975 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
978 /** @ingroup G_wim_information
981 /** General information about a WIM file. */
982 struct wimlib_wim_info {
984 /** Globally unique identifier for the WIM file. Note: all parts of a
985 * split WIM should have an identical value in this field. */
986 uint8_t guid[WIMLIB_GUID_LEN];
988 /** Number of images in the WIM. */
989 uint32_t image_count;
991 /** 1-based index of the bootable image in the WIM, or 0 if no image is
995 /** Version of the WIM file. */
996 uint32_t wim_version;
998 /** Chunk size used for compression. */
1001 /** For split WIMs, the 1-based index of this part within the split WIM;
1003 uint16_t part_number;
1005 /** For split WIMs, the total number of parts in the split WIM;
1007 uint16_t total_parts;
1009 /** One of the ::wimlib_compression_type values that specifies the
1010 * method used to compress resources in the WIM. */
1011 int32_t compression_type;
1013 /** Size of the WIM file in bytes, excluding the XML data and integrity
1015 uint64_t total_bytes;
1017 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1018 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1019 * this will always be 0, even if the ::WIMStruct was written to
1020 * somewhere by calling wimlib_write() with the
1021 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1022 uint32_t has_integrity_table : 1;
1024 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1025 * wimlib_create_new_wim(). */
1026 uint32_t opened_from_file : 1;
1028 /** 1 if the WIM is considered readonly for any reason. */
1029 uint32_t is_readonly : 1;
1031 /** 1 if reparse-point fixups are supposedly enabled for one or more
1032 * images in the WIM. */
1033 uint32_t has_rpfix : 1;
1035 /** 1 if the WIM is marked as read-only. */
1036 uint32_t is_marked_readonly : 1;
1038 /** 1 if the WIM is part of a spanned set. */
1039 uint32_t spanned : 1;
1041 uint32_t write_in_progress : 1;
1042 uint32_t metadata_only : 1;
1043 uint32_t resource_only : 1;
1045 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1046 uint32_t pipable : 1;
1047 uint32_t reserved_flags : 22;
1048 uint32_t reserved[9];
1051 /** Information about a unique stream in the WIM file. (A stream is the same
1052 * thing as a "resource", except in the case of packed resources.) */
1053 struct wimlib_resource_entry {
1054 /** Uncompressed size of the stream in bytes. */
1055 uint64_t uncompressed_size;
1057 /** Compressed size of the stream in bytes. This will be the same as @p
1058 * uncompressed_size if the stream is uncompressed. Or, if @p
1059 * is_packed_streams is 1, this will be 0. */
1060 uint64_t compressed_size;
1062 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1063 * if @p packed is 1, then this is actually the offset at which this
1064 * stream begins in the uncompressed contents of the packed resource.
1068 /** SHA1 message digest of the stream's uncompressed contents. */
1069 uint8_t sha1_hash[20];
1071 /** Which part number of the split WIM this stream is in. This should
1072 * be the same as the part number provided by wimlib_get_wim_info(). */
1073 uint32_t part_number;
1075 /** Number of times this stream is referenced over all WIM images. */
1076 uint32_t reference_count;
1078 /** 1 if this stream is compressed. */
1079 uint32_t is_compressed : 1;
1081 /** 1 if this stream is a metadata resource rather than a file resource.
1083 uint32_t is_metadata : 1;
1085 uint32_t is_free : 1;
1086 uint32_t is_spanned : 1;
1088 /** 1 if this stream was not found in the lookup table of the
1089 * ::WIMStruct. This normally implies a missing call to
1090 * wimlib_reference_resource_files() or wimlib_reference_resources().
1092 uint32_t is_missing : 1;
1094 /** 1 if this stream is located in a packed resource which may contain
1095 * other streams (all compressed together) as well. */
1096 uint32_t packed : 1;
1098 uint32_t reserved_flags : 26;
1100 /** If @p packed is 1, then this will specify the offset of the packed
1101 * resource in the WIM. */
1102 uint64_t raw_resource_offset_in_wim;
1104 /** If @p is_packed_streams is 1, then this will specify the compressed
1105 * size of the packed resource in the WIM. */
1106 uint64_t raw_resource_compressed_size;
1108 uint64_t reserved[2];
1111 /** A stream of a file in the WIM. */
1112 struct wimlib_stream_entry {
1113 /** Name of the stream, or NULL if the stream is unnamed. */
1114 const wimlib_tchar *stream_name;
1115 /** Location, size, etc. of the stream within the WIM file. */
1116 struct wimlib_resource_entry resource;
1117 uint64_t reserved[4];
1120 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1121 * Roughly, the information about a "file" in the WIM--- but really a directory
1122 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1123 * field can be used to distinguish actual file inodes. */
1124 struct wimlib_dir_entry {
1125 /** Name of the file, or NULL if this file is unnamed (only possible for
1126 * the root directory) */
1127 const wimlib_tchar *filename;
1129 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1131 const wimlib_tchar *dos_name;
1133 /** Full path to this file within the WIM image. */
1134 const wimlib_tchar *full_path;
1136 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1137 * children, ..., etc. */
1140 /** Pointer to the security descriptor for this file, in Windows
1141 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1142 * security descriptor. */
1143 const char *security_descriptor;
1145 /** Length of the above security descriptor. */
1146 size_t security_descriptor_size;
1148 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1149 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1150 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1151 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1152 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1153 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1154 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1155 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1156 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1157 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1158 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1159 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1160 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1161 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1162 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1163 /** File attributes, such as whether the file is a directory or not.
1164 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1165 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1166 * on other platforms. */
1167 uint32_t attributes;
1169 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1170 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1171 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1172 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1173 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1174 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1175 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1176 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1177 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1178 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1179 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1180 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1181 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1182 * attributes), this will give the reparse tag. This tells you whether
1183 * the reparse point is a symbolic link, junction point, or some other,
1184 * more unusual kind of reparse point. */
1185 uint32_t reparse_tag;
1187 /* Number of (hard) links to this file. */
1190 /** Number of named data streams that this file has. Normally 0. */
1191 uint32_t num_named_streams;
1193 /** Roughly, the inode number of this file. However, it may be 0 if
1194 * @p num_links == 1. */
1195 uint64_t hard_link_group_id;
1197 /** Time this file was created. */
1198 struct timespec creation_time;
1200 /** Time this file was last written to. */
1201 struct timespec last_write_time;
1203 /** Time this file was last accessed. */
1204 struct timespec last_access_time;
1205 uint64_t reserved[16];
1207 /** Array of streams that make up this file. The first entry will
1208 * always exist and will correspond to the unnamed data stream (default
1209 * file contents), so it will have @p stream_name == @c NULL. There
1210 * will then be @p num_named_streams additional entries that specify the
1211 * named data streams, if any, each of which will have @p stream_name !=
1213 struct wimlib_stream_entry streams[];
1217 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1220 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1224 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1227 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1230 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1231 * just on the specified path. */
1232 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1234 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1235 * itself; only its children (in the case of a non-empty directory) */
1236 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1238 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1239 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1240 * table of the ::WIMStruct. The default behavior without this flag is to fill
1241 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1242 * wimlib_resource_entry::is_missing "is_missing" flag. */
1243 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1247 /** @ingroup G_modifying_wims
1250 /** Directly capture a NTFS volume rather than a generic directory. This flag
1251 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1252 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1253 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1255 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1256 * with ::WIMLIB_ADD_FLAG_NTFS. */
1257 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1259 /** Call the progress function with the message
1260 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1262 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1264 /** Mark the image being added as the bootable image of the WIM. Not valid for
1265 * wimlib_update_image(). */
1266 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1268 /** Store the UNIX owner, group, and mode. This is done by adding a special
1269 * alternate data stream to each regular file, symbolic link, and directory to
1270 * contain this information. Please note that this flag is for convenience
1271 * only; Microsoft's implementation will not understand this special
1272 * information. This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1273 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1275 /** Do not capture security descriptors. Only has an effect in NTFS capture
1276 * mode, or in Windows native builds. */
1277 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1279 /** Fail immediately if the full security descriptor of any file or directory
1280 * cannot be accessed. Only has an effect in Windows native builds. The
1281 * default behavior without this flag is to first try omitting the SACL from the
1282 * security descriptor, then to try omitting the security descriptor entirely.
1284 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1286 /** Call the progress function with the message
1287 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1288 * capture. This is a subset of the messages provided by
1289 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1290 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1292 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1293 * in the case of Windows) that point inside the directory being captured to
1294 * instead be absolute relative to the directory being captured, rather than the
1295 * current root; also exclude absolute symbolic links that point outside the
1296 * directory tree being captured.
1298 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1299 * the WIM header or if this is the first image being added.
1300 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1301 * reparse point fixups enabled and currently cannot be unset. */
1302 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1304 /** Don't do reparse point fixups. The default behavior is described in the
1305 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1306 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1308 /** Do not automatically exclude unsupported files or directories from capture;
1309 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1310 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1311 * such a file is encountered. */
1312 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1315 * Automatically select a capture configuration appropriate for capturing
1316 * filesystems containing Windows operating systems. For example,
1317 * "pagefile.sys" and "System Volume Information" will be excluded.
1319 * When this flag is specified, the corresponding @p config parameter or member
1322 * Note that the default behavior--- that is, when this flag is not specified
1323 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1324 * no files are excluded from capture.
1326 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1329 * Capture image as WIMBoot compatible. In addition, if no capture
1330 * configuration file is explicitly specified use the capture configuration file
1331 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1332 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1333 * configuration file is explicitly specified, use it and also place it at
1334 * /Windows/System32/WimBootCompress.ini in the WIM image.
1336 * Note: this will not by itself change the compression type. Before writing
1337 * the WIM file, it's recommended to also do:
1340 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1341 * wimlib_set_output_chunk_size(wim, 4096);
1344 * since that makes access to the data faster (at the cost of a worse
1345 * compression ratio compared to the 32768-byte LZX chunks usually used).
1347 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1349 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1350 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1351 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1352 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1353 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1354 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1355 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1356 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1357 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1358 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1359 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1360 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1361 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1362 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1366 /** @ingroup G_modifying_wims
1369 /** Do not issue an error if the path to delete does not exist. */
1370 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1372 /** Delete the file or directory tree recursively; if not specified, an error is
1373 * issued if the path to delete is a directory. */
1374 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1377 /** @ingroup G_modifying_wims
1381 * If a single image is being exported, mark it bootable in the destination WIM.
1382 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1383 * the image in the source WIM (if any) that is marked as bootable is also
1384 * marked as bootable in the destination WIM.
1386 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1388 /** Give the exported image(s) no names. Avoids problems with image name
1391 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1393 /** Give the exported image(s) no descriptions. */
1394 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1397 /** @ingroup G_extracting_wims
1400 /** Extract the image directly to a NTFS volume rather than a generic directory.
1401 * This mode is only available if wimlib was compiled with libntfs-3g support;
1402 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1403 * extraction target will be interpreted as the path to a NTFS volume image (as
1404 * a regular file or block device) rather than a directory. It will be opened
1405 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1406 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1407 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1408 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1410 /** When identical files are extracted from the WIM, always hard link them
1411 * together. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_SYMLINK.
1413 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1415 /** When identical files are extracted from the WIM, always symlink them
1416 * together. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_HARDLINK.
1418 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1420 /** This flag no longer does anything but is reserved for future use. */
1421 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1423 /** Read the WIM file sequentially while extracting the image. As of wimlib
1424 * v1.6.0 this is the default behavior, and this flag no longer does anything.
1426 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1428 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1429 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1431 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1433 /** Do not extract security descriptors. This flag cannot be combined with
1434 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1435 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1437 /** Fail immediately if the full security descriptor of any file or directory
1438 * cannot be set exactly as specified in the WIM file. On Windows, the default
1439 * behavior without this flag when wimlib does not have permission to set the
1440 * correct security descriptor is to fall back to setting the security
1441 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1442 * owner omitted, then not at all. This flag cannot be combined with
1443 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1444 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1446 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1447 * reparse-point fixups on, so absolute symbolic links or junction points will
1448 * be fixed to be absolute relative to the actual extraction root. Reparse-
1449 * point fixups are done by default for wimlib_extract_image() and
1450 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1451 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1452 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1454 /** Force reparse-point fixups on extraction off, regardless of the state of the
1455 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1456 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1457 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1459 /** Extract the paths, each of which must name a regular file, to standard
1460 * output. Not valid for wimlib_extract_image() and
1461 * wimlib_extract_image_from_pipe(). */
1462 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1464 /** Instead of ignoring files and directories with names that cannot be
1465 * represented on the current platform (note: Windows has more restrictions on
1466 * filenames than POSIX-compliant systems), try to replace characters or append
1467 * junk to the names so that they can be extracted in some form. */
1468 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1470 /** On Windows, when there exist two or more files with the same case
1471 * insensitive name but different case sensitive names, try to extract them all
1472 * by appending junk to the end of them, rather than arbitrarily extracting only
1474 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1476 /** Do not ignore failure to set timestamps on extracted files. */
1477 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1479 /** Do not ignore failure to set short names on extracted files. */
1480 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1482 /** Do not ignore failure to extract symbolic links (and junction points, on
1483 * Windows) due to permissions problems. By default, such failures are ignored
1484 * since the default configuration of Windows only allows the Administrator to
1485 * create symbolic links. */
1486 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1488 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1489 * behavior is currently less than satisfactory. Do not use (yet). */
1490 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1492 /** Perform the extraction ordered by the tree of files to extract rather than
1493 * how the underlying streams are arranged in the WIM file. For regular WIM
1494 * files this may decrease or increase performance, depending on various
1495 * factors. For WIM files containing packed streams this will decrease
1497 #define WIMLIB_EXTRACT_FLAG_FILE_ORDER 0x00020000
1499 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1500 * paths to extract as wildcard patterns ("globs") which may contain the
1501 * wildcard characters @c ? and @c *. The @c ? character matches any
1502 * non-path-separator character, whereas the @c * character matches zero or more
1503 * non-path-separator characters. Consequently, each glob may match zero or
1504 * more actual paths in the WIM image. By default, if a glob does not match any
1505 * files, a warning but not an error will be issued, even if the glob did not
1506 * actually contain wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1507 * to get an error instead. */
1508 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1510 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1511 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1512 * one of the provided globs did not match a file. */
1513 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1515 /** Do not extract Windows file attributes such as readonly, hidden, etc. */
1516 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1518 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1519 * preserve the directory structure of the archive when extracting --- that is,
1520 * place each extracted file or directory tree directly in the target directory.
1522 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1524 /** Windows only: Extract files as "pointers" back to the WIM archive. See the
1525 * documentation for the <b>--wimboot</b> option of <b>wimlib-imagex apply</b>
1526 * for more information. */
1527 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1530 /** @ingroup G_mounting_wim_images
1533 /** Mount the WIM image read-write rather than the default of read-only. */
1534 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1536 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1537 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1539 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1540 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1542 /** Access alternate data streams in the mounted WIM image through extended file
1543 * attributes. This is the default mode. */
1544 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1546 /** Access alternate data streams in the mounted WIM image by specifying the
1547 * file name, a colon, then the alternate file stream name. */
1548 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1550 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1551 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1552 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1554 /** Allow other users to see the mounted filesystem. (this passes the @c
1555 * allow_other option to FUSE mount) */
1556 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1559 /** @ingroup G_creating_and_opening_wims
1562 /** Verify the WIM contents against the WIM's integrity table, if present. This
1563 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1564 * checksummed and checked against the SHA1 message digests specified in the
1565 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1566 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1567 * integrity table is invalid). */
1568 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1570 /** Issue an error if the WIM is part of a split WIM. Software can provide
1571 * this flag for convenience if it explicitly does not want to support split
1573 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1575 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1576 * is not. A WIM is considered writable only if it is writable at the
1577 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1578 * header, and is not part of a spanned set. It is not required to provide this
1579 * flag before attempting to make changes to the WIM, but with this flag you get
1580 * an error sooner rather than later. */
1581 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1584 /** @ingroup G_mounting_wim_images
1587 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1588 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1590 /** Unless this flag is given, changes to a read-write mounted WIM are
1591 * discarded. Ignored for read-only mounts. */
1592 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1594 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1595 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1597 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1598 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1600 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1601 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1603 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1604 * image, causes the modified image to be committed as a new, unnamed image
1605 * appended to the archive. The original image will be unmodified. */
1606 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
1609 /** @ingroup G_modifying_wims
1612 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1613 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1614 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1617 /** @ingroup G_writing_and_overwriting_wims
1620 /** Include an integrity table in the WIM.
1622 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1623 * an integrity table if and only if one was present before. For WIMs created
1624 * with wimlib_create_new_wim(), the default behavior is to not include an
1625 * integrity table. */
1626 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1628 /** Do not include an integrity table in the new WIM file. This is the default
1629 * behavior, unless the WIM already included an integrity table. */
1630 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1632 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1633 * images from it can be applied directly from a pipe using
1634 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1635 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1636 * with this flag will not be compatible with Microsoft's software.
1638 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1639 * WIM as pipable if and only if it was pipable before. For WIMs created with
1640 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1642 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1644 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1645 * WIM was pipable already. */
1646 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1648 /** Recompress all resources, even if they could otherwise be copied from a
1649 * different WIM with the same compression type (in the case of
1650 * wimlib_export_image() being called previously). This flag is also valid in
1651 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1652 * in the joined WIM file will be recompressed. */
1653 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1655 /** Call fsync() just before the WIM file is closed. */
1656 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1658 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1659 * data to it if possible. */
1660 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1662 /** wimlib_overwrite() only: Specifying this flag overrides the default
1663 * behavior of wimlib_overwrite() after one or more calls to
1664 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1665 * only minimal changes to correctly remove the image from the WIM will be
1666 * taken. In particular, all streams will be left alone, even if they are no
1667 * longer referenced. This is probably not what you want, because almost no
1668 * space will be saved by deleting an image in this way. */
1669 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1671 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1672 * flag is set in the WIM header. This can be used in combination with
1673 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1674 * set the readonly flag on the on-disk WIM file. */
1675 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1677 /** Do not include non-metadata resources already present in other WIMs. This
1678 * flag can be used to write a "delta" WIM after resources from the WIM on which
1679 * the delta is to be based were referenced with
1680 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1681 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1683 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1684 * are already present (not in external resource WIMs) and their reference
1685 * counts are correct, so the code does not need to recalculate which streams
1686 * are referenced. This is for optimization purposes only, since with this flag
1687 * specified, the metadata resources may not need to be decompressed and parsed.
1689 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1690 * already implied for wimlib_overwrite(). */
1691 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1693 #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
1696 * When writing streams in the resulting WIM file, pack multiple streams into a
1697 * single WIM resource instead of compressing them independently. This tends to
1698 * produce a better compression ratio at the cost of less random access.
1699 * However, WIMs created with this flag are only compatible with wimlib v1.6.0
1700 * or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup only and
1701 * <b>not including ImageX and Dism</b>. WIMs created with this flag must use
1702 * version number 3584 in their header instead of 68864.
1704 * If this flag is passed to wimlib_overwrite() and the WIM did not previously
1705 * contain packed streams, the WIM's version number will be changed to 3584 and
1706 * the new streams will be written packed. Use ::WIMLIB_WRITE_FLAG_REBUILD to
1707 * force the WIM to be fully rebuilt. */
1708 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1711 /** @ingroup G_general
1714 /** Assume that strings are represented in UTF-8, even if this is not the
1715 * locale's character encoding. This flag is ignored on Windows, where wimlib
1716 * always uses UTF-16LE. */
1717 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1719 /** Windows-only: do not attempt to acquire additional privileges (currently
1720 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1721 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1722 * for the case where the calling program manages these privileges itself.
1723 * Note: no error is issued if privileges cannot be acquired, although related
1724 * errors may be reported later, depending on if the operations performed
1725 * actually require additional privileges or not. */
1726 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1728 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1729 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1730 * to read all possible data and metadata for a capture operation could not be
1731 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1733 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1735 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1736 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1737 * to restore all possible data and metadata for an apply operation could not be
1738 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1740 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1742 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
1744 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
1746 /** Default to interpreting WIM paths case insensitively (default on Windows).
1747 * This does not apply to mounted images. */
1748 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
1751 /** @ingroup G_nonstandalone_wims
1754 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
1755 * Ignored by wimlib_reference_resources(). */
1756 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1758 /** For wimlib_reference_resource_files(), issue an error
1759 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1760 * default behavior without this flag is to issue no error at that point, but
1761 * then attempt to open the glob as a literal path, which of course will fail
1762 * anyway if no file exists at that path. No effect if
1763 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
1764 * wimlib_reference_resources(). */
1765 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1768 /** @ingroup G_modifying_wims
1771 /** The specific type of update to perform. */
1772 enum wimlib_update_op {
1773 /** Add a new file or directory tree to the WIM image in a
1774 * certain location. */
1775 WIMLIB_UPDATE_OP_ADD = 0,
1777 /** Delete a file or directory tree from the WIM image. */
1778 WIMLIB_UPDATE_OP_DELETE,
1780 /** Rename a file or directory tree in the WIM image. */
1781 WIMLIB_UPDATE_OP_RENAME,
1784 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1785 struct wimlib_add_command {
1786 /** Filesystem path to the file or directory tree to
1788 wimlib_tchar *fs_source_path;
1789 /** Path, specified from the root of the WIM image, at
1790 * which to add the file or directory tree within the
1792 wimlib_tchar *wim_target_path;
1794 /** Path to capture configuration file to use, or @c NULL for default.
1796 wimlib_tchar *config_file;
1798 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1802 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1803 struct wimlib_delete_command {
1804 /** Path, specified from the root of the WIM image, for
1805 * the file or directory tree within the WIM image to be
1807 wimlib_tchar *wim_path;
1808 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1812 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1813 struct wimlib_rename_command {
1814 /** Path, specified from the root of the WIM image, for
1815 * the source file or directory tree within the WIM
1817 wimlib_tchar *wim_source_path;
1818 /** Path, specified from the root of the WIM image, for
1819 * the destination file or directory tree within the WIM
1821 wimlib_tchar *wim_target_path;
1822 /** Reserved; set to 0. */
1826 /** Specification of an update to perform on a WIM image. */
1827 struct wimlib_update_command {
1829 enum wimlib_update_op op;
1832 struct wimlib_add_command add;
1833 struct wimlib_delete_command delete_; /* Underscore is for C++
1835 struct wimlib_rename_command rename;
1840 /** @ingroup G_general
1844 * Possible values of the error code returned by many functions in wimlib.
1846 * See the documentation for each wimlib function to see specifically what error
1847 * codes can be returned by a given function, and what they mean.
1849 enum wimlib_error_code {
1850 WIMLIB_ERR_SUCCESS = 0,
1851 WIMLIB_ERR_ALREADY_LOCKED,
1852 WIMLIB_ERR_DECOMPRESSION,
1853 WIMLIB_ERR_DELETE_STAGING_DIR,
1854 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1857 WIMLIB_ERR_FUSERMOUNT,
1858 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1859 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1860 WIMLIB_ERR_IMAGE_COUNT,
1861 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1862 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1863 WIMLIB_ERR_INTEGRITY,
1864 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1865 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1866 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1867 WIMLIB_ERR_INVALID_HEADER,
1868 WIMLIB_ERR_INVALID_IMAGE,
1869 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1870 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1871 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1872 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1873 WIMLIB_ERR_INVALID_OVERLAY,
1874 WIMLIB_ERR_INVALID_PARAM,
1875 WIMLIB_ERR_INVALID_PART_NUMBER,
1876 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1877 WIMLIB_ERR_INVALID_REPARSE_DATA,
1878 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1879 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1880 WIMLIB_ERR_INVALID_UTF16_STRING,
1881 WIMLIB_ERR_INVALID_UTF8_STRING,
1882 WIMLIB_ERR_IS_DIRECTORY,
1883 WIMLIB_ERR_IS_SPLIT_WIM,
1884 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1886 WIMLIB_ERR_METADATA_NOT_FOUND,
1891 WIMLIB_ERR_NOTEMPTY,
1892 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1893 WIMLIB_ERR_NOT_A_WIM_FILE,
1894 WIMLIB_ERR_NOT_PIPABLE,
1895 WIMLIB_ERR_NO_FILENAME,
1899 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1901 WIMLIB_ERR_READLINK,
1904 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1905 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1906 WIMLIB_ERR_RESOURCE_ORDER,
1907 WIMLIB_ERR_SET_ATTRIBUTES,
1908 WIMLIB_ERR_SET_REPARSE_DATA,
1909 WIMLIB_ERR_SET_SECURITY,
1910 WIMLIB_ERR_SET_SHORT_NAME,
1911 WIMLIB_ERR_SET_TIMESTAMPS,
1912 WIMLIB_ERR_SPLIT_INVALID,
1915 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1916 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1917 WIMLIB_ERR_UNKNOWN_VERSION,
1918 WIMLIB_ERR_UNSUPPORTED,
1919 WIMLIB_ERR_UNSUPPORTED_FILE,
1920 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1921 WIMLIB_ERR_WIM_IS_READONLY,
1924 WIMLIB_ERR_WIM_IS_ENCRYPTED,
1929 /** Used to indicate no WIM image or an invalid WIM image. */
1930 #define WIMLIB_NO_IMAGE 0
1932 /** Used to specify all images in the WIM. */
1933 #define WIMLIB_ALL_IMAGES (-1)
1938 * @ingroup G_modifying_wims
1940 * Appends an empty image to a WIM file. This empty image will initially
1941 * contain no files or directories, although if written without further
1942 * modifications, a root directory will be created automatically for it. After
1943 * calling this function, you can use wimlib_update_image() to add files to the
1944 * new WIM image. This gives you slightly more control over making the new
1945 * image compared to calling wimlib_add_image() or
1946 * wimlib_add_image_multisource() directly.
1949 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1952 * Name to give the new image. If @c NULL or empty, the new image is given
1953 * no name. If nonempty, it must specify a name that does not already
1955 * @param new_idx_ret
1956 * If non-<code>NULL</code>, the index of the newly added image is returned
1959 * @return 0 on success; nonzero on failure. The possible error codes are:
1961 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1962 * There is already an image in @p wim named @p name.
1963 * @retval ::WIMLIB_ERR_NOMEM
1964 * Failed to allocate the memory needed to add the new image.
1965 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1966 * The WIM file is considered read-only because of any of the reasons
1967 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1971 wimlib_add_empty_image(WIMStruct *wim,
1972 const wimlib_tchar *name,
1976 * @ingroup G_modifying_wims
1978 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1980 * The directory tree or NTFS volume is scanned immediately to load the dentry
1981 * tree into memory, and file attributes and symbolic links are read. However,
1982 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1985 * See the manual page for the @b wimlib-imagex program for more information
1986 * about the "normal" capture mode versus the NTFS capture mode (entered by
1987 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1989 * Note that @b no changes are committed to the underlying WIM file (if
1990 * any) until wimlib_write() or wimlib_overwrite() is called.
1993 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1996 * A path to a directory or unmounted NTFS volume that will be captured as
1999 * Name to give the new image. If @c NULL or empty, the new image is given
2000 * no name. If nonempty, it must specify a name that does not already
2002 * @param config_file
2003 * Path to capture configuration file, or @c NULL. This file may specify,
2004 * among other things, which files to exclude from capture. See the man
2005 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2006 * details of the file format. If @c NULL, the default capture
2007 * configuration shall be used. Ordinarily, the default capture
2008 * configuration will result in no files being excluded from capture purely
2009 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2010 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2012 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2013 * @param progress_func
2014 * If non-NULL, a function that will be called periodically with the
2015 * progress of the current operation. The progress messages that will be
2016 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
2017 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
2018 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2020 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2021 * discarded so that it appears to be in the same state as when this function
2024 * This function is implemented by calling wimlib_add_empty_image(), then
2025 * calling wimlib_update_image() with a single "add" command, so any error code
2026 * returned by wimlib_add_empty_image() may be returned, as well as any error
2027 * codes returned by wimlib_update_image() other than ones documented as only
2028 * being returned specifically by an update involving delete or rename commands.
2031 wimlib_add_image(WIMStruct *wim,
2032 const wimlib_tchar *source,
2033 const wimlib_tchar *name,
2034 const wimlib_tchar *config_file,
2036 wimlib_progress_func_t progress_func);
2039 * @ingroup G_modifying_wims
2041 * This function is equivalent to wimlib_add_image() except it allows for
2042 * multiple sources to be combined into a single WIM image. This is done by
2043 * specifying the @p sources and @p num_sources parameters instead of the @p
2044 * source parameter of wimlib_add_image(). The rest of the parameters are the
2045 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2046 * capture</b> for full details on how this mode works.
2048 * In addition to the error codes that wimlib_add_image() can return,
2049 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2050 * when trying to overlay a non-directory on a directory or when otherwise
2051 * trying to overlay multiple conflicting files to the same location in the WIM
2052 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2053 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2054 * was not exactly one capture source with the target being the root directory.
2055 * (In this respect, there is no advantage to using
2056 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2059 wimlib_add_image_multisource(WIMStruct *wim,
2060 const struct wimlib_capture_source *sources,
2062 const wimlib_tchar *name,
2063 const wimlib_tchar *config_file,
2065 wimlib_progress_func_t progress_func);
2068 * @ingroup G_creating_and_opening_wims
2070 * Creates a ::WIMStruct for a new WIM file.
2072 * This only creates an in-memory structure for a WIM that initially contains no
2073 * images. No on-disk file is created until wimlib_write() is called.
2076 * The type of compression to be used in the new WIM file, as one of the
2077 * ::wimlib_compression_type constants.
2079 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2080 * written to the memory location pointed to by this paramater. The
2081 * ::WIMStruct must be freed using using wimlib_free() when finished with
2083 * @return 0 on success; nonzero on error.
2084 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2085 * @p ctype was not a supported compression type.
2086 * @retval ::WIMLIB_ERR_NOMEM
2087 * Failed to allocate needed memory.
2090 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2093 * @ingroup G_modifying_wims
2095 * Deletes an image, or all images, from a WIM file.
2097 * All streams referenced by the image(s) being deleted are removed from the
2098 * lookup table of the WIM if they are not referenced by any other images in the
2101 * Please note that @b no changes are committed to the underlying WIM file (if
2102 * any) until wimlib_write() or wimlib_overwrite() is called.
2105 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2108 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2110 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2111 * to be left unmodified only if @p image specified a single image. If instead
2112 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2113 * possible for some but not all of the images to have been deleted when a
2114 * failure status is returned.
2116 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2117 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2118 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2119 * The WIM file is considered read-only because of any of the reasons
2120 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2123 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2124 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2125 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2126 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2127 * different reasons) to read the metadata resource for an image that needed to
2131 wimlib_delete_image(WIMStruct *wim, int image);
2134 * @ingroup G_modifying_wims
2136 * Exports an image, or all the images, from a WIM file, into another WIM file.
2138 * The destination image is made to share the same dentry tree and security data
2139 * structure as the source image. This places some restrictions on additional
2140 * functions that may be called. wimlib_mount_image() may not be called on
2141 * either the source image or the destination image without an intervening call
2142 * to a function that un-shares the images, such as wimlib_free() on @p
2143 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2144 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2145 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2146 * have references back to @p src_wim.
2148 * If this function fails, all changes to @p dest_wim are rolled back.
2150 * Please note that no changes are committed to the underlying WIM file of @p
2151 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2154 * The WIM from which to export the images, specified as a pointer to the
2155 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2156 * split WIM. In the case of a WIM file that is not standalone, this
2157 * ::WIMStruct must have had any needed external resources previously
2158 * referenced using wimlib_reference_resources() or
2159 * wimlib_reference_resource_files().
2161 * The image to export from @p src_wim, as either a 1-based image index to
2162 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2164 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2167 * For single-image exports, the name to give the exported image in @p
2168 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2169 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2170 * that case, the names are all taken from @p src_wim. This parameter is
2171 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2172 * @param dest_description
2173 * For single-image exports, the description to give the exported image in
2174 * the new WIM file. If left @c NULL, the description from @p src_wim is
2175 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2176 * NULL; in that case, the description are all taken from @p src_wim. This
2177 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2178 * @param export_flags
2179 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2180 * @param progress_func
2181 * Currently ignored, but reserved for a function that will be called with
2182 * information about the operation. Use NULL if no additional information
2185 * @return 0 on success; nonzero on error.
2186 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2187 * One or more of the names being given to an exported image was already in
2188 * use in the destination WIM.
2189 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2190 * @p src_image does not exist in @p src_wim and was not
2191 * ::WIMLIB_ALL_IMAGES.
2192 * @retval ::WIMLIB_ERR_INVALID_PARAM
2193 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2194 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2196 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2197 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2198 * example, one of them was a non-first part of a split WIM.
2199 * @retval ::WIMLIB_ERR_NOMEM
2200 * Failed to allocate needed memory.
2201 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2202 * A resource that needed to be exported could not be found in either the
2203 * source or destination WIMs. This error can occur if, for example, @p
2204 * src_wim is part of a split WIM but needed resources from the other split
2205 * WIM parts were not referenced with wimlib_reference_resources() or
2206 * wimlib_reference_resource_files() before the call to
2207 * wimlib_export_image().
2208 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2209 * @p dest_wim is considered read-only because of any of the reasons
2210 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2213 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2214 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2215 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2216 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2217 * different reasons) to read the metadata resource for an image in @p src_wim
2218 * that needed to be exported.
2221 wimlib_export_image(WIMStruct *src_wim, int src_image,
2222 WIMStruct *dest_wim,
2223 const wimlib_tchar *dest_name,
2224 const wimlib_tchar *dest_description,
2226 wimlib_progress_func_t progress_func);
2230 * @ingroup G_extracting_wims
2232 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2235 * The exact behavior of how wimlib extracts files from a WIM image is
2236 * controllable by the @p extract_flags parameter, but there also are
2237 * differences depending on the platform (UNIX-like vs Windows). See the manual
2238 * page for <b>wimlib-imagex apply</b> for more information, including about the
2239 * special "NTFS volume extraction mode" entered by providing
2240 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2243 * The WIM from which to extract the image(s), specified as a pointer to
2244 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2245 * of a split WIM. In the case of a WIM file that is not standalone, this
2246 * ::WIMStruct must have had any needed external resources previously
2247 * referenced using wimlib_reference_resources() or
2248 * wimlib_reference_resource_files().
2250 * The image to extract, specified as either the 1-based index of a single
2251 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2252 * to be extracted. ::WIMLIB_ALL_IMAGES cannot be used if
2253 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2255 * Directory to extract the WIM image(s) to; or, with
2256 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2257 * the unmounted NTFS volume to which to extract the image.
2258 * @param extract_flags
2259 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2260 * @param progress_func
2261 * If non-NULL, a function that will be called periodically with the
2262 * progress of the current operation. The main message to look for is
2263 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2266 * @return 0 on success; nonzero on error.
2267 * @retval ::WIMLIB_ERR_DECOMPRESSION
2268 * Failed to decompress data contained in the WIM.
2269 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2270 * The metadata for one of the images to extract was invalid.
2271 * @retval ::WIMLIB_ERR_INVALID_PARAM
2272 * The extraction flags were invalid; more details may be found in the
2273 * documentation for the specific extraction flags that were specified. Or
2274 * @p target was @c NULL or the empty string, or @p wim was @c NULL.
2275 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2276 * The SHA1 message digest of an extracted stream did not match the SHA1
2277 * message digest given in the WIM.
2278 * @retval ::WIMLIB_ERR_LINK
2279 * Failed to create a symbolic link or a hard link.
2280 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2281 * The metadata resource for one of the images to extract was not found.
2282 * This can happen if @p wim represents a non-first part of a split WIM.
2283 * @retval ::WIMLIB_ERR_MKDIR
2284 * Failed create a directory.
2285 * @retval ::WIMLIB_ERR_NOMEM
2286 * Failed to allocate needed memory.
2287 * @retval ::WIMLIB_ERR_OPEN
2288 * Could not create a file, or failed to open an already-extracted file.
2289 * @retval ::WIMLIB_ERR_READ
2290 * Failed to read data from the WIM.
2291 * @retval ::WIMLIB_ERR_READLINK
2292 * Failed to determine the target of a symbolic link in the WIM.
2293 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2294 * Failed to fix the target of an absolute symbolic link (e.g. if the
2295 * target would have exceeded the maximum allowed length). (Only if
2296 * reparse data was supported by the extraction mode and
2297 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2299 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2300 * One of the files or directories that needed to be extracted referenced a
2301 * stream not present in the WIM's lookup table (or in any of the lookup
2302 * tables of the split WIM parts).
2303 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2304 * Failed to set attributes on a file.
2305 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2306 * Failed to set reparse data on a file (only if reparse data was supported
2307 * by the extraction mode).
2308 * @retval ::WIMLIB_ERR_SET_SECURITY
2309 * Failed to set security descriptor on a file
2310 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2312 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2313 * Failed to set the short name of a file (only if
2314 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2315 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2316 * Failed to set timestamps on a file (only if
2317 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2318 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2319 * Unexpected end-of-file occurred when reading data from the WIM.
2320 * @retval ::WIMLIB_ERR_UNSUPPORTED
2321 * A requested extraction flag, or the data or metadata that must be
2322 * extracted to support it, is unsupported in the build and configuration
2323 * of wimlib, or on the current platform or extraction mode or target
2324 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2325 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2326 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2327 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2328 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2329 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2330 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2331 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2332 * image contains one or more files with short names, but extracting short
2333 * names is not supported --- on Windows, this occurs if the target volume
2334 * does not support short names, while on non-Windows, this occurs if
2335 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2336 * @retval ::WIMLIB_ERR_WIMBOOT
2337 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2338 * there was a problem creating WIMBoot pointer files.
2339 * @retval ::WIMLIB_ERR_WRITE
2340 * Failed to write data to a file being extracted.
2343 wimlib_extract_image(WIMStruct *wim, int image,
2344 const wimlib_tchar *target,
2346 wimlib_progress_func_t progress_func);
2349 * @ingroup G_extracting_wims
2351 * Since wimlib v1.5.0: Extract one image from a pipe on which a pipable WIM is
2354 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2355 * about pipable WIMs.
2357 * This function operates in a special way to read the WIM fully sequentially.
2358 * As a result, there is no ::WIMStruct is made visible to library users, and
2359 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2360 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2361 * seekable file, not a pipe.)
2364 * File descriptor, which may be a pipe, opened for reading and positioned
2365 * at the start of the pipable WIM.
2366 * @param image_num_or_name
2367 * String that specifies the 1-based index or name of the image to extract.
2368 * It is translated to an image index using the same rules that
2369 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2370 * only a single image (not all images) can be specified. Alternatively,
2371 * specify @p NULL here to use the first image in the WIM if it contains
2372 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2374 * Same as the corresponding parameter to wimlib_extract_image().
2375 * @param extract_flags
2376 * Same as the corresponding parameter to wimlib_extract_image(), except
2377 * that ::WIMLIB_EXTRACT_FLAG_FILE_ORDER cannot be specified and will
2378 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2379 * @param progress_func
2380 * Same as the corresponding parameter to wimlib_extract_image(), except
2381 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2382 * received by the progress function.
2384 * @return 0 on success; nonzero on error. The possible error codes include
2385 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2388 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2389 * Data read from the pipable WIM was invalid.
2390 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2391 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2394 wimlib_extract_image_from_pipe(int pipe_fd,
2395 const wimlib_tchar *image_num_or_name,
2396 const wimlib_tchar *target, int extract_flags,
2397 wimlib_progress_func_t progress_func);
2400 * @ingroup G_extracting_wims
2402 * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to
2403 * extract from the WIM image are specified in the UTF-8 text file named by @p
2404 * path_list_file which itself contains the list of paths to use, one per line.
2405 * Leading and trailing whitespace, and otherwise empty lines and lines
2406 * beginning with the ';' character are ignored. No quotes are needed as paths
2407 * are otherwise delimited by the newline character.
2409 * The error codes are the same as those returned by wimlib_extract_paths(),
2410 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2411 * cannot read the path list file (::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2412 * ::WIMLIB_ERR_READ, ::WIMLIB_ERR_NOMEM, or ::WIMLIB_ERR_INVALID_UTF8_STRING).
2415 wimlib_extract_pathlist(WIMStruct *wim, int image,
2416 const wimlib_tchar *target,
2417 const wimlib_tchar *path_list_file,
2419 wimlib_progress_func_t progress_func);
2422 * @ingroup G_extracting_wims
2424 * Since wimlib v1.6.0: Extract zero or more paths (files or directory trees)
2425 * from the specified WIM image.
2427 * By default, each path will be extracted to a corresponding subdirectory of
2428 * the target based on its location in the WIM image. For example, if one of
2429 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2430 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2431 * can be changed by providing the flag
2432 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2433 * or directory tree to be placed directly in the target directory --- so the
2434 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2436 * Symbolic links will not be dereferenced when paths in the WIM image are
2440 * WIM from which to extract the paths, specified as a pointer to the
2441 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2442 * split WIM. In the case of a WIM file that is not standalone, this
2443 * ::WIMStruct must have had any needed external resources previously
2444 * referenced using wimlib_reference_resources() or
2445 * wimlib_reference_resource_files().
2447 * 1-based index of the WIM image from which to extract the paths.
2449 * Array of paths to extract. Each element must be the absolute path to a
2450 * file or directory within the WIM image. Separators may be either
2451 * forwards or backwards slashes, and leading path separators are optional.
2452 * The paths will be interpreted either case-sensitively (UNIX default) or
2453 * case-insensitively (Windows default); this can be changed by
2454 * wimlib_global_init().
2456 * By default, the characters @c * and @c ? are interpreted literally.
2457 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2460 * By default, if any paths to extract do not exist, the error code
2461 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2462 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2464 * Number of paths specified in @p paths.
2466 * Directory to which to extract the paths; or with
2467 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2468 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2469 * paths being extracted, the @p target must be native path. On UNIX-like
2470 * systems it may not contain backslashes, for example.
2471 * @param extract_flags
2472 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2473 * @param progress_func
2474 * If non-NULL, a function that will be called periodically with the
2475 * progress of the current operation. The main message to look for is
2476 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2477 * well. Note: because the extraction code is stream-based and not
2478 * file-based, there is no way to get information about which path is
2479 * currently being extracted, but based on byte count you can still
2480 * calculate an approximate percentage complete for the extraction overall
2481 * which may be all you really need anyway.
2483 * @return 0 on success; nonzero on error. Most of the error codes are the same
2484 * as those returned by wimlib_extract_image(). Below, some of the error codes
2485 * returned in situations specific to path-mode extraction are documented:
2487 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2488 * @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2490 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2491 * One of the paths to extract did not exist in the WIM image. This error
2492 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2493 * specified in @p extract_flags, or if both
2494 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2495 * were specified in @p extract_flags.
2496 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2497 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2498 * one of the paths to extract did not name a regular file.
2501 wimlib_extract_paths(WIMStruct *wim,
2503 const wimlib_tchar *target,
2504 const wimlib_tchar * const *paths,
2507 wimlib_progress_func_t progress_func);
2510 * @ingroup G_wim_information
2512 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2513 * includes a string of XML that describes the images contained in the WIM.
2515 * See wimlib_get_xml_data() to read the XML data into memory instead.
2518 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2519 * have to be standalone (e.g. it could be part of a split WIM).
2521 * @c stdout, or a FILE* opened for writing, to extract the data to.
2523 * @return 0 on success; nonzero on error.
2524 * @retval ::WIMLIB_ERR_INVALID_PARAM
2525 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2526 * @retval ::WIMLIB_ERR_NOMEM
2527 * @retval ::WIMLIB_ERR_READ
2528 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2529 * Failed to read the XML data from the WIM.
2530 * @retval ::WIMLIB_ERR_WRITE
2531 * Failed to completely write the XML data to @p fp.
2534 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2537 * @ingroup G_general
2539 * Frees all memory allocated for a WIMStruct and closes all files associated
2543 * Pointer to the ::WIMStruct for a WIM file.
2545 * @return This function has no return value.
2548 wimlib_free(WIMStruct *wim);
2551 * @ingroup G_general
2553 * Converts a ::wimlib_compression_type value into a string.
2556 * The ::wimlib_compression_type value to convert.
2559 * A statically allocated string naming the compression algorithm,
2560 * such as "None", "LZX", "XPRESS", or "Invalid".
2562 extern const wimlib_tchar *
2563 wimlib_get_compression_type_string(int ctype);
2566 * @ingroup G_general
2568 * Converts an error code into a string describing it.
2571 * The error code returned by one of wimlib's functions.
2574 * Pointer to a statically allocated string describing the error code,
2575 * or @c NULL if the error code is not valid.
2577 extern const wimlib_tchar *
2578 wimlib_get_error_string(enum wimlib_error_code code);
2581 * @ingroup G_wim_information
2583 * Returns the description of the specified image.
2586 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2587 * to be standalone (e.g. it could be part of a split WIM).
2589 * The number of the image, numbered starting at 1.
2592 * The description of the image, or @c NULL if there is no such image, or
2593 * @c NULL if the specified image has no description. The description
2594 * string is in library-internal memory and may not be modified or freed;
2595 * in addition, the string will become invalid if the description of the
2596 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2598 extern const wimlib_tchar *
2599 wimlib_get_image_description(const WIMStruct *wim, int image);
2602 * @ingroup G_wim_information
2604 * Returns the name of the specified image.
2607 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2608 * to be standalone (e.g. it could be part of a split WIM).
2610 * The number of the image, numbered starting at 1.
2613 * The name of the image, or @c NULL if there is no such image, or an empty
2614 * string if the image is unnamed. The name string is in
2615 * library-internal memory and may not be modified or freed; in addition,
2616 * the string will become invalid if the name of the image is changed, the
2617 * image is deleted, or the ::WIMStruct is destroyed.
2619 extern const wimlib_tchar *
2620 wimlib_get_image_name(const WIMStruct *wim, int image);
2623 * @ingroup G_general
2625 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2626 * the major version, the next 10 bits contain the minor version, and the low 10
2627 * bits contain the patch version.
2629 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2630 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2631 * corresponding header file.
2634 wimlib_get_version(void);
2637 * @ingroup G_wim_information
2639 * Get basic information about a WIM file.
2642 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2643 * to be standalone (e.g. it could be part of a split WIM).
2645 * A ::wimlib_wim_info structure that will be filled in with information
2646 * about the WIM file.
2651 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2654 * @ingroup G_wim_information
2656 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2657 * includes a string of XML that describes the images contained in the WIM.
2659 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2663 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2664 * have to be standalone (e.g. it could be part of a split WIM).
2666 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2667 * XML data is written to this location.
2668 * @param bufsize_ret
2669 * The size of the XML data in bytes is written to this location.
2671 * @return 0 on success; nonzero on error.
2672 * @retval ::WIMLIB_ERR_INVALID_PARAM
2673 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2674 * @p buf_ret or @p bufsize_ret was @c NULL.
2675 * @retval ::WIMLIB_ERR_NOMEM
2676 * @retval ::WIMLIB_ERR_READ
2677 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2678 * Failed to read the XML data from the WIM.
2681 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2684 * @ingroup G_general
2686 * Initialization function for wimlib. Call before using any other wimlib
2687 * function except wimlib_set_print_errors(). If not done manually, this
2688 * function will be called automatically with @p init_flags set to
2689 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
2690 * after it has already successfully run.
2693 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2695 * @return 0 on success; nonzero on failure. Currently, only the following
2696 * error code is defined:
2698 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2699 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2700 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2701 * init_flags, but the corresponding privileges could not be acquired.
2704 wimlib_global_init(int init_flags);
2707 * @ingroup G_general
2709 * Cleanup function for wimlib. You are not required to call this function, but
2710 * it will release any global resources allocated by the library.
2713 wimlib_global_cleanup(void);
2716 * @ingroup G_wim_information
2718 * Determines if an image name is already used by some image in the WIM.
2721 * Pointer to the ::WIMStruct for a WIM file.
2723 * The name to check.
2726 * @c true if there is already an image in @p wim named @p name; @c false
2727 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2728 * the empty string, @c false is returned.
2731 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2734 * @ingroup G_wim_information
2736 * Iterate through a file or directory tree in the WIM image. By specifying
2737 * appropriate flags and a callback function, you can get the attributes of a
2738 * file in the WIM, get a directory listing, or even get a listing of the entire
2742 * The WIM containing the image(s) over which to iterate, specified as a
2743 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2744 * or part 1 of a split WIM. In the case of a WIM file that is not
2745 * standalone, this ::WIMStruct should have had any needed external
2746 * resources previously referenced using wimlib_reference_resources() or
2747 * wimlib_reference_resource_files(). If not, see
2748 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2749 * the behavior when resources are missing.
2752 * The 1-based number of the image in @p wim that contains the files or
2753 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2754 * iteration on all images in the WIM.
2757 * Path in the WIM image at which to do the iteration.
2760 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2763 * A callback function that will receive each directory entry.
2766 * An extra parameter that will always be passed to the callback function
2769 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2770 * first nonzero value that was returned from @p cb. However, additional error
2771 * codes may be returned, including the following:
2773 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2774 * @p path did not exist in the WIM image.
2775 * @retval ::WIMLIB_ERR_NOMEM
2776 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2778 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2779 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2780 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2781 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2782 * different reasons) to read the metadata resource for an image over which
2783 * iteration needed to be done.
2786 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2788 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2791 * @ingroup G_wim_information
2793 * Iterate through the lookup table of a WIM file. This can be used to directly
2794 * get a listing of the unique resources contained in a WIM file over all
2795 * images. Both file resources and metadata resources are included. However,
2796 * only resources actually included in the file represented by @a wim, plus
2797 * explicitly referenced external resources (via wimlib_reference_resources() or
2798 * wimlib_reference_resource_files()) are included in the iteration. For
2799 * example, if @p wim represents just one part of a split WIM, then only
2800 * resources in that part will be included, unless other resources were
2801 * explicitly referenced.
2804 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2805 * to be standalone (e.g. it could be part of a split WIM).
2808 * Reserved; set to 0.
2811 * A callback function that will receive each resource.
2814 * An extra parameter that will always be passed to the callback function
2817 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2818 * that was returned from @p cb.
2821 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2822 wimlib_iterate_lookup_table_callback_t cb,
2826 * @ingroup G_nonstandalone_wims
2828 * Joins a split WIM into a stand-alone one-part WIM.
2831 * An array of strings that gives the filenames of all parts of the split
2832 * WIM. No specific order is required, but all parts must be included with
2835 * Number of filenames in @p swms.
2836 * @param swm_open_flags
2837 * Open flags for the split WIM parts (e.g.
2838 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2839 * @param wim_write_flags
2840 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2841 * be used to write the joined WIM.
2842 * @param output_path
2843 * The path to write the joined WIM file to.
2844 * @param progress_func
2845 * If non-NULL, a function that will be called periodically with the
2846 * progress of the current operation.
2848 * @return 0 on success; nonzero on error. This function may return most error
2849 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2850 * as the following error code:
2852 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2853 * The split WIMs do not form a valid WIM because they do not include all
2854 * the parts of the original WIM, there are duplicate parts, or not all the
2855 * parts have the same GUID and compression type.
2857 * Note: wimlib is generalized enough that this function is not actually needed
2858 * to join a split WIM; instead, you could open the first part of the split WIM,
2859 * then reference the other parts with wimlib_reference_resource_files(), then
2860 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2861 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2865 wimlib_join(const wimlib_tchar * const *swms,
2867 const wimlib_tchar *output_path,
2869 int wim_write_flags,
2870 wimlib_progress_func_t progress_func);
2874 * @ingroup G_mounting_wim_images
2876 * Mounts an image in a WIM file on a directory read-only or read-write.
2878 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2879 * supported if wimlib was configured with @c --without-fuse. This includes
2880 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2883 * Calling this function daemonizes the process, unless
2884 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2885 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2886 * to the WIM are staged in a temporary directory.
2888 * It is safe to mount multiple images from the same underlying WIM file
2889 * read-only at the same time, but only if different ::WIMStruct's are used. It
2890 * is @b not safe to mount multiple images from the same WIM file read-write at
2893 * wimlib_mount_image() cannot be used on an image that was exported with
2894 * wimlib_export_image() while the dentry trees for both images are still in
2895 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2896 * that already has modifications pending (e.g. an image added with
2897 * wimlib_add_image()).
2900 * Pointer to the ::WIMStruct containing the image to be mounted.
2902 * The number of the image to mount, indexed starting from it. It must be
2903 * an existing, single image.
2905 * The path to an existing empty directory to mount the image on.
2906 * @param mount_flags
2907 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.
2908 * @param staging_dir
2909 * If non-NULL, the name of a directory in which the staging directory will
2910 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2911 * in @p mount_flags. If left @c NULL, the staging directory is created in
2912 * the same directory as the WIM file that @p wim was originally read from.
2914 * @return 0 on success; nonzero on error.
2916 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2917 * A read-write mount was requested, but an an exclusive advisory lock on
2918 * the on-disk WIM file could not be acquired because another thread or
2919 * process has mounted an image from the WIM read-write or is currently
2920 * modifying the WIM in-place.
2921 * @retval ::WIMLIB_ERR_FUSE
2922 * A non-zero status was returned by @c fuse_main().
2923 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2924 * @p image does not specify an existing, single image in @p wim.
2925 * @retval ::WIMLIB_ERR_INVALID_PARAM
2926 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2927 * wimlib_export_image(), or @p image has been added with
2928 * wimlib_add_image().
2929 * @retval ::WIMLIB_ERR_MKDIR
2930 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2931 * staging directory could not be created.
2932 * @retval ::WIMLIB_ERR_NOTDIR
2933 * Could not determine the current working directory.
2934 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2935 * One of the dentries in the image referenced a stream not present in the
2936 * WIM's lookup table (or in any of the lookup tables of the split WIM
2938 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2939 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2940 * wim is considered read-only because of any of the reasons mentioned in
2941 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2942 * @retval ::WIMLIB_ERR_UNSUPPORTED
2943 * Mounting is not supported, either because the platform is Windows, or
2944 * because the platform is UNIX-like and wimlib was compiled with @c
2947 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2948 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2949 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2950 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2951 * different reasons) to read the metadata resource for the image to mount.
2954 wimlib_mount_image(WIMStruct *wim,
2956 const wimlib_tchar *dir,
2958 const wimlib_tchar *staging_dir);
2961 * @ingroup G_creating_and_opening_wims
2963 * Opens a WIM file and creates a ::WIMStruct for it.
2966 * The path to the WIM file to open.
2969 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2971 * @param progress_func
2972 * If non-NULL, a function that will be called periodically with the
2973 * progress of the current operation. Currently, the only messages sent
2974 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2975 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2978 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2979 * is written to the memory location pointed to by this parameter. The
2980 * ::WIMStruct can be freed using using wimlib_free() when finished with
2983 * @return 0 on success; nonzero on error.
2984 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2985 * The WIM is not the non-first part of a split WIM, and the number of
2986 * metadata resources found in the WIM did not match the image count given
2987 * in the WIM header, or the number of <IMAGE> elements in the XML
2988 * data for the WIM did not match the image count given in the WIM header.
2989 * @retval ::WIMLIB_ERR_INTEGRITY
2990 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2991 * wim_file contains an integrity table, but the SHA1 message digest for a
2992 * chunk of the WIM does not match the corresponding message digest given
2993 * in the integrity table.
2994 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2995 * Resources in @p wim_file are compressed, but the chunk size was invalid
2996 * for the WIM's compression type.
2997 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2998 * The header of @p wim_file says that resources in the WIM are compressed,
2999 * but the header flag for a recognized compression type is not set.
3000 * @retval ::WIMLIB_ERR_INVALID_HEADER
3001 * The header of @p wim_file was otherwise invalid.
3002 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3003 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3004 * wim_file contains an integrity table, but the integrity table is
3006 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3007 * The lookup table for the WIM was invalid.
3008 * @retval ::WIMLIB_ERR_INVALID_PARAM
3009 * @p wim_ret was @c NULL.
3010 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3011 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3012 * specified in @p open_flags.
3013 * @retval ::WIMLIB_ERR_NOMEM
3014 * Failed to allocated needed memory.
3015 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3016 * @p wim_file does not begin with the expected magic characters.
3017 * @retval ::WIMLIB_ERR_OPEN
3018 * Failed to open the file @p wim_file for reading.
3019 * @retval ::WIMLIB_ERR_READ
3020 * Failed to read data from @p wim_file.
3021 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3022 * Unexpected end-of-file while reading data from @p wim_file.
3023 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3024 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3025 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3026 * The WIM cannot be opened because it contains encrypted segments. (It
3027 * may be a Windows 8 "ESD" file).
3028 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3029 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3030 * considered read-only because of any of the reasons mentioned in the
3031 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3032 * @retval ::WIMLIB_ERR_XML
3033 * The XML data for @p wim_file is invalid.
3036 wimlib_open_wim(const wimlib_tchar *wim_file,
3038 WIMStruct **wim_ret,
3039 wimlib_progress_func_t progress_func);
3042 * @ingroup G_writing_and_overwriting_wims
3044 * Overwrites the file that the WIM was originally read from, with changes made.
3045 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3046 * rather than wimlib_create_new_wim().
3048 * There are two ways that a WIM may be overwritten. The first is to do a full
3049 * rebuild. In this mode, the new WIM is written to a temporary file and then
3050 * renamed to the original file after it is has been completely written. The
3051 * temporary file is made in the same directory as the original WIM file. A
3052 * full rebuild may take a while, but can be used even if images have been
3053 * modified or deleted, will produce a WIM with no holes, and has little chance
3054 * of unintentional data loss because the temporary WIM is fsync()ed before
3055 * being renamed to the original WIM.
3057 * The second way to overwrite a WIM is by appending to the end of it and
3058 * overwriting the header. This can be much faster than a full rebuild, but the
3059 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3060 * begins with writing any new file resources *after* everything in the old WIM,
3061 * even though this will leave a hole where the old lookup table, XML data, and
3062 * integrity were. This is done so that the WIM remains valid even if the
3063 * operation is aborted mid-write. The WIM header is only overwritten at the
3064 * very last moment, and up until that point the WIM will be seen as the old
3067 * By default, wimlib_overwrite() does the append-style overwrite described
3068 * above, unless resources in the WIM are arranged in an unusual way or if
3069 * images have been deleted from the WIM. Use the flag
3070 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3071 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3072 * images have been deleted from the WIM.
3074 * In the temporary-file overwrite mode, no changes are made to the WIM on
3075 * failure, and the temporary file is deleted if possible. Abnormal termination
3076 * of the program will result in the temporary file being orphaned. In the
3077 * direct append mode, the WIM is truncated to the original length on failure;
3078 * and while abnormal termination of the program will result in extra data
3079 * appended to the original WIM, it should still be a valid WIM.
3081 * If this function completes successfully, no more functions should be called
3082 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3083 * the WIM file anew.
3086 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3087 * been in-memory changes made to it, which are then reflected in the
3089 * @param write_flags
3090 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3091 * @param num_threads
3092 * Number of threads to use for compression (see wimlib_write()).
3093 * @param progress_func
3094 * If non-NULL, a function that will be called periodically with the
3095 * progress of the current operation.
3097 * @return 0 on success; nonzero on error. This function may return most error
3098 * codes returned by wimlib_write() as well as the following error codes:
3100 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3101 * The WIM was going to be modified in-place (with no temporary file), but
3102 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3103 * because another thread or process has mounted an image from the WIM
3104 * read-write or is currently modifying the WIM in-place.
3105 * @retval ::WIMLIB_ERR_NO_FILENAME
3106 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3107 * than a WIM read with wimlib_open_wim().
3108 * @retval ::WIMLIB_ERR_RENAME
3109 * The temporary file that the WIM was written to could not be renamed to
3110 * the original filename of @p wim.
3111 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3112 * The WIM file is considered read-only because of any of the reasons
3113 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3117 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3118 wimlib_progress_func_t progress_func);
3121 * @ingroup G_wim_information
3123 * Prints information about one image, or all images, contained in a WIM.
3126 * Pointer to the ::WIMStruct for a WIM file.
3128 * The image about which to print information. Can be the number of an
3129 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3132 * @return This function has no return value. No error checking is done when
3133 * printing the information. If @p image is invalid, an error message is
3137 wimlib_print_available_images(const WIMStruct *wim, int image);
3140 * @ingroup G_wim_information
3142 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3143 * in a way that can be accessed programatically.
3146 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3149 * @ingroup G_nonstandalone_wims
3151 * Reference resources from other WIM files or split WIM parts. This function
3152 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3153 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3154 * from other files, before calling a function such as wimlib_extract_image()
3155 * that requires the resources to be present.
3158 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3159 * necessarily "standalone". In the case of split WIMs, this should be the
3160 * first part, since only the first part contains the metadata resources.
3161 * In the case of delta WIMs, this should be the delta WIM rather than the
3162 * WIM on which it is based.
3163 * @param resource_wimfiles_or_globs
3164 * Array of paths to WIM files and/or split WIM parts to reference.
3165 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3166 * ref_flags, these are treated as globs rather than literal paths. That
3167 * is, using this function you can specify zero or more globs, each of
3168 * which expands to one or more literal paths.
3170 * Number of entries in @p resource_wimfiles_or_globs.
3172 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3173 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3175 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3176 * pass to internal calls to wimlib_open_wim() on the reference files.
3177 * @param progress_func
3178 * Passed to internal calls to wimlib_open_wim() on the reference files.
3180 * @return 0 on success; nonzero on error.
3182 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3183 * One of the specified globs did not match any paths (only with both
3184 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3185 * specified in @p ref_flags).
3186 * @retval ::WIMLIB_ERR_NOMEM
3187 * Failed to allocate memory.
3188 * @retval ::WIMLIB_ERR_READ
3189 * I/O or permissions error while processing a file glob.
3191 * This function can additionally return most values that can be returned by
3192 * wimlib_open_wim().
3195 wimlib_reference_resource_files(WIMStruct *wim,
3196 const wimlib_tchar * const *resource_wimfiles_or_globs,
3200 wimlib_progress_func_t progress_func);
3203 * @ingroup G_nonstandalone_wims
3205 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3206 * where the caller must open the ::WIMStruct for each referenced file itself.
3209 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3210 * necessarily "standalone". In the case of split WIMs, this should be the
3211 * first part, since only the first part contains the metadata resources.
3212 * @param resource_wims
3213 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3214 * split WIM parts to reference.
3215 * @param num_resource_wims
3216 * Number of entries in @p resource_wims.
3218 * Currently ignored (set to 0).
3220 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3221 * @p resource_wims are referenced internally by @p wim and must not be freed
3222 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3223 * been freed with wimlib_free(), or immediately before freeing @p wim with
3226 * @retval ::WIMLIB_ERR_INVALID_PARAM
3227 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3228 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3229 * @retval ::WIMLIB_ERR_NOMEM
3230 * Failed to allocate memory.
3233 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3234 unsigned num_resource_wims, int ref_flags);
3237 * @ingroup G_modifying_wims
3239 * Declares that a newly added image is mostly the same as a prior image, but
3240 * captured at a later point in time, possibly with some modifications in the
3241 * intervening time. This is designed to be used in incremental backups of the
3242 * same filesystem or directory tree.
3244 * This function compares the metadata of the directory tree of the newly added
3245 * image against that of the old image. Any files that are present in both the
3246 * newly added image and the old image and have timestamps that indicate they
3247 * haven't been modified are deemed not to have been modified and have their
3248 * SHA1 message digest copied from the old image. Because of this and because
3249 * WIM uses single-instance streams, such files need not be read from the
3250 * filesystem when the WIM is being written or overwritten. Note that these
3251 * unchanged files will still be "archived" and will be logically present in the
3252 * new image; the optimization is that they don't need to actually be read from
3253 * the filesystem because the WIM already contains them.
3255 * This function is provided to optimize incremental backups. The resulting WIM
3256 * file will still be the same regardless of whether this function is called.
3257 * (This is, however, assuming that timestamps have not been manipulated or
3258 * unmaintained as to trick this function into thinking a file has not been
3259 * modified when really it has. To partly guard against such cases, other
3260 * metadata such as file sizes will be checked as well.)
3262 * This function must be called after adding the new image (e.g. with
3263 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3264 * wimlib_overwrite()).
3267 * Pointer to the ::WIMStruct for a WIM.
3269 * 1-based index in the WIM of the newly added image. This image can have
3270 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3271 * wimlib_add_empty_image() followed by wimlib_update_image().
3272 * @param template_wim
3273 * The ::WIMStruct for the WIM containing the template image. This can be
3274 * the same as @p wim, or it can be a different ::WIMStruct.
3275 * @param template_image
3276 * 1-based index in the WIM of a template image that reflects a prior state
3277 * of the directory tree being captured.
3279 * Reserved; must be 0.
3280 * @param progress_func
3281 * Currently ignored, but reserved for a function that will be called with
3282 * information about the operation. Use NULL if no additional information
3285 * @return 0 on success; nonzero on error.
3287 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3288 * @p new_image and/or @p template_image were not a valid image indices in
3290 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3291 * The specified ::WIMStruct did not actually contain the metadata resource
3292 * for the new or template image; for example, it was a non-first part of a
3294 * @retval ::WIMLIB_ERR_NOMEM
3295 * Failed to allocate needed memory.
3296 * @retval ::WIMLIB_ERR_INVALID_PARAM
3297 * @p new_image was equal to @p template_image, or @p new_image specified
3298 * an image that had not been modified since opening the WIM.
3300 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3301 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3302 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3303 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3304 * different reasons) to read the metadata resource for the template image.
3307 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3308 WIMStruct *template_wim, int template_image,
3309 int flags, wimlib_progress_func_t progress_func);
3312 * @ingroup G_wim_information
3314 * Translates a string specifying the name or number of an image in the WIM into
3315 * the number of the image. The images are numbered starting at 1.
3318 * Pointer to the ::WIMStruct for a WIM.
3319 * @param image_name_or_num
3320 * A string specifying the name or number of an image in the WIM. If it
3321 * parses to a positive integer, this integer is taken to specify the
3322 * number of the image, indexed starting at 1. Otherwise, it is taken to
3323 * be the name of an image, as given in the XML data for the WIM file. It
3324 * also may be the keyword "all" or the string "*", both of which will
3325 * resolve to ::WIMLIB_ALL_IMAGES.
3327 * There is no way to search for an image actually named "all", "*", or an
3328 * integer number, or an image that has no name. However, you can use
3329 * wimlib_get_image_name() to get the name of any image.
3332 * If the string resolved to a single existing image, the number of that
3333 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3334 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3335 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3336 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3337 * images in @p wim has no name.
3340 wimlib_resolve_image(WIMStruct *wim,
3341 const wimlib_tchar *image_name_or_num);
3344 * @ingroup G_modifying_wims
3346 * Changes the description of an image in the WIM.
3349 * Pointer to the ::WIMStruct for a WIM.
3351 * The number of the image for which to change the description.
3352 * @param description
3353 * The new description to give the image. It may be @c NULL, which
3354 * indicates that the image is to be given no description.
3356 * @return 0 on success; nonzero on error.
3357 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3358 * @p image does not specify a single existing image in @p wim.
3359 * @retval ::WIMLIB_ERR_NOMEM
3360 * Failed to allocate the memory needed to duplicate the @p description
3362 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3363 * @p wim is considered read-only because of any of the reasons mentioned
3364 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3367 wimlib_set_image_descripton(WIMStruct *wim, int image,
3368 const wimlib_tchar *description);
3371 * @ingroup G_writing_and_overwriting_wims
3373 * Set the compression chunk size of a WIM to use in subsequent calls to
3374 * wimlib_write() or wimlib_overwrite().
3376 * For compatibility reasons, using this function is not generally recommended.
3377 * See the documentation for the @c --chunk-size option of <b>wimlib-imagex
3378 * capture</b> for more information.
3380 * A larger compression chunk size will likely result in a better compression
3381 * ratio, but the speed of random access to the WIM will be reduced.
3382 * Furthermore, the effect of a larger compression chunk size is limited by the
3383 * size of each stream ("file") being compressed.
3386 * ::WIMStruct for a WIM.
3388 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3389 * on the compression format; see the documentation for the @c --chunk-size
3390 * option of <b>wimlib-imagex capture</b> for more information. As a
3391 * special case, if @p chunk_size is specified as 0, the chunk size is set
3392 * to the default for the currently selected output compression type.
3394 * @return 0 on success; nonzero on error.
3396 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3397 * @p chunk_size is not a supported chunk size for the currently selected
3398 * output compression type.
3401 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3404 * @ingroup G_writing_and_overwriting_wims
3406 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3410 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3413 * @ingroup G_writing_and_overwriting_wims
3415 * Set the compression type of a WIM to use in subsequent calls to
3416 * wimlib_write() or wimlib_overwrite().
3419 * ::WIMStruct for a WIM.
3421 * The compression type to set (one of ::wimlib_compression_type). If this
3422 * compression type is incompatible with the current output chunk size
3423 * (either the default or as set with wimlib_set_output_chunk_size()), the
3424 * output chunk size is reset to the default for that compression type.
3426 * @return 0 on success; nonzero on error.
3428 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3429 * @p ctype did not specify a valid compression type.
3432 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3435 * @ingroup G_writing_and_overwriting_wims
3437 * Similar to wimlib_set_output_compression_type(), but set the compression type
3438 * for writing packed streams (solid blocks).
3441 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3444 * @ingroup G_modifying_wims
3446 * Set basic information about a WIM.
3449 * Pointer to the ::WIMStruct for a WIM.
3451 * A struct ::wimlib_wim_info that contains the information to set. Only
3452 * the information explicitly specified in the @p which flags need be
3455 * Flags that specify which information to set. This is a bitwise OR of
3456 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3457 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3459 * @return 0 on success; nonzero on failure.
3460 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3461 * The WIM file is considered read-only because of any of the reasons
3462 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3463 * flag. However, as a special case, if you are using
3464 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3465 * function will not fail due to the readonly flag being previously set.
3466 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3467 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3468 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3472 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3476 * @ingroup G_modifying_wims
3478 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3479 * (something like "Core" or "Ultimate")
3482 * Pointer to the ::WIMStruct for a WIM.
3484 * The number of the image for which to change the description.
3486 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3487 * indicates that the image is to be given no \<FLAGS\> element.
3489 * @return 0 on success; nonzero on error.
3490 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3491 * @p image does not specify a single existing image in @p wim.
3492 * @retval ::WIMLIB_ERR_NOMEM
3493 * Failed to allocate the memory needed to duplicate the @p flags string.
3494 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3495 * @p wim is considered read-only because of any of the reasons mentioned
3496 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3499 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3502 * @ingroup G_modifying_wims
3504 * Changes the name of an image in the WIM.
3507 * Pointer to the ::WIMStruct for a WIM.
3509 * The number of the image for which to change the name.
3511 * New name to give the new image. If @c NULL or empty, the new image is
3512 * given no name. If nonempty, it must specify a name that does not
3513 * already exist in @p wim.
3515 * @return 0 on success; nonzero on error.
3516 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3517 * There is already an image named @p name in @p wim.
3518 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3519 * @p image does not specify a single existing image in @p wim.
3520 * @retval ::WIMLIB_ERR_NOMEM
3521 * Failed to allocate the memory needed to duplicate the @p name string.
3522 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3523 * @p wim is considered read-only because of any of the reasons mentioned
3524 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3527 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3530 * @ingroup G_general
3532 * Set the functions that wimlib uses to allocate and free memory.
3534 * These settings are global and not per-WIM.
3536 * The default is to use the default @c malloc() and @c free() from the C
3539 * Please note that some external functions, such as those in @c libntfs-3g, may
3540 * use the standard memory allocation functions.
3542 * @param malloc_func
3543 * A function equivalent to @c malloc() that wimlib will use to allocate
3544 * memory. If @c NULL, the allocator function is set back to the default
3545 * @c malloc() from the C library.
3547 * A function equivalent to @c free() that wimlib will use to free memory.
3548 * If @c NULL, the free function is set back to the default @c free() from
3550 * @param realloc_func
3551 * A function equivalent to @c realloc() that wimlib will use to reallocate
3552 * memory. If @c NULL, the free function is set back to the default @c
3553 * realloc() from the C library.
3557 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3558 void (*free_func)(void *),
3559 void *(*realloc_func)(void *, size_t));
3562 * @ingroup G_general
3564 * Sets whether wimlib is to print error messages to @c stderr when a function
3565 * fails. These error messages may provide information that cannot be
3566 * determined only from the error code that is returned. Not every error will
3567 * result in an error message being printed.
3569 * This setting is global and not per-WIM.
3571 * By default, error messages are not printed.
3573 * This can be called before wimlib_global_init().
3575 * @param show_messages
3576 * @c true if error messages are to be printed; @c false if error messages
3577 * are not to be printed.
3579 * @return 0 on success; nonzero on error.
3580 * @retval ::WIMLIB_ERR_UNSUPPORTED
3581 * @p show_messages was @c true, but wimlib was compiled with the @c
3582 * --without-error-messages option. Therefore, error messages cannot be
3586 wimlib_set_print_errors(bool show_messages);
3589 * @ingroup G_nonstandalone_wims
3591 * Splits a WIM into multiple parts.
3594 * The ::WIMStruct for the WIM to split.
3596 * Name of the SWM file to create. This will be the name of the first
3597 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3598 * appended before the suffix.
3600 * The maximum size per part, in bytes. Unfortunately, it is not
3601 * guaranteed that this will really be the maximum size per part, because
3602 * some file resources in the WIM may be larger than this size, and the WIM
3603 * file format provides no way to split up file resources among multiple
3605 * @param write_flags
3606 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3607 * flags will be used to write each split WIM part. Specify 0 here to get
3608 * the default behavior.
3609 * @param progress_func
3610 * If non-NULL, a function that will be called periodically with the
3611 * progress of the current operation
3612 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3613 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3615 * @return 0 on success; nonzero on error. This function may return most error
3616 * codes that can be returned by wimlib_write() as well as the following error
3619 * @retval ::WIMLIB_ERR_INVALID_PARAM
3620 * @p swm_name was not a nonempty string, or @p part_size was 0.
3622 * Note: the WIM's uncompressed and compressed resources are not checksummed
3623 * when they are copied from the joined WIM to the split WIM parts, nor are
3624 * compressed resources re-compressed (unless explicitly requested with
3625 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3628 wimlib_split(WIMStruct *wim,
3629 const wimlib_tchar *swm_name,
3632 wimlib_progress_func_t progress_func);
3635 * @ingroup G_mounting_wim_images
3637 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3639 * The image to unmount is specified by the path to the mountpoint, not the
3640 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3641 * touched and also may have been allocated in a different process.
3643 * To unmount the image, the process calling this function communicates with the
3644 * process that is managing the mounted WIM image. This function blocks until it
3645 * is known whether the unmount succeeded or failed. In the case of a
3646 * read-write mounted WIM, the unmount is not considered to have succeeded until
3647 * all changes have been saved to the underlying WIM file.
3650 * The directory that the WIM image was mounted on.
3651 * @param unmount_flags
3652 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3653 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3654 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3656 * @param progress_func
3657 * If non-NULL, a function that will be called periodically with the
3658 * progress of the current operation. Currently, only
3659 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3661 * @return 0 on success; nonzero on error.
3663 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3664 * The filesystem daemon was unable to remove the staging directory and the
3665 * temporary files that it contains.
3666 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3667 * The filesystem daemon appears to have terminated before sending an exit
3669 * @retval ::WIMLIB_ERR_FORK
3670 * Could not @c fork() the process.
3671 * @retval ::WIMLIB_ERR_FUSERMOUNT
3672 * The @b fusermount program could not be executed or exited with a failure
3674 * @retval ::WIMLIB_ERR_MQUEUE
3675 * Could not open a POSIX message queue to communicate with the filesystem
3676 * daemon servicing the mounted filesystem, could not send a message
3677 * through the queue, or could not receive a message through the queue.
3678 * @retval ::WIMLIB_ERR_NOMEM
3679 * Failed to allocate needed memory.
3680 * @retval ::WIMLIB_ERR_OPEN
3681 * The filesystem daemon could not open a temporary file for writing the
3683 * @retval ::WIMLIB_ERR_READ
3684 * A read error occurred when the filesystem daemon tried to a file from
3685 * the staging directory
3686 * @retval ::WIMLIB_ERR_RENAME
3687 * The filesystem daemon failed to rename the newly written WIM file to the
3688 * original WIM file.
3689 * @retval ::WIMLIB_ERR_UNSUPPORTED
3690 * Mounting is not supported, either because the platform is Windows, or
3691 * because the platform is UNIX-like and wimlib was compiled with @c
3693 * @retval ::WIMLIB_ERR_WRITE
3694 * A write error occurred when the filesystem daemon was writing to the new
3695 * WIM file, or the filesystem daemon was unable to flush changes that had
3696 * been made to files in the staging directory.
3699 wimlib_unmount_image(const wimlib_tchar *dir,
3701 wimlib_progress_func_t progress_func);
3704 * @ingroup G_modifying_wims
3706 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3709 * Pointer to the ::WIMStruct for the WIM file to update.
3711 * The 1-based index of the image in the WIM to update. It cannot be
3712 * ::WIMLIB_ALL_IMAGES.
3714 * An array of ::wimlib_update_command's that specify the update operations
3717 * Number of commands in @p cmds.
3718 * @param update_flags
3719 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3720 * @param progress_func
3721 * If non-NULL, a function that will be called periodically with the
3722 * progress of the current operation.
3724 * @return 0 on success; nonzero on error. On failure, some but not all of the
3725 * update commands may have been executed. No individual update command will
3726 * have been partially executed. Possible error codes include:
3728 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3729 * The capture configuration structure specified for an add command was
3731 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3732 * @p image did not specify a single, existing image in @p wim.
3733 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3734 * Attempted to perform an add command that conflicted with previously
3735 * existing files in the WIM when an overlay was attempted.
3736 * @retval ::WIMLIB_ERR_INVALID_PARAM
3737 * An unknown operation type was specified in the update commands; or,
3738 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3739 * in the @p add_flags, but the same image had previously already been
3740 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3741 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3742 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3743 * specified in the @p add_flags for an add command in which @p
3744 * wim_target_path was not the root directory of the WIM image.
3745 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3746 * (Windows only): While executing an add command, tried to capture a
3747 * reparse point with invalid data.
3748 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3749 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3750 * for a WIM path that corresponded to a directory; or, a rename command
3751 * attempted to rename a directory to a non-directory.
3752 * @retval ::WIMLIB_ERR_NOMEM
3753 * Failed to allocate needed memory.
3754 * @retval ::WIMLIB_ERR_NOTDIR
3755 * A rename command attempted to rename a directory to a non-directory; or,
3756 * an add command was executed that attempted to set the root of the WIM
3757 * image as a non-directory; or, a path component used as a directory in a
3758 * rename command was not, in fact, a directory.
3759 * @retval ::WIMLIB_ERR_NOTEMPTY
3760 * A rename command attempted to rename a directory to a non-empty
3762 * @retval ::WIMLIB_ERR_NTFS_3G
3763 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3764 * error occurred while reading data from the NTFS volume using libntfs-3g.
3765 * @retval ::WIMLIB_ERR_OPEN
3766 * Failed to open a file to be captured while executing an add command.
3767 * @retval ::WIMLIB_ERR_OPENDIR
3768 * Failed to open a directory to be captured while executing an add command.
3769 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3770 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3771 * WIM path that did not exist; or, a rename command attempted to rename a
3772 * file that does not exist.
3773 * @retval ::WIMLIB_ERR_READ
3774 * While executing an add command, failed to read data from a file or
3775 * directory to be captured.
3776 * @retval ::WIMLIB_ERR_READLINK
3777 * While executing an add command, failed to read the target of a symbolic
3778 * link or junction point.
3779 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3780 * (Windows only) Failed to perform a reparse point fixup because of
3781 * problems with the data of a reparse point.
3782 * @retval ::WIMLIB_ERR_STAT
3783 * While executing an add command, failed to get attributes for a file or
3785 * @retval ::WIMLIB_ERR_UNSUPPORTED
3786 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3787 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3788 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3789 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3790 * add_flags for an update command.
3791 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3792 * While executing an add command, attempted to capture a file that was not
3793 * a supported file type (e.g. a device file). Only if
3794 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3795 * for an update command.
3796 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3797 * The WIM file is considered read-only because of any of the reasons
3798 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3801 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3802 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3803 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3804 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3805 * different reasons) to read the metadata resource for an image that needed to
3809 wimlib_update_image(WIMStruct *wim,
3811 const struct wimlib_update_command *cmds,
3814 wimlib_progress_func_t progress_func);
3817 * @ingroup G_writing_and_overwriting_wims
3819 * Writes a WIM to a file.
3821 * This brings in resources from any external locations, such as directory trees
3822 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3823 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3825 * By default, the new WIM file is written as stand-alone. Using the
3826 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3827 * instead. However, this function cannot directly write a "split" WIM; use
3828 * wimlib_split() for that.
3831 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3832 * changes made to it, which are then reflected in the output file.
3834 * The path to the file to write the WIM to.
3836 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3837 * images are to be included in the new on-disk WIM file. If for some
3838 * reason you only want to include a single image, specify the index of
3839 * that image instead.
3840 * @param write_flags
3841 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3842 * @param num_threads
3843 * Number of threads to use for compressing data. If 0, the number of
3844 * threads is taken to be the number of online processors. Note: if no
3845 * data compression needs to be done, no additional threads will be created
3846 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3847 * exporting an image from a compressed WIM to another WIM of the same
3848 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3850 * @param progress_func
3851 * If non-NULL, a function that will be called periodically with the
3852 * progress of the current operation. The possible messages are
3853 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3854 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3855 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3857 * @return 0 on success; nonzero on error.
3859 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3860 * @p image does not specify a single existing image in @p wim, and is not
3861 * ::WIMLIB_ALL_IMAGES.
3862 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3863 * A file that had previously been scanned for inclusion in the WIM by
3864 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3865 * message digest check.
3866 * @retval ::WIMLIB_ERR_INVALID_PARAM
3867 * @p path was @c NULL.
3868 * @retval ::WIMLIB_ERR_NOMEM
3869 * Failed to allocate needed memory.
3870 * @retval ::WIMLIB_ERR_OPEN
3871 * Failed to open @p path for writing, or some file resources in @p wim
3872 * refer to files in the outside filesystem, and one of these files could
3873 * not be opened for reading.
3874 * @retval ::WIMLIB_ERR_READ
3875 * An error occurred when trying to read data from the WIM file associated
3876 * with @p wim, or some file resources in @p wim refer to files in the
3877 * outside filesystem, and a read error occurred when reading one of these
3879 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3880 * A stream that needed to be written could not be found in the stream
3881 * lookup table of @p wim. This error can occur if, for example, @p wim is
3882 * part of a split WIM but needed resources from the other split WIM parts
3883 * were not referenced with wimlib_reference_resources() or
3884 * wimlib_reference_resource_files() before the call to wimlib_write().
3885 * @retval ::WIMLIB_ERR_WRITE
3886 * An error occurred when trying to write data to the new WIM file.
3888 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3889 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3890 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3891 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3892 * different reasons) to read the metadata resource for an image that needed to
3896 wimlib_write(WIMStruct *wim,
3897 const wimlib_tchar *path,
3900 unsigned num_threads,
3901 wimlib_progress_func_t progress_func);
3904 * @ingroup G_writing_and_overwriting_wims
3906 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3907 * file descriptor, which need not be seekable if the write is done in a special
3908 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3909 * write_flags. This can, for example, allow capturing a WIM image and
3910 * streaming it over the network. See the documentation for
3911 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3913 * The file descriptor @p fd will @b not be closed when the write is complete;
3914 * the calling code is responsible for this.
3916 * Returns 0 on success; nonzero on failure. The possible error codes include
3917 * those that can be returned by wimlib_write() as well as the following:
3919 * @retval ::WIMLIB_ERR_INVALID_PARAM
3920 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3921 * specified in @p write_flags.
3924 wimlib_write_to_fd(WIMStruct *wim,
3928 unsigned num_threads,
3929 wimlib_progress_func_t progress_func);
3932 * @defgroup G_compression Compression and decompression functions
3934 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
3935 * exported for convenience only, as they are already used by wimlib internally
3938 * These functions can be used for general-purpose lossless data compression,
3939 * but some limitations apply; for example, none of the compressors or
3940 * decompressors currently support sliding windows, and there also exist
3941 * slightly different variants of these formats that are not supported
3947 /** Header for compression parameters to pass to wimlib_create_compressor() or
3948 * wimlib_set_default_compressor_params(). */
3949 struct wimlib_compressor_params_header {
3950 /** Size of the parameters, in bytes. */
3954 /** Header for decompression parameters to pass to wimlib_create_decompressor()
3955 * or wimlib_set_default_decompressor_params() */
3956 struct wimlib_decompressor_params_header {
3957 /** Size of the parameters, in bytes. */
3961 /** LZX compression parameters that can optionally be passed to
3962 * wimlib_create_compressor() with the compression type
3963 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
3964 struct wimlib_lzx_compressor_params {
3965 /** hdr.size Must be set to the size of this structure, in bytes. */
3966 struct wimlib_compressor_params_header hdr;
3968 /** Relatively fast LZX compression algorithm with a decent compression
3969 * ratio; the suggested default. */
3970 #define WIMLIB_LZX_ALGORITHM_FAST 0
3972 /** Slower LZX compression algorithm that provides a better compression
3974 #define WIMLIB_LZX_ALGORITHM_SLOW 1
3976 /** Algorithm to use to perform the compression: either
3977 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
3978 * format is still LZX; this refers to the method the code will use to
3979 * perform LZX-compatible compression. */
3980 uint32_t algorithm : 3;
3982 /** If set to 1, the default parameters for the specified algorithm are
3983 * used rather than the ones specified in the following union. */
3984 uint32_t use_defaults : 1;
3987 /** Parameters for the fast algorithm. */
3988 struct wimlib_lzx_fast_params {
3989 uint32_t fast_reserved1[10];
3992 /** Parameters for the slow algorithm. */
3993 struct wimlib_lzx_slow_params {
3994 /** If set to 1, the compressor can output length 2
3995 * matches. If set 0, the compressor only outputs
3996 * matches of length 3 or greater. Suggested value: 1
3998 uint32_t use_len2_matches : 1;
4000 uint32_t slow_reserved1 : 31;
4002 /** Matches with length (in bytes) greater than or equal
4003 * to this value are immediately taken without spending
4004 * time on minimum-cost measurements. Suggested value:
4006 uint32_t nice_match_length;
4008 /** Number of passes to compute a match/literal sequence
4009 * for each LZX block. This is for an iterative
4010 * algorithm that attempts to minimize the cost of the
4011 * match/literal sequence by using a cost model provided
4012 * by the previous iteration. Must be at least 1.
4013 * Suggested value: 2. */
4014 uint32_t num_optim_passes;
4016 /** Reserved; set to 0. */
4017 uint32_t slow_reserved_blocksplit;
4019 /** Maximum depth to search for matches at each
4020 * position. Suggested value: 50. */
4021 uint32_t max_search_depth;
4023 /** Maximum number of potentially good matches to
4024 * consider for each position. Suggested value: 3. */
4025 uint32_t max_matches_per_pos;
4027 uint32_t slow_reserved2[2];
4029 /** Assumed cost of a main symbol with zero frequency.
4030 * Must be at least 1 and no more than 16. Suggested
4032 uint8_t main_nostat_cost;
4034 /** Assumed cost of a length symbol with zero frequency.
4035 * Must be at least 1 and no more than 16. Suggested
4037 uint8_t len_nostat_cost;
4039 /** Assumed cost of an aligned symbol with zero
4040 * frequency. Must be at least 1 and no more than 8.
4041 * Suggested value: 7. */
4042 uint8_t aligned_nostat_cost;
4044 uint8_t slow_reserved3[5];
4049 /** LZMS compression parameters that can optionally be passed to
4050 * wimlib_create_compressor() with the compression type
4051 * ::WIMLIB_COMPRESSION_TYPE_LZMS. */
4052 struct wimlib_lzms_compressor_params {
4053 /** hdr.size Must be set to the size of this structure, in bytes. */
4054 struct wimlib_compressor_params_header hdr;
4056 /** Minimum match length to output. This must be at least 2. Suggested
4058 uint32_t min_match_length;
4060 /** Maximum match length to output. This must be at least @p
4061 * min_match_length. Suggested value: @p UINT32_MAX. */
4062 uint32_t max_match_length;
4064 /** Matches with length (in bytes) greater than or equal to this value
4065 * are immediately taken without spending time on minimum-cost
4066 * measurements. The minimum of @p max_match_length and @p
4067 * nice_match_length may not exceed 65536. Suggested value: 32. */
4068 uint32_t nice_match_length;
4070 /** Maximum depth to search for matches at each position. Suggested
4072 uint32_t max_search_depth;
4074 /** Maximum number of potentially good matches to consider at each
4075 * position. Suggested value: 3. */
4076 uint32_t max_matches_per_pos;
4078 /** Length of the array for the near-optimal LZ parsing algorithm. This
4079 * must be at least 1. Suggested value: 1024. */
4080 uint32_t optim_array_length;
4082 uint64_t reserved2[4];
4085 /** Opaque compressor handle. */
4086 struct wimlib_compressor;
4088 /** Opaque decompressor handle. */
4089 struct wimlib_decompressor;
4092 * Set the default compression parameters for the specified compression type.
4093 * This will affect both explicit and wimlib-internal calls to
4094 * wimlib_create_compressor().
4097 * Compression type for which to set the default compression parameters.
4099 * Compression-type specific parameters. This may be @c NULL, in which
4100 * case the "default default" parameters are restored.
4102 * @return 0 on success; nonzero on error.
4104 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4105 * @p ctype was not a supported compression type.
4106 * @retval ::WIMLIB_ERR_INVALID_PARAM
4107 * @p params were invalid.
4108 * @retval ::WIMLIB_ERR_NOMEM
4109 * Not enough memory to duplicate the parameters (perhaps @c params->size
4113 wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
4114 const struct wimlib_compressor_params_header *params);
4117 * Returns the approximate number of bytes needed to allocate a compressor with
4118 * wimlib_create_compressor() for the specified compression type, block size,
4119 * and parameters. @p params may be @c NULL, in which case the current default
4120 * parameters for @p ctype are used. Returns 0 if the compression type or
4121 * parameters are invalid.
4124 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4125 size_t max_block_size,
4126 const struct wimlib_compressor_params_header *params);
4129 * Allocate a compressor for the specified compression type using the specified
4133 * Compression type for which to create the compressor.
4134 * @param max_block_size
4135 * Maximum block size to support. The exact meaning and allowed values for
4136 * this parameter depend on the compression type, but it at least specifies
4137 * the maximum allowed value for @p uncompressed_size to wimlib_compress().
4138 * @param extra_params
4139 * An optional pointer to extra compressor parameters for the specified
4140 * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params
4141 * may be specified here. If left @c NULL, the default parameters are
4143 * @param compressor_ret
4144 * A location into which to return the pointer to the allocated compressor,
4145 * which can be used for any number of calls to wimlib_compress() before
4146 * being freed with wimlib_free_compressor().
4148 * @return 0 on success; nonzero on error.
4150 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4151 * @p ctype was not a supported compression type.
4152 * @retval ::WIMLIB_ERR_INVALID_PARAM
4153 * The compression parameters were invalid.
4154 * @retval ::WIMLIB_ERR_NOMEM
4155 * Insufficient memory to allocate the compressor.
4158 wimlib_create_compressor(enum wimlib_compression_type ctype,
4159 size_t max_block_size,
4160 const struct wimlib_compressor_params_header *extra_params,
4161 struct wimlib_compressor **compressor_ret);
4164 * Losslessly compress a block of data using a compressor previously created
4165 * with wimlib_create_compressor().
4167 * @param uncompressed_data
4168 * Buffer containing the data to compress.
4169 * @param uncompressed_size
4170 * Size, in bytes, of the data to compress.
4171 * @param compressed_data
4172 * Buffer into which to write the compressed data.
4173 * @param compressed_size_avail
4174 * Number of bytes available in @p compressed_data.
4176 * A compressor previously allocated with wimlib_create_compressor().
4179 * The size of the compressed data, in bytes, or 0 if the input data could
4180 * not be compressed to @p compressed_size_avail or fewer bytes.
4183 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4184 void *compressed_data, size_t compressed_size_avail,
4185 struct wimlib_compressor *compressor);
4188 * Free a compressor previously allocated with wimlib_create_compressor().
4191 * The compressor to free.
4194 wimlib_free_compressor(struct wimlib_compressor *compressor);
4197 * Set the default decompression parameters for the specified compression type.
4198 * This will affect both explicit and wimlib-internal calls to
4199 * wimlib_create_decompressor().
4202 * Compression type for which to set the default decompression parameters.
4204 * Compression-type specific parameters. This may be @c NULL, in which
4205 * case the "default default" parameters are restored.
4207 * @return 0 on success; nonzero on error.
4209 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4210 * @p ctype was not a supported compression type.
4211 * @retval ::WIMLIB_ERR_NOMEM
4212 * Not enough memory to duplicate the parameters (perhaps @c params->size
4216 wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
4217 const struct wimlib_decompressor_params_header *params);
4220 * Allocate a decompressor for the specified compression type using the
4221 * specified parameters.
4224 * Compression type for which to create the decompressor.
4225 * @param max_block_size
4226 * Maximum block size to support. The exact meaning and allowed values for
4227 * this parameter depend on the compression type, but it at least specifies
4228 * the maximum allowed value for @p uncompressed_size to
4229 * wimlib_decompress().
4230 * @param extra_params
4231 * An optional pointer to extra decompressor parameters for the specified
4232 * compression type. If @c NULL, the default parameters are used.
4233 * @param decompressor_ret
4234 * A location into which to return the pointer to the allocated
4235 * decompressor, which can be used for any number of calls to
4236 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4238 * @return 0 on success; nonzero on error.
4240 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4241 * @p ctype was not a supported compression type.
4242 * @retval ::WIMLIB_ERR_INVALID_PARAM
4243 * The decompression parameters were invalid.
4244 * @retval ::WIMLIB_ERR_NOMEM
4245 * Insufficient memory to allocate the decompressor.
4248 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4249 size_t max_block_size,
4250 const struct wimlib_decompressor_params_header *extra_params,
4251 struct wimlib_decompressor **decompressor_ret);
4254 * Decompress a block of data using a decompressor previously created with
4255 * wimlib_create_decompressor().
4257 * @param compressed_data
4258 * Buffer containing the data to decompress.
4259 * @param compressed_size
4260 * Size, in bytes, of the data to decompress.
4261 * @param uncompressed_data
4262 * Buffer into which to write the uncompressed data.
4263 * @param uncompressed_size
4264 * Size, in bytes, of the data when uncompressed.
4265 * @param decompressor
4266 * A decompressor previously allocated with wimlib_create_decompressor().
4268 * @return 0 on success; nonzero on error.
4271 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4272 void *uncompressed_data, size_t uncompressed_size,
4273 struct wimlib_decompressor *decompressor);
4276 * Free a decompressor previously allocated with wimlib_create_decompressor().
4278 * @param decompressor
4279 * The decompressor to free.
4282 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4294 #endif /* _WIMLIB_H */