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 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.5.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 * - Compressed resource chunk sizes other than 32768 are not supported. This
174 * doesn't seem to be a real problem because the chunk size always seems to be
176 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
177 * functionality other than that already present in @b ImageX, that allows you
178 * to make certain Windows-specific modifications to a Windows PE image, such
179 * as adding a driver or Windows component. Such a tool could be implemented
182 * @subsection more_info More information
184 * You are advised to read the README as well as the manual pages for
185 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
186 * the API documentation.
189 /** @defgroup G_general General
191 * @brief Declarations and structures shared across the library.
194 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
196 * @brief Create new WIMs and open existing WIMs.
199 /** @defgroup G_wim_information Retrieving WIM information and directory listings
201 * @brief Retrieve information about a WIM or WIM image.
204 /** @defgroup G_modifying_wims Modifying WIMs
206 * @brief Make changes to a WIM.
208 * @section sec_adding_images Capturing and adding WIM images
210 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
211 * appending an image to an existing WIM is a multi-step process, but at its
212 * core is wimlib_add_image() or an equivalent function. Normally,
213 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
214 * ::WIMStruct as a new image. However, when supported by the build of the
215 * library, there is also a special NTFS volume capture mode (entered when
216 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
217 * from an unmounted NTFS volume.
219 * Another function, wimlib_add_image_multisource() is also provided. It
220 * generalizes wimlib_add_image() to allow combining multiple files or directory
221 * trees into a single WIM image in a configurable way.
223 * For maximum customization of WIM image creation, it is also possible to add a
224 * completely empty WIM image with wimlib_add_empty_image(), then update it with
225 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
226 * wimlib_add_image_multisource() do internally.)
228 * Note that some details of how image addition/capture works are documented
229 * more fully in the manual page for <b>wimlib-imagex capture</b>.
231 * @section sec_deleting_images Deleting WIM images
233 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
234 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
235 * be made persistent in an on-disk WIM file.
237 * @section sec_exporting_images Exporting WIM images
239 * wimlib_export_image() can copy, or "export", an image from one WIM to
242 * @section sec_other_modifications Other modifications
244 * wimlib_update_image() can add, delete, and rename files in a WIM image.
246 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
247 * wimlib_set_image_flags() can change other image metadata.
249 * wimlib_set_wim_info() can change information about the WIM file itself, such
253 /** @defgroup G_extracting_wims Extracting WIMs
255 * @brief Extract files, directories, and images from a WIM.
257 * wimlib_extract_image() extracts, or "applies", an image from a WIM
258 * (represented, as usual, by a ::WIMStruct). This normally extracts the image
259 * to a directory, but when supported by the build of the library there is also
260 * a special NTFS volume extraction mode (entered when
261 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified) that allows extracting a WIM image
262 * directly to an unmounted NTFS volume. Various other flags allow further
263 * customization of image extraction.
265 * Another function, wimlib_extract_files(), is also provided. It can extract
266 * certain files or directories from a WIM image, instead of a full image.
268 * A third function, wimlib_extract_image_from_pipe(), allows an image to be
269 * extracted from a pipable WIM sent over a pipe; see @ref subsec_pipable_wims.
271 * Note that some details of how image extraction/application works are
272 * documented more fully in the manual pages for <b>wimlib-imagex apply</b> and
273 * <b>wimlib-imagex extract</b>.
276 /** @defgroup G_mounting_wim_images Mounting WIM images
278 * @brief Mount and unmount WIM images.
280 * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
281 * mounting images from WIM files either read-only or read-write. To mount an
282 * image, call wimlib_mount_image(). To unmount an image, call
283 * wimlib_unmount_image(). Mounting can be done without root privileges because
284 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
285 * compiled with the <code>--without-fuse</code> flag, these functions will be
286 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED. Note that mounting an
287 * image read-write is an alternative to calling wimlib_update_image().
290 /** @defgroup G_progress Progress Messages
292 * @brief Track the progress of long WIM operations.
294 * When operating on large archives, operations such as extraction will
295 * naturally take a while to complete. Because of this and to improve the
296 * potential user-friendliness of library clients, a number of functions take a
297 * pointer to a progress function of type ::wimlib_progress_func_t. This
298 * function will be called periodically during the WIM operation(s) to report on
299 * the progress of the operation (for example, how many bytes have been written
303 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
305 * @brief Write and overwrite on-disk WIM files.
307 * As described in @ref sec_basic_wim_handling_concepts, these functions are
308 * critical to the design of the library as they allow new or modified WIMs to
309 * actually be written to on-disk files. Generally, wimlib_write() is the
310 * function you need to call to write a new WIM file, and wimlib_overwrite() is
311 * the function you need to call to persistently update an existing WIM file.
314 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
316 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
318 * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it
319 * than that. Normally, WIM files are "standalone". However, WIM files can
320 * also be arranged in non-standalone ways, such as a set of on-disk files that
321 * together form a single "split WIM" or "delta WIM". Such arrangements are
322 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
323 * created from one of these on-disk files initially only partially represents
324 * the full WIM and needs to, in effect, be logically combined with other
325 * ::WIMStruct's before performing certain operations, such as extracting files
326 * with wimlib_extract_image() or wimlib_extract_files(). This is done by
327 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
329 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
330 * specialized function (wimlib_split()) is needed to create a split WIM.
333 /** @defgroup G_compression Compression and decompression functions
335 * @brief Functions for LZX and XPRESS compression and decompression, exported
336 * for convenience only. These functions normally do not need to be used.
345 #include <inttypes.h>
348 /** @ingroup G_general
351 /** Major version of the library (for example, the 1 in 1.2.5). */
352 #define WIMLIB_MAJOR_VERSION 1
354 /** Minor version of the library (for example, the 2 in 1.2.5). */
355 #define WIMLIB_MINOR_VERSION 5
357 /** Patch version of the library (for example, the 5 in 1.2.5). */
358 #define WIMLIB_PATCH_VERSION 2
365 /** @ingroup G_general
369 * Opaque structure that represents a WIM file. This is an in-memory structure
370 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
371 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
372 * continuing to exist so that data can be read from it as needed.
374 * Most functions in this library will work the same way regardless of whether a
375 * given ::WIMStruct was obtained through wimlib_open_wim() or
376 * wimlib_create_new_wim(). Exceptions are documented.
378 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
379 * file from a ::WIMStruct.
381 * See @ref sec_basic_wim_handling_concepts for more information.
383 #ifndef WIMLIB_WIMSTRUCT_DECLARED
384 typedef struct WIMStruct WIMStruct;
385 #define WIMLIB_WIMSTRUCT_DECLARED
389 typedef wchar_t wimlib_tchar;
391 /** See @ref sec_encodings */
392 typedef char wimlib_tchar;
396 /** Path separator for WIM paths passed back to progress callbacks. */
397 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
398 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
400 /** Path separator for WIM paths passed back to progress callbacks. */
401 # define WIMLIB_WIM_PATH_SEPARATOR '/'
402 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
406 # define _wimlib_deprecated __attribute__((deprecated))
408 # define _wimlib_deprecated
411 #define WIMLIB_GUID_LEN 16
414 * Specifies the compression type of a WIM file.
416 enum wimlib_compression_type {
417 /** An invalid compression type. */
418 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
420 /** The WIM does not include any compressed resources. */
421 WIMLIB_COMPRESSION_TYPE_NONE = 0,
423 /** Compressed resources in the WIM use LZX compression. */
424 WIMLIB_COMPRESSION_TYPE_LZX = 1,
426 /** Compressed resources in the WIM use XPRESS compression. */
427 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
431 /** @ingroup G_progress
434 /** Possible values of the first parameter to the user-supplied
435 * ::wimlib_progress_func_t progress function */
436 enum wimlib_progress_msg {
438 /** A WIM image is about to be extracted. @p info will point to
439 * ::wimlib_progress_info.extract. */
440 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
442 /** A file or directory tree within a WIM image (not the full image) is
443 * about to be extracted. @p info will point to
444 * ::wimlib_progress_info.extract. */
445 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
447 /** The directory structure of the WIM image is about to be extracted.
448 * @p info will point to ::wimlib_progress_info.extract. */
449 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
451 /** The directory structure of the WIM image has been successfully
452 * extracted. @p info will point to ::wimlib_progress_info.extract. */
453 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
455 /** The WIM image's files resources are currently being extracted. @p
456 * info will point to ::wimlib_progress_info.extract. */
457 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
459 /** Starting to read a new part of a split pipable WIM over the pipe.
460 * @p info will point to ::wimlib_progress_info.extract. */
461 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
463 /** All the WIM files and directories have been extracted, and
464 * timestamps are about to be applied. @p info will point to
465 * ::wimlib_progress_info.extract. */
466 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
468 /** A WIM image has been successfully extracted. @p info will point to
469 * ::wimlib_progress_info.extract. */
470 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
472 /** A file or directory tree within a WIM image (not the full image) has
473 * been successfully extracted. @p info will point to
474 * ::wimlib_progress_info.extract. */
475 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
477 /** The directory or NTFS volume is about to be scanned to build a tree
478 * of WIM dentries in-memory. @p info will point to
479 * ::wimlib_progress_info.scan. */
480 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
482 /** A directory or file is being scanned. @p info will point to
483 * ::wimlib_progress_info.scan, and its @p cur_path member will be
484 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
485 * is passed to wimlib_add_image(). */
486 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
488 /** The directory or NTFS volume has been successfully scanned, and a
489 * tree of WIM dentries has been built in-memory. @p info will point to
490 * ::wimlib_progress_info.scan. */
491 WIMLIB_PROGRESS_MSG_SCAN_END,
494 * File resources are currently being written to the WIM.
495 * @p info will point to ::wimlib_progress_info.write_streams. */
496 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
499 * The metadata resource for each image is about to be written to the
500 * WIM. @p info will not be valid. */
501 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
504 * The metadata resource for each image has successfully been writen to
505 * the WIM. @p info will not be valid. */
506 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
509 * The temporary file has successfully been renamed to the original WIM
510 * file. Only happens when wimlib_overwrite() is called and the
511 * overwrite is not done in-place.
512 * @p info will point to ::wimlib_progress_info.rename. */
513 WIMLIB_PROGRESS_MSG_RENAME,
515 /** The contents of the WIM are being checked against the integrity
516 * table. Only happens when wimlib_open_wim() is called with the
517 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @p info will point to
518 * ::wimlib_progress_info.integrity. */
519 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
521 /** An integrity table is being calculated for the WIM being written.
522 * Only happens when wimlib_write() or wimlib_overwrite() is called with
523 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @p info will point to
524 * ::wimlib_progress_info.integrity. */
525 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
527 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
528 * but in wimlib v1.5.0 this was removed to simplify the code and now
529 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
530 WIMLIB_PROGRESS_MSG_RESERVED,
532 /** A wimlib_split() operation is in progress, and a new split part is
533 * about to be started. @p info will point to
534 * ::wimlib_progress_info.split. */
535 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
537 /** A wimlib_split() operation is in progress, and a split part has been
538 * finished. @p info will point to ::wimlib_progress_info.split. */
539 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
542 * A WIM update command is just about to be executed; @p info will point
543 * to ::wimlib_progress_info.update.
545 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
548 * A WIM update command has just been executed; @p info will point to
549 * ::wimlib_progress_info.update.
551 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
555 /** A pointer to this union is passed to the user-supplied
556 * ::wimlib_progress_func_t progress function. One (or none) of the structures
557 * contained in this union will be applicable for the operation
558 * (::wimlib_progress_msg) indicated in the first argument to the progress
560 union wimlib_progress_info {
562 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
563 * document them if they aren't given a name... */
565 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
566 struct wimlib_progress_info_write_streams {
567 /** Number of bytes that are going to be written for all the
568 * streams combined. This is the amount in uncompressed data.
569 * (The actual number of bytes will be less if the data is being
570 * written compressed.) */
571 uint64_t total_bytes;
573 /** Number of streams that are going to be written. */
574 uint64_t total_streams;
576 /** Number of uncompressed bytes that have been written so far.
577 * Will be 0 initially, and equal to @p total_bytes at the end.
579 uint64_t completed_bytes;
581 /** Number of streams that have been written. Will be 0
582 * initially, and equal to @p total_streams at the end. */
583 uint64_t completed_streams;
585 /** Number of threads that are being used to compress resources
586 * (if applicable). */
587 unsigned num_threads;
589 /** The compression type being used to write the streams; either
590 * ::WIMLIB_COMPRESSION_TYPE_NONE,
591 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
592 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
593 int compression_type;
595 /** Number of split WIM parts from which streams are being
596 * written (may be 0 if irrelevant). */
597 unsigned total_parts;
599 /** Number of split WIM parts from which streams have been
600 * written (may be 0 if irrelevant). */
601 unsigned completed_parts;
604 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
605 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
606 struct wimlib_progress_info_scan {
607 /** Directory or NTFS volume that is being scanned. */
608 const wimlib_tchar *source;
610 /** Path to the file or directory that is about to be scanned,
611 * relative to the root of the image capture or the NTFS volume.
613 const wimlib_tchar *cur_path;
616 /** File or directory looks okay and will be captured. */
617 WIMLIB_SCAN_DENTRY_OK = 0,
619 /** File or directory is being excluded from capture due
620 * to the capture configuration file. */
621 WIMLIB_SCAN_DENTRY_EXCLUDED,
623 /** File or directory is being excluded from capture due
624 * to being unsupported (e.g. an encrypted or device
626 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
629 /** Target path in the WIM. Only valid on messages
630 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
631 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
632 const wimlib_tchar *wim_target_path;
635 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
636 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
637 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
638 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
639 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
640 struct wimlib_progress_info_extract {
641 /** Number of the image being extracted (1-based). */
644 /** Flags passed to to wimlib_extract_image() */
647 /** Full path to the WIM file being extracted. */
648 const wimlib_tchar *wimfile_name;
650 /** Name of the image being extracted. */
651 const wimlib_tchar *image_name;
653 /** Directory or NTFS volume to which the image is being
655 const wimlib_tchar *target;
658 const wimlib_tchar *cur_path;
660 /** Number of bytes of uncompressed data that will be extracted.
661 * Takes into account hard links (they are not counted for each
663 uint64_t total_bytes;
665 /** Number of bytes that have been written so far. Will be 0
666 * initially, and equal to @p total_bytes at the end. */
667 uint64_t completed_bytes;
669 /** Number of streams that will be extracted. This may more or
670 * less than the number of "files" to be extracted due to
671 * special cases (hard links, symbolic links, and alternate data
673 uint64_t num_streams;
675 /** Path to the root dentry within the WIM for the tree that is
676 * being extracted. Will be the empty string when extracting a
678 const wimlib_tchar *extract_root_wim_source_path;
680 /** Currently only used for
681 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
683 unsigned part_number;
685 /** Currently only used for
686 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
687 unsigned total_parts;
689 /** Currently only used for
690 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
691 uint8_t guid[WIMLIB_GUID_LEN];
694 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
695 struct wimlib_progress_info_rename {
696 /** Name of the temporary file that the WIM was written to. */
697 const wimlib_tchar *from;
699 /** Name of the original WIM file to which the temporary file is
701 const wimlib_tchar *to;
704 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
705 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
706 struct wimlib_progress_info_update {
707 /** Pointer to the update command that will be executed or has
708 * just been executed. */
709 const struct wimlib_update_command *command;
711 /** Number of update commands that have been completed so far.
713 size_t completed_commands;
715 /** Number of update commands that are being executed as part of
716 * this call to wimlib_update_image(). */
717 size_t total_commands;
720 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
721 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
722 struct wimlib_progress_info_integrity {
723 /** Number of bytes from the end of the WIM header to the end of
724 * the lookup table (the area that is covered by the SHA1
725 * integrity checks.) */
726 uint64_t total_bytes;
728 /** Number of bytes that have been SHA1-summed so far. Will be
729 * 0 initially, and equal @p total_bytes at the end. */
730 uint64_t completed_bytes;
732 /** Number of chunks that the checksummed region is divided
734 uint32_t total_chunks;
736 /** Number of chunks that have been SHA1-summed so far. Will
737 * be 0 initially, and equal to @p total_chunks at the end. */
738 uint32_t completed_chunks;
740 /** Size of the chunks used for the integrity calculation. */
743 /** Filename of the WIM (only valid if the message is
744 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
745 const wimlib_tchar *filename;
748 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
749 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
750 struct wimlib_progress_info_split {
751 /** Total size of the original WIM's file and metadata resources
753 uint64_t total_bytes;
755 /** Number of bytes of file and metadata resources that have
756 * been copied out of the original WIM so far. Will be 0
757 * initially, and equal to @p total_bytes at the end. */
758 uint64_t completed_bytes;
760 /** Number of the split WIM part that is about to be started
761 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
762 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
763 unsigned cur_part_number;
765 /** Total number of split WIM parts that are being written. */
766 unsigned total_parts;
768 /** Name of the split WIM part that is about to be started
769 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
770 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
771 const wimlib_tchar *part_name;
775 /** A user-supplied function that will be called periodically during certain WIM
776 * operations. The first argument will be the type of operation that is being
777 * performed or is about to be started or has been completed. The second
778 * argument will be a pointer to one of a number of structures depending on the
779 * first argument. It may be @c NULL for some message types.
781 * The return value of the progress function is currently ignored, but it may do
782 * something in the future. (Set it to 0 for now.)
784 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
785 const union wimlib_progress_info *info);
788 /** @ingroup G_modifying_wims
791 /** An array of these structures is passed to wimlib_add_image_multisource() to
792 * specify the sources from which to create a WIM image. */
793 struct wimlib_capture_source {
794 /** Absolute or relative path to a file or directory on the external
795 * filesystem to be included in the WIM image. */
796 wimlib_tchar *fs_source_path;
798 /** Destination path in the WIM image. Leading and trailing slashes are
799 * ignored. The empty string or @c NULL means the root directory of the
801 wimlib_tchar *wim_target_path;
803 /** Reserved; set to 0. */
807 /** Structure that specifies a list of path patterns. */
808 struct wimlib_pattern_list {
809 /** Array of patterns. The patterns may be modified by library code,
810 * but the @p pats pointer itself will not. See the man page for
811 * <b>wimlib-imagex capture</b> for more information about allowed
815 /** Number of patterns in the @p pats array. */
818 /** Ignored; may be used by the calling code. */
819 size_t num_allocated_pats;
822 /** A structure that contains lists of wildcards that match paths to treat
823 * specially when capturing a WIM image. */
824 struct wimlib_capture_config {
825 /** Paths matching any pattern this list are excluded from being
826 * captured, except if the same path appears in @p
827 * exclusion_exception_pats. */
828 struct wimlib_pattern_list exclusion_pats;
830 /** Paths matching any pattern in this list are never excluded from
832 struct wimlib_pattern_list exclusion_exception_pats;
834 /** Reserved for future capture configuration options. */
835 struct wimlib_pattern_list reserved1;
837 /** Reserved for future capture configuration options. */
838 struct wimlib_pattern_list reserved2;
840 /** Library internal use only. */
841 wimlib_tchar *_prefix;
843 /** Library internal use only. */
844 size_t _prefix_num_tchars;
847 /** Set or unset the WIM header flag that marks it read-only
848 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
849 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
850 * is distinct from basic file permissions; this flag can be set on a WIM file
851 * that is physically writable. If this flag is set, all further operations to
852 * modify the WIM will fail, except calling wimlib_overwrite() with
853 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
854 * allows you to set this flag persistently on the underlying WIM file.
856 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
858 /** Set the GUID (globally unique identifier) of the WIM file to the value
859 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
860 #define WIMLIB_CHANGE_GUID 0x00000002
862 /** Change the bootable image of the WIM to the value specified in
863 * ::wimlib_wim_info.boot_index of the @p info parameter. */
864 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
866 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
867 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
868 * indicates whether an image in the WIM has been captured with reparse-point
869 * fixups enabled. wimlib also treats this flag as specifying whether to do
870 * reparse-point fixups by default when capturing or applying WIM images. */
871 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
874 /** @ingroup G_wim_information
877 /** General information about a WIM file. */
878 struct wimlib_wim_info {
880 /** Globally unique identifier for the WIM file. Note: all parts of a
881 * split WIM should have an identical value in this field. */
882 uint8_t guid[WIMLIB_GUID_LEN];
884 /** Number of images in the WIM. */
885 uint32_t image_count;
887 /** 1-based index of the bootable image in the WIM, or 0 if no image is
891 /** Version of the WIM file. */
892 uint32_t wim_version;
894 /** Chunk size used for compression. */
897 /** For split WIMs, the 1-based index of this part within the split WIM;
899 uint16_t part_number;
901 /** For split WIMs, the total number of parts in the split WIM;
903 uint16_t total_parts;
905 /** One of the ::wimlib_compression_type values that specifies the
906 * method used to compress resources in the WIM. */
907 int32_t compression_type;
909 /** Size of the WIM file in bytes, excluding the XML data and integrity
911 uint64_t total_bytes;
913 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
914 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
915 * this will always be 0, even if the ::WIMStruct was written to
916 * somewhere by calling wimlib_write() with the
917 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
918 uint32_t has_integrity_table : 1;
920 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
921 * wimlib_create_new_wim(). */
922 uint32_t opened_from_file : 1;
924 /** 1 if the WIM is considered readonly for any reason. */
925 uint32_t is_readonly : 1;
927 /** 1 if reparse-point fixups are supposedly enabled for one or more
928 * images in the WIM. */
929 uint32_t has_rpfix : 1;
931 /** 1 if the WIM is marked as read-only. */
932 uint32_t is_marked_readonly : 1;
934 /** 1 if the WIM is part of a spanned set. */
935 uint32_t spanned : 1;
937 uint32_t write_in_progress : 1;
938 uint32_t metadata_only : 1;
939 uint32_t resource_only : 1;
941 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
942 uint32_t pipable : 1;
943 uint32_t reserved_flags : 22;
944 uint32_t reserved[9];
947 /** Information about a unique resource in the WIM file.
949 struct wimlib_resource_entry {
950 /** Uncompressed size of the resource in bytes. */
951 uint64_t uncompressed_size;
953 /** Compressed size of the resource in bytes. This will be the same as
954 * @p uncompressed_size if the resource is uncompressed. */
955 uint64_t compressed_size;
957 /** Offset, in bytes, of this resource from the start of the WIM file.
961 /** SHA1 message digest of the resource's uncompressed contents. */
962 uint8_t sha1_hash[20];
964 /** Which part number of the split WIM this resource is in. This should
965 * be the same as the part number provided by wimlib_get_wim_info(). */
966 uint32_t part_number;
968 /** Number of times this resource is referenced over all WIM images. */
969 uint32_t reference_count;
971 /** 1 if this resource is compressed. */
972 uint32_t is_compressed : 1;
974 /** 1 if this resource is a metadata resource rather than a file
976 uint32_t is_metadata : 1;
978 uint32_t is_free : 1;
979 uint32_t is_spanned : 1;
981 /** 1 if this resource was not found in the lookup table of the
982 * ::WIMStruct. This normally implies a missing call to
983 * wimlib_reference_resource_files() or wimlib_reference_resources().
985 uint32_t is_missing : 1;
987 uint32_t reserved_flags : 27;
988 uint64_t reserved[4];
991 /** A stream of a file in the WIM. */
992 struct wimlib_stream_entry {
993 /** Name of the stream, or NULL if the stream is unnamed. */
994 const wimlib_tchar *stream_name;
995 /** Location, size, etc. of the stream within the WIM file. */
996 struct wimlib_resource_entry resource;
997 uint64_t reserved[4];
1000 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1001 * Roughly, the information about a "file" in the WIM--- but really a directory
1002 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1003 * field can be used to distinguish actual file inodes. */
1004 struct wimlib_dir_entry {
1005 /** Name of the file, or NULL if this file is unnamed (only possible for
1006 * the root directory) */
1007 const wimlib_tchar *filename;
1009 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1011 const wimlib_tchar *dos_name;
1013 /** Full path to this file within the WIM image. */
1014 const wimlib_tchar *full_path;
1016 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1017 * children, ..., etc. */
1020 /** Pointer to the security descriptor for this file, in Windows
1021 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1022 * security descriptor. */
1023 const char *security_descriptor;
1025 /** Length of the above security descriptor. */
1026 size_t security_descriptor_size;
1028 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1029 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1030 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1031 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1032 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1033 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1034 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1035 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1036 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1037 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1038 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1039 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1040 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1041 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1042 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1043 /** File attributes, such as whether the file is a directory or not.
1044 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1045 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1046 * on other platforms. */
1047 uint32_t attributes;
1049 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1050 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1051 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1052 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1053 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1054 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1055 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1056 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1057 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1058 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1059 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1060 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1061 * attributes), this will give the reparse tag. This tells you whether
1062 * the reparse point is a symbolic link, junction point, or some other,
1063 * more unusual kind of reparse point. */
1064 uint32_t reparse_tag;
1066 /* Number of (hard) links to this file. */
1069 /** Number of named data streams that this file has. Normally 0. */
1070 uint32_t num_named_streams;
1072 /** Roughly, the inode number of this file. However, it may be 0 if
1073 * @p num_links == 1. */
1074 uint64_t hard_link_group_id;
1076 /** Time this file was created. */
1077 struct timespec creation_time;
1079 /** Time this file was last written to. */
1080 struct timespec last_write_time;
1082 /** Time this file was last accessed. */
1083 struct timespec last_access_time;
1084 uint64_t reserved[16];
1086 /** Array of streams that make up this file. The first entry will
1087 * always exist and will correspond to the unnamed data stream (default
1088 * file contents), so it will have @p stream_name == @c NULL. There
1089 * will then be @p num_named_streams additional entries that specify the
1090 * named data streams, if any, each of which will have @p stream_name !=
1092 struct wimlib_stream_entry streams[];
1096 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1099 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1103 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1106 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1109 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1110 * just on the specified path. */
1111 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1113 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1114 * itself; only its children (in the case of a non-empty directory) */
1115 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1117 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1118 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1119 * table of the ::WIMStruct. The default behavior without this flag is to fill
1120 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1121 * wimlib_resource_entry::is_missing "is_missing" flag. */
1122 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1126 /** @ingroup G_modifying_wims
1129 /** Directly capture a NTFS volume rather than a generic directory. This flag
1130 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1131 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1132 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1134 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1135 * with ::WIMLIB_ADD_FLAG_NTFS. */
1136 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1138 /** Call the progress function with the message
1139 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
1140 * be scanned, or when a directory or file is being excluded from capture. */
1141 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1143 /** Mark the image being added as the bootable image of the WIM. */
1144 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1146 /** Store the UNIX owner, group, and mode. This is done by adding a special
1147 * alternate data stream to each regular file, symbolic link, and directory to
1148 * contain this information. Please note that this flag is for convenience
1149 * only; Microsoft's @a imagex.exe will not understand this special information.
1150 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1151 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1153 /** Do not capture security descriptors. Only has an effect in NTFS capture
1154 * mode, or in Win32 native builds. */
1155 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1157 /** Fail immediately if the full security descriptor of any file or directory
1158 * cannot be accessed. Only has an effect in Win32 native builds. The default
1159 * behavior without this flag is to first try omitting the SACL from the
1160 * security descriptor, then to try omitting the security descriptor entirely.
1162 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1164 /** Call the progress function with the message
1165 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1166 * capture. This is a subset of the messages provided by
1167 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1168 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1170 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1171 * in the case of Windows) that point inside the directory being captured to
1172 * instead be absolute relative to the directory being captured, rather than the
1173 * current root; also exclude absolute symbolic links that point outside the
1174 * directory tree being captured.
1176 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1177 * the WIM header or if this is the first image being added.
1178 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1179 * reparse point fixups enabled and currently cannot be unset. */
1180 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1182 /** Don't do reparse point fixups. The default behavior is described in the
1183 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1184 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1186 /** Do not automatically exclude unsupported files or directories from capture;
1187 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1188 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1189 * such a file is encountered. */
1190 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1192 /** Automatically select a capture configuration appropriate for capturing
1193 * filesystems containing Windows operating systems. When this flag is
1194 * specified, the corresponding @p config parameter or member must be @c NULL.
1196 * Currently, selecting this capture configuration will cause the following
1197 * files and directories to be excluded from capture:
1202 * - "\System Volume Information"
1206 * Note that the default behavior--- that is, when this flag is not specified
1207 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1208 * no files are excluded from capture.
1210 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1212 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1213 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1214 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1215 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1216 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1217 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1218 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1219 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1220 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1221 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1222 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1223 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1224 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1227 /** @ingroup G_modifying_wims
1230 /** Do not issue an error if the path to delete does not exist. */
1231 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1233 /** Delete the file or directory tree recursively; if not specified, an error is
1234 * issued if the path to delete is a directory. */
1235 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1238 /** @ingroup G_modifying_wims
1242 * If a single image is being exported, mark it bootable in the destination WIM.
1243 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1244 * the image in the source WIM (if any) that is marked as bootable is also
1245 * marked as bootable in the destination WIM.
1247 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1249 /** Give the exported image(s) no names. Avoids problems with image name
1252 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1254 /** Give the exported image(s) no descriptions. */
1255 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1258 /** @ingroup G_extracting_wims
1261 /** Extract the image directly to a NTFS volume rather than a generic directory.
1262 * This mode is only available if wimlib was compiled with libntfs-3g support;
1263 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1264 * extraction target will be interpreted as the path to a NTFS volume image (as
1265 * a regular file or block device) rather than a directory. It will be opened
1266 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1267 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1268 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1269 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1271 /** When identical files are extracted from the WIM, always hard link them
1273 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1275 /** When identical files are extracted from the WIM, always symlink them
1277 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1279 /** This flag no longer does anything but is reserved for future use. */
1280 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1282 /** Read the WIM file sequentially while extracting the image. */
1283 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1285 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1286 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1288 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1290 /** Do not extract security descriptors. */
1291 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1293 /** Fail immediately if the full security descriptor of any file or directory
1294 * cannot be set exactly as specified in the WIM file. On Windows, the default
1295 * behavior without this flag is to fall back to setting the security descriptor
1296 * with the SACL omitted, then only the default inherited security descriptor,
1297 * if we do not have permission to set the desired one. */
1298 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1300 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1301 * reparse-point fixups on, so absolute symbolic links or junction points will
1302 * be fixed to be absolute relative to the actual extraction root. Reparse
1303 * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1304 * header. This flag may only be specified when extracting a full image (not a
1305 * file or directory tree within one). */
1306 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1308 /** Force reparse-point fixups on extraction off, regardless of the state of the
1309 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1310 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1312 /** Extract the specified file to standard output. This is only valid in an
1313 * extraction command that specifies the extraction of a regular file in the WIM
1315 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1317 /** Instead of ignoring files and directories with names that cannot be
1318 * represented on the current platform (note: Windows has more restrictions on
1319 * filenames than POSIX-compliant systems), try to replace characters or append
1320 * junk to the names so that they can be extracted in some form. */
1321 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1323 /** On Windows, when there exist two or more files with the same case
1324 * insensitive name but different case sensitive names, try to extract them all
1325 * by appending junk to the end of them, rather than arbitrarily extracting only
1327 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1329 /** Do not ignore failure to set timestamps on extracted files. */
1330 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1332 /** Do not ignore failure to set short names on extracted files. */
1333 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1335 /** Do not ignore failure to extract symbolic links (and junction points, on
1336 * Windows) due to permissions problems. By default, such failures are ignored
1337 * since the default configuration of Windows only allows the Administrator to
1338 * create symbolic links. */
1339 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1341 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1342 * behavior is currently less than satisfactory. Do not use (yet). */
1343 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1346 /** @ingroup G_mounting_wim_images
1349 /** Mount the WIM image read-write rather than the default of read-only. */
1350 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1352 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1353 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1355 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1356 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1358 /** Access alternate data streams in the mounted WIM image through extended file
1359 * attributes. This is the default mode. */
1360 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1362 /** Access alternate data streams in the mounted WIM image by specifying the
1363 * file name, a colon, then the alternate file stream name. */
1364 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1366 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1367 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1368 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1370 /** Allow other users to see the mounted filesystem. (this passes the @c
1371 * allow_other option to FUSE mount) */
1372 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1375 /** @ingroup G_creating_and_opening_wims
1378 /** Verify the WIM contents against the WIM's integrity table, if present. This
1379 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1380 * checksummed and checked against the SHA1 message digests specified in the
1381 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1382 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1383 * integrity table is invalid). */
1384 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1386 /** Issue an error if the WIM is part of a split WIM. Software can provide
1387 * this flag for convenience if it explicitly does not want to support split
1389 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1391 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1392 * is not. A WIM is considered writable only if it is writable at the
1393 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1394 * header, and is not part of a spanned set. It is not required to provide this
1395 * flag before attempting to make changes to the WIM, but with this flag you get
1396 * an error sooner rather than later. */
1397 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1400 /** @ingroup G_mounting_wim_images
1403 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1404 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1406 /** Unless this flag is given, changes to a read-write mounted WIM are
1407 * discarded. Ignored for read-only mounts. */
1408 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1410 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1411 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1413 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1414 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1416 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1417 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1420 /** @ingroup G_modifying_wims
1423 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1424 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1425 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1428 /** @ingroup G_writing_and_overwriting_wims
1431 /** Include an integrity table in the WIM.
1433 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1434 * an integrity table if and only if one was present before. For WIMs created
1435 * with wimlib_create_new_wim(), the default behavior is to not include an
1436 * integrity table. */
1437 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1439 /** Do not include an integrity table in the new WIM file. This is the default
1440 * behavior, unless the WIM already included an integrity table. */
1441 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1443 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1444 * images from it can be applied directly from a pipe using
1445 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1446 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1447 * with this flag will not be compatible with Microsoft's software.
1449 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1450 * WIM as pipable if and only if it was pipable before. For WIMs created with
1451 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1453 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1455 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1456 * WIM was pipable already. */
1457 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1459 /** Recompress all resources, even if they could otherwise be copied from a
1460 * different WIM with the same compression type (in the case of
1461 * wimlib_export_image() being called previously). This flag is also valid in
1462 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1463 * in the joined WIM file will be recompressed. */
1464 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1466 /** Call fsync() just before the WIM file is closed. */
1467 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1469 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1470 * data to it if possible. */
1471 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1473 /** wimlib_overwrite() only: Specifying this flag overrides the default
1474 * behavior of wimlib_overwrite() after one or more calls to
1475 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1476 * only minimal changes to correctly remove the image from the WIM will be
1477 * taken. In particular, all streams will be left alone, even if they are no
1478 * longer referenced. This is probably not what you want, because almost no
1479 * space will be saved by deleting an image in this way. */
1480 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1482 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1483 * flag is set in the WIM header. This can be used in combination with
1484 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1485 * set the readonly flag on the on-disk WIM file. */
1486 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1488 /** Do not include non-metadata resources already present in other WIMs. This
1489 * flag can be used to write a "delta" WIM after resources from the WIM on which
1490 * the delta is to be based were referenced with
1491 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1492 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1494 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1495 * are already present (not in external resource WIMs) and their reference
1496 * counts are correct, so the code does not need to recalculate which streams
1497 * are referenced. This is for optimization purposes only, since with this flag
1498 * specified, the metadata resources may not need to be decompressed and parsed.
1500 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1501 * already implied for wimlib_overwrite(). */
1502 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1504 /** Use the slow LZX compression algorithm (rather than the default fast LZX
1505 * compression algorithm) to try to achieve a higher compression ratio. Only
1506 * has an effect if the WIM uses LZX compression; not to be confused with "fast"
1507 * (XPRESS) compression. This can be combined with
1508 * ::WIMLIB_WRITE_FLAG_RECOMPRESS. */
1509 #define WIMLIB_WRITE_FLAG_COMPRESS_SLOW 0x00000800
1512 /** @ingroup G_general
1515 /** Assume that strings are represented in UTF-8, even if this is not the
1516 * locale's character encoding. This flag is ignored on Windows, where wimlib
1517 * always uses UTF-16LE. */
1518 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1520 /** Windows-only: do not attempt to acquire additional privileges (currently
1521 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1522 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1523 * for the case where the calling program manages these privileges itself.
1524 * Note: no error is issued if privileges cannot be acquired, although related
1525 * errors may be reported later, depending on if the operations performed
1526 * actually require additional privileges or not. */
1527 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1529 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1530 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1531 * to read all possible data and metadata for a capture operation could not be
1532 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1534 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1536 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1537 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1538 * to restore all possible data and metadata for an apply operation could not be
1539 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1541 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1544 /** @ingroup G_nonstandalone_wims
1547 /** wimlib_reference_resource_files() only: Enable shell-style filename
1549 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1551 /** wimlib_reference_resource_files() only: Issue an error
1552 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1553 * default behavior without this flag is to issue no error at that point, but
1554 * then attempt to open the glob as a literal path, which of course will fail
1555 * anyway if no file exists at that path. No effect if
1556 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. */
1557 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1560 /** @ingroup G_modifying_wims
1563 /** The specific type of update to perform. */
1564 enum wimlib_update_op {
1565 /** Add a new file or directory tree to the WIM image in a
1566 * certain location. */
1567 WIMLIB_UPDATE_OP_ADD = 0,
1569 /** Delete a file or directory tree from the WIM image. */
1570 WIMLIB_UPDATE_OP_DELETE,
1572 /** Rename a file or directory tree in the WIM image. */
1573 WIMLIB_UPDATE_OP_RENAME,
1576 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1577 struct wimlib_add_command {
1578 /** Filesystem path to the file or directory tree to
1580 wimlib_tchar *fs_source_path;
1581 /** Path, specified from the root of the WIM image, at
1582 * which to add the file or directory tree within the
1584 wimlib_tchar *wim_target_path;
1586 /** Configuration for excluded files. @c NULL means
1587 * exclude no files (use no configuration), unless
1588 * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1590 struct wimlib_capture_config *config;
1592 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1596 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1597 struct wimlib_delete_command {
1598 /** Path, specified from the root of the WIM image, for
1599 * the file or directory tree within the WIM image to be
1601 wimlib_tchar *wim_path;
1602 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1606 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1607 struct wimlib_rename_command {
1608 /** Path, specified from the root of the WIM image, for
1609 * the source file or directory tree within the WIM
1611 wimlib_tchar *wim_source_path;
1612 /** Path, specified from the root of the WIM image, for
1613 * the destination file or directory tree within the WIM
1615 wimlib_tchar *wim_target_path;
1616 /** Reserved; set to 0. */
1620 /** Specification of an update to perform on a WIM image. */
1621 struct wimlib_update_command {
1623 enum wimlib_update_op op;
1626 struct wimlib_add_command add;
1627 struct wimlib_delete_command delete_; /* Underscore is for C++
1629 struct wimlib_rename_command rename;
1634 /** @ingroup G_extracting_wims
1637 /** Specification of a file or directory tree to extract from a WIM image. Used
1638 * in calls to wimlib_extract_files(). */
1639 struct wimlib_extract_command {
1640 /** Path to file or directory tree within the WIM image to extract. It
1641 * must be provided as an absolute path from the root of the WIM image.
1642 * The path separators may be either forward slashes or backslashes. */
1643 wimlib_tchar *wim_source_path;
1645 /** Filesystem path to extract the file or directory tree to. */
1646 wimlib_tchar *fs_dest_path;
1648 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1653 /** @ingroup G_compression
1656 /** LZX compression parameters to pass to wimlib_lzx_alloc_context(). */
1657 struct wimlib_lzx_params {
1658 /** Must be set to the size of this structure, in bytes. */
1659 uint32_t size_of_this;
1661 /** Relatively fast LZX compression algorithm with a decent compression
1662 * ratio; the suggested default. */
1663 #define WIMLIB_LZX_ALGORITHM_FAST 0
1665 /** Slower LZX compression algorithm that provides a better compression
1667 #define WIMLIB_LZX_ALGORITHM_SLOW 1
1669 /** Algorithm to use to perform the compression: either
1670 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
1671 * format is still LZX; this refers to the method the code will use to
1672 * perform LZX-compatible compression. */
1673 uint32_t algorithm : 3;
1675 /** If set to 1, the default parameters for the specified algorithm are
1676 * used rather than the ones specified in the following union. */
1677 uint32_t use_defaults : 1;
1680 /** Parameters for the fast algorithm. */
1681 struct wimlib_lzx_fast_params {
1682 uint32_t fast_reserved1[10];
1685 /** Parameters for the slow algorithm. */
1686 struct wimlib_lzx_slow_params {
1687 /** If set to 1, the compressor can output length 2
1688 * matches. If set 0, the compressor only outputs
1689 * matches of length 3 or greater. Suggested value: 1
1691 uint32_t use_len2_matches : 1;
1693 uint32_t slow_reserved1 : 31;
1695 /** This is the maximum match length to return from the
1696 * binary tree match-finder. Any match reaching this
1697 * limit is still extended as far as possible. Must be
1698 * at least 3 and no more than 257. Suggested value:
1700 uint32_t num_fast_bytes;
1702 /** Number of passes to compute a match/literal sequence
1703 * for each LZX block. This is for an iterative
1704 * algorithm that attempts to minimize the cost of the
1705 * match/literal sequence by using a cost model provided
1706 * by the previous iteration. Must be at least 1.
1707 * Suggested value: 3. */
1708 uint32_t num_optim_passes;
1710 /** The number of times to attempt to recursively split
1711 * each LZX block. Up to (2**(num_split_passes)
1712 * sub-blocks can be created for a given input. This
1713 * parameter can be 0, in which case the full input is
1714 * always output as one block. Suggested value: 3.
1716 uint32_t num_split_passes;
1718 uint32_t slow_reserved2[4];
1720 /** Assumed cost of a main symbol with zero frequency.
1721 * Must be at least 1 and no more than 16. Suggested
1723 uint8_t main_nostat_cost;
1725 /** Assumed cost of a length symbol with zero frequency.
1726 * Must be at least 1 and no more than 16. Suggested
1728 uint8_t len_nostat_cost;
1730 /** Assumed cost of an aligned symbol with zero
1731 * frequency. Must be at least 1 and no more than 8.
1732 * Suggested value: 7. */
1733 uint8_t aligned_nostat_cost;
1735 uint8_t slow_reserved3[5];
1740 /** Opaque LZX compression context. */
1741 struct wimlib_lzx_context;
1744 /** @ingroup G_general
1748 * Possible values of the error code returned by many functions in wimlib.
1750 * See the documentation for each wimlib function to see specifically what error
1751 * codes can be returned by a given function, and what they mean.
1753 enum wimlib_error_code {
1754 WIMLIB_ERR_SUCCESS = 0,
1755 WIMLIB_ERR_ALREADY_LOCKED,
1756 WIMLIB_ERR_DECOMPRESSION,
1757 WIMLIB_ERR_DELETE_STAGING_DIR,
1758 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1761 WIMLIB_ERR_FUSERMOUNT,
1762 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1763 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1764 WIMLIB_ERR_IMAGE_COUNT,
1765 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1766 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1767 WIMLIB_ERR_INTEGRITY,
1768 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1769 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1770 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1771 WIMLIB_ERR_INVALID_HEADER,
1772 WIMLIB_ERR_INVALID_IMAGE,
1773 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1774 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1775 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1776 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1777 WIMLIB_ERR_INVALID_OVERLAY,
1778 WIMLIB_ERR_INVALID_PARAM,
1779 WIMLIB_ERR_INVALID_PART_NUMBER,
1780 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1781 WIMLIB_ERR_INVALID_REPARSE_DATA,
1782 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1783 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1784 WIMLIB_ERR_INVALID_UTF16_STRING,
1785 WIMLIB_ERR_INVALID_UTF8_STRING,
1786 WIMLIB_ERR_IS_DIRECTORY,
1787 WIMLIB_ERR_IS_SPLIT_WIM,
1788 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1790 WIMLIB_ERR_METADATA_NOT_FOUND,
1795 WIMLIB_ERR_NOTEMPTY,
1796 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1797 WIMLIB_ERR_NOT_A_WIM_FILE,
1798 WIMLIB_ERR_NOT_PIPABLE,
1799 WIMLIB_ERR_NO_FILENAME,
1803 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1805 WIMLIB_ERR_READLINK,
1808 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1809 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1810 WIMLIB_ERR_RESOURCE_ORDER,
1811 WIMLIB_ERR_SET_ATTRIBUTES,
1812 WIMLIB_ERR_SET_REPARSE_DATA,
1813 WIMLIB_ERR_SET_SECURITY,
1814 WIMLIB_ERR_SET_SHORT_NAME,
1815 WIMLIB_ERR_SET_TIMESTAMPS,
1816 WIMLIB_ERR_SPLIT_INVALID,
1819 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1820 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1821 WIMLIB_ERR_UNKNOWN_VERSION,
1822 WIMLIB_ERR_UNSUPPORTED,
1823 WIMLIB_ERR_UNSUPPORTED_FILE,
1824 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1825 WIMLIB_ERR_WIM_IS_READONLY,
1831 /** Used to indicate no WIM image or an invalid WIM image. */
1832 #define WIMLIB_NO_IMAGE 0
1834 /** Used to specify all images in the WIM. */
1835 #define WIMLIB_ALL_IMAGES (-1)
1838 * @ingroup G_modifying_wims
1840 * Appends an empty image to a WIM file. This empty image will initially
1841 * contain no files or directories, although if written without further
1842 * modifications, a root directory will be created automatically for it. After
1843 * calling this function, you can use wimlib_update_image() to add files to the
1844 * new WIM image. This gives you slightly more control over making the new
1845 * image compared to calling wimlib_add_image() or
1846 * wimlib_add_image_multisource() directly.
1849 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1852 * Name to give the new image. If @c NULL or empty, the new image is given
1853 * no name. If nonempty, it must specify a name that does not already
1855 * @param new_idx_ret
1856 * If non-<code>NULL</code>, the index of the newly added image is returned
1859 * @return 0 on success; nonzero on failure. The possible error codes are:
1861 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1862 * There is already an image in @p wim named @p name.
1863 * @retval ::WIMLIB_ERR_NOMEM
1864 * Failed to allocate the memory needed to add the new image.
1865 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1866 * The WIM file is considered read-only because of any of the reasons
1867 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1871 wimlib_add_empty_image(WIMStruct *wim,
1872 const wimlib_tchar *name,
1876 * @ingroup G_modifying_wims
1878 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1880 * The directory tree or NTFS volume is scanned immediately to load the dentry
1881 * tree into memory, and file attributes and symbolic links are read. However,
1882 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1885 * See the manual page for the @b wimlib-imagex program for more information
1886 * about the "normal" capture mode versus the NTFS capture mode (entered by
1887 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1889 * Note that @b no changes are committed to the underlying WIM file (if
1890 * any) until wimlib_write() or wimlib_overwrite() is called.
1893 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1896 * A path to a directory or unmounted NTFS volume that will be captured as
1899 * Name to give the new image. If @c NULL or empty, the new image is given
1900 * no name. If nonempty, it must specify a name that does not already
1903 * Capture configuration that specifies files, directories, or path globs
1904 * to exclude from being captured. If @c NULL, a dummy configuration where
1905 * no paths are treated specially is used.
1907 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1908 * @param progress_func
1909 * If non-NULL, a function that will be called periodically with the
1910 * progress of the current operation. The progress messages that will be
1911 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1912 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1913 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1915 * @return 0 on success; nonzero on error. On error, changes to @p wim are
1916 * discarded so that it appears to be in the same state as when this function
1919 * This function is implemented by calling wimlib_add_empty_image(), then
1920 * calling wimlib_update_image() with a single "add" command, so any error code
1921 * returned by wimlib_add_empty_image() may be returned, as well as any error
1922 * codes returned by wimlib_update_image() other than ones documented as only
1923 * being returned specifically by an update involving delete or rename commands.
1926 wimlib_add_image(WIMStruct *wim,
1927 const wimlib_tchar *source,
1928 const wimlib_tchar *name,
1929 const struct wimlib_capture_config *config,
1931 wimlib_progress_func_t progress_func);
1934 * @ingroup G_modifying_wims
1936 * This function is equivalent to wimlib_add_image() except it allows for
1937 * multiple sources to be combined into a single WIM image. This is done by
1938 * specifying the @p sources and @p num_sources parameters instead of the @p
1939 * source parameter of wimlib_add_image(). The rest of the parameters are the
1940 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1941 * capture</b> for full details on how this mode works.
1943 * In addition to the error codes that wimlib_add_image() can return,
1944 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1945 * when trying to overlay a non-directory on a directory or when otherwise
1946 * trying to overlay multiple conflicting files to the same location in the WIM
1947 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1948 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1949 * was not exactly one capture source with the target being the root directory.
1950 * (In this respect, there is no advantage to using
1951 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1954 wimlib_add_image_multisource(WIMStruct *wim,
1955 const struct wimlib_capture_source *sources,
1957 const wimlib_tchar *name,
1958 const struct wimlib_capture_config *config,
1960 wimlib_progress_func_t progress_func);
1963 * @ingroup G_creating_and_opening_wims
1965 * Creates a ::WIMStruct for a new WIM file.
1967 * This only creates an in-memory structure for a WIM that initially contains no
1968 * images. No on-disk file is created until wimlib_write() is called.
1971 * The type of compression to be used in the new WIM file. Must be
1972 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1973 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1975 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1976 * written to the memory location pointed to by this paramater. The
1977 * ::WIMStruct must be freed using using wimlib_free() when finished with
1979 * @return 0 on success; nonzero on error.
1980 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1981 * @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1982 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1983 * @retval ::WIMLIB_ERR_NOMEM
1984 * Failed to allocate needed memory.
1987 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1990 * @ingroup G_modifying_wims
1992 * Deletes an image, or all images, from a WIM file.
1994 * All streams referenced by the image(s) being deleted are removed from the
1995 * lookup table of the WIM if they are not referenced by any other images in the
1998 * Please note that @b no changes are committed to the underlying WIM file (if
1999 * any) until wimlib_write() or wimlib_overwrite() is called.
2002 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2005 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2007 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2008 * to be left unmodified only if @p image specified a single image. If instead
2009 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2010 * possible for some but not all of the images to have been deleted when a
2011 * failure status is returned.
2013 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2014 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2015 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2016 * The WIM file is considered read-only because of any of the reasons
2017 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2020 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2021 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2022 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2023 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2024 * different reasons) to read the metadata resource for an image that needed to
2028 wimlib_delete_image(WIMStruct *wim, int image);
2031 * @ingroup G_modifying_wims
2033 * Exports an image, or all the images, from a WIM file, into another WIM file.
2035 * The destination image is made to share the same dentry tree and security data
2036 * structure as the source image. This places some restrictions on additional
2037 * functions that may be called. wimlib_mount_image() may not be called on
2038 * either the source image or the destination image without an intervening call
2039 * to a function that un-shares the images, such as wimlib_free() on @p
2040 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2041 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2042 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2043 * have references back to @p src_wim.
2045 * If this function fails, all changes to @p dest_wim are rolled back.
2047 * Please note that no changes are committed to the underlying WIM file of @p
2048 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2051 * The WIM from which to export the images, specified as a pointer to the
2052 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2053 * split WIM. In the case of a WIM file that is not standalone, this
2054 * ::WIMStruct must have had any needed external resources previously
2055 * referenced using wimlib_reference_resources() or
2056 * wimlib_reference_resource_files().
2058 * The image to export from @p src_wim, as either a 1-based image index to
2059 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2061 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2064 * For single-image exports, the name to give the exported image in @p
2065 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2066 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2067 * that case, the names are all taken from @p src_wim. This parameter is
2068 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2069 * @param dest_description
2070 * For single-image exports, the description to give the exported image in
2071 * the new WIM file. If left @c NULL, the description from @p src_wim is
2072 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2073 * NULL; in that case, the description are all taken from @p src_wim. This
2074 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2075 * @param export_flags
2076 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2077 * @param progress_func
2078 * Currently ignored, but reserved for a function that will be called with
2079 * information about the operation. Use NULL if no additional information
2082 * @return 0 on success; nonzero on error.
2083 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2084 * One or more of the names being given to an exported image was already in
2085 * use in the destination WIM.
2086 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2087 * @p src_image does not exist in @p src_wim and was not
2088 * ::WIMLIB_ALL_IMAGES.
2089 * @retval ::WIMLIB_ERR_INVALID_PARAM
2090 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2091 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2093 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2094 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2095 * example, one of them was a non-first part of a split WIM.
2096 * @retval ::WIMLIB_ERR_NOMEM
2097 * Failed to allocate needed memory.
2098 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2099 * A resource that needed to be exported could not be found in either the
2100 * source or destination WIMs. This error can occur if, for example, @p
2101 * src_wim is part of a split WIM but needed resources from the other split
2102 * WIM parts were not referenced with wimlib_reference_resources() or
2103 * wimlib_reference_resource_files() before the call to
2104 * wimlib_export_image().
2105 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2106 * @p dest_wim is considered read-only because of any of the reasons
2107 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2110 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2111 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2112 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2113 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2114 * different reasons) to read the metadata resource for an image in @p src_wim
2115 * that needed to be exported.
2118 wimlib_export_image(WIMStruct *src_wim, int src_image,
2119 WIMStruct *dest_wim,
2120 const wimlib_tchar *dest_name,
2121 const wimlib_tchar *dest_description,
2123 wimlib_progress_func_t progress_func);
2126 * @ingroup G_extracting_wims
2128 * Extract zero or more files or directory trees from a WIM image.
2130 * This generalizes the single-image extraction functionality of
2131 * wimlib_extract_image() to allow extracting only the specified subsets of the
2135 * The WIM from which to extract the files, specified as a pointer to the
2136 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2137 * split WIM. In the case of a WIM file that is not standalone, this
2138 * ::WIMStruct must have had any needed external resources previously
2139 * referenced using wimlib_reference_resources() or
2140 * wimlib_reference_resource_files().
2143 * The 1-based number of the image in @p wim from which the files or
2144 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
2147 * An array of ::wimlib_extract_command structures that specifies the
2148 * extractions to perform.
2151 * Number of commands in the @p cmds array.
2153 * @param default_extract_flags
2154 * Default extraction flags; the behavior shall be as if these flags had
2155 * been specified in the ::wimlib_extract_command.extract_flags member in
2156 * each extraction command, in combination with any flags already present.
2158 * @param progress_func
2159 * If non-NULL, a function that will be called periodically with the
2160 * progress of the current operation.
2162 * @return 0 on success; nonzero on error. The possible error codes include
2163 * most of those documented as returned by wimlib_extract_image() as well as the
2164 * following additional error codes:
2166 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2167 * @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
2169 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2170 * The ::wimlib_extract_command.wim_source_path member in one of the
2171 * extract commands did not exist in the WIM.
2172 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2173 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
2174 * in which ::wimlib_extract_command.wim_source_path existed but was not a
2175 * regular file or directory.
2176 * @retval ::WIMLIB_ERR_INVALID_PARAM
2177 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
2178 * specified for some commands but not all; or
2179 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
2180 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
2181 * for a command in which ::wimlib_extract_command.wim_source_path did not
2182 * specify the root directory of the WIM image.
2185 wimlib_extract_files(WIMStruct *wim,
2187 const struct wimlib_extract_command *cmds,
2189 int default_extract_flags,
2190 wimlib_progress_func_t progress_func);
2193 * @ingroup G_extracting_wims
2195 * Extracts an image, or all images, from a WIM to a directory or directly to a
2196 * NTFS volume image.
2198 * The exact behavior of how wimlib extracts files from a WIM image is
2199 * controllable by the @p extract_flags parameter, but there also are
2200 * differences depending on the platform (UNIX-like vs Windows). See the manual
2201 * page for <b>wimlib-imagex apply</b> for more information, including about the
2202 * special "NTFS volume extraction mode" entered by providing
2203 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2205 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
2206 * returned if any resulting SHA1 message digests do not match the values
2207 * provided in the WIM file. Therefore, if this function is successful, you can
2208 * be fairly sure that any compressed data in the WIM was uncompressed
2212 * The WIM from which to extract the image(s), specified as a pointer to
2213 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2214 * of a split WIM. In the case of a WIM file that is not standalone, this
2215 * ::WIMStruct must have had any needed external resources previously
2216 * referenced using wimlib_reference_resources() or
2217 * wimlib_reference_resource_files().
2219 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
2220 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
2221 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2223 * Directory to extract the WIM image(s) to (created if it does not already
2224 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
2225 * path to the unmounted NTFS volume to extract the image to.
2226 * @param extract_flags
2227 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
2228 * @param progress_func
2229 * If non-NULL, a function that will be called periodically with the
2230 * progress of the current operation.
2232 * @return 0 on success; nonzero on error.
2233 * @retval ::WIMLIB_ERR_DECOMPRESSION
2234 * Failed to decompress a resource to be extracted.
2235 * @retval ::WIMLIB_ERR_INVALID_PARAM
2236 * Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
2237 * were specified in @p extract_flags; or both
2238 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
2239 * specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
2240 * ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
2241 * ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
2242 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
2243 * @p image was ::WIMLIB_ALL_IMAGES.
2244 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2245 * The SHA1 message digest of an extracted stream did not match the SHA1
2246 * message digest given in the WIM file.
2247 * @retval ::WIMLIB_ERR_LINK
2248 * Failed to create a symbolic link or a hard link.
2249 * @retval ::WIMLIB_ERR_MKDIR
2250 * Failed create a directory.
2251 * @retval ::WIMLIB_ERR_NOMEM
2252 * Failed to allocate needed memory.
2253 * @retval ::WIMLIB_ERR_OPEN
2254 * Could not create a file, or failed to open an already-extracted file.
2255 * @retval ::WIMLIB_ERR_READ
2256 * Failed to read data from the WIM file associated with @p wim.
2257 * @retval ::WIMLIB_ERR_READLINK
2258 * Failed to determine the target of a symbolic link in the WIM.
2259 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2260 * Failed to fix the target of an absolute symbolic link (e.g. if the
2261 * target would have exceeded the maximum allowed length). (Only if
2262 * reparse data was supported by the extraction mode and
2263 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
2264 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2265 * One of the files or directories that needed to be extracted referenced a
2266 * stream not present in the WIM's lookup table (or in any of the lookup
2267 * tables of the split WIM parts).
2268 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2269 * Failed to set attributes on a file.
2270 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2271 * Failed to set reparse data on a file (only if reparse data was supported
2272 * by the extraction mode).
2273 * @retval ::WIMLIB_ERR_SET_SECURITY
2274 * Failed to set security descriptor on a file
2275 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2277 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2278 * Failed to set the short name of a file (only if
2279 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2280 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2281 * Failed to set timestamps on a file (only if
2282 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2283 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2284 * Unexpected end-of-file occurred when reading data from the WIM file
2285 * associated with @p wim.
2286 * @retval ::WIMLIB_ERR_UNSUPPORTED
2287 * A requested extraction flag, or the data or metadata that must be
2288 * extracted to support it, is unsupported in the build and configuration
2289 * of wimlib, or on the current platform or extraction mode or target
2290 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2291 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2292 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2293 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2294 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2295 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2296 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2298 * ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
2299 * or more files with short names, but extracting short names is not
2300 * supported --- on Windows, this occurs if the target volume does not
2301 * support short names, while on non-Windows, this occurs if
2302 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2303 * @retval ::WIMLIB_ERR_WRITE
2304 * Failed to write data to a file being extracted.
2306 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2307 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2308 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2309 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2310 * different reasons) to read the metadata resource for an image that needed to
2314 wimlib_extract_image(WIMStruct *wim, int image,
2315 const wimlib_tchar *target,
2317 wimlib_progress_func_t progress_func);
2320 * @ingroup G_extracting_wims
2322 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
2323 * pipable WIM is being sent.
2325 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2326 * about pipable WIMs.
2328 * This function operates in a special way to read the WIM fully sequentially.
2329 * As a result, there is no ::WIMStruct is made visible to library users, and
2330 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2331 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2332 * seekable file, not a pipe.)
2335 * File descriptor, which may be a pipe, opened for reading and positioned
2336 * at the start of the pipable WIM.
2337 * @param image_num_or_name
2338 * String that specifies the 1-based index or name of the image to extract.
2339 * It is translated to an image index using the same rules that
2340 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2341 * only a single image (not all images) can be specified. Alternatively,
2342 * specify @p NULL here to use the first image in the WIM if it contains
2343 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2345 * Same as the corresponding parameter to wimlib_extract_image().
2346 * @param extract_flags
2347 * Same as the corresponding parameter to wimlib_extract_image(), except
2348 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
2349 * always implied, since data is always read from @p pipe_fd sequentially
2350 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
2351 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2352 * @param progress_func
2353 * Same as the corresponding parameter to wimlib_extract_image(), except
2354 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2357 * @return 0 on success; nonzero on error. The possible error codes include
2358 * those returned by wimlib_extract_image() as well as the following:
2360 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2361 * Data read from the pipable WIM was invalid.
2362 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2363 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2366 wimlib_extract_image_from_pipe(int pipe_fd,
2367 const wimlib_tchar *image_num_or_name,
2368 const wimlib_tchar *target, int extract_flags,
2369 wimlib_progress_func_t progress_func);
2372 * @ingroup G_wim_information
2374 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2375 * includes a string of XML that describes the images contained in the WIM.
2378 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2379 * have to be standalone (e.g. it could be part of a split WIM).
2381 * @c stdout, or a FILE* opened for writing, to extract the data to.
2383 * @return 0 on success; nonzero on error.
2384 * @retval ::WIMLIB_ERR_INVALID_PARAM
2385 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2386 * @retval ::WIMLIB_ERR_NOMEM
2387 * @retval ::WIMLIB_ERR_READ
2388 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2389 * Failed to read the XML data from the WIM.
2390 * @retval ::WIMLIB_ERR_WRITE
2391 * Failed to completely write the XML data to @p fp.
2394 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2397 * @ingroup G_general
2399 * Frees all memory allocated for a WIMStruct and closes all files associated
2403 * Pointer to the ::WIMStruct for a WIM file.
2405 * @return This function has no return value.
2408 wimlib_free(WIMStruct *wim);
2411 * @ingroup G_general
2413 * Converts a ::wimlib_compression_type value into a string.
2416 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2417 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2420 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2423 extern const wimlib_tchar *
2424 wimlib_get_compression_type_string(int ctype);
2427 * @ingroup G_general
2429 * Converts an error code into a string describing it.
2432 * The error code returned by one of wimlib's functions.
2435 * Pointer to a statically allocated string describing the error code,
2436 * or @c NULL if the error code is not valid.
2438 extern const wimlib_tchar *
2439 wimlib_get_error_string(enum wimlib_error_code code);
2442 * @ingroup G_wim_information
2444 * Returns the description of the specified image.
2447 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2448 * to be standalone (e.g. it could be part of a split WIM).
2450 * The number of the image, numbered starting at 1.
2453 * The description of the image, or @c NULL if there is no such image, or
2454 * @c NULL if the specified image has no description. The description
2455 * string is in library-internal memory and may not be modified or freed;
2456 * in addition, the string will become invalid if the description of the
2457 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2459 extern const wimlib_tchar *
2460 wimlib_get_image_description(const WIMStruct *wim, int image);
2463 * @ingroup G_wim_information
2465 * Returns the name of the specified image.
2468 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2469 * to be standalone (e.g. it could be part of a split WIM).
2471 * The number of the image, numbered starting at 1.
2474 * The name of the image, or @c NULL if there is no such image, or an empty
2475 * string if the image is unnamed. The name string is in
2476 * library-internal memory and may not be modified or freed; in addition,
2477 * the string will become invalid if the name of the image is changed, the
2478 * image is deleted, or the ::WIMStruct is destroyed.
2480 extern const wimlib_tchar *
2481 wimlib_get_image_name(const WIMStruct *wim, int image);
2485 * @ingroup G_wim_information
2487 * Get basic information about a WIM file.
2490 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2491 * to be standalone (e.g. it could be part of a split WIM).
2493 * A ::wimlib_wim_info structure that will be filled in with information
2494 * about the WIM file.
2499 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2502 * @ingroup G_general
2504 * Initialization function for wimlib. Call before using any other wimlib
2505 * function except wimlib_set_print_errors(). If not done manually, this
2506 * function will be called automatically with @p init_flags set to
2507 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.
2510 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2512 * @return 0 on success; nonzero on failure. Currently, only the following
2513 * error code is defined:
2515 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2516 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2517 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2518 * init_flags, but the corresponding privileges could not be acquired.
2521 wimlib_global_init(int init_flags);
2524 * @ingroup G_general
2526 * Cleanup function for wimlib. You are not required to call this function, but
2527 * it will release any global resources allocated by the library.
2530 wimlib_global_cleanup(void);
2533 * @ingroup G_wim_information
2535 * Determines if an image name is already used by some image in the WIM.
2538 * Pointer to the ::WIMStruct for a WIM file.
2540 * The name to check.
2543 * @c true if there is already an image in @p wim named @p name; @c false
2544 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2545 * the empty string, @c false is returned.
2548 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2551 * @ingroup G_wim_information
2553 * Iterate through a file or directory tree in the WIM image. By specifying
2554 * appropriate flags and a callback function, you can get the attributes of a
2555 * file in the WIM, get a directory listing, or even get a listing of the entire
2559 * The WIM containing the image(s) over which to iterate, specified as a
2560 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2561 * or part 1 of a split WIM. In the case of a WIM file that is not
2562 * standalone, this ::WIMStruct should have had any needed external
2563 * resources previously referenced using wimlib_reference_resources() or
2564 * wimlib_reference_resource_files(). If not, see
2565 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2566 * the behavior when resources are missing.
2569 * The 1-based number of the image in @p wim that contains the files or
2570 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2571 * iteration on all images in the WIM.
2574 * Path in the WIM image at which to do the iteration.
2577 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2580 * A callback function that will receive each directory entry.
2583 * An extra parameter that will always be passed to the callback function
2586 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2587 * first nonzero value that was returned from @p cb. However, additional error
2588 * codes may be returned, including the following:
2590 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2591 * @p path did not exist in the WIM image.
2592 * @retval ::WIMLIB_ERR_NOMEM
2593 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2595 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2596 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2597 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2598 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2599 * different reasons) to read the metadata resource for an image over which
2600 * iteration needed to be done.
2603 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2605 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2608 * @ingroup G_wim_information
2610 * Iterate through the lookup table of a WIM file. This can be used to directly
2611 * get a listing of the unique resources contained in a WIM file over all
2612 * images. Both file resources and metadata resources are included. However,
2613 * only resources actually included in the file represented by @a wim, plus
2614 * explicitly referenced external resources (via wimlib_reference_resources() or
2615 * wimlib_reference_resource_files()) are included in the iteration. For
2616 * example, if @p wim represents just one part of a split WIM, then only
2617 * resources in that part will be included, unless other resources were
2618 * explicitly referenced.
2621 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2622 * to be standalone (e.g. it could be part of a split WIM).
2625 * Reserved; set to 0.
2628 * A callback function that will receive each resource.
2631 * An extra parameter that will always be passed to the callback function
2634 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2635 * that was returned from @p cb.
2638 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2639 wimlib_iterate_lookup_table_callback_t cb,
2643 * @ingroup G_nonstandalone_wims
2645 * Joins a split WIM into a stand-alone one-part WIM.
2648 * An array of strings that gives the filenames of all parts of the split
2649 * WIM. No specific order is required, but all parts must be included with
2652 * Number of filenames in @p swms.
2653 * @param swm_open_flags
2654 * Open flags for the split WIM parts (e.g.
2655 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2656 * @param wim_write_flags
2657 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2658 * be used to write the joined WIM.
2659 * @param output_path
2660 * The path to write the joined WIM file to.
2661 * @param progress_func
2662 * If non-NULL, a function that will be called periodically with the
2663 * progress of the current operation.
2665 * @return 0 on success; nonzero on error. This function may return most error
2666 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2667 * as the following error code:
2669 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2670 * The split WIMs do not form a valid WIM because they do not include all
2671 * the parts of the original WIM, there are duplicate parts, or not all the
2672 * parts have the same GUID and compression type.
2674 * Note: wimlib is generalized enough that this function is not actually needed
2675 * to join a split WIM; instead, you could open the first part of the split WIM,
2676 * then reference the other parts with wimlib_reference_resource_files(), then
2677 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2678 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2682 wimlib_join(const wimlib_tchar * const *swms,
2684 const wimlib_tchar *output_path,
2686 int wim_write_flags,
2687 wimlib_progress_func_t progress_func);
2690 * @ingroup G_compression
2692 * Compress a chunk of a WIM resource using LZX compression.
2694 * This function is exported for convenience only and should only be used by
2695 * library clients looking to make use of wimlib's compression code for another
2699 * Uncompressed data of the chunk.
2701 * Size of the uncompressed chunk, in bytes.
2703 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2706 * The size of the compressed data written to @p out in bytes, or 0 if the
2707 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2709 * As a special requirement, the compression code is optimized for the WIM
2710 * format and therefore requires (@p chunk_size <= 32768).
2713 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out)
2717 * @ingroup G_compression
2719 * Equivalent to wimlib_lzx_compress(), but uses the specified compression
2720 * context, allocated by wimlib_lzx_alloc_context().
2723 wimlib_lzx_compress2(const void *chunk, unsigned chunk_size, void *out,
2724 struct wimlib_lzx_context *ctx);
2727 * @ingroup G_compression
2729 * Allocate a LZX compression context using the specified parameters.
2731 * This function is exported for convenience only and should only be used by
2732 * library clients looking to make use of wimlib's compression code for another
2736 * Compression parameters to use, or @c NULL to use the default algorithm
2740 * A pointer to either @c NULL or an existing ::wimlib_lzx_context. If
2741 * <code>*ctx_ret == NULL</code>, the new context is allocated. If
2742 * <code>*ctx_ret != NULL</code>, the existing context is re-used if
2743 * possible. Alternatively, this argument can itself be @c NULL to
2744 * indicate that only parameter validation is to be performed.
2746 * @return 0 on success; nonzero on error.
2748 * @retval ::WIMLIB_ERR_INVALID_PARAM
2749 * The compression parameters were invalid.
2750 * @retval ::WIMLIB_ERR_NOMEM
2751 * Not enough memory to allocate the compression context.
2754 wimlib_lzx_alloc_context(const struct wimlib_lzx_params *params,
2755 struct wimlib_lzx_context **ctx_pp);
2758 * @ingroup G_compression
2760 * Free the specified LZX compression context, allocated with
2761 * wimlib_lzx_alloc_context().
2764 wimlib_lzx_free_context(struct wimlib_lzx_context *ctx);
2767 * @ingroup G_compression
2769 * Decompresses a block of LZX-compressed data as used in the WIM file format.
2771 * Note that this will NOT work unmodified for LZX as used in the cabinet
2772 * format, which is not the same as in the WIM format!
2774 * This function is exported for convenience only and should only be used by
2775 * library clients looking to make use of wimlib's compression code for another
2778 * @param compressed_data
2779 * Pointer to the compressed data.
2781 * @param compressed_len
2782 * Length of the compressed data, in bytes.
2784 * @param uncompressed_data
2785 * Pointer to the buffer into which to write the uncompressed data.
2787 * @param uncompressed_len
2788 * Length of the uncompressed data. It must be 32768 bytes or less.
2791 * 0 on success; non-zero on failure.
2794 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2795 void *uncompressed_data, unsigned uncompressed_len);
2799 * @ingroup G_mounting_wim_images
2801 * Mounts an image in a WIM file on a directory read-only or read-write.
2803 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2804 * supported if wimlib was configured with @c --without-fuse. This includes
2805 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2808 * Calling this function daemonizes the process, unless
2809 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2810 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2811 * to the WIM are staged in a temporary directory.
2813 * It is safe to mount multiple images from the same underlying WIM file
2814 * read-only at the same time, but only if different ::WIMStruct's are used. It
2815 * is @b not safe to mount multiple images from the same WIM file read-write at
2818 * wimlib_mount_image() cannot be used on an image that was exported with
2819 * wimlib_export_image() while the dentry trees for both images are still in
2820 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2821 * that already has modifications pending (e.g. an image added with
2822 * wimlib_add_image()).
2825 * Pointer to the ::WIMStruct containing the image to be mounted.
2827 * The number of the image to mount, indexed starting from it. It must be
2828 * an existing, single image.
2830 * The path to an existing empty directory to mount the image on.
2831 * @param mount_flags
2832 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2833 * @param staging_dir
2834 * If non-NULL, the name of a directory in which the staging directory will
2835 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2836 * in @p mount_flags. If left @c NULL, the staging directory is created in
2837 * the same directory as the WIM file that @p wim was originally read from.
2839 * @return 0 on success; nonzero on error.
2841 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2842 * A read-write mount was requested, but an an exclusive advisory lock on
2843 * the on-disk WIM file could not be acquired because another thread or
2844 * process has mounted an image from the WIM read-write or is currently
2845 * modifying the WIM in-place.
2846 * @retval ::WIMLIB_ERR_FUSE
2847 * A non-zero status was returned by @c fuse_main().
2848 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2849 * @p image does not specify an existing, single image in @p wim.
2850 * @retval ::WIMLIB_ERR_INVALID_PARAM
2851 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2852 * wimlib_export_image(), or @p image has been added with
2853 * wimlib_add_image().
2854 * @retval ::WIMLIB_ERR_MKDIR
2855 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2856 * staging directory could not be created.
2857 * @retval ::WIMLIB_ERR_NOTDIR
2858 * Could not determine the current working directory.
2859 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2860 * One of the dentries in the image referenced a stream not present in the
2861 * WIM's lookup table (or in any of the lookup tables of the split WIM
2863 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2864 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2865 * wim is considered read-only because of any of the reasons mentioned in
2866 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2867 * @retval ::WIMLIB_ERR_UNSUPPORTED
2868 * Mounting is not supported, either because the platform is Windows, or
2869 * because the platform is UNIX-like and wimlib was compiled with @c
2872 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2873 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2874 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2875 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2876 * different reasons) to read the metadata resource for the image to mount.
2879 wimlib_mount_image(WIMStruct *wim,
2881 const wimlib_tchar *dir,
2883 const wimlib_tchar *staging_dir);
2886 * @ingroup G_creating_and_opening_wims
2888 * Opens a WIM file and creates a ::WIMStruct for it.
2891 * The path to the WIM file to open.
2894 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2896 * @param progress_func
2897 * If non-NULL, a function that will be called periodically with the
2898 * progress of the current operation. Currently, the only messages sent
2899 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2900 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2903 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2904 * is written to the memory location pointed to by this parameter. The
2905 * ::WIMStruct can be freed using using wimlib_free() when finished with
2908 * @return 0 on success; nonzero on error.
2909 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2910 * The WIM is not the non-first part of a split WIM, and the number of
2911 * metadata resources found in the WIM did not match the image count given
2912 * in the WIM header, or the number of <IMAGE> elements in the XML
2913 * data for the WIM did not match the image count given in the WIM header.
2914 * @retval ::WIMLIB_ERR_INTEGRITY
2915 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2916 * wim_file contains an integrity table, but the SHA1 message digest for a
2917 * chunk of the WIM does not match the corresponding message digest given
2918 * in the integrity table.
2919 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2920 * Resources in @p wim_file are compressed, but the chunk size is not 32768.
2921 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2922 * The header of @p wim_file says that resources in the WIM are compressed,
2923 * but the header flag indicating LZX or XPRESS compression is not set.
2924 * @retval ::WIMLIB_ERR_INVALID_HEADER
2925 * The header of @p wim_file was otherwise invalid.
2926 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2927 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2928 * wim_file contains an integrity table, but the integrity table is
2930 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2931 * The lookup table for the WIM contained duplicate entries that are not
2932 * for metadata resources, or it contained an entry with a SHA1 message
2933 * digest of all 0's.
2934 * @retval ::WIMLIB_ERR_INVALID_PARAM
2935 * @p wim_ret was @c NULL.
2936 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
2937 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
2938 * specified in @p open_flags.
2939 * @retval ::WIMLIB_ERR_NOMEM
2940 * Failed to allocated needed memory.
2941 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2942 * @p wim_file does not begin with the expected magic characters.
2943 * @retval ::WIMLIB_ERR_OPEN
2944 * Failed to open the file @p wim_file for reading.
2945 * @retval ::WIMLIB_ERR_READ
2946 * Failed to read data from @p wim_file.
2947 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2948 * Unexpected end-of-file while reading data from @p wim_file.
2949 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2950 * A number other than 0x10d00 is written in the version field of the WIM
2951 * header of @p wim_file. (May be a pre-Vista WIM.)
2952 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2953 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2954 * considered read-only because of any of the reasons mentioned in the
2955 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2956 * @retval ::WIMLIB_ERR_XML
2957 * The XML data for @p wim_file is invalid.
2960 wimlib_open_wim(const wimlib_tchar *wim_file,
2962 WIMStruct **wim_ret,
2963 wimlib_progress_func_t progress_func);
2966 * @ingroup G_writing_and_overwriting_wims
2968 * Overwrites the file that the WIM was originally read from, with changes made.
2969 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2970 * rather than wimlib_create_new_wim().
2972 * There are two ways that a WIM may be overwritten. The first is to do a full
2973 * rebuild. In this mode, the new WIM is written to a temporary file and then
2974 * renamed to the original file after it is has been completely written. The
2975 * temporary file is made in the same directory as the original WIM file. A
2976 * full rebuild may take a while, but can be used even if images have been
2977 * modified or deleted, will produce a WIM with no holes, and has little chance
2978 * of unintentional data loss because the temporary WIM is fsync()ed before
2979 * being renamed to the original WIM.
2981 * The second way to overwrite a WIM is by appending to the end of it and
2982 * overwriting the header. This can be much faster than a full rebuild, but the
2983 * disadvantage is that some space will be wasted. Writing a WIM in this mode
2984 * begins with writing any new file resources *after* everything in the old WIM,
2985 * even though this will leave a hole where the old lookup table, XML data, and
2986 * integrity were. This is done so that the WIM remains valid even if the
2987 * operation is aborted mid-write. The WIM header is only overwritten at the
2988 * very last moment, and up until that point the WIM will be seen as the old
2991 * By default, wimlib_overwrite() does the append-style overwrite described
2992 * above, unless resources in the WIM are arranged in an unusual way or if
2993 * images have been deleted from the WIM. Use the flag
2994 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2995 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2996 * images have been deleted from the WIM.
2998 * In the temporary-file overwrite mode, no changes are made to the WIM on
2999 * failure, and the temporary file is deleted if possible. Abnormal termination
3000 * of the program will result in the temporary file being orphaned. In the
3001 * direct append mode, the WIM is truncated to the original length on failure;
3002 * and while abnormal termination of the program will result in extra data
3003 * appended to the original WIM, it should still be a valid WIM.
3005 * If this function completes successfully, no more functions should be called
3006 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3007 * the WIM file anew.
3010 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3011 * been in-memory changes made to it, which are then reflected in the
3013 * @param write_flags
3014 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3015 * @param num_threads
3016 * Number of threads to use for compression (see wimlib_write()).
3017 * @param progress_func
3018 * If non-NULL, a function that will be called periodically with the
3019 * progress of the current operation.
3021 * @return 0 on success; nonzero on error. This function may return most error
3022 * codes returned by wimlib_write() as well as the following error codes:
3024 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3025 * The WIM was going to be modified in-place (with no temporary file), but
3026 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3027 * because another thread or process has mounted an image from the WIM
3028 * read-write or is currently modifying the WIM in-place.
3029 * @retval ::WIMLIB_ERR_NO_FILENAME
3030 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3031 * than a WIM read with wimlib_open_wim().
3032 * @retval ::WIMLIB_ERR_RENAME
3033 * The temporary file that the WIM was written to could not be renamed to
3034 * the original filename of @p wim.
3035 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3036 * The WIM file is considered read-only because of any of the reasons
3037 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3041 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3042 wimlib_progress_func_t progress_func);
3045 * @ingroup G_wim_information
3047 * Prints information about one image, or all images, contained in a WIM.
3050 * Pointer to the ::WIMStruct for a WIM file.
3052 * The image about which to print information. Can be the number of an
3053 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3056 * @return This function has no return value. No error checking is done when
3057 * printing the information. If @p image is invalid, an error message is
3061 wimlib_print_available_images(const WIMStruct *wim, int image);
3064 * @ingroup G_wim_information
3066 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3067 * in a way that can be accessed programatically.
3070 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3073 * @ingroup G_wim_information
3075 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
3076 * information in a way that can be accessed programatically.
3079 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
3082 * @ingroup G_nonstandalone_wims
3084 * Reference resources from other WIM files or split WIM parts. This function
3085 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3086 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3087 * from other files, before calling a function such as wimlib_extract_image()
3088 * that requires the resources to be present.
3091 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3092 * necessarily "standalone". In the case of split WIMs, this should be the
3093 * first part, since only the first part contains the metadata resources.
3094 * In the case of delta WIMs, this should be the delta WIM rather than the
3095 * WIM on which it is based.
3096 * @param resource_wimfiles_or_globs
3097 * Array of paths to WIM files and/or split WIM parts to reference.
3098 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3099 * ref_flags, these are treated as globs rather than literal paths. That
3100 * is, using this function you can specify zero or more globs, each of
3101 * which expands to one or more literal paths.
3103 * Number of entries in @p resource_wimfiles_or_globs.
3105 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3106 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3108 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3109 * pass to internal calls to wimlib_open_wim() on the reference files.
3110 * @param progress_func
3111 * Passed to internal calls to wimlib_open_wim() on the reference files.
3113 * @return 0 on success; nonzero on error.
3115 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3116 * One of the specified globs did not match any paths (only with both
3117 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3118 * specified in @p ref_flags).
3119 * @retval ::WIMLIB_ERR_NOMEM
3120 * Failed to allocate memory.
3121 * @retval ::WIMLIB_ERR_READ
3122 * I/O or permissions error while processing a file glob.
3124 * This function can additionally return most values that can be returned by
3125 * wimlib_open_wim().
3128 wimlib_reference_resource_files(WIMStruct *wim,
3129 const wimlib_tchar * const *resource_wimfiles_or_globs,
3133 wimlib_progress_func_t progress_func);
3136 * @ingroup G_nonstandalone_wims
3138 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3139 * where the caller must open the ::WIMStruct for each referenced file itself.
3142 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3143 * necessarily "standalone". In the case of split WIMs, this should be the
3144 * first part, since only the first part contains the metadata resources.
3145 * @param resource_wims
3146 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3147 * split WIM parts to reference.
3148 * @param num_resource_wims
3149 * Number of entries in @p resource_wims.
3151 * Currently ignored (set to 0).
3153 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3154 * @p resource_wims are referenced internally by @p wim and must not be freed
3155 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3156 * been freed with wimlib_free(), or immediately before freeing @p wim with
3159 * @retval ::WIMLIB_ERR_INVALID_PARAM
3160 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3161 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3162 * @retval ::WIMLIB_ERR_NOMEM
3163 * Failed to allocate memory.
3166 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3167 unsigned num_resource_wims, int ref_flags);
3170 * @ingroup G_modifying_wims
3172 * Declares that a newly added image is mostly the same as a prior image, but
3173 * captured at a later point in time, possibly with some modifications in the
3174 * intervening time. This is designed to be used in incremental backups of the
3175 * same filesystem or directory tree.
3177 * This function compares the metadata of the directory tree of the newly added
3178 * image against that of the old image. Any files that are present in both the
3179 * newly added image and the old image and have timestamps that indicate they
3180 * haven't been modified are deemed not to have been modified and have their
3181 * SHA1 message digest copied from the old image. Because of this and because
3182 * WIM uses single-instance streams, such files need not be read from the
3183 * filesystem when the WIM is being written or overwritten. Note that these
3184 * unchanged files will still be "archived" and will be logically present in the
3185 * new image; the optimization is that they don't need to actually be read from
3186 * the filesystem because the WIM already contains them.
3188 * This function is provided to optimize incremental backups. The resulting WIM
3189 * file will still be the same regardless of whether this function is called.
3190 * (This is, however, assuming that timestamps have not been manipulated or
3191 * unmaintained as to trick this function into thinking a file has not been
3192 * modified when really it has. To partly guard against such cases, other
3193 * metadata such as file sizes will be checked as well.)
3195 * This function must be called after adding the new image (e.g. with
3196 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3197 * wimlib_overwrite()).
3200 * Pointer to the ::WIMStruct for a WIM.
3202 * 1-based index in the WIM of the newly added image. This image can have
3203 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3204 * wimlib_add_empty_image() followed by wimlib_update_image().
3205 * @param template_wim
3206 * The ::WIMStruct for the WIM containing the template image. This can be
3207 * the same as @p wim, or it can be a different ::WIMStruct.
3208 * @param template_image
3209 * 1-based index in the WIM of a template image that reflects a prior state
3210 * of the directory tree being captured.
3212 * Reserved; must be 0.
3213 * @param progress_func
3214 * Currently ignored, but reserved for a function that will be called with
3215 * information about the operation. Use NULL if no additional information
3218 * @return 0 on success; nonzero on error.
3220 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3221 * @p new_image and/or @p template_image were not a valid image indices in
3223 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3224 * The specified ::WIMStruct did not actually contain the metadata resource
3225 * for the new or template image; for example, it was a non-first part of a
3227 * @retval ::WIMLIB_ERR_NOMEM
3228 * Failed to allocate needed memory.
3229 * @retval ::WIMLIB_ERR_INVALID_PARAM
3230 * @p new_image was equal to @p template_image, or @p new_image specified
3231 * an image that had not been modified since opening the WIM.
3233 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3234 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3235 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3236 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3237 * different reasons) to read the metadata resource for the template image.
3240 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3241 WIMStruct *template_wim, int template_image,
3242 int flags, wimlib_progress_func_t progress_func);
3245 * @ingroup G_wim_information
3247 * Translates a string specifying the name or number of an image in the WIM into
3248 * the number of the image. The images are numbered starting at 1.
3251 * Pointer to the ::WIMStruct for a WIM.
3252 * @param image_name_or_num
3253 * A string specifying the name or number of an image in the WIM. If it
3254 * parses to a positive integer, this integer is taken to specify the
3255 * number of the image, indexed starting at 1. Otherwise, it is taken to
3256 * be the name of an image, as given in the XML data for the WIM file. It
3257 * also may be the keyword "all" or the string "*", both of which will
3258 * resolve to ::WIMLIB_ALL_IMAGES.
3260 * There is no way to search for an image actually named "all", "*", or an
3261 * integer number, or an image that has no name. However, you can use
3262 * wimlib_get_image_name() to get the name of any image.
3265 * If the string resolved to a single existing image, the number of that
3266 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3267 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3268 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3269 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3270 * images in @p wim has no name.
3273 wimlib_resolve_image(WIMStruct *wim,
3274 const wimlib_tchar *image_name_or_num);
3277 * @ingroup G_modifying_wims
3279 * Changes the description of an image in the WIM.
3282 * Pointer to the ::WIMStruct for a WIM.
3284 * The number of the image for which to change the description.
3285 * @param description
3286 * The new description to give the image. It may be @c NULL, which
3287 * indicates that the image is to be given no description.
3289 * @return 0 on success; nonzero on error.
3290 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3291 * @p image does not specify a single existing image in @p wim.
3292 * @retval ::WIMLIB_ERR_NOMEM
3293 * Failed to allocate the memory needed to duplicate the @p description
3295 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3296 * @p wim is considered read-only because of any of the reasons mentioned
3297 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3300 wimlib_set_image_descripton(WIMStruct *wim, int image,
3301 const wimlib_tchar *description);
3304 * @ingroup G_modifying_wims
3306 * Set basic information about a WIM.
3309 * Pointer to the ::WIMStruct for a WIM.
3311 * A struct ::wimlib_wim_info that contains the information to set. Only
3312 * the information explicitly specified in the @p which flags need be
3315 * Flags that specify which information to set. This is a bitwise OR of
3316 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3317 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3319 * @return 0 on success; nonzero on failure.
3320 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3321 * The WIM file is considered read-only because of any of the reasons
3322 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3323 * flag. However, as a special case, if you are using
3324 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3325 * function will not fail due to the readonly flag being previously set.
3326 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3327 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3328 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3332 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3336 * @ingroup G_modifying_wims
3338 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3339 * (something like "Core" or "Ultimate")
3342 * Pointer to the ::WIMStruct for a WIM.
3344 * The number of the image for which to change the description.
3346 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3347 * indicates that the image is to be given no \<FLAGS\> element.
3349 * @return 0 on success; nonzero on error.
3350 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3351 * @p image does not specify a single existing image in @p wim.
3352 * @retval ::WIMLIB_ERR_NOMEM
3353 * Failed to allocate the memory needed to duplicate the @p flags string.
3354 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3355 * @p wim is considered read-only because of any of the reasons mentioned
3356 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3359 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3362 * @ingroup G_modifying_wims
3364 * Changes the name of an image in the WIM.
3367 * Pointer to the ::WIMStruct for a WIM.
3369 * The number of the image for which to change the name.
3371 * New name to give the new image. If @c NULL or empty, the new image is
3372 * given no name. If nonempty, it must specify a name that does not
3373 * already exist in @p wim.
3375 * @return 0 on success; nonzero on error.
3376 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3377 * There is already an image named @p name in @p wim.
3378 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3379 * @p image does not specify a single existing image in @p wim.
3380 * @retval ::WIMLIB_ERR_NOMEM
3381 * Failed to allocate the memory needed to duplicate the @p name string.
3382 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3383 * @p wim is considered read-only because of any of the reasons mentioned
3384 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3387 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3390 * @ingroup G_general
3392 * Set the functions that wimlib uses to allocate and free memory.
3394 * These settings are global and not per-WIM.
3396 * The default is to use the default @c malloc() and @c free() from the C
3399 * Please note that some external functions, such as those in @c libntfs-3g, may
3400 * use the standard memory allocation functions.
3402 * @param malloc_func
3403 * A function equivalent to @c malloc() that wimlib will use to allocate
3404 * memory. If @c NULL, the allocator function is set back to the default
3405 * @c malloc() from the C library.
3407 * A function equivalent to @c free() that wimlib will use to free memory.
3408 * If @c NULL, the free function is set back to the default @c free() from
3410 * @param realloc_func
3411 * A function equivalent to @c realloc() that wimlib will use to reallocate
3412 * memory. If @c NULL, the free function is set back to the default @c
3413 * realloc() from the C library.
3414 * @return 0 on success; nonzero on error.
3415 * @retval ::WIMLIB_ERR_UNSUPPORTED
3416 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
3417 * so custom memory allocators are unsupported.
3420 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3421 void (*free_func)(void *),
3422 void *(*realloc_func)(void *, size_t));
3425 * @ingroup G_general
3427 * Sets whether wimlib is to print error messages to @c stderr when a function
3428 * fails. These error messages may provide information that cannot be
3429 * determined only from the error code that is returned. Not every error will
3430 * result in an error message being printed.
3432 * This setting is global and not per-WIM.
3434 * By default, error messages are not printed.
3436 * This can be called before wimlib_global_init().
3438 * @param show_messages
3439 * @c true if error messages are to be printed; @c false if error messages
3440 * are not to be printed.
3442 * @return 0 on success; nonzero on error.
3443 * @retval ::WIMLIB_ERR_UNSUPPORTED
3444 * @p show_messages was @c true, but wimlib was compiled with the @c
3445 * --without-error-messages option. Therefore, error messages cannot be
3449 wimlib_set_print_errors(bool show_messages);
3452 * @ingroup G_nonstandalone_wims
3454 * Splits a WIM into multiple parts.
3457 * The ::WIMStruct for the WIM to split.
3459 * Name of the SWM file to create. This will be the name of the first
3460 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3461 * appended before the suffix.
3463 * The maximum size per part, in bytes. Unfortunately, it is not
3464 * guaranteed that this will really be the maximum size per part, because
3465 * some file resources in the WIM may be larger than this size, and the WIM
3466 * file format provides no way to split up file resources among multiple
3468 * @param write_flags
3469 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3470 * flags will be used to write each split WIM part. Specify 0 here to get
3471 * the default behavior.
3472 * @param progress_func
3473 * If non-NULL, a function that will be called periodically with the
3474 * progress of the current operation
3475 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3476 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3478 * @return 0 on success; nonzero on error. This function may return most error
3479 * codes that can be returned by wimlib_write() as well as the following error
3482 * @retval ::WIMLIB_ERR_INVALID_PARAM
3483 * @p swm_name was not a nonempty string, or @p part_size was 0.
3485 * Note: the WIM's uncompressed and compressed resources are not checksummed
3486 * when they are copied from the joined WIM to the split WIM parts, nor are
3487 * compressed resources re-compressed (unless explicitly requested with
3488 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3491 wimlib_split(WIMStruct *wim,
3492 const wimlib_tchar *swm_name,
3495 wimlib_progress_func_t progress_func);
3498 * @ingroup G_mounting_wim_images
3500 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3502 * The image to unmount is specified by the path to the mountpoint, not the
3503 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3504 * touched and also may have been allocated in a different process.
3506 * To unmount the image, the process calling this function communicates with the
3507 * process that is managing the mounted WIM image. This function blocks until it
3508 * is known whether the unmount succeeded or failed. In the case of a
3509 * read-write mounted WIM, the unmount is not considered to have succeeded until
3510 * all changes have been saved to the underlying WIM file.
3513 * The directory that the WIM image was mounted on.
3514 * @param unmount_flags
3515 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3516 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3517 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3519 * @param progress_func
3520 * If non-NULL, a function that will be called periodically with the
3521 * progress of the current operation. Currently, only
3522 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3524 * @return 0 on success; nonzero on error.
3526 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3527 * The filesystem daemon was unable to remove the staging directory and the
3528 * temporary files that it contains.
3529 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3530 * The filesystem daemon appears to have terminated before sending an exit
3532 * @retval ::WIMLIB_ERR_FORK
3533 * Could not @c fork() the process.
3534 * @retval ::WIMLIB_ERR_FUSERMOUNT
3535 * The @b fusermount program could not be executed or exited with a failure
3537 * @retval ::WIMLIB_ERR_MQUEUE
3538 * Could not open a POSIX message queue to communicate with the filesystem
3539 * daemon servicing the mounted filesystem, could not send a message
3540 * through the queue, or could not receive a message through the queue.
3541 * @retval ::WIMLIB_ERR_NOMEM
3542 * Failed to allocate needed memory.
3543 * @retval ::WIMLIB_ERR_OPEN
3544 * The filesystem daemon could not open a temporary file for writing the
3546 * @retval ::WIMLIB_ERR_READ
3547 * A read error occurred when the filesystem daemon tried to a file from
3548 * the staging directory
3549 * @retval ::WIMLIB_ERR_RENAME
3550 * The filesystem daemon failed to rename the newly written WIM file to the
3551 * original WIM file.
3552 * @retval ::WIMLIB_ERR_UNSUPPORTED
3553 * Mounting is not supported, either because the platform is Windows, or
3554 * because the platform is UNIX-like and wimlib was compiled with @c
3556 * @retval ::WIMLIB_ERR_WRITE
3557 * A write error occurred when the filesystem daemon was writing to the new
3558 * WIM file, or the filesystem daemon was unable to flush changes that had
3559 * been made to files in the staging directory.
3562 wimlib_unmount_image(const wimlib_tchar *dir,
3564 wimlib_progress_func_t progress_func);
3567 * @ingroup G_modifying_wims
3569 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3572 * Pointer to the ::WIMStruct for the WIM file to update.
3574 * The 1-based index of the image in the WIM to update. It cannot be
3575 * ::WIMLIB_ALL_IMAGES.
3577 * An array of ::wimlib_update_command's that specify the update operations
3580 * Number of commands in @p cmds.
3581 * @param update_flags
3582 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3583 * @param progress_func
3584 * If non-NULL, a function that will be called periodically with the
3585 * progress of the current operation.
3587 * @return 0 on success; nonzero on error. On failure, some but not all of the
3588 * update commands may have been executed. No individual update command will
3589 * have been partially executed. Possible error codes include:
3591 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3592 * The capture configuration structure specified for an add command was
3594 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3595 * @p image did not specify a single, existing image in @p wim.
3596 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3597 * Attempted to perform an add command that conflicted with previously
3598 * existing files in the WIM when an overlay was attempted.
3599 * @retval ::WIMLIB_ERR_INVALID_PARAM
3600 * An unknown operation type was specified in the update commands; or,
3601 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3602 * in the @p add_flags, but the same image had previously already been
3603 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3604 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3605 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3606 * specified in the @p add_flags for an add command in which @p
3607 * wim_target_path was not the root directory of the WIM image.
3608 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3609 * (Windows only): While executing an add command, tried to capture a
3610 * reparse point with invalid data.
3611 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3612 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3613 * for a WIM path that corresponded to a directory; or, a rename command
3614 * attempted to rename a directory to a non-directory.
3615 * @retval ::WIMLIB_ERR_NOMEM
3616 * Failed to allocate needed memory.
3617 * @retval ::WIMLIB_ERR_NOTDIR
3618 * A rename command attempted to rename a directory to a non-directory; or,
3619 * an add command was executed that attempted to set the root of the WIM
3620 * image as a non-directory; or, a path component used as a directory in a
3621 * rename command was not, in fact, a directory.
3622 * @retval ::WIMLIB_ERR_NOTEMPTY
3623 * A rename command attempted to rename a directory to a non-empty
3625 * @retval ::WIMLIB_ERR_NTFS_3G
3626 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3627 * error occurred while reading data from the NTFS volume using libntfs-3g.
3628 * @retval ::WIMLIB_ERR_OPEN
3629 * Failed to open a file to be captured while executing an add command.
3630 * @retval ::WIMLIB_ERR_OPENDIR
3631 * Failed to open a directory to be captured while executing an add command.
3632 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3633 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3634 * WIM path that did not exist; or, a rename command attempted to rename a
3635 * file that does not exist.
3636 * @retval ::WIMLIB_ERR_READ
3637 * While executing an add command, failed to read data from a file or
3638 * directory to be captured.
3639 * @retval ::WIMLIB_ERR_READLINK
3640 * While executing an add command, failed to read the target of a symbolic
3641 * link or junction point.
3642 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3643 * (Windows only) Failed to perform a reparse point fixup because of
3644 * problems with the data of a reparse point.
3645 * @retval ::WIMLIB_ERR_STAT
3646 * While executing an add command, failed to get attributes for a file or
3648 * @retval ::WIMLIB_ERR_UNSUPPORTED
3649 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3650 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3651 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3652 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3653 * add_flags for an update command.
3654 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3655 * While executing an add command, attempted to capture a file that was not
3656 * a supported file type (e.g. a device file). Only if
3657 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3658 * for an update command.
3659 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3660 * The WIM file is considered read-only because of any of the reasons
3661 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3664 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3665 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3666 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3667 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3668 * different reasons) to read the metadata resource for an image that needed to
3672 wimlib_update_image(WIMStruct *wim,
3674 const struct wimlib_update_command *cmds,
3677 wimlib_progress_func_t progress_func);
3680 * @ingroup G_writing_and_overwriting_wims
3682 * Writes a WIM to a file.
3684 * This brings in resources from any external locations, such as directory trees
3685 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3686 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3688 * By default, the new WIM file is written as stand-alone. Using the
3689 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3690 * instead. However, this function cannot directly write a "split" WIM; use
3691 * wimlib_split() for that.
3694 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3695 * changes made to it, which are then reflected in the output file.
3697 * The path to the file to write the WIM to.
3699 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3700 * images are to be included in the new on-disk WIM file. If for some
3701 * reason you only want to include a single image, specify the index of
3702 * that image instead.
3703 * @param write_flags
3704 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3705 * @param num_threads
3706 * Number of threads to use for compressing data. If 0, the number of
3707 * threads is taken to be the number of online processors. Note: if no
3708 * data compression needs to be done, no additional threads will be created
3709 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3710 * exporting an image from a compressed WIM to another WIM of the same
3711 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3713 * @param progress_func
3714 * If non-NULL, a function that will be called periodically with the
3715 * progress of the current operation. The possible messages are
3716 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3717 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3718 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3720 * @return 0 on success; nonzero on error.
3722 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3723 * @p image does not specify a single existing image in @p wim, and is not
3724 * ::WIMLIB_ALL_IMAGES.
3725 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3726 * A file that had previously been scanned for inclusion in the WIM by
3727 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3728 * message digest check.
3729 * @retval ::WIMLIB_ERR_INVALID_PARAM
3730 * @p path was @c NULL.
3731 * @retval ::WIMLIB_ERR_NOMEM
3732 * Failed to allocate needed memory.
3733 * @retval ::WIMLIB_ERR_OPEN
3734 * Failed to open @p path for writing, or some file resources in @p wim
3735 * refer to files in the outside filesystem, and one of these files could
3736 * not be opened for reading.
3737 * @retval ::WIMLIB_ERR_READ
3738 * An error occurred when trying to read data from the WIM file associated
3739 * with @p wim, or some file resources in @p wim refer to files in the
3740 * outside filesystem, and a read error occurred when reading one of these
3742 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3743 * A stream that needed to be written could not be found in the stream
3744 * lookup table of @p wim. This error can occur if, for example, @p wim is
3745 * part of a split WIM but needed resources from the other split WIM parts
3746 * were not referenced with wimlib_reference_resources() or
3747 * wimlib_reference_resource_files() before the call to wimlib_write().
3748 * @retval ::WIMLIB_ERR_WRITE
3749 * An error occurred when trying to write data to the new WIM file.
3751 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3752 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3753 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3754 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3755 * different reasons) to read the metadata resource for an image that needed to
3759 wimlib_write(WIMStruct *wim,
3760 const wimlib_tchar *path,
3763 unsigned num_threads,
3764 wimlib_progress_func_t progress_func);
3767 * @ingroup G_writing_and_overwriting_wims
3769 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3770 * file descriptor, which need not be seekable if the write is done in a special
3771 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3772 * write_flags. This can, for example, allow capturing a WIM image and
3773 * streaming it over the network. See the documentation for
3774 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3776 * The file descriptor @p fd will @b not be closed when the write is complete;
3777 * the calling code is responsible for this.
3779 * Returns 0 on success; nonzero on failure. The possible error codes include
3780 * those that can be returned by wimlib_write() as well as the following:
3782 * @retval ::WIMLIB_ERR_INVALID_PARAM
3783 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3784 * specified in @p write_flags.
3787 wimlib_write_to_fd(WIMStruct *wim,
3791 unsigned num_threads,
3792 wimlib_progress_func_t progress_func);
3795 * @ingroup G_compression
3797 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
3798 * the data using "XPRESS" compression.
3801 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3804 * @ingroup G_compression
3806 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
3807 * the data is compressed using "XPRESS" compression.
3810 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3811 void *uncompressed_data, unsigned uncompressed_len);
3817 #endif /* _WIMLIB_H */