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.3, a C
37 * library for creating, modifying, extracting, and mounting files in the
38 * Windows Imaging Format. This documentation is intended for developers only.
39 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
40 * program, please see the README file or manual pages.
42 * @section sec_installing_and_compiling Installing and Compiling
44 * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
45 * install with <code>configure && make && sudo make install</code>; however,
46 * please see the README for more information about installing it.
48 * To use wimlib in your program after installing it, include wimlib.h and link
49 * your program with @c -lwim.
51 * As of wimlib 1.5.0, wimlib.h is also compatible with C++.
53 * Note: before calling any other function declared in wimlib.h,
54 * wimlib_global_init() can (and in some cases, must) be called. See its
55 * documentation for more details.
57 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
59 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
60 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
61 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
62 * which creates a new ::WIMStruct that initially contains no images and does
63 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
66 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
67 * Images can be extracted (or "applied") using wimlib_extract_image(), added
68 * (or "captured" or "appended") using wimlib_add_image(), deleted using
69 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
70 * modified using wimlib_update_image(). However, changes made to a WIM
71 * represented by a ::WIMStruct have no persistent effect until the WIM is
72 * actually written to an on-disk file. This can be done using wimlib_write(),
73 * but if the WIM was originally opened using wimlib_open_wim(), then
74 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
75 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
77 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
78 * files is a multi-step process. For example, to add, or "append" an image to
79 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
80 * append</b>, you must call the following functions:
82 * 1. wimlib_open_wim()
83 * 2. wimlib_add_image()
84 * 3. wimlib_overwrite()
86 * This design is very much on purpose as it makes the library more useful in
87 * general by allowing functions to be composed in different ways. For example,
88 * you can make multiple changes to a WIM and commit them all to the underlying
89 * file in only one overwrite operation, which is more efficient.
91 * @section sec_cleaning_up Cleaning up
93 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
94 * all resources associated with it. Also, when you are completely done with
95 * using wimlib in your program, you can call wimlib_global_cleanup() to free
96 * any other resources allocated by the library.
98 * @section sec_error_handling Error Handling
100 * Most functions in wimlib return 0 on success and a positive error code on
101 * failure. Use wimlib_get_error_string() to get a string that describes an
102 * error code. wimlib also can print error messages to standard error itself
103 * when an error happens, and these may be more informative than the error code;
104 * to enable this, call wimlib_set_print_errors(). Please note that this is for
105 * convenience only, and some errors can occur without a message being printed.
106 * Currently, error messages and strings (as well as all documentation, for that
107 * matter) are only available in English.
109 * @section sec_encodings Locales and character encodings
111 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
112 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
115 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
116 * and the encoding is UTF-16LE.
118 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
119 * and the encoding is the locale-dependent multibyte encoding. I recommend you
120 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
121 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
122 * call wimlib_global_init() after having set your desired locale.
124 * @section sec_advanced Additional information and features
127 * @subsection subsec_mounting_wim_images Mounting WIM images
129 * See @ref G_mounting_wim_images.
131 * @subsection subsec_progress_functions Progress Messages
133 * See @ref G_progress.
135 * @subsection subsec_non_standalone_wims Non-standalone WIMs
137 * See @ref G_nonstandalone_wims.
139 * @subsection subsec_pipable_wims Pipable WIMs
141 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
142 * compatible with Microsoft's software. To create a pipable WIM, call
143 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
144 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
145 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
146 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
147 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
148 * s using a seekable file descriptor using the regular function calls (e.g.
149 * wimlib_open_wim(), wimlib_extract_image()).
151 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
152 * capture</b> for more information about pipable WIMs.
154 * @subsection subsec_thread_safety Thread Safety
156 * wimlib is thread-safe, with the following exceptions:
157 * - Different threads cannot operate on the same ::WIMStruct at the same time;
158 * they must use different ::WIMStruct's.
159 * - You must call wimlib_global_init() in one thread before calling any other
161 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
162 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
163 * concurrently in the same process, will daemonize the entire process when it
164 * does so for the first time. This includes changing the working directory
165 * to the root directory.
167 * @subsection subsec_limitations Limitations
169 * This section documents some technical limitations of wimlib not already
170 * documented in the man page for @b wimlib-imagex.
172 * - The old WIM format from Vista pre-releases is not supported.
173 * - 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 3
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,
430 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
434 /** @ingroup G_progress
437 /** Possible values of the first parameter to the user-supplied
438 * ::wimlib_progress_func_t progress function */
439 enum wimlib_progress_msg {
441 /** A WIM image is about to be extracted. @p info will point to
442 * ::wimlib_progress_info.extract. */
443 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
445 /** A file or directory tree within a WIM image (not the full image) is
446 * about to be extracted. @p info will point to
447 * ::wimlib_progress_info.extract. */
448 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
450 /** The directory structure of the WIM image is about to be extracted.
451 * @p info will point to ::wimlib_progress_info.extract. */
452 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
454 /** The directory structure of the WIM image has been successfully
455 * extracted. @p info will point to ::wimlib_progress_info.extract. */
456 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
458 /** The WIM image's files resources are currently being extracted. @p
459 * info will point to ::wimlib_progress_info.extract. */
460 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
462 /** Starting to read a new part of a split pipable WIM over the pipe.
463 * @p info will point to ::wimlib_progress_info.extract. */
464 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
466 /** All the WIM files and directories have been extracted, and
467 * timestamps are about to be applied. @p info will point to
468 * ::wimlib_progress_info.extract. */
469 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
471 /** A WIM image has been successfully extracted. @p info will point to
472 * ::wimlib_progress_info.extract. */
473 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
475 /** A file or directory tree within a WIM image (not the full image) has
476 * been successfully extracted. @p info will point to
477 * ::wimlib_progress_info.extract. */
478 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
480 /** The directory or NTFS volume is about to be scanned to build a tree
481 * of WIM dentries in-memory. @p info will point to
482 * ::wimlib_progress_info.scan. */
483 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
485 /** A directory or file is being scanned. @p info will point to
486 * ::wimlib_progress_info.scan, and its @p cur_path member will be
487 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
488 * is passed to wimlib_add_image(). */
489 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
491 /** The directory or NTFS volume has been successfully scanned, and a
492 * tree of WIM dentries has been built in-memory. @p info will point to
493 * ::wimlib_progress_info.scan. */
494 WIMLIB_PROGRESS_MSG_SCAN_END,
497 * File resources are currently being written to the WIM.
498 * @p info will point to ::wimlib_progress_info.write_streams. */
499 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
502 * The metadata resource for each image is about to be written to the
503 * WIM. @p info will not be valid. */
504 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
507 * The metadata resource for each image has successfully been writen to
508 * the WIM. @p info will not be valid. */
509 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
512 * The temporary file has successfully been renamed to the original WIM
513 * file. Only happens when wimlib_overwrite() is called and the
514 * overwrite is not done in-place.
515 * @p info will point to ::wimlib_progress_info.rename. */
516 WIMLIB_PROGRESS_MSG_RENAME,
518 /** The contents of the WIM are being checked against the integrity
519 * table. Only happens when wimlib_open_wim() is called with the
520 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @p info will point to
521 * ::wimlib_progress_info.integrity. */
522 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
524 /** An integrity table is being calculated for the WIM being written.
525 * Only happens when wimlib_write() or wimlib_overwrite() is called with
526 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @p info will point to
527 * ::wimlib_progress_info.integrity. */
528 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
530 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
531 * but in wimlib v1.5.0 this was removed to simplify the code and now
532 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
533 WIMLIB_PROGRESS_MSG_RESERVED,
535 /** A wimlib_split() operation is in progress, and a new split part is
536 * about to be started. @p info will point to
537 * ::wimlib_progress_info.split. */
538 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
540 /** A wimlib_split() operation is in progress, and a split part has been
541 * finished. @p info will point to ::wimlib_progress_info.split. */
542 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
545 * A WIM update command is just about to be executed; @p info will point
546 * to ::wimlib_progress_info.update.
548 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
551 * A WIM update command has just been executed; @p info will point to
552 * ::wimlib_progress_info.update.
554 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
558 /** A pointer to this union is passed to the user-supplied
559 * ::wimlib_progress_func_t progress function. One (or none) of the structures
560 * contained in this union will be applicable for the operation
561 * (::wimlib_progress_msg) indicated in the first argument to the progress
563 union wimlib_progress_info {
565 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
566 * document them if they aren't given a name... */
568 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
569 struct wimlib_progress_info_write_streams {
570 /** Number of bytes that are going to be written for all the
571 * streams combined. This is the amount in uncompressed data.
572 * (The actual number of bytes will be less if the data is being
573 * written compressed.) */
574 uint64_t total_bytes;
576 /** Number of streams that are going to be written. */
577 uint64_t total_streams;
579 /** Number of uncompressed bytes that have been written so far.
580 * Will be 0 initially, and equal to @p total_bytes at the end.
582 uint64_t completed_bytes;
584 /** Number of streams that have been written. Will be 0
585 * initially, and equal to @p total_streams at the end. */
586 uint64_t completed_streams;
588 /** Number of threads that are being used to compress resources
589 * (if applicable). */
590 unsigned num_threads;
592 /** The compression type being used to write the streams; either
593 * ::WIMLIB_COMPRESSION_TYPE_NONE,
594 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
595 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
596 int compression_type;
598 /** Number of split WIM parts from which streams are being
599 * written (may be 0 if irrelevant). */
600 unsigned total_parts;
602 /** Number of split WIM parts from which streams have been
603 * written (may be 0 if irrelevant). */
604 unsigned completed_parts;
607 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
608 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
609 struct wimlib_progress_info_scan {
610 /** Directory or NTFS volume that is being scanned. */
611 const wimlib_tchar *source;
613 /** Path to the file or directory that is about to be scanned,
614 * relative to the root of the image capture or the NTFS volume.
616 const wimlib_tchar *cur_path;
619 /** File or directory looks okay and will be captured. */
620 WIMLIB_SCAN_DENTRY_OK = 0,
622 /** File or directory is being excluded from capture due
623 * to the capture configuration file. */
624 WIMLIB_SCAN_DENTRY_EXCLUDED,
626 /** File or directory is being excluded from capture due
627 * to being unsupported (e.g. an encrypted or device
629 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
632 /** Target path in the WIM. Only valid on messages
633 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
634 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
635 const wimlib_tchar *wim_target_path;
638 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
639 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
640 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
641 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
642 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
643 struct wimlib_progress_info_extract {
644 /** Number of the image being extracted (1-based). */
647 /** Flags passed to to wimlib_extract_image() */
650 /** Full path to the WIM file being extracted. */
651 const wimlib_tchar *wimfile_name;
653 /** Name of the image being extracted. */
654 const wimlib_tchar *image_name;
656 /** Directory or NTFS volume to which the image is being
658 const wimlib_tchar *target;
661 const wimlib_tchar *cur_path;
663 /** Number of bytes of uncompressed data that will be extracted.
664 * Takes into account hard links (they are not counted for each
666 uint64_t total_bytes;
668 /** Number of bytes that have been written so far. Will be 0
669 * initially, and equal to @p total_bytes at the end. */
670 uint64_t completed_bytes;
672 /** Number of streams that will be extracted. This may more or
673 * less than the number of "files" to be extracted due to
674 * special cases (hard links, symbolic links, and alternate data
676 uint64_t num_streams;
678 /** Path to the root dentry within the WIM for the tree that is
679 * being extracted. Will be the empty string when extracting a
681 const wimlib_tchar *extract_root_wim_source_path;
683 /** Currently only used for
684 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
686 unsigned part_number;
688 /** Currently only used for
689 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
690 unsigned total_parts;
692 /** Currently only used for
693 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
694 uint8_t guid[WIMLIB_GUID_LEN];
697 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
698 struct wimlib_progress_info_rename {
699 /** Name of the temporary file that the WIM was written to. */
700 const wimlib_tchar *from;
702 /** Name of the original WIM file to which the temporary file is
704 const wimlib_tchar *to;
707 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
708 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
709 struct wimlib_progress_info_update {
710 /** Pointer to the update command that will be executed or has
711 * just been executed. */
712 const struct wimlib_update_command *command;
714 /** Number of update commands that have been completed so far.
716 size_t completed_commands;
718 /** Number of update commands that are being executed as part of
719 * this call to wimlib_update_image(). */
720 size_t total_commands;
723 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
724 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
725 struct wimlib_progress_info_integrity {
726 /** Number of bytes from the end of the WIM header to the end of
727 * the lookup table (the area that is covered by the SHA1
728 * integrity checks.) */
729 uint64_t total_bytes;
731 /** Number of bytes that have been SHA1-summed so far. Will be
732 * 0 initially, and equal @p total_bytes at the end. */
733 uint64_t completed_bytes;
735 /** Number of chunks that the checksummed region is divided
737 uint32_t total_chunks;
739 /** Number of chunks that have been SHA1-summed so far. Will
740 * be 0 initially, and equal to @p total_chunks at the end. */
741 uint32_t completed_chunks;
743 /** Size of the chunks used for the integrity calculation. */
746 /** Filename of the WIM (only valid if the message is
747 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
748 const wimlib_tchar *filename;
751 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
752 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
753 struct wimlib_progress_info_split {
754 /** Total size of the original WIM's file and metadata resources
756 uint64_t total_bytes;
758 /** Number of bytes of file and metadata resources that have
759 * been copied out of the original WIM so far. Will be 0
760 * initially, and equal to @p total_bytes at the end. */
761 uint64_t completed_bytes;
763 /** Number of the split WIM part that is about to be started
764 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
765 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
766 unsigned cur_part_number;
768 /** Total number of split WIM parts that are being written. */
769 unsigned total_parts;
771 /** Name of the split WIM part that is about to be started
772 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
773 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
774 const wimlib_tchar *part_name;
778 /** A user-supplied function that will be called periodically during certain WIM
779 * operations. The first argument will be the type of operation that is being
780 * performed or is about to be started or has been completed. The second
781 * argument will be a pointer to one of a number of structures depending on the
782 * first argument. It may be @c NULL for some message types.
784 * The return value of the progress function is currently ignored, but it may do
785 * something in the future. (Set it to 0 for now.)
787 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
788 const union wimlib_progress_info *info);
791 /** @ingroup G_modifying_wims
794 /** An array of these structures is passed to wimlib_add_image_multisource() to
795 * specify the sources from which to create a WIM image. */
796 struct wimlib_capture_source {
797 /** Absolute or relative path to a file or directory on the external
798 * filesystem to be included in the WIM image. */
799 wimlib_tchar *fs_source_path;
801 /** Destination path in the WIM image. Leading and trailing slashes are
802 * ignored. The empty string or @c NULL means the root directory of the
804 wimlib_tchar *wim_target_path;
806 /** Reserved; set to 0. */
810 /** Structure that specifies a list of path patterns. */
811 struct wimlib_pattern_list {
812 /** Array of patterns. The patterns may be modified by library code,
813 * but the @p pats pointer itself will not. See the man page for
814 * <b>wimlib-imagex capture</b> for more information about allowed
818 /** Number of patterns in the @p pats array. */
821 /** Ignored; may be used by the calling code. */
822 size_t num_allocated_pats;
825 /** A structure that contains lists of wildcards that match paths to treat
826 * specially when capturing a WIM image. */
827 struct wimlib_capture_config {
828 /** Paths matching any pattern this list are excluded from being
829 * captured, except if the same path appears in @p
830 * exclusion_exception_pats. */
831 struct wimlib_pattern_list exclusion_pats;
833 /** Paths matching any pattern in this list are never excluded from
835 struct wimlib_pattern_list exclusion_exception_pats;
837 /** Reserved for future capture configuration options. */
838 struct wimlib_pattern_list reserved1;
840 /** Reserved for future capture configuration options. */
841 struct wimlib_pattern_list reserved2;
843 /** Library internal use only. */
844 wimlib_tchar *_prefix;
846 /** Library internal use only. */
847 size_t _prefix_num_tchars;
850 /** Set or unset the WIM header flag that marks it read-only
851 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
852 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
853 * is distinct from basic file permissions; this flag can be set on a WIM file
854 * that is physically writable. If this flag is set, all further operations to
855 * modify the WIM will fail, except calling wimlib_overwrite() with
856 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
857 * allows you to set this flag persistently on the underlying WIM file.
859 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
861 /** Set the GUID (globally unique identifier) of the WIM file to the value
862 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
863 #define WIMLIB_CHANGE_GUID 0x00000002
865 /** Change the bootable image of the WIM to the value specified in
866 * ::wimlib_wim_info.boot_index of the @p info parameter. */
867 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
869 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
870 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
871 * indicates whether an image in the WIM has been captured with reparse-point
872 * fixups enabled. wimlib also treats this flag as specifying whether to do
873 * reparse-point fixups by default when capturing or applying WIM images. */
874 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
877 /** @ingroup G_wim_information
880 /** General information about a WIM file. */
881 struct wimlib_wim_info {
883 /** Globally unique identifier for the WIM file. Note: all parts of a
884 * split WIM should have an identical value in this field. */
885 uint8_t guid[WIMLIB_GUID_LEN];
887 /** Number of images in the WIM. */
888 uint32_t image_count;
890 /** 1-based index of the bootable image in the WIM, or 0 if no image is
894 /** Version of the WIM file. */
895 uint32_t wim_version;
897 /** Chunk size used for compression. */
900 /** For split WIMs, the 1-based index of this part within the split WIM;
902 uint16_t part_number;
904 /** For split WIMs, the total number of parts in the split WIM;
906 uint16_t total_parts;
908 /** One of the ::wimlib_compression_type values that specifies the
909 * method used to compress resources in the WIM. */
910 int32_t compression_type;
912 /** Size of the WIM file in bytes, excluding the XML data and integrity
914 uint64_t total_bytes;
916 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
917 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
918 * this will always be 0, even if the ::WIMStruct was written to
919 * somewhere by calling wimlib_write() with the
920 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
921 uint32_t has_integrity_table : 1;
923 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
924 * wimlib_create_new_wim(). */
925 uint32_t opened_from_file : 1;
927 /** 1 if the WIM is considered readonly for any reason. */
928 uint32_t is_readonly : 1;
930 /** 1 if reparse-point fixups are supposedly enabled for one or more
931 * images in the WIM. */
932 uint32_t has_rpfix : 1;
934 /** 1 if the WIM is marked as read-only. */
935 uint32_t is_marked_readonly : 1;
937 /** 1 if the WIM is part of a spanned set. */
938 uint32_t spanned : 1;
940 uint32_t write_in_progress : 1;
941 uint32_t metadata_only : 1;
942 uint32_t resource_only : 1;
944 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
945 uint32_t pipable : 1;
946 uint32_t reserved_flags : 22;
947 uint32_t reserved[9];
950 /** Information about a unique resource in the WIM file.
952 struct wimlib_resource_entry {
953 /** Uncompressed size of the resource in bytes. */
954 uint64_t uncompressed_size;
956 /** Compressed size of the resource in bytes. This will be the same as
957 * @p uncompressed_size if the resource is uncompressed. */
958 uint64_t compressed_size;
960 /** Offset, in bytes, of this resource from the start of the WIM file.
964 /** SHA1 message digest of the resource's uncompressed contents. */
965 uint8_t sha1_hash[20];
967 /** Which part number of the split WIM this resource is in. This should
968 * be the same as the part number provided by wimlib_get_wim_info(). */
969 uint32_t part_number;
971 /** Number of times this resource is referenced over all WIM images. */
972 uint32_t reference_count;
974 /** 1 if this resource is compressed. */
975 uint32_t is_compressed : 1;
977 /** 1 if this resource is a metadata resource rather than a file
979 uint32_t is_metadata : 1;
981 uint32_t is_free : 1;
982 uint32_t is_spanned : 1;
984 /** 1 if this resource was not found in the lookup table of the
985 * ::WIMStruct. This normally implies a missing call to
986 * wimlib_reference_resource_files() or wimlib_reference_resources().
988 uint32_t is_missing : 1;
990 uint32_t is_partial : 1;
992 uint32_t reserved_flags : 26;
994 uint64_t raw_resource_offset_in_wim;
995 uint64_t raw_resource_uncompressed_size;
996 uint64_t raw_resource_compressed_size;
998 uint64_t reserved[1];
1001 /** A stream of a file in the WIM. */
1002 struct wimlib_stream_entry {
1003 /** Name of the stream, or NULL if the stream is unnamed. */
1004 const wimlib_tchar *stream_name;
1005 /** Location, size, etc. of the stream within the WIM file. */
1006 struct wimlib_resource_entry resource;
1007 uint64_t reserved[4];
1010 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1011 * Roughly, the information about a "file" in the WIM--- but really a directory
1012 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1013 * field can be used to distinguish actual file inodes. */
1014 struct wimlib_dir_entry {
1015 /** Name of the file, or NULL if this file is unnamed (only possible for
1016 * the root directory) */
1017 const wimlib_tchar *filename;
1019 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1021 const wimlib_tchar *dos_name;
1023 /** Full path to this file within the WIM image. */
1024 const wimlib_tchar *full_path;
1026 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1027 * children, ..., etc. */
1030 /** Pointer to the security descriptor for this file, in Windows
1031 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1032 * security descriptor. */
1033 const char *security_descriptor;
1035 /** Length of the above security descriptor. */
1036 size_t security_descriptor_size;
1038 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1039 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1040 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1041 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1042 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1043 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1044 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1045 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1046 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1047 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1048 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1049 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1050 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1051 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1052 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1053 /** File attributes, such as whether the file is a directory or not.
1054 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1055 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1056 * on other platforms. */
1057 uint32_t attributes;
1059 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1060 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1061 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1062 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1063 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1064 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1065 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1066 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1067 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1068 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1069 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1070 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1071 * attributes), this will give the reparse tag. This tells you whether
1072 * the reparse point is a symbolic link, junction point, or some other,
1073 * more unusual kind of reparse point. */
1074 uint32_t reparse_tag;
1076 /* Number of (hard) links to this file. */
1079 /** Number of named data streams that this file has. Normally 0. */
1080 uint32_t num_named_streams;
1082 /** Roughly, the inode number of this file. However, it may be 0 if
1083 * @p num_links == 1. */
1084 uint64_t hard_link_group_id;
1086 /** Time this file was created. */
1087 struct timespec creation_time;
1089 /** Time this file was last written to. */
1090 struct timespec last_write_time;
1092 /** Time this file was last accessed. */
1093 struct timespec last_access_time;
1094 uint64_t reserved[16];
1096 /** Array of streams that make up this file. The first entry will
1097 * always exist and will correspond to the unnamed data stream (default
1098 * file contents), so it will have @p stream_name == @c NULL. There
1099 * will then be @p num_named_streams additional entries that specify the
1100 * named data streams, if any, each of which will have @p stream_name !=
1102 struct wimlib_stream_entry streams[];
1106 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1109 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1113 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1116 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1119 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1120 * just on the specified path. */
1121 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1123 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1124 * itself; only its children (in the case of a non-empty directory) */
1125 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1127 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1128 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1129 * table of the ::WIMStruct. The default behavior without this flag is to fill
1130 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1131 * wimlib_resource_entry::is_missing "is_missing" flag. */
1132 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1136 /** @ingroup G_modifying_wims
1139 /** Directly capture a NTFS volume rather than a generic directory. This flag
1140 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1141 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1142 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1144 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1145 * with ::WIMLIB_ADD_FLAG_NTFS. */
1146 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1148 /** Call the progress function with the message
1149 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
1150 * be scanned, or when a directory or file is being excluded from capture. */
1151 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1153 /** Mark the image being added as the bootable image of the WIM. */
1154 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1156 /** Store the UNIX owner, group, and mode. This is done by adding a special
1157 * alternate data stream to each regular file, symbolic link, and directory to
1158 * contain this information. Please note that this flag is for convenience
1159 * only; Microsoft's @a imagex.exe will not understand this special information.
1160 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1161 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1163 /** Do not capture security descriptors. Only has an effect in NTFS capture
1164 * mode, or in Win32 native builds. */
1165 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1167 /** Fail immediately if the full security descriptor of any file or directory
1168 * cannot be accessed. Only has an effect in Win32 native builds. The default
1169 * behavior without this flag is to first try omitting the SACL from the
1170 * security descriptor, then to try omitting the security descriptor entirely.
1172 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1174 /** Call the progress function with the message
1175 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1176 * capture. This is a subset of the messages provided by
1177 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1178 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1180 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1181 * in the case of Windows) that point inside the directory being captured to
1182 * instead be absolute relative to the directory being captured, rather than the
1183 * current root; also exclude absolute symbolic links that point outside the
1184 * directory tree being captured.
1186 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1187 * the WIM header or if this is the first image being added.
1188 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1189 * reparse point fixups enabled and currently cannot be unset. */
1190 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1192 /** Don't do reparse point fixups. The default behavior is described in the
1193 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1194 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1196 /** Do not automatically exclude unsupported files or directories from capture;
1197 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1198 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1199 * such a file is encountered. */
1200 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1202 /** Automatically select a capture configuration appropriate for capturing
1203 * filesystems containing Windows operating systems. When this flag is
1204 * specified, the corresponding @p config parameter or member must be @c NULL.
1206 * Currently, selecting this capture configuration will cause the following
1207 * files and directories to be excluded from capture:
1212 * - "\System Volume Information"
1216 * Note that the default behavior--- that is, when this flag is not specified
1217 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1218 * no files are excluded from capture.
1220 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1222 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1223 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1224 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1225 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1226 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1227 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1228 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1229 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1230 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1231 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1232 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1233 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1234 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1237 /** @ingroup G_modifying_wims
1240 /** Do not issue an error if the path to delete does not exist. */
1241 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1243 /** Delete the file or directory tree recursively; if not specified, an error is
1244 * issued if the path to delete is a directory. */
1245 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1248 /** @ingroup G_modifying_wims
1252 * If a single image is being exported, mark it bootable in the destination WIM.
1253 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1254 * the image in the source WIM (if any) that is marked as bootable is also
1255 * marked as bootable in the destination WIM.
1257 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1259 /** Give the exported image(s) no names. Avoids problems with image name
1262 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1264 /** Give the exported image(s) no descriptions. */
1265 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1268 /** @ingroup G_extracting_wims
1271 /** Extract the image directly to a NTFS volume rather than a generic directory.
1272 * This mode is only available if wimlib was compiled with libntfs-3g support;
1273 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1274 * extraction target will be interpreted as the path to a NTFS volume image (as
1275 * a regular file or block device) rather than a directory. It will be opened
1276 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1277 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1278 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1279 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1281 /** When identical files are extracted from the WIM, always hard link them
1283 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1285 /** When identical files are extracted from the WIM, always symlink them
1287 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1289 /** This flag no longer does anything but is reserved for future use. */
1290 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1292 /** Read the WIM file sequentially while extracting the image. */
1293 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1295 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1296 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1298 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1300 /** Do not extract security descriptors. */
1301 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1303 /** Fail immediately if the full security descriptor of any file or directory
1304 * cannot be set exactly as specified in the WIM file. On Windows, the default
1305 * behavior without this flag is to fall back to setting the security descriptor
1306 * with the SACL omitted, then only the default inherited security descriptor,
1307 * if we do not have permission to set the desired one. */
1308 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1310 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1311 * reparse-point fixups on, so absolute symbolic links or junction points will
1312 * be fixed to be absolute relative to the actual extraction root. Reparse
1313 * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1314 * header. This flag may only be specified when extracting a full image (not a
1315 * file or directory tree within one). */
1316 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1318 /** Force reparse-point fixups on extraction off, regardless of the state of the
1319 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1320 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1322 /** Extract the specified file to standard output. This is only valid in an
1323 * extraction command that specifies the extraction of a regular file in the WIM
1325 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1327 /** Instead of ignoring files and directories with names that cannot be
1328 * represented on the current platform (note: Windows has more restrictions on
1329 * filenames than POSIX-compliant systems), try to replace characters or append
1330 * junk to the names so that they can be extracted in some form. */
1331 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1333 /** On Windows, when there exist two or more files with the same case
1334 * insensitive name but different case sensitive names, try to extract them all
1335 * by appending junk to the end of them, rather than arbitrarily extracting only
1337 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1339 /** Do not ignore failure to set timestamps on extracted files. */
1340 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1342 /** Do not ignore failure to set short names on extracted files. */
1343 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1345 /** Do not ignore failure to extract symbolic links (and junction points, on
1346 * Windows) due to permissions problems. By default, such failures are ignored
1347 * since the default configuration of Windows only allows the Administrator to
1348 * create symbolic links. */
1349 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1351 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1352 * behavior is currently less than satisfactory. Do not use (yet). */
1353 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1356 /** @ingroup G_mounting_wim_images
1359 /** Mount the WIM image read-write rather than the default of read-only. */
1360 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1362 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1363 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1365 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1366 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1368 /** Access alternate data streams in the mounted WIM image through extended file
1369 * attributes. This is the default mode. */
1370 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1372 /** Access alternate data streams in the mounted WIM image by specifying the
1373 * file name, a colon, then the alternate file stream name. */
1374 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1376 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1377 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1378 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1380 /** Allow other users to see the mounted filesystem. (this passes the @c
1381 * allow_other option to FUSE mount) */
1382 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1385 /** @ingroup G_creating_and_opening_wims
1388 /** Verify the WIM contents against the WIM's integrity table, if present. This
1389 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1390 * checksummed and checked against the SHA1 message digests specified in the
1391 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1392 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1393 * integrity table is invalid). */
1394 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1396 /** Issue an error if the WIM is part of a split WIM. Software can provide
1397 * this flag for convenience if it explicitly does not want to support split
1399 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1401 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1402 * is not. A WIM is considered writable only if it is writable at the
1403 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1404 * header, and is not part of a spanned set. It is not required to provide this
1405 * flag before attempting to make changes to the WIM, but with this flag you get
1406 * an error sooner rather than later. */
1407 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1410 /** @ingroup G_mounting_wim_images
1413 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1414 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1416 /** Unless this flag is given, changes to a read-write mounted WIM are
1417 * discarded. Ignored for read-only mounts. */
1418 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1420 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1421 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1423 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1424 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1426 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1427 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1430 /** @ingroup G_modifying_wims
1433 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1434 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1435 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1438 /** @ingroup G_writing_and_overwriting_wims
1441 /** Include an integrity table in the WIM.
1443 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1444 * an integrity table if and only if one was present before. For WIMs created
1445 * with wimlib_create_new_wim(), the default behavior is to not include an
1446 * integrity table. */
1447 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1449 /** Do not include an integrity table in the new WIM file. This is the default
1450 * behavior, unless the WIM already included an integrity table. */
1451 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1453 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1454 * images from it can be applied directly from a pipe using
1455 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1456 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1457 * with this flag will not be compatible with Microsoft's software.
1459 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1460 * WIM as pipable if and only if it was pipable before. For WIMs created with
1461 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1463 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1465 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1466 * WIM was pipable already. */
1467 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1469 /** Recompress all resources, even if they could otherwise be copied from a
1470 * different WIM with the same compression type (in the case of
1471 * wimlib_export_image() being called previously). This flag is also valid in
1472 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1473 * in the joined WIM file will be recompressed. */
1474 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1476 /** Call fsync() just before the WIM file is closed. */
1477 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1479 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1480 * data to it if possible. */
1481 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1483 /** wimlib_overwrite() only: Specifying this flag overrides the default
1484 * behavior of wimlib_overwrite() after one or more calls to
1485 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1486 * only minimal changes to correctly remove the image from the WIM will be
1487 * taken. In particular, all streams will be left alone, even if they are no
1488 * longer referenced. This is probably not what you want, because almost no
1489 * space will be saved by deleting an image in this way. */
1490 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1492 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1493 * flag is set in the WIM header. This can be used in combination with
1494 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1495 * set the readonly flag on the on-disk WIM file. */
1496 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1498 /** Do not include non-metadata resources already present in other WIMs. This
1499 * flag can be used to write a "delta" WIM after resources from the WIM on which
1500 * the delta is to be based were referenced with
1501 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1502 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1504 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1505 * are already present (not in external resource WIMs) and their reference
1506 * counts are correct, so the code does not need to recalculate which streams
1507 * are referenced. This is for optimization purposes only, since with this flag
1508 * specified, the metadata resources may not need to be decompressed and parsed.
1510 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1511 * already implied for wimlib_overwrite(). */
1512 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1514 #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
1517 /** @ingroup G_general
1520 /** Assume that strings are represented in UTF-8, even if this is not the
1521 * locale's character encoding. This flag is ignored on Windows, where wimlib
1522 * always uses UTF-16LE. */
1523 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1525 /** Windows-only: do not attempt to acquire additional privileges (currently
1526 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1527 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1528 * for the case where the calling program manages these privileges itself.
1529 * Note: no error is issued if privileges cannot be acquired, although related
1530 * errors may be reported later, depending on if the operations performed
1531 * actually require additional privileges or not. */
1532 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1534 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1535 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1536 * to read all possible data and metadata for a capture operation could not be
1537 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1539 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1541 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1542 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1543 * to restore all possible data and metadata for an apply operation could not be
1544 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1546 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1549 /** @ingroup G_nonstandalone_wims
1552 /** wimlib_reference_resource_files() only: Enable shell-style filename
1554 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1556 /** wimlib_reference_resource_files() only: Issue an error
1557 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1558 * default behavior without this flag is to issue no error at that point, but
1559 * then attempt to open the glob as a literal path, which of course will fail
1560 * anyway if no file exists at that path. No effect if
1561 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. */
1562 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1565 /** @ingroup G_modifying_wims
1568 /** The specific type of update to perform. */
1569 enum wimlib_update_op {
1570 /** Add a new file or directory tree to the WIM image in a
1571 * certain location. */
1572 WIMLIB_UPDATE_OP_ADD = 0,
1574 /** Delete a file or directory tree from the WIM image. */
1575 WIMLIB_UPDATE_OP_DELETE,
1577 /** Rename a file or directory tree in the WIM image. */
1578 WIMLIB_UPDATE_OP_RENAME,
1581 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1582 struct wimlib_add_command {
1583 /** Filesystem path to the file or directory tree to
1585 wimlib_tchar *fs_source_path;
1586 /** Path, specified from the root of the WIM image, at
1587 * which to add the file or directory tree within the
1589 wimlib_tchar *wim_target_path;
1591 /** Configuration for excluded files. @c NULL means
1592 * exclude no files (use no configuration), unless
1593 * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1595 struct wimlib_capture_config *config;
1597 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1601 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1602 struct wimlib_delete_command {
1603 /** Path, specified from the root of the WIM image, for
1604 * the file or directory tree within the WIM image to be
1606 wimlib_tchar *wim_path;
1607 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1611 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1612 struct wimlib_rename_command {
1613 /** Path, specified from the root of the WIM image, for
1614 * the source file or directory tree within the WIM
1616 wimlib_tchar *wim_source_path;
1617 /** Path, specified from the root of the WIM image, for
1618 * the destination file or directory tree within the WIM
1620 wimlib_tchar *wim_target_path;
1621 /** Reserved; set to 0. */
1625 /** Specification of an update to perform on a WIM image. */
1626 struct wimlib_update_command {
1628 enum wimlib_update_op op;
1631 struct wimlib_add_command add;
1632 struct wimlib_delete_command delete_; /* Underscore is for C++
1634 struct wimlib_rename_command rename;
1639 /** @ingroup G_extracting_wims
1642 /** Specification of a file or directory tree to extract from a WIM image. Used
1643 * in calls to wimlib_extract_files(). */
1644 struct wimlib_extract_command {
1645 /** Path to file or directory tree within the WIM image to extract. It
1646 * must be provided as an absolute path from the root of the WIM image.
1647 * The path separators may be either forward slashes or backslashes. */
1648 wimlib_tchar *wim_source_path;
1650 /** Filesystem path to extract the file or directory tree to. */
1651 wimlib_tchar *fs_dest_path;
1653 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1658 /** @ingroup G_compression
1661 /** LZX compression parameters to pass to wimlib_lzx_alloc_context(). */
1662 struct wimlib_lzx_params {
1663 /** Must be set to the size of this structure, in bytes. */
1664 uint32_t size_of_this;
1666 /** Relatively fast LZX compression algorithm with a decent compression
1667 * ratio; the suggested default. */
1668 #define WIMLIB_LZX_ALGORITHM_FAST 0
1670 /** Slower LZX compression algorithm that provides a better compression
1672 #define WIMLIB_LZX_ALGORITHM_SLOW 1
1674 /** Algorithm to use to perform the compression: either
1675 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
1676 * format is still LZX; this refers to the method the code will use to
1677 * perform LZX-compatible compression. */
1678 uint32_t algorithm : 3;
1680 /** If set to 1, the default parameters for the specified algorithm are
1681 * used rather than the ones specified in the following union. */
1682 uint32_t use_defaults : 1;
1685 /** Parameters for the fast algorithm. */
1686 struct wimlib_lzx_fast_params {
1687 uint32_t fast_reserved1[10];
1690 /** Parameters for the slow algorithm. */
1691 struct wimlib_lzx_slow_params {
1692 /** If set to 1, the compressor can output length 2
1693 * matches. If set 0, the compressor only outputs
1694 * matches of length 3 or greater. Suggested value: 1
1696 uint32_t use_len2_matches : 1;
1698 uint32_t slow_reserved1 : 31;
1700 /** Matches with length (in bytes) longer than this
1701 * value are immediately taken without spending time on
1702 * minimum-cost measurements. Suggested value: 32. */
1703 uint32_t num_fast_bytes;
1705 /** Number of passes to compute a match/literal sequence
1706 * for each LZX block. This is for an iterative
1707 * algorithm that attempts to minimize the cost of the
1708 * match/literal sequence by using a cost model provided
1709 * by the previous iteration. Must be at least 1.
1710 * Suggested value: 2. */
1711 uint32_t num_optim_passes;
1713 /** Reserved; set to 0. */
1714 uint32_t slow_reserved_blocksplit;
1716 /** Maximum depth to search for matches at each
1717 * position. Suggested value: 50. */
1718 uint32_t max_search_depth;
1720 /** Maximum number of potentially good matches to
1721 * consider for each position. Suggested value: 3. */
1722 uint32_t max_matches_per_pos;
1724 uint32_t slow_reserved2[2];
1726 /** Assumed cost of a main symbol with zero frequency.
1727 * Must be at least 1 and no more than 16. Suggested
1729 uint8_t main_nostat_cost;
1731 /** Assumed cost of a length symbol with zero frequency.
1732 * Must be at least 1 and no more than 16. Suggested
1734 uint8_t len_nostat_cost;
1736 /** Assumed cost of an aligned symbol with zero
1737 * frequency. Must be at least 1 and no more than 8.
1738 * Suggested value: 7. */
1739 uint8_t aligned_nostat_cost;
1741 uint8_t slow_reserved3[5];
1746 /** Opaque LZX compression context. */
1747 struct wimlib_lzx_context;
1750 /** @ingroup G_general
1754 * Possible values of the error code returned by many functions in wimlib.
1756 * See the documentation for each wimlib function to see specifically what error
1757 * codes can be returned by a given function, and what they mean.
1759 enum wimlib_error_code {
1760 WIMLIB_ERR_SUCCESS = 0,
1761 WIMLIB_ERR_ALREADY_LOCKED,
1762 WIMLIB_ERR_DECOMPRESSION,
1763 WIMLIB_ERR_DELETE_STAGING_DIR,
1764 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1767 WIMLIB_ERR_FUSERMOUNT,
1768 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1769 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1770 WIMLIB_ERR_IMAGE_COUNT,
1771 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1772 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1773 WIMLIB_ERR_INTEGRITY,
1774 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1775 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1776 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1777 WIMLIB_ERR_INVALID_HEADER,
1778 WIMLIB_ERR_INVALID_IMAGE,
1779 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1780 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1781 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1782 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1783 WIMLIB_ERR_INVALID_OVERLAY,
1784 WIMLIB_ERR_INVALID_PARAM,
1785 WIMLIB_ERR_INVALID_PART_NUMBER,
1786 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1787 WIMLIB_ERR_INVALID_REPARSE_DATA,
1788 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1789 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1790 WIMLIB_ERR_INVALID_UTF16_STRING,
1791 WIMLIB_ERR_INVALID_UTF8_STRING,
1792 WIMLIB_ERR_IS_DIRECTORY,
1793 WIMLIB_ERR_IS_SPLIT_WIM,
1794 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1796 WIMLIB_ERR_METADATA_NOT_FOUND,
1801 WIMLIB_ERR_NOTEMPTY,
1802 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1803 WIMLIB_ERR_NOT_A_WIM_FILE,
1804 WIMLIB_ERR_NOT_PIPABLE,
1805 WIMLIB_ERR_NO_FILENAME,
1809 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1811 WIMLIB_ERR_READLINK,
1814 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1815 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1816 WIMLIB_ERR_RESOURCE_ORDER,
1817 WIMLIB_ERR_SET_ATTRIBUTES,
1818 WIMLIB_ERR_SET_REPARSE_DATA,
1819 WIMLIB_ERR_SET_SECURITY,
1820 WIMLIB_ERR_SET_SHORT_NAME,
1821 WIMLIB_ERR_SET_TIMESTAMPS,
1822 WIMLIB_ERR_SPLIT_INVALID,
1825 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1826 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1827 WIMLIB_ERR_UNKNOWN_VERSION,
1828 WIMLIB_ERR_UNSUPPORTED,
1829 WIMLIB_ERR_UNSUPPORTED_FILE,
1830 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1831 WIMLIB_ERR_WIM_IS_READONLY,
1837 /** Used to indicate no WIM image or an invalid WIM image. */
1838 #define WIMLIB_NO_IMAGE 0
1840 /** Used to specify all images in the WIM. */
1841 #define WIMLIB_ALL_IMAGES (-1)
1844 * @ingroup G_modifying_wims
1846 * Appends an empty image to a WIM file. This empty image will initially
1847 * contain no files or directories, although if written without further
1848 * modifications, a root directory will be created automatically for it. After
1849 * calling this function, you can use wimlib_update_image() to add files to the
1850 * new WIM image. This gives you slightly more control over making the new
1851 * image compared to calling wimlib_add_image() or
1852 * wimlib_add_image_multisource() directly.
1855 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1858 * Name to give the new image. If @c NULL or empty, the new image is given
1859 * no name. If nonempty, it must specify a name that does not already
1861 * @param new_idx_ret
1862 * If non-<code>NULL</code>, the index of the newly added image is returned
1865 * @return 0 on success; nonzero on failure. The possible error codes are:
1867 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1868 * There is already an image in @p wim named @p name.
1869 * @retval ::WIMLIB_ERR_NOMEM
1870 * Failed to allocate the memory needed to add the new image.
1871 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1872 * The WIM file is considered read-only because of any of the reasons
1873 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1877 wimlib_add_empty_image(WIMStruct *wim,
1878 const wimlib_tchar *name,
1882 * @ingroup G_modifying_wims
1884 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1886 * The directory tree or NTFS volume is scanned immediately to load the dentry
1887 * tree into memory, and file attributes and symbolic links are read. However,
1888 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1891 * See the manual page for the @b wimlib-imagex program for more information
1892 * about the "normal" capture mode versus the NTFS capture mode (entered by
1893 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1895 * Note that @b no changes are committed to the underlying WIM file (if
1896 * any) until wimlib_write() or wimlib_overwrite() is called.
1899 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1902 * A path to a directory or unmounted NTFS volume that will be captured as
1905 * Name to give the new image. If @c NULL or empty, the new image is given
1906 * no name. If nonempty, it must specify a name that does not already
1909 * Capture configuration that specifies files, directories, or path globs
1910 * to exclude from being captured. If @c NULL, a dummy configuration where
1911 * no paths are treated specially is used.
1913 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1914 * @param progress_func
1915 * If non-NULL, a function that will be called periodically with the
1916 * progress of the current operation. The progress messages that will be
1917 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1918 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1919 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1921 * @return 0 on success; nonzero on error. On error, changes to @p wim are
1922 * discarded so that it appears to be in the same state as when this function
1925 * This function is implemented by calling wimlib_add_empty_image(), then
1926 * calling wimlib_update_image() with a single "add" command, so any error code
1927 * returned by wimlib_add_empty_image() may be returned, as well as any error
1928 * codes returned by wimlib_update_image() other than ones documented as only
1929 * being returned specifically by an update involving delete or rename commands.
1932 wimlib_add_image(WIMStruct *wim,
1933 const wimlib_tchar *source,
1934 const wimlib_tchar *name,
1935 const struct wimlib_capture_config *config,
1937 wimlib_progress_func_t progress_func);
1940 * @ingroup G_modifying_wims
1942 * This function is equivalent to wimlib_add_image() except it allows for
1943 * multiple sources to be combined into a single WIM image. This is done by
1944 * specifying the @p sources and @p num_sources parameters instead of the @p
1945 * source parameter of wimlib_add_image(). The rest of the parameters are the
1946 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1947 * capture</b> for full details on how this mode works.
1949 * In addition to the error codes that wimlib_add_image() can return,
1950 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1951 * when trying to overlay a non-directory on a directory or when otherwise
1952 * trying to overlay multiple conflicting files to the same location in the WIM
1953 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1954 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1955 * was not exactly one capture source with the target being the root directory.
1956 * (In this respect, there is no advantage to using
1957 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1960 wimlib_add_image_multisource(WIMStruct *wim,
1961 const struct wimlib_capture_source *sources,
1963 const wimlib_tchar *name,
1964 const struct wimlib_capture_config *config,
1966 wimlib_progress_func_t progress_func);
1969 * @ingroup G_creating_and_opening_wims
1971 * Creates a ::WIMStruct for a new WIM file.
1973 * This only creates an in-memory structure for a WIM that initially contains no
1974 * images. No on-disk file is created until wimlib_write() is called.
1977 * The type of compression to be used in the new WIM file. Must be
1978 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1979 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1981 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1982 * written to the memory location pointed to by this paramater. The
1983 * ::WIMStruct must be freed using using wimlib_free() when finished with
1985 * @return 0 on success; nonzero on error.
1986 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1987 * @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1988 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1989 * @retval ::WIMLIB_ERR_NOMEM
1990 * Failed to allocate needed memory.
1993 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1996 * @ingroup G_modifying_wims
1998 * Deletes an image, or all images, from a WIM file.
2000 * All streams referenced by the image(s) being deleted are removed from the
2001 * lookup table of the WIM if they are not referenced by any other images in the
2004 * Please note that @b no changes are committed to the underlying WIM file (if
2005 * any) until wimlib_write() or wimlib_overwrite() is called.
2008 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2011 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2013 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2014 * to be left unmodified only if @p image specified a single image. If instead
2015 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2016 * possible for some but not all of the images to have been deleted when a
2017 * failure status is returned.
2019 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2020 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2021 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2022 * The WIM file is considered read-only because of any of the reasons
2023 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2026 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2027 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2028 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2029 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2030 * different reasons) to read the metadata resource for an image that needed to
2034 wimlib_delete_image(WIMStruct *wim, int image);
2037 * @ingroup G_modifying_wims
2039 * Exports an image, or all the images, from a WIM file, into another WIM file.
2041 * The destination image is made to share the same dentry tree and security data
2042 * structure as the source image. This places some restrictions on additional
2043 * functions that may be called. wimlib_mount_image() may not be called on
2044 * either the source image or the destination image without an intervening call
2045 * to a function that un-shares the images, such as wimlib_free() on @p
2046 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2047 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2048 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2049 * have references back to @p src_wim.
2051 * If this function fails, all changes to @p dest_wim are rolled back.
2053 * Please note that no changes are committed to the underlying WIM file of @p
2054 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2057 * The WIM from which to export the images, specified as a pointer to the
2058 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2059 * split WIM. In the case of a WIM file that is not standalone, this
2060 * ::WIMStruct must have had any needed external resources previously
2061 * referenced using wimlib_reference_resources() or
2062 * wimlib_reference_resource_files().
2064 * The image to export from @p src_wim, as either a 1-based image index to
2065 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2067 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2070 * For single-image exports, the name to give the exported image in @p
2071 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2072 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2073 * that case, the names are all taken from @p src_wim. This parameter is
2074 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2075 * @param dest_description
2076 * For single-image exports, the description to give the exported image in
2077 * the new WIM file. If left @c NULL, the description from @p src_wim is
2078 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2079 * NULL; in that case, the description are all taken from @p src_wim. This
2080 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2081 * @param export_flags
2082 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2083 * @param progress_func
2084 * Currently ignored, but reserved for a function that will be called with
2085 * information about the operation. Use NULL if no additional information
2088 * @return 0 on success; nonzero on error.
2089 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2090 * One or more of the names being given to an exported image was already in
2091 * use in the destination WIM.
2092 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2093 * @p src_image does not exist in @p src_wim and was not
2094 * ::WIMLIB_ALL_IMAGES.
2095 * @retval ::WIMLIB_ERR_INVALID_PARAM
2096 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2097 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2099 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2100 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2101 * example, one of them was a non-first part of a split WIM.
2102 * @retval ::WIMLIB_ERR_NOMEM
2103 * Failed to allocate needed memory.
2104 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2105 * A resource that needed to be exported could not be found in either the
2106 * source or destination WIMs. This error can occur if, for example, @p
2107 * src_wim is part of a split WIM but needed resources from the other split
2108 * WIM parts were not referenced with wimlib_reference_resources() or
2109 * wimlib_reference_resource_files() before the call to
2110 * wimlib_export_image().
2111 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2112 * @p dest_wim is considered read-only because of any of the reasons
2113 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2116 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2117 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2118 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2119 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2120 * different reasons) to read the metadata resource for an image in @p src_wim
2121 * that needed to be exported.
2124 wimlib_export_image(WIMStruct *src_wim, int src_image,
2125 WIMStruct *dest_wim,
2126 const wimlib_tchar *dest_name,
2127 const wimlib_tchar *dest_description,
2129 wimlib_progress_func_t progress_func);
2132 * @ingroup G_extracting_wims
2134 * Extract zero or more files or directory trees from a WIM image.
2136 * This generalizes the single-image extraction functionality of
2137 * wimlib_extract_image() to allow extracting only the specified subsets of the
2141 * The WIM from which to extract the files, specified as a pointer to the
2142 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2143 * split WIM. In the case of a WIM file that is not standalone, this
2144 * ::WIMStruct must have had any needed external resources previously
2145 * referenced using wimlib_reference_resources() or
2146 * wimlib_reference_resource_files().
2149 * The 1-based number of the image in @p wim from which the files or
2150 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
2153 * An array of ::wimlib_extract_command structures that specifies the
2154 * extractions to perform.
2157 * Number of commands in the @p cmds array.
2159 * @param default_extract_flags
2160 * Default extraction flags; the behavior shall be as if these flags had
2161 * been specified in the ::wimlib_extract_command.extract_flags member in
2162 * each extraction command, in combination with any flags already present.
2164 * @param progress_func
2165 * If non-NULL, a function that will be called periodically with the
2166 * progress of the current operation.
2168 * @return 0 on success; nonzero on error. The possible error codes include
2169 * most of those documented as returned by wimlib_extract_image() as well as the
2170 * following additional error codes:
2172 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2173 * @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
2175 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2176 * The ::wimlib_extract_command.wim_source_path member in one of the
2177 * extract commands did not exist in the WIM.
2178 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2179 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
2180 * in which ::wimlib_extract_command.wim_source_path existed but was not a
2181 * regular file or directory.
2182 * @retval ::WIMLIB_ERR_INVALID_PARAM
2183 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
2184 * specified for some commands but not all; or
2185 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
2186 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
2187 * for a command in which ::wimlib_extract_command.wim_source_path did not
2188 * specify the root directory of the WIM image.
2191 wimlib_extract_files(WIMStruct *wim,
2193 const struct wimlib_extract_command *cmds,
2195 int default_extract_flags,
2196 wimlib_progress_func_t progress_func);
2199 * @ingroup G_extracting_wims
2201 * Extracts an image, or all images, from a WIM to a directory or directly to a
2202 * NTFS volume image.
2204 * The exact behavior of how wimlib extracts files from a WIM image is
2205 * controllable by the @p extract_flags parameter, but there also are
2206 * differences depending on the platform (UNIX-like vs Windows). See the manual
2207 * page for <b>wimlib-imagex apply</b> for more information, including about the
2208 * special "NTFS volume extraction mode" entered by providing
2209 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2211 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
2212 * returned if any resulting SHA1 message digests do not match the values
2213 * provided in the WIM file. Therefore, if this function is successful, you can
2214 * be fairly sure that any compressed data in the WIM was uncompressed
2218 * The WIM from which to extract the image(s), specified as a pointer to
2219 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2220 * of a split WIM. In the case of a WIM file that is not standalone, this
2221 * ::WIMStruct must have had any needed external resources previously
2222 * referenced using wimlib_reference_resources() or
2223 * wimlib_reference_resource_files().
2225 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
2226 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
2227 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2229 * Directory to extract the WIM image(s) to (created if it does not already
2230 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
2231 * path to the unmounted NTFS volume to extract the image to.
2232 * @param extract_flags
2233 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
2234 * @param progress_func
2235 * If non-NULL, a function that will be called periodically with the
2236 * progress of the current operation.
2238 * @return 0 on success; nonzero on error.
2239 * @retval ::WIMLIB_ERR_DECOMPRESSION
2240 * Failed to decompress a resource to be extracted.
2241 * @retval ::WIMLIB_ERR_INVALID_PARAM
2242 * Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
2243 * were specified in @p extract_flags; or both
2244 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
2245 * specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
2246 * ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
2247 * ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
2248 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
2249 * @p image was ::WIMLIB_ALL_IMAGES.
2250 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2251 * The SHA1 message digest of an extracted stream did not match the SHA1
2252 * message digest given in the WIM file.
2253 * @retval ::WIMLIB_ERR_LINK
2254 * Failed to create a symbolic link or a hard link.
2255 * @retval ::WIMLIB_ERR_MKDIR
2256 * Failed create a directory.
2257 * @retval ::WIMLIB_ERR_NOMEM
2258 * Failed to allocate needed memory.
2259 * @retval ::WIMLIB_ERR_OPEN
2260 * Could not create a file, or failed to open an already-extracted file.
2261 * @retval ::WIMLIB_ERR_READ
2262 * Failed to read data from the WIM file associated with @p wim.
2263 * @retval ::WIMLIB_ERR_READLINK
2264 * Failed to determine the target of a symbolic link in the WIM.
2265 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2266 * Failed to fix the target of an absolute symbolic link (e.g. if the
2267 * target would have exceeded the maximum allowed length). (Only if
2268 * reparse data was supported by the extraction mode and
2269 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
2270 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2271 * One of the files or directories that needed to be extracted referenced a
2272 * stream not present in the WIM's lookup table (or in any of the lookup
2273 * tables of the split WIM parts).
2274 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2275 * Failed to set attributes on a file.
2276 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2277 * Failed to set reparse data on a file (only if reparse data was supported
2278 * by the extraction mode).
2279 * @retval ::WIMLIB_ERR_SET_SECURITY
2280 * Failed to set security descriptor on a file
2281 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2283 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2284 * Failed to set the short name of a file (only if
2285 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2286 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2287 * Failed to set timestamps on a file (only if
2288 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2289 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2290 * Unexpected end-of-file occurred when reading data from the WIM file
2291 * associated with @p wim.
2292 * @retval ::WIMLIB_ERR_UNSUPPORTED
2293 * A requested extraction flag, or the data or metadata that must be
2294 * extracted to support it, is unsupported in the build and configuration
2295 * of wimlib, or on the current platform or extraction mode or target
2296 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2297 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2298 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2299 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2300 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2301 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2302 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2304 * ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
2305 * or more files with short names, but extracting short names is not
2306 * supported --- on Windows, this occurs if the target volume does not
2307 * support short names, while on non-Windows, this occurs if
2308 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2309 * @retval ::WIMLIB_ERR_WRITE
2310 * Failed to write data to a file being extracted.
2312 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2313 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2314 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2315 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2316 * different reasons) to read the metadata resource for an image that needed to
2320 wimlib_extract_image(WIMStruct *wim, int image,
2321 const wimlib_tchar *target,
2323 wimlib_progress_func_t progress_func);
2326 * @ingroup G_extracting_wims
2328 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
2329 * pipable WIM is being sent.
2331 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2332 * about pipable WIMs.
2334 * This function operates in a special way to read the WIM fully sequentially.
2335 * As a result, there is no ::WIMStruct is made visible to library users, and
2336 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2337 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2338 * seekable file, not a pipe.)
2341 * File descriptor, which may be a pipe, opened for reading and positioned
2342 * at the start of the pipable WIM.
2343 * @param image_num_or_name
2344 * String that specifies the 1-based index or name of the image to extract.
2345 * It is translated to an image index using the same rules that
2346 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2347 * only a single image (not all images) can be specified. Alternatively,
2348 * specify @p NULL here to use the first image in the WIM if it contains
2349 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2351 * Same as the corresponding parameter to wimlib_extract_image().
2352 * @param extract_flags
2353 * Same as the corresponding parameter to wimlib_extract_image(), except
2354 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
2355 * always implied, since data is always read from @p pipe_fd sequentially
2356 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
2357 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2358 * @param progress_func
2359 * Same as the corresponding parameter to wimlib_extract_image(), except
2360 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2363 * @return 0 on success; nonzero on error. The possible error codes include
2364 * those returned by wimlib_extract_image() as well as the following:
2366 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2367 * Data read from the pipable WIM was invalid.
2368 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2369 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2372 wimlib_extract_image_from_pipe(int pipe_fd,
2373 const wimlib_tchar *image_num_or_name,
2374 const wimlib_tchar *target, int extract_flags,
2375 wimlib_progress_func_t progress_func);
2378 * @ingroup G_wim_information
2380 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2381 * includes a string of XML that describes the images contained in the WIM.
2383 * See wimlib_get_xml_data() to read the XML data into memory instead.
2386 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2387 * have to be standalone (e.g. it could be part of a split WIM).
2389 * @c stdout, or a FILE* opened for writing, to extract the data to.
2391 * @return 0 on success; nonzero on error.
2392 * @retval ::WIMLIB_ERR_INVALID_PARAM
2393 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2394 * @retval ::WIMLIB_ERR_NOMEM
2395 * @retval ::WIMLIB_ERR_READ
2396 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2397 * Failed to read the XML data from the WIM.
2398 * @retval ::WIMLIB_ERR_WRITE
2399 * Failed to completely write the XML data to @p fp.
2402 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2405 * @ingroup G_general
2407 * Frees all memory allocated for a WIMStruct and closes all files associated
2411 * Pointer to the ::WIMStruct for a WIM file.
2413 * @return This function has no return value.
2416 wimlib_free(WIMStruct *wim);
2419 * @ingroup G_general
2421 * Converts a ::wimlib_compression_type value into a string.
2424 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2425 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2428 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2431 extern const wimlib_tchar *
2432 wimlib_get_compression_type_string(int ctype);
2435 * @ingroup G_general
2437 * Converts an error code into a string describing it.
2440 * The error code returned by one of wimlib's functions.
2443 * Pointer to a statically allocated string describing the error code,
2444 * or @c NULL if the error code is not valid.
2446 extern const wimlib_tchar *
2447 wimlib_get_error_string(enum wimlib_error_code code);
2450 * @ingroup G_wim_information
2452 * Returns the description of the specified image.
2455 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2456 * to be standalone (e.g. it could be part of a split WIM).
2458 * The number of the image, numbered starting at 1.
2461 * The description of the image, or @c NULL if there is no such image, or
2462 * @c NULL if the specified image has no description. The description
2463 * string is in library-internal memory and may not be modified or freed;
2464 * in addition, the string will become invalid if the description of the
2465 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2467 extern const wimlib_tchar *
2468 wimlib_get_image_description(const WIMStruct *wim, int image);
2471 * @ingroup G_wim_information
2473 * Returns the name of the specified image.
2476 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2477 * to be standalone (e.g. it could be part of a split WIM).
2479 * The number of the image, numbered starting at 1.
2482 * The name of the image, or @c NULL if there is no such image, or an empty
2483 * string if the image is unnamed. The name string is in
2484 * library-internal memory and may not be modified or freed; in addition,
2485 * the string will become invalid if the name of the image is changed, the
2486 * image is deleted, or the ::WIMStruct is destroyed.
2488 extern const wimlib_tchar *
2489 wimlib_get_image_name(const WIMStruct *wim, int image);
2493 * @ingroup G_wim_information
2495 * Get basic information about a WIM file.
2498 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2499 * to be standalone (e.g. it could be part of a split WIM).
2501 * A ::wimlib_wim_info structure that will be filled in with information
2502 * about the WIM file.
2507 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2510 * @ingroup G_wim_information
2512 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2513 * includes a string of XML that describes the images contained in the WIM.
2515 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2519 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2520 * have to be standalone (e.g. it could be part of a split WIM).
2522 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2523 * XML data is written to this location.
2524 * @param bufsize_ret
2525 * The size of the XML data in bytes is written to this location.
2527 * @return 0 on success; nonzero on error.
2528 * @retval ::WIMLIB_ERR_INVALID_PARAM
2529 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2530 * @p buf_ret or @p bufsize_ret was @c NULL.
2531 * @retval ::WIMLIB_ERR_NOMEM
2532 * @retval ::WIMLIB_ERR_READ
2533 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2534 * Failed to read the XML data from the WIM.
2537 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2540 * @ingroup G_general
2542 * Initialization function for wimlib. Call before using any other wimlib
2543 * function except wimlib_set_print_errors(). If not done manually, this
2544 * function will be called automatically with @p init_flags set to
2545 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.
2548 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2550 * @return 0 on success; nonzero on failure. Currently, only the following
2551 * error code is defined:
2553 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2554 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2555 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2556 * init_flags, but the corresponding privileges could not be acquired.
2559 wimlib_global_init(int init_flags);
2562 * @ingroup G_general
2564 * Cleanup function for wimlib. You are not required to call this function, but
2565 * it will release any global resources allocated by the library.
2568 wimlib_global_cleanup(void);
2571 * @ingroup G_wim_information
2573 * Determines if an image name is already used by some image in the WIM.
2576 * Pointer to the ::WIMStruct for a WIM file.
2578 * The name to check.
2581 * @c true if there is already an image in @p wim named @p name; @c false
2582 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2583 * the empty string, @c false is returned.
2586 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2589 * @ingroup G_wim_information
2591 * Iterate through a file or directory tree in the WIM image. By specifying
2592 * appropriate flags and a callback function, you can get the attributes of a
2593 * file in the WIM, get a directory listing, or even get a listing of the entire
2597 * The WIM containing the image(s) over which to iterate, specified as a
2598 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2599 * or part 1 of a split WIM. In the case of a WIM file that is not
2600 * standalone, this ::WIMStruct should have had any needed external
2601 * resources previously referenced using wimlib_reference_resources() or
2602 * wimlib_reference_resource_files(). If not, see
2603 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2604 * the behavior when resources are missing.
2607 * The 1-based number of the image in @p wim that contains the files or
2608 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2609 * iteration on all images in the WIM.
2612 * Path in the WIM image at which to do the iteration.
2615 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2618 * A callback function that will receive each directory entry.
2621 * An extra parameter that will always be passed to the callback function
2624 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2625 * first nonzero value that was returned from @p cb. However, additional error
2626 * codes may be returned, including the following:
2628 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2629 * @p path did not exist in the WIM image.
2630 * @retval ::WIMLIB_ERR_NOMEM
2631 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2633 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2634 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2635 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2636 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2637 * different reasons) to read the metadata resource for an image over which
2638 * iteration needed to be done.
2641 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2643 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2646 * @ingroup G_wim_information
2648 * Iterate through the lookup table of a WIM file. This can be used to directly
2649 * get a listing of the unique resources contained in a WIM file over all
2650 * images. Both file resources and metadata resources are included. However,
2651 * only resources actually included in the file represented by @a wim, plus
2652 * explicitly referenced external resources (via wimlib_reference_resources() or
2653 * wimlib_reference_resource_files()) are included in the iteration. For
2654 * example, if @p wim represents just one part of a split WIM, then only
2655 * resources in that part will be included, unless other resources were
2656 * explicitly referenced.
2659 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2660 * to be standalone (e.g. it could be part of a split WIM).
2663 * Reserved; set to 0.
2666 * A callback function that will receive each resource.
2669 * An extra parameter that will always be passed to the callback function
2672 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2673 * that was returned from @p cb.
2676 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2677 wimlib_iterate_lookup_table_callback_t cb,
2681 * @ingroup G_nonstandalone_wims
2683 * Joins a split WIM into a stand-alone one-part WIM.
2686 * An array of strings that gives the filenames of all parts of the split
2687 * WIM. No specific order is required, but all parts must be included with
2690 * Number of filenames in @p swms.
2691 * @param swm_open_flags
2692 * Open flags for the split WIM parts (e.g.
2693 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2694 * @param wim_write_flags
2695 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2696 * be used to write the joined WIM.
2697 * @param output_path
2698 * The path to write the joined WIM file to.
2699 * @param progress_func
2700 * If non-NULL, a function that will be called periodically with the
2701 * progress of the current operation.
2703 * @return 0 on success; nonzero on error. This function may return most error
2704 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2705 * as the following error code:
2707 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2708 * The split WIMs do not form a valid WIM because they do not include all
2709 * the parts of the original WIM, there are duplicate parts, or not all the
2710 * parts have the same GUID and compression type.
2712 * Note: wimlib is generalized enough that this function is not actually needed
2713 * to join a split WIM; instead, you could open the first part of the split WIM,
2714 * then reference the other parts with wimlib_reference_resource_files(), then
2715 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2716 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2720 wimlib_join(const wimlib_tchar * const *swms,
2722 const wimlib_tchar *output_path,
2724 int wim_write_flags,
2725 wimlib_progress_func_t progress_func);
2728 * @ingroup G_compression
2730 * Compress a chunk of a WIM resource using LZX compression.
2732 * This function is exported for convenience only and should only be used by
2733 * library clients looking to make use of wimlib's compression code for another
2737 * Uncompressed data of the chunk.
2739 * Size of the uncompressed chunk, in bytes.
2741 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2744 * The size of the compressed data written to @p out in bytes, or 0 if the
2745 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2747 * As a special requirement, the compression code is optimized for the WIM
2748 * format and therefore requires (@p chunk_size <= 32768).
2751 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out)
2755 * @ingroup G_compression
2757 * Equivalent to wimlib_lzx_compress(), but uses the specified compression
2758 * context, allocated by wimlib_lzx_alloc_context().
2761 wimlib_lzx_compress2(const void *chunk, unsigned chunk_size, void *out,
2762 struct wimlib_lzx_context *ctx);
2765 * @ingroup G_compression
2767 * Allocate a LZX compression context using the specified parameters.
2769 * This function is exported for convenience only and should only be used by
2770 * library clients looking to make use of wimlib's compression code for another
2773 * @param window_size
2774 * Size of the LZX window. Must be a power of 2 between 2^15 and 2^21,
2778 * Compression parameters to use, or @c NULL to use the default parameters.
2781 * A pointer to either @c NULL or an existing ::wimlib_lzx_context. If
2782 * <code>*ctx_ret == NULL</code>, the new context is allocated. If
2783 * <code>*ctx_ret != NULL</code>, the existing context is re-used if
2784 * possible. Alternatively, this argument can itself be @c NULL to
2785 * indicate that only parameter validation is to be performed.
2787 * @return 0 on success; nonzero on error.
2789 * @retval ::WIMLIB_ERR_INVALID_PARAM
2790 * The window size or compression parameters were invalid.
2791 * @retval ::WIMLIB_ERR_NOMEM
2792 * Not enough memory to allocate the compression context.
2795 wimlib_lzx_alloc_context(uint32_t window_size,
2796 const struct wimlib_lzx_params *params,
2797 struct wimlib_lzx_context **ctx_pp);
2800 * @ingroup G_compression
2802 * Decompresses a block of LZX-compressed data as used in the WIM file format.
2804 * Note that this will NOT work unmodified for LZX as used in the cabinet
2805 * format, which is not the same as in the WIM format!
2807 * This function is exported for convenience only and should only be used by
2808 * library clients looking to make use of wimlib's compression code for another
2811 * @param compressed_data
2812 * Pointer to the compressed data.
2814 * @param compressed_len
2815 * Length of the compressed data, in bytes.
2817 * @param uncompressed_data
2818 * Pointer to the buffer into which to write the uncompressed data.
2820 * @param uncompressed_len
2821 * Length of the uncompressed data. It must be 32768 bytes or less.
2824 * 0 on success; non-zero on failure.
2827 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2828 void *uncompressed_data, unsigned uncompressed_len);
2831 * @ingroup G_compression
2833 * Equivalent to wimlib_lzx_decompress(), except the window size is specified in
2834 * @p max_window_size as any power of 2 between 2^15 and 2^21, inclusively, and
2835 * @p uncompressed_len may be any size less than or equal to @p max_window_size.
2838 wimlib_lzx_decompress2(const void *compressed_data, unsigned compressed_len,
2839 void *uncompressed_data, unsigned uncompressed_len,
2840 uint32_t max_window_size);
2843 * @ingroup G_compression
2845 * Free the specified LZX compression context, allocated with
2846 * wimlib_lzx_alloc_context().
2849 wimlib_lzx_free_context(struct wimlib_lzx_context *ctx);
2852 * @ingroup G_compression
2854 * Set the global default LZX compression parameters.
2857 * The LZX compression parameters to set. These default parameters will be
2858 * used by any calls to wimlib_lzx_alloc_context() with @c NULL LZX
2859 * parameters specified, as well as by any future compression performed by
2860 * the library itself. Passing @p NULL here resets the default LZX
2861 * parameters to their original value.
2863 * @return 0 on success; nonzero on error.
2865 * @retval ::WIMLIB_ERR_INVALID_PARAM
2866 * The compression parameters were invalid.
2869 wimlib_lzx_set_default_params(const struct wimlib_lzx_params *params);
2872 * @ingroup G_compression
2874 * Free the specified LZX compression context, allocated with
2875 * wimlib_lzx_alloc_context().
2878 wimlib_lzx_free_context(struct wimlib_lzx_context *ctx);
2882 * @ingroup G_mounting_wim_images
2884 * Mounts an image in a WIM file on a directory read-only or read-write.
2886 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2887 * supported if wimlib was configured with @c --without-fuse. This includes
2888 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2891 * Calling this function daemonizes the process, unless
2892 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2893 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2894 * to the WIM are staged in a temporary directory.
2896 * It is safe to mount multiple images from the same underlying WIM file
2897 * read-only at the same time, but only if different ::WIMStruct's are used. It
2898 * is @b not safe to mount multiple images from the same WIM file read-write at
2901 * wimlib_mount_image() cannot be used on an image that was exported with
2902 * wimlib_export_image() while the dentry trees for both images are still in
2903 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2904 * that already has modifications pending (e.g. an image added with
2905 * wimlib_add_image()).
2908 * Pointer to the ::WIMStruct containing the image to be mounted.
2910 * The number of the image to mount, indexed starting from it. It must be
2911 * an existing, single image.
2913 * The path to an existing empty directory to mount the image on.
2914 * @param mount_flags
2915 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2916 * @param staging_dir
2917 * If non-NULL, the name of a directory in which the staging directory will
2918 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2919 * in @p mount_flags. If left @c NULL, the staging directory is created in
2920 * the same directory as the WIM file that @p wim was originally read from.
2922 * @return 0 on success; nonzero on error.
2924 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2925 * A read-write mount was requested, but an an exclusive advisory lock on
2926 * the on-disk WIM file could not be acquired because another thread or
2927 * process has mounted an image from the WIM read-write or is currently
2928 * modifying the WIM in-place.
2929 * @retval ::WIMLIB_ERR_FUSE
2930 * A non-zero status was returned by @c fuse_main().
2931 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2932 * @p image does not specify an existing, single image in @p wim.
2933 * @retval ::WIMLIB_ERR_INVALID_PARAM
2934 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2935 * wimlib_export_image(), or @p image has been added with
2936 * wimlib_add_image().
2937 * @retval ::WIMLIB_ERR_MKDIR
2938 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2939 * staging directory could not be created.
2940 * @retval ::WIMLIB_ERR_NOTDIR
2941 * Could not determine the current working directory.
2942 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2943 * One of the dentries in the image referenced a stream not present in the
2944 * WIM's lookup table (or in any of the lookup tables of the split WIM
2946 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2947 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2948 * wim is considered read-only because of any of the reasons mentioned in
2949 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2950 * @retval ::WIMLIB_ERR_UNSUPPORTED
2951 * Mounting is not supported, either because the platform is Windows, or
2952 * because the platform is UNIX-like and wimlib was compiled with @c
2955 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2956 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2957 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2958 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2959 * different reasons) to read the metadata resource for the image to mount.
2962 wimlib_mount_image(WIMStruct *wim,
2964 const wimlib_tchar *dir,
2966 const wimlib_tchar *staging_dir);
2969 * @ingroup G_creating_and_opening_wims
2971 * Opens a WIM file and creates a ::WIMStruct for it.
2974 * The path to the WIM file to open.
2977 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2979 * @param progress_func
2980 * If non-NULL, a function that will be called periodically with the
2981 * progress of the current operation. Currently, the only messages sent
2982 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2983 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2986 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2987 * is written to the memory location pointed to by this parameter. The
2988 * ::WIMStruct can be freed using using wimlib_free() when finished with
2991 * @return 0 on success; nonzero on error.
2992 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2993 * The WIM is not the non-first part of a split WIM, and the number of
2994 * metadata resources found in the WIM did not match the image count given
2995 * in the WIM header, or the number of <IMAGE> elements in the XML
2996 * data for the WIM did not match the image count given in the WIM header.
2997 * @retval ::WIMLIB_ERR_INTEGRITY
2998 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2999 * wim_file contains an integrity table, but the SHA1 message digest for a
3000 * chunk of the WIM does not match the corresponding message digest given
3001 * in the integrity table.
3002 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3003 * Resources in @p wim_file are compressed, but the chunk size is not 32768.
3004 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3005 * The header of @p wim_file says that resources in the WIM are compressed,
3006 * but the header flag indicating LZX or XPRESS compression is not set.
3007 * @retval ::WIMLIB_ERR_INVALID_HEADER
3008 * The header of @p wim_file was otherwise invalid.
3009 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3010 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3011 * wim_file contains an integrity table, but the integrity table is
3013 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3014 * The lookup table for the WIM contained duplicate entries that are not
3015 * for metadata resources, or it contained an entry with a SHA1 message
3016 * digest of all 0's.
3017 * @retval ::WIMLIB_ERR_INVALID_PARAM
3018 * @p wim_ret was @c NULL.
3019 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3020 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3021 * specified in @p open_flags.
3022 * @retval ::WIMLIB_ERR_NOMEM
3023 * Failed to allocated needed memory.
3024 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3025 * @p wim_file does not begin with the expected magic characters.
3026 * @retval ::WIMLIB_ERR_OPEN
3027 * Failed to open the file @p wim_file for reading.
3028 * @retval ::WIMLIB_ERR_READ
3029 * Failed to read data from @p wim_file.
3030 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3031 * Unexpected end-of-file while reading data from @p wim_file.
3032 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3033 * A number other than 0x10d00 is written in the version field of the WIM
3034 * header of @p wim_file. (May be a pre-Vista WIM.)
3035 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3036 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3037 * considered read-only because of any of the reasons mentioned in the
3038 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3039 * @retval ::WIMLIB_ERR_XML
3040 * The XML data for @p wim_file is invalid.
3043 wimlib_open_wim(const wimlib_tchar *wim_file,
3045 WIMStruct **wim_ret,
3046 wimlib_progress_func_t progress_func);
3049 * @ingroup G_writing_and_overwriting_wims
3051 * Overwrites the file that the WIM was originally read from, with changes made.
3052 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3053 * rather than wimlib_create_new_wim().
3055 * There are two ways that a WIM may be overwritten. The first is to do a full
3056 * rebuild. In this mode, the new WIM is written to a temporary file and then
3057 * renamed to the original file after it is has been completely written. The
3058 * temporary file is made in the same directory as the original WIM file. A
3059 * full rebuild may take a while, but can be used even if images have been
3060 * modified or deleted, will produce a WIM with no holes, and has little chance
3061 * of unintentional data loss because the temporary WIM is fsync()ed before
3062 * being renamed to the original WIM.
3064 * The second way to overwrite a WIM is by appending to the end of it and
3065 * overwriting the header. This can be much faster than a full rebuild, but the
3066 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3067 * begins with writing any new file resources *after* everything in the old WIM,
3068 * even though this will leave a hole where the old lookup table, XML data, and
3069 * integrity were. This is done so that the WIM remains valid even if the
3070 * operation is aborted mid-write. The WIM header is only overwritten at the
3071 * very last moment, and up until that point the WIM will be seen as the old
3074 * By default, wimlib_overwrite() does the append-style overwrite described
3075 * above, unless resources in the WIM are arranged in an unusual way or if
3076 * images have been deleted from the WIM. Use the flag
3077 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3078 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3079 * images have been deleted from the WIM.
3081 * In the temporary-file overwrite mode, no changes are made to the WIM on
3082 * failure, and the temporary file is deleted if possible. Abnormal termination
3083 * of the program will result in the temporary file being orphaned. In the
3084 * direct append mode, the WIM is truncated to the original length on failure;
3085 * and while abnormal termination of the program will result in extra data
3086 * appended to the original WIM, it should still be a valid WIM.
3088 * If this function completes successfully, no more functions should be called
3089 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3090 * the WIM file anew.
3093 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3094 * been in-memory changes made to it, which are then reflected in the
3096 * @param write_flags
3097 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3098 * @param num_threads
3099 * Number of threads to use for compression (see wimlib_write()).
3100 * @param progress_func
3101 * If non-NULL, a function that will be called periodically with the
3102 * progress of the current operation.
3104 * @return 0 on success; nonzero on error. This function may return most error
3105 * codes returned by wimlib_write() as well as the following error codes:
3107 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3108 * The WIM was going to be modified in-place (with no temporary file), but
3109 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3110 * because another thread or process has mounted an image from the WIM
3111 * read-write or is currently modifying the WIM in-place.
3112 * @retval ::WIMLIB_ERR_NO_FILENAME
3113 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3114 * than a WIM read with wimlib_open_wim().
3115 * @retval ::WIMLIB_ERR_RENAME
3116 * The temporary file that the WIM was written to could not be renamed to
3117 * the original filename of @p wim.
3118 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3119 * The WIM file is considered read-only because of any of the reasons
3120 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3124 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3125 wimlib_progress_func_t progress_func);
3128 * @ingroup G_wim_information
3130 * Prints information about one image, or all images, contained in a WIM.
3133 * Pointer to the ::WIMStruct for a WIM file.
3135 * The image about which to print information. Can be the number of an
3136 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3139 * @return This function has no return value. No error checking is done when
3140 * printing the information. If @p image is invalid, an error message is
3144 wimlib_print_available_images(const WIMStruct *wim, int image);
3147 * @ingroup G_wim_information
3149 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3150 * in a way that can be accessed programatically.
3153 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3156 * @ingroup G_wim_information
3158 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
3159 * information in a way that can be accessed programatically.
3162 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
3165 * @ingroup G_nonstandalone_wims
3167 * Reference resources from other WIM files or split WIM parts. This function
3168 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3169 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3170 * from other files, before calling a function such as wimlib_extract_image()
3171 * that requires the resources to be present.
3174 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3175 * necessarily "standalone". In the case of split WIMs, this should be the
3176 * first part, since only the first part contains the metadata resources.
3177 * In the case of delta WIMs, this should be the delta WIM rather than the
3178 * WIM on which it is based.
3179 * @param resource_wimfiles_or_globs
3180 * Array of paths to WIM files and/or split WIM parts to reference.
3181 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3182 * ref_flags, these are treated as globs rather than literal paths. That
3183 * is, using this function you can specify zero or more globs, each of
3184 * which expands to one or more literal paths.
3186 * Number of entries in @p resource_wimfiles_or_globs.
3188 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3189 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3191 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3192 * pass to internal calls to wimlib_open_wim() on the reference files.
3193 * @param progress_func
3194 * Passed to internal calls to wimlib_open_wim() on the reference files.
3196 * @return 0 on success; nonzero on error.
3198 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3199 * One of the specified globs did not match any paths (only with both
3200 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3201 * specified in @p ref_flags).
3202 * @retval ::WIMLIB_ERR_NOMEM
3203 * Failed to allocate memory.
3204 * @retval ::WIMLIB_ERR_READ
3205 * I/O or permissions error while processing a file glob.
3207 * This function can additionally return most values that can be returned by
3208 * wimlib_open_wim().
3211 wimlib_reference_resource_files(WIMStruct *wim,
3212 const wimlib_tchar * const *resource_wimfiles_or_globs,
3216 wimlib_progress_func_t progress_func);
3219 * @ingroup G_nonstandalone_wims
3221 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3222 * where the caller must open the ::WIMStruct for each referenced file itself.
3225 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3226 * necessarily "standalone". In the case of split WIMs, this should be the
3227 * first part, since only the first part contains the metadata resources.
3228 * @param resource_wims
3229 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3230 * split WIM parts to reference.
3231 * @param num_resource_wims
3232 * Number of entries in @p resource_wims.
3234 * Currently ignored (set to 0).
3236 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3237 * @p resource_wims are referenced internally by @p wim and must not be freed
3238 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3239 * been freed with wimlib_free(), or immediately before freeing @p wim with
3242 * @retval ::WIMLIB_ERR_INVALID_PARAM
3243 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3244 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3245 * @retval ::WIMLIB_ERR_NOMEM
3246 * Failed to allocate memory.
3249 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3250 unsigned num_resource_wims, int ref_flags);
3253 * @ingroup G_modifying_wims
3255 * Declares that a newly added image is mostly the same as a prior image, but
3256 * captured at a later point in time, possibly with some modifications in the
3257 * intervening time. This is designed to be used in incremental backups of the
3258 * same filesystem or directory tree.
3260 * This function compares the metadata of the directory tree of the newly added
3261 * image against that of the old image. Any files that are present in both the
3262 * newly added image and the old image and have timestamps that indicate they
3263 * haven't been modified are deemed not to have been modified and have their
3264 * SHA1 message digest copied from the old image. Because of this and because
3265 * WIM uses single-instance streams, such files need not be read from the
3266 * filesystem when the WIM is being written or overwritten. Note that these
3267 * unchanged files will still be "archived" and will be logically present in the
3268 * new image; the optimization is that they don't need to actually be read from
3269 * the filesystem because the WIM already contains them.
3271 * This function is provided to optimize incremental backups. The resulting WIM
3272 * file will still be the same regardless of whether this function is called.
3273 * (This is, however, assuming that timestamps have not been manipulated or
3274 * unmaintained as to trick this function into thinking a file has not been
3275 * modified when really it has. To partly guard against such cases, other
3276 * metadata such as file sizes will be checked as well.)
3278 * This function must be called after adding the new image (e.g. with
3279 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3280 * wimlib_overwrite()).
3283 * Pointer to the ::WIMStruct for a WIM.
3285 * 1-based index in the WIM of the newly added image. This image can have
3286 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3287 * wimlib_add_empty_image() followed by wimlib_update_image().
3288 * @param template_wim
3289 * The ::WIMStruct for the WIM containing the template image. This can be
3290 * the same as @p wim, or it can be a different ::WIMStruct.
3291 * @param template_image
3292 * 1-based index in the WIM of a template image that reflects a prior state
3293 * of the directory tree being captured.
3295 * Reserved; must be 0.
3296 * @param progress_func
3297 * Currently ignored, but reserved for a function that will be called with
3298 * information about the operation. Use NULL if no additional information
3301 * @return 0 on success; nonzero on error.
3303 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3304 * @p new_image and/or @p template_image were not a valid image indices in
3306 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3307 * The specified ::WIMStruct did not actually contain the metadata resource
3308 * for the new or template image; for example, it was a non-first part of a
3310 * @retval ::WIMLIB_ERR_NOMEM
3311 * Failed to allocate needed memory.
3312 * @retval ::WIMLIB_ERR_INVALID_PARAM
3313 * @p new_image was equal to @p template_image, or @p new_image specified
3314 * an image that had not been modified since opening the WIM.
3316 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3317 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3318 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3319 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3320 * different reasons) to read the metadata resource for the template image.
3323 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3324 WIMStruct *template_wim, int template_image,
3325 int flags, wimlib_progress_func_t progress_func);
3328 * @ingroup G_wim_information
3330 * Translates a string specifying the name or number of an image in the WIM into
3331 * the number of the image. The images are numbered starting at 1.
3334 * Pointer to the ::WIMStruct for a WIM.
3335 * @param image_name_or_num
3336 * A string specifying the name or number of an image in the WIM. If it
3337 * parses to a positive integer, this integer is taken to specify the
3338 * number of the image, indexed starting at 1. Otherwise, it is taken to
3339 * be the name of an image, as given in the XML data for the WIM file. It
3340 * also may be the keyword "all" or the string "*", both of which will
3341 * resolve to ::WIMLIB_ALL_IMAGES.
3343 * There is no way to search for an image actually named "all", "*", or an
3344 * integer number, or an image that has no name. However, you can use
3345 * wimlib_get_image_name() to get the name of any image.
3348 * If the string resolved to a single existing image, the number of that
3349 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3350 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3351 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3352 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3353 * images in @p wim has no name.
3356 wimlib_resolve_image(WIMStruct *wim,
3357 const wimlib_tchar *image_name_or_num);
3360 * @ingroup G_modifying_wims
3362 * Changes the description of an image in the WIM.
3365 * Pointer to the ::WIMStruct for a WIM.
3367 * The number of the image for which to change the description.
3368 * @param description
3369 * The new description to give the image. It may be @c NULL, which
3370 * indicates that the image is to be given no description.
3372 * @return 0 on success; nonzero on error.
3373 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3374 * @p image does not specify a single existing image in @p wim.
3375 * @retval ::WIMLIB_ERR_NOMEM
3376 * Failed to allocate the memory needed to duplicate the @p description
3378 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3379 * @p wim is considered read-only because of any of the reasons mentioned
3380 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3383 wimlib_set_image_descripton(WIMStruct *wim, int image,
3384 const wimlib_tchar *description);
3387 * @ingroup G_writing_and_overwriting_wims
3389 * Set the compression chunk size of a WIM to use in subsequent calls to
3390 * wimlib_write() or wimlib_overwrite().
3392 * A compression chunk size will result in a greater compression ratio, but the
3393 * speed of random access to the WIM will be reduced, and the effect of an
3394 * increased compression chunk size is limited by the size of each file being
3397 * <b>WARNING: Changing the compression chunk size to any value other than the
3398 * default of 32768 bytes eliminates compatibility with Microsoft's software,
3399 * except when increasing the XPRESS chunk size before Windows 8.</b>
3402 * ::WIMStruct for a WIM.
3403 * @param out_chunk_size
3404 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3405 * on the compression format. The XPRESS compression format supports chunk
3406 * sizes that are powers of 2 with exponents between 15 and 26 inclusively,
3407 * whereas the LZX compression format supports chunk sizes that are powers
3408 * of 2 with exponents between 15 and 21 inclusively.
3410 * @return 0 on success; nonzero on error.
3412 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3413 * @p ctype is not a supported chunk size.
3416 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3419 * @ingroup G_writing_and_overwriting_wims
3421 * Set the compression type of a WIM to use in subsequent calls to
3422 * wimlib_write() or wimlib_overwrite().
3425 * ::WIMStruct for a WIM.
3427 * The compression type to set (one of ::wimlib_compression_type). If this
3428 * compression type is incompatible with the current output chunk size
3429 * (either the default or as set with wimlib_set_output_chunk_size()), the
3430 * output chunk size is reset to the default for that compression type.
3432 * @return 0 on success; nonzero on error.
3434 * @retval ::WIMLIB_ERR_INVALID_PARAM
3435 * @p ctype did not specify a valid compression type.
3438 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3441 * @ingroup G_modifying_wims
3443 * Set basic information about a WIM.
3446 * Pointer to the ::WIMStruct for a WIM.
3448 * A struct ::wimlib_wim_info that contains the information to set. Only
3449 * the information explicitly specified in the @p which flags need be
3452 * Flags that specify which information to set. This is a bitwise OR of
3453 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3454 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3456 * @return 0 on success; nonzero on failure.
3457 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3458 * The WIM file is considered read-only because of any of the reasons
3459 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3460 * flag. However, as a special case, if you are using
3461 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3462 * function will not fail due to the readonly flag being previously set.
3463 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3464 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3465 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3469 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3473 * @ingroup G_modifying_wims
3475 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3476 * (something like "Core" or "Ultimate")
3479 * Pointer to the ::WIMStruct for a WIM.
3481 * The number of the image for which to change the description.
3483 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3484 * indicates that the image is to be given no \<FLAGS\> element.
3486 * @return 0 on success; nonzero on error.
3487 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3488 * @p image does not specify a single existing image in @p wim.
3489 * @retval ::WIMLIB_ERR_NOMEM
3490 * Failed to allocate the memory needed to duplicate the @p flags string.
3491 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3492 * @p wim is considered read-only because of any of the reasons mentioned
3493 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3496 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3499 * @ingroup G_modifying_wims
3501 * Changes the name of an image in the WIM.
3504 * Pointer to the ::WIMStruct for a WIM.
3506 * The number of the image for which to change the name.
3508 * New name to give the new image. If @c NULL or empty, the new image is
3509 * given no name. If nonempty, it must specify a name that does not
3510 * already exist in @p wim.
3512 * @return 0 on success; nonzero on error.
3513 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3514 * There is already an image named @p name in @p wim.
3515 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3516 * @p image does not specify a single existing image in @p wim.
3517 * @retval ::WIMLIB_ERR_NOMEM
3518 * Failed to allocate the memory needed to duplicate the @p name string.
3519 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3520 * @p wim is considered read-only because of any of the reasons mentioned
3521 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3524 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3527 * @ingroup G_general
3529 * Set the functions that wimlib uses to allocate and free memory.
3531 * These settings are global and not per-WIM.
3533 * The default is to use the default @c malloc() and @c free() from the C
3536 * Please note that some external functions, such as those in @c libntfs-3g, may
3537 * use the standard memory allocation functions.
3539 * @param malloc_func
3540 * A function equivalent to @c malloc() that wimlib will use to allocate
3541 * memory. If @c NULL, the allocator function is set back to the default
3542 * @c malloc() from the C library.
3544 * A function equivalent to @c free() that wimlib will use to free memory.
3545 * If @c NULL, the free function is set back to the default @c free() from
3547 * @param realloc_func
3548 * A function equivalent to @c realloc() that wimlib will use to reallocate
3549 * memory. If @c NULL, the free function is set back to the default @c
3550 * realloc() from the C library.
3551 * @return 0 on success; nonzero on error.
3552 * @retval ::WIMLIB_ERR_UNSUPPORTED
3553 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
3554 * so custom memory allocators are unsupported.
3557 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3558 void (*free_func)(void *),
3559 void *(*realloc_func)(void *, size_t));
3562 * @ingroup G_general
3564 * Sets whether wimlib is to print error messages to @c stderr when a function
3565 * fails. These error messages may provide information that cannot be
3566 * determined only from the error code that is returned. Not every error will
3567 * result in an error message being printed.
3569 * This setting is global and not per-WIM.
3571 * By default, error messages are not printed.
3573 * This can be called before wimlib_global_init().
3575 * @param show_messages
3576 * @c true if error messages are to be printed; @c false if error messages
3577 * are not to be printed.
3579 * @return 0 on success; nonzero on error.
3580 * @retval ::WIMLIB_ERR_UNSUPPORTED
3581 * @p show_messages was @c true, but wimlib was compiled with the @c
3582 * --without-error-messages option. Therefore, error messages cannot be
3586 wimlib_set_print_errors(bool show_messages);
3589 * @ingroup G_nonstandalone_wims
3591 * Splits a WIM into multiple parts.
3594 * The ::WIMStruct for the WIM to split.
3596 * Name of the SWM file to create. This will be the name of the first
3597 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3598 * appended before the suffix.
3600 * The maximum size per part, in bytes. Unfortunately, it is not
3601 * guaranteed that this will really be the maximum size per part, because
3602 * some file resources in the WIM may be larger than this size, and the WIM
3603 * file format provides no way to split up file resources among multiple
3605 * @param write_flags
3606 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3607 * flags will be used to write each split WIM part. Specify 0 here to get
3608 * the default behavior.
3609 * @param progress_func
3610 * If non-NULL, a function that will be called periodically with the
3611 * progress of the current operation
3612 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3613 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3615 * @return 0 on success; nonzero on error. This function may return most error
3616 * codes that can be returned by wimlib_write() as well as the following error
3619 * @retval ::WIMLIB_ERR_INVALID_PARAM
3620 * @p swm_name was not a nonempty string, or @p part_size was 0.
3622 * Note: the WIM's uncompressed and compressed resources are not checksummed
3623 * when they are copied from the joined WIM to the split WIM parts, nor are
3624 * compressed resources re-compressed (unless explicitly requested with
3625 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3628 wimlib_split(WIMStruct *wim,
3629 const wimlib_tchar *swm_name,
3632 wimlib_progress_func_t progress_func);
3635 * @ingroup G_mounting_wim_images
3637 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3639 * The image to unmount is specified by the path to the mountpoint, not the
3640 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3641 * touched and also may have been allocated in a different process.
3643 * To unmount the image, the process calling this function communicates with the
3644 * process that is managing the mounted WIM image. This function blocks until it
3645 * is known whether the unmount succeeded or failed. In the case of a
3646 * read-write mounted WIM, the unmount is not considered to have succeeded until
3647 * all changes have been saved to the underlying WIM file.
3650 * The directory that the WIM image was mounted on.
3651 * @param unmount_flags
3652 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3653 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3654 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3656 * @param progress_func
3657 * If non-NULL, a function that will be called periodically with the
3658 * progress of the current operation. Currently, only
3659 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3661 * @return 0 on success; nonzero on error.
3663 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3664 * The filesystem daemon was unable to remove the staging directory and the
3665 * temporary files that it contains.
3666 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3667 * The filesystem daemon appears to have terminated before sending an exit
3669 * @retval ::WIMLIB_ERR_FORK
3670 * Could not @c fork() the process.
3671 * @retval ::WIMLIB_ERR_FUSERMOUNT
3672 * The @b fusermount program could not be executed or exited with a failure
3674 * @retval ::WIMLIB_ERR_MQUEUE
3675 * Could not open a POSIX message queue to communicate with the filesystem
3676 * daemon servicing the mounted filesystem, could not send a message
3677 * through the queue, or could not receive a message through the queue.
3678 * @retval ::WIMLIB_ERR_NOMEM
3679 * Failed to allocate needed memory.
3680 * @retval ::WIMLIB_ERR_OPEN
3681 * The filesystem daemon could not open a temporary file for writing the
3683 * @retval ::WIMLIB_ERR_READ
3684 * A read error occurred when the filesystem daemon tried to a file from
3685 * the staging directory
3686 * @retval ::WIMLIB_ERR_RENAME
3687 * The filesystem daemon failed to rename the newly written WIM file to the
3688 * original WIM file.
3689 * @retval ::WIMLIB_ERR_UNSUPPORTED
3690 * Mounting is not supported, either because the platform is Windows, or
3691 * because the platform is UNIX-like and wimlib was compiled with @c
3693 * @retval ::WIMLIB_ERR_WRITE
3694 * A write error occurred when the filesystem daemon was writing to the new
3695 * WIM file, or the filesystem daemon was unable to flush changes that had
3696 * been made to files in the staging directory.
3699 wimlib_unmount_image(const wimlib_tchar *dir,
3701 wimlib_progress_func_t progress_func);
3704 * @ingroup G_modifying_wims
3706 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3709 * Pointer to the ::WIMStruct for the WIM file to update.
3711 * The 1-based index of the image in the WIM to update. It cannot be
3712 * ::WIMLIB_ALL_IMAGES.
3714 * An array of ::wimlib_update_command's that specify the update operations
3717 * Number of commands in @p cmds.
3718 * @param update_flags
3719 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3720 * @param progress_func
3721 * If non-NULL, a function that will be called periodically with the
3722 * progress of the current operation.
3724 * @return 0 on success; nonzero on error. On failure, some but not all of the
3725 * update commands may have been executed. No individual update command will
3726 * have been partially executed. Possible error codes include:
3728 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3729 * The capture configuration structure specified for an add command was
3731 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3732 * @p image did not specify a single, existing image in @p wim.
3733 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3734 * Attempted to perform an add command that conflicted with previously
3735 * existing files in the WIM when an overlay was attempted.
3736 * @retval ::WIMLIB_ERR_INVALID_PARAM
3737 * An unknown operation type was specified in the update commands; or,
3738 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3739 * in the @p add_flags, but the same image had previously already been
3740 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3741 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3742 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3743 * specified in the @p add_flags for an add command in which @p
3744 * wim_target_path was not the root directory of the WIM image.
3745 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3746 * (Windows only): While executing an add command, tried to capture a
3747 * reparse point with invalid data.
3748 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3749 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3750 * for a WIM path that corresponded to a directory; or, a rename command
3751 * attempted to rename a directory to a non-directory.
3752 * @retval ::WIMLIB_ERR_NOMEM
3753 * Failed to allocate needed memory.
3754 * @retval ::WIMLIB_ERR_NOTDIR
3755 * A rename command attempted to rename a directory to a non-directory; or,
3756 * an add command was executed that attempted to set the root of the WIM
3757 * image as a non-directory; or, a path component used as a directory in a
3758 * rename command was not, in fact, a directory.
3759 * @retval ::WIMLIB_ERR_NOTEMPTY
3760 * A rename command attempted to rename a directory to a non-empty
3762 * @retval ::WIMLIB_ERR_NTFS_3G
3763 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3764 * error occurred while reading data from the NTFS volume using libntfs-3g.
3765 * @retval ::WIMLIB_ERR_OPEN
3766 * Failed to open a file to be captured while executing an add command.
3767 * @retval ::WIMLIB_ERR_OPENDIR
3768 * Failed to open a directory to be captured while executing an add command.
3769 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3770 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3771 * WIM path that did not exist; or, a rename command attempted to rename a
3772 * file that does not exist.
3773 * @retval ::WIMLIB_ERR_READ
3774 * While executing an add command, failed to read data from a file or
3775 * directory to be captured.
3776 * @retval ::WIMLIB_ERR_READLINK
3777 * While executing an add command, failed to read the target of a symbolic
3778 * link or junction point.
3779 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3780 * (Windows only) Failed to perform a reparse point fixup because of
3781 * problems with the data of a reparse point.
3782 * @retval ::WIMLIB_ERR_STAT
3783 * While executing an add command, failed to get attributes for a file or
3785 * @retval ::WIMLIB_ERR_UNSUPPORTED
3786 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3787 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3788 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3789 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3790 * add_flags for an update command.
3791 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3792 * While executing an add command, attempted to capture a file that was not
3793 * a supported file type (e.g. a device file). Only if
3794 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3795 * for an update command.
3796 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3797 * The WIM file is considered read-only because of any of the reasons
3798 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3801 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3802 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3803 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3804 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3805 * different reasons) to read the metadata resource for an image that needed to
3809 wimlib_update_image(WIMStruct *wim,
3811 const struct wimlib_update_command *cmds,
3814 wimlib_progress_func_t progress_func);
3817 * @ingroup G_writing_and_overwriting_wims
3819 * Writes a WIM to a file.
3821 * This brings in resources from any external locations, such as directory trees
3822 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3823 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3825 * By default, the new WIM file is written as stand-alone. Using the
3826 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3827 * instead. However, this function cannot directly write a "split" WIM; use
3828 * wimlib_split() for that.
3831 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3832 * changes made to it, which are then reflected in the output file.
3834 * The path to the file to write the WIM to.
3836 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3837 * images are to be included in the new on-disk WIM file. If for some
3838 * reason you only want to include a single image, specify the index of
3839 * that image instead.
3840 * @param write_flags
3841 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3842 * @param num_threads
3843 * Number of threads to use for compressing data. If 0, the number of
3844 * threads is taken to be the number of online processors. Note: if no
3845 * data compression needs to be done, no additional threads will be created
3846 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3847 * exporting an image from a compressed WIM to another WIM of the same
3848 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3850 * @param progress_func
3851 * If non-NULL, a function that will be called periodically with the
3852 * progress of the current operation. The possible messages are
3853 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3854 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3855 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3857 * @return 0 on success; nonzero on error.
3859 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3860 * @p image does not specify a single existing image in @p wim, and is not
3861 * ::WIMLIB_ALL_IMAGES.
3862 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3863 * A file that had previously been scanned for inclusion in the WIM by
3864 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3865 * message digest check.
3866 * @retval ::WIMLIB_ERR_INVALID_PARAM
3867 * @p path was @c NULL.
3868 * @retval ::WIMLIB_ERR_NOMEM
3869 * Failed to allocate needed memory.
3870 * @retval ::WIMLIB_ERR_OPEN
3871 * Failed to open @p path for writing, or some file resources in @p wim
3872 * refer to files in the outside filesystem, and one of these files could
3873 * not be opened for reading.
3874 * @retval ::WIMLIB_ERR_READ
3875 * An error occurred when trying to read data from the WIM file associated
3876 * with @p wim, or some file resources in @p wim refer to files in the
3877 * outside filesystem, and a read error occurred when reading one of these
3879 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3880 * A stream that needed to be written could not be found in the stream
3881 * lookup table of @p wim. This error can occur if, for example, @p wim is
3882 * part of a split WIM but needed resources from the other split WIM parts
3883 * were not referenced with wimlib_reference_resources() or
3884 * wimlib_reference_resource_files() before the call to wimlib_write().
3885 * @retval ::WIMLIB_ERR_WRITE
3886 * An error occurred when trying to write data to the new WIM file.
3888 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3889 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3890 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3891 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3892 * different reasons) to read the metadata resource for an image that needed to
3896 wimlib_write(WIMStruct *wim,
3897 const wimlib_tchar *path,
3900 unsigned num_threads,
3901 wimlib_progress_func_t progress_func);
3904 * @ingroup G_writing_and_overwriting_wims
3906 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3907 * file descriptor, which need not be seekable if the write is done in a special
3908 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3909 * write_flags. This can, for example, allow capturing a WIM image and
3910 * streaming it over the network. See the documentation for
3911 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3913 * The file descriptor @p fd will @b not be closed when the write is complete;
3914 * the calling code is responsible for this.
3916 * Returns 0 on success; nonzero on failure. The possible error codes include
3917 * those that can be returned by wimlib_write() as well as the following:
3919 * @retval ::WIMLIB_ERR_INVALID_PARAM
3920 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3921 * specified in @p write_flags.
3924 wimlib_write_to_fd(WIMStruct *wim,
3928 unsigned num_threads,
3929 wimlib_progress_func_t progress_func);
3932 * @ingroup G_compression
3934 * Compress a chunk of data using XPRESS compression.
3936 * This function is exported for convenience only and should only be used by
3937 * library clients looking to make use of wimlib's compression code for another
3940 * As of wimlib v1.5.4, this function can be used with @p chunk_size greater
3941 * than 32768 bytes and is only limited by available memory. However, the
3942 * XPRESS format itself still caps match offsets to 65535, so if a larger chunk
3943 * size is chosen, then the matching will effectively occur in a sliding window
3947 * Uncompressed data of the chunk.
3949 * Size of the uncompressed chunk, in bytes.
3951 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
3954 * The size of the compressed data written to @p out in bytes, or 0 if the
3955 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
3958 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3961 * @ingroup G_compression
3963 * Decompresses a chunk of XPRESS-compressed data.
3965 * This function is exported for convenience only and should only be used by
3966 * library clients looking to make use of wimlib's compression code for another
3969 * @param compressed_data
3970 * Pointer to the compressed data.
3972 * @param compressed_len
3973 * Length of the compressed data, in bytes.
3975 * @param uncompressed_data
3976 * Pointer to the buffer into which to write the uncompressed data.
3978 * @param uncompressed_len
3979 * Length of the uncompressed data.
3982 * 0 on success; non-zero on failure.
3985 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3986 void *uncompressed_data, unsigned uncompressed_len);
3992 #endif /* _WIMLIB_H */