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,
429 /** Compressed resources in the WIM use LZMS compression. Currently,
430 * wimlib has a decompressor for this format but not a compressor. LZMS
431 * compression is only compatible with wimlib v1.6.0 and later and with
432 * WIMGAPI Windows 8 and later (and some restrictions apply on the
434 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
438 /** @ingroup G_progress
441 /** Possible values of the first parameter to the user-supplied
442 * ::wimlib_progress_func_t progress function */
443 enum wimlib_progress_msg {
445 /** A WIM image is about to be extracted. @p info will point to
446 * ::wimlib_progress_info.extract. */
447 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
449 /** A file or directory tree within a WIM image (not the full image) is
450 * about to be extracted. @p info will point to
451 * ::wimlib_progress_info.extract. */
452 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
454 /** The directory structure of the WIM image is about to be extracted.
455 * @p info will point to ::wimlib_progress_info.extract. */
456 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
458 /** The directory structure of the WIM image has been successfully
459 * extracted. @p info will point to ::wimlib_progress_info.extract. */
460 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
462 /** The WIM image's files resources are currently being extracted. @p
463 * info will point to ::wimlib_progress_info.extract. */
464 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
466 /** Starting to read a new part of a split pipable WIM over the pipe.
467 * @p info will point to ::wimlib_progress_info.extract. */
468 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
470 /** All the WIM files and directories have been extracted, and
471 * timestamps are about to be applied. @p info will point to
472 * ::wimlib_progress_info.extract. */
473 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
475 /** A WIM image has been successfully extracted. @p info will point to
476 * ::wimlib_progress_info.extract. */
477 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
479 /** A file or directory tree within a WIM image (not the full image) has
480 * been successfully extracted. @p info will point to
481 * ::wimlib_progress_info.extract. */
482 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
484 /** The directory or NTFS volume is about to be scanned to build a tree
485 * of WIM dentries in-memory. @p info will point to
486 * ::wimlib_progress_info.scan. */
487 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
489 /** A directory or file is being scanned. @p info will point to
490 * ::wimlib_progress_info.scan, and its @p cur_path member will be
491 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
492 * is passed to wimlib_add_image(). */
493 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
495 /** The directory or NTFS volume has been successfully scanned, and a
496 * tree of WIM dentries has been built in-memory. @p info will point to
497 * ::wimlib_progress_info.scan. */
498 WIMLIB_PROGRESS_MSG_SCAN_END,
501 * File resources are currently being written to the WIM.
502 * @p info will point to ::wimlib_progress_info.write_streams. */
503 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
506 * The metadata resource for each image is about to be written to the
507 * WIM. @p info will not be valid. */
508 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
511 * The metadata resource for each image has successfully been writen to
512 * the WIM. @p info will not be valid. */
513 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
516 * The temporary file has successfully been renamed to the original WIM
517 * file. Only happens when wimlib_overwrite() is called and the
518 * overwrite is not done in-place.
519 * @p info will point to ::wimlib_progress_info.rename. */
520 WIMLIB_PROGRESS_MSG_RENAME,
522 /** The contents of the WIM are being checked against the integrity
523 * table. Only happens when wimlib_open_wim() is called with the
524 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @p info will point to
525 * ::wimlib_progress_info.integrity. */
526 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
528 /** An integrity table is being calculated for the WIM being written.
529 * Only happens when wimlib_write() or wimlib_overwrite() is called with
530 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @p info will point to
531 * ::wimlib_progress_info.integrity. */
532 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
534 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
535 * but in wimlib v1.5.0 this was removed to simplify the code and now
536 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
537 WIMLIB_PROGRESS_MSG_RESERVED,
539 /** A wimlib_split() operation is in progress, and a new split part is
540 * about to be started. @p info will point to
541 * ::wimlib_progress_info.split. */
542 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
544 /** A wimlib_split() operation is in progress, and a split part has been
545 * finished. @p info will point to ::wimlib_progress_info.split. */
546 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
549 * A WIM update command is just about to be executed; @p info will point
550 * to ::wimlib_progress_info.update.
552 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
555 * A WIM update command has just been executed; @p info will point to
556 * ::wimlib_progress_info.update.
558 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
562 /** A pointer to this union is passed to the user-supplied
563 * ::wimlib_progress_func_t progress function. One (or none) of the structures
564 * contained in this union will be applicable for the operation
565 * (::wimlib_progress_msg) indicated in the first argument to the progress
567 union wimlib_progress_info {
569 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
570 * document them if they aren't given a name... */
572 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
573 struct wimlib_progress_info_write_streams {
574 /** Number of bytes that are going to be written for all the
575 * streams combined. This is the amount in uncompressed data.
576 * (The actual number of bytes will be less if the data is being
577 * written compressed.) */
578 uint64_t total_bytes;
580 /** Number of streams that are going to be written. */
581 uint64_t total_streams;
583 /** Number of uncompressed bytes that have been written so far.
584 * Will be 0 initially, and equal to @p total_bytes at the end.
586 uint64_t completed_bytes;
588 /** Number of streams that have been written. Will be 0
589 * initially, and equal to @p total_streams at the end. */
590 uint64_t completed_streams;
592 /** Number of threads that are being used to compress resources
593 * (if applicable). */
594 unsigned num_threads;
596 /** The compression type being used to write the streams; either
597 * ::WIMLIB_COMPRESSION_TYPE_NONE,
598 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
599 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
600 int compression_type;
602 /** Number of split WIM parts from which streams are being
603 * written (may be 0 if irrelevant). */
604 unsigned total_parts;
606 /** Number of split WIM parts from which streams have been
607 * written (may be 0 if irrelevant). */
608 unsigned completed_parts;
611 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
612 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
613 struct wimlib_progress_info_scan {
614 /** Directory or NTFS volume that is being scanned. */
615 const wimlib_tchar *source;
617 /** Path to the file or directory that is about to be scanned,
618 * relative to the root of the image capture or the NTFS volume.
620 const wimlib_tchar *cur_path;
623 /** File or directory looks okay and will be captured. */
624 WIMLIB_SCAN_DENTRY_OK = 0,
626 /** File or directory is being excluded from capture due
627 * to the capture configuration file. */
628 WIMLIB_SCAN_DENTRY_EXCLUDED,
630 /** File or directory is being excluded from capture due
631 * to being unsupported (e.g. an encrypted or device
633 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
636 /** Target path in the WIM. Only valid on messages
637 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
638 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
639 const wimlib_tchar *wim_target_path;
642 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
643 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
644 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
645 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
646 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
647 struct wimlib_progress_info_extract {
648 /** Number of the image being extracted (1-based). */
651 /** Flags passed to to wimlib_extract_image() */
654 /** Full path to the WIM file being extracted. */
655 const wimlib_tchar *wimfile_name;
657 /** Name of the image being extracted. */
658 const wimlib_tchar *image_name;
660 /** Directory or NTFS volume to which the image is being
662 const wimlib_tchar *target;
665 const wimlib_tchar *cur_path;
667 /** Number of bytes of uncompressed data that will be extracted.
668 * Takes into account hard links (they are not counted for each
670 uint64_t total_bytes;
672 /** Number of bytes that have been written so far. Will be 0
673 * initially, and equal to @p total_bytes at the end. */
674 uint64_t completed_bytes;
676 /** Number of streams that will be extracted. This may more or
677 * less than the number of "files" to be extracted due to
678 * special cases (hard links, symbolic links, and alternate data
680 uint64_t num_streams;
682 /** Path to the root dentry within the WIM for the tree that is
683 * being extracted. Will be the empty string when extracting a
685 const wimlib_tchar *extract_root_wim_source_path;
687 /** Currently only used for
688 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
690 unsigned part_number;
692 /** Currently only used for
693 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
694 unsigned total_parts;
696 /** Currently only used for
697 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
698 uint8_t guid[WIMLIB_GUID_LEN];
701 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
702 struct wimlib_progress_info_rename {
703 /** Name of the temporary file that the WIM was written to. */
704 const wimlib_tchar *from;
706 /** Name of the original WIM file to which the temporary file is
708 const wimlib_tchar *to;
711 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
712 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
713 struct wimlib_progress_info_update {
714 /** Pointer to the update command that will be executed or has
715 * just been executed. */
716 const struct wimlib_update_command *command;
718 /** Number of update commands that have been completed so far.
720 size_t completed_commands;
722 /** Number of update commands that are being executed as part of
723 * this call to wimlib_update_image(). */
724 size_t total_commands;
727 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
728 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
729 struct wimlib_progress_info_integrity {
730 /** Number of bytes from the end of the WIM header to the end of
731 * the lookup table (the area that is covered by the SHA1
732 * integrity checks.) */
733 uint64_t total_bytes;
735 /** Number of bytes that have been SHA1-summed so far. Will be
736 * 0 initially, and equal @p total_bytes at the end. */
737 uint64_t completed_bytes;
739 /** Number of chunks that the checksummed region is divided
741 uint32_t total_chunks;
743 /** Number of chunks that have been SHA1-summed so far. Will
744 * be 0 initially, and equal to @p total_chunks at the end. */
745 uint32_t completed_chunks;
747 /** Size of the chunks used for the integrity calculation. */
750 /** Filename of the WIM (only valid if the message is
751 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
752 const wimlib_tchar *filename;
755 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
756 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
757 struct wimlib_progress_info_split {
758 /** Total size of the original WIM's file and metadata resources
760 uint64_t total_bytes;
762 /** Number of bytes of file and metadata resources that have
763 * been copied out of the original WIM so far. Will be 0
764 * initially, and equal to @p total_bytes at the end. */
765 uint64_t completed_bytes;
767 /** Number of the split WIM part that is about to be started
768 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
769 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
770 unsigned cur_part_number;
772 /** Total number of split WIM parts that are being written. */
773 unsigned total_parts;
775 /** Name of the split WIM part that is about to be started
776 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
777 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
778 const wimlib_tchar *part_name;
782 /** A user-supplied function that will be called periodically during certain WIM
783 * operations. The first argument will be the type of operation that is being
784 * performed or is about to be started or has been completed. The second
785 * argument will be a pointer to one of a number of structures depending on the
786 * first argument. It may be @c NULL for some message types.
788 * The return value of the progress function is currently ignored, but it may do
789 * something in the future. (Set it to 0 for now.)
791 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
792 const union wimlib_progress_info *info);
795 /** @ingroup G_modifying_wims
798 /** An array of these structures is passed to wimlib_add_image_multisource() to
799 * specify the sources from which to create a WIM image. */
800 struct wimlib_capture_source {
801 /** Absolute or relative path to a file or directory on the external
802 * filesystem to be included in the WIM image. */
803 wimlib_tchar *fs_source_path;
805 /** Destination path in the WIM image. Leading and trailing slashes are
806 * ignored. The empty string or @c NULL means the root directory of the
808 wimlib_tchar *wim_target_path;
810 /** Reserved; set to 0. */
814 /** Structure that specifies a list of path patterns. */
815 struct wimlib_pattern_list {
816 /** Array of patterns. The patterns may be modified by library code,
817 * but the @p pats pointer itself will not. See the man page for
818 * <b>wimlib-imagex capture</b> for more information about allowed
822 /** Number of patterns in the @p pats array. */
825 /** Ignored; may be used by the calling code. */
826 size_t num_allocated_pats;
829 /** A structure that contains lists of wildcards that match paths to treat
830 * specially when capturing a WIM image. */
831 struct wimlib_capture_config {
832 /** Paths matching any pattern this list are excluded from being
833 * captured, except if the same path appears in @p
834 * exclusion_exception_pats. */
835 struct wimlib_pattern_list exclusion_pats;
837 /** Paths matching any pattern in this list are never excluded from
839 struct wimlib_pattern_list exclusion_exception_pats;
841 /** Reserved for future capture configuration options. */
842 struct wimlib_pattern_list reserved1;
844 /** Reserved for future capture configuration options. */
845 struct wimlib_pattern_list reserved2;
847 /** Library internal use only. */
848 wimlib_tchar *_prefix;
850 /** Library internal use only. */
851 size_t _prefix_num_tchars;
854 /** Set or unset the WIM header flag that marks it read-only
855 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
856 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
857 * is distinct from basic file permissions; this flag can be set on a WIM file
858 * that is physically writable. If this flag is set, all further operations to
859 * modify the WIM will fail, except calling wimlib_overwrite() with
860 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
861 * allows you to set this flag persistently on the underlying WIM file.
863 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
865 /** Set the GUID (globally unique identifier) of the WIM file to the value
866 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
867 #define WIMLIB_CHANGE_GUID 0x00000002
869 /** Change the bootable image of the WIM to the value specified in
870 * ::wimlib_wim_info.boot_index of the @p info parameter. */
871 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
873 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
874 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
875 * indicates whether an image in the WIM has been captured with reparse-point
876 * fixups enabled. wimlib also treats this flag as specifying whether to do
877 * reparse-point fixups by default when capturing or applying WIM images. */
878 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
881 /** @ingroup G_wim_information
884 /** General information about a WIM file. */
885 struct wimlib_wim_info {
887 /** Globally unique identifier for the WIM file. Note: all parts of a
888 * split WIM should have an identical value in this field. */
889 uint8_t guid[WIMLIB_GUID_LEN];
891 /** Number of images in the WIM. */
892 uint32_t image_count;
894 /** 1-based index of the bootable image in the WIM, or 0 if no image is
898 /** Version of the WIM file. */
899 uint32_t wim_version;
901 /** Chunk size used for compression. */
904 /** For split WIMs, the 1-based index of this part within the split WIM;
906 uint16_t part_number;
908 /** For split WIMs, the total number of parts in the split WIM;
910 uint16_t total_parts;
912 /** One of the ::wimlib_compression_type values that specifies the
913 * method used to compress resources in the WIM. */
914 int32_t compression_type;
916 /** Size of the WIM file in bytes, excluding the XML data and integrity
918 uint64_t total_bytes;
920 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
921 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
922 * this will always be 0, even if the ::WIMStruct was written to
923 * somewhere by calling wimlib_write() with the
924 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
925 uint32_t has_integrity_table : 1;
927 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
928 * wimlib_create_new_wim(). */
929 uint32_t opened_from_file : 1;
931 /** 1 if the WIM is considered readonly for any reason. */
932 uint32_t is_readonly : 1;
934 /** 1 if reparse-point fixups are supposedly enabled for one or more
935 * images in the WIM. */
936 uint32_t has_rpfix : 1;
938 /** 1 if the WIM is marked as read-only. */
939 uint32_t is_marked_readonly : 1;
941 /** 1 if the WIM is part of a spanned set. */
942 uint32_t spanned : 1;
944 uint32_t write_in_progress : 1;
945 uint32_t metadata_only : 1;
946 uint32_t resource_only : 1;
948 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
949 uint32_t pipable : 1;
950 uint32_t reserved_flags : 22;
951 uint32_t reserved[9];
954 /** Information about a unique stream in the WIM file. (A stream is the same
955 * thing as a "resource", except in the case of packed resources.) */
956 struct wimlib_resource_entry {
957 /** Uncompressed size of the stream in bytes. */
958 uint64_t uncompressed_size;
960 /** Compressed size of the stream in bytes. This will be the same as @p
961 * uncompressed_size if the stream is uncompressed. Or, if @p
962 * is_packed_streams is 1, this will be 0. */
963 uint64_t compressed_size;
965 /** Offset, in bytes, of this stream from the start of the WIM file. Or
966 * if @p packed is 1, then this is actually the offset at which this
967 * stream begins in the uncompressed contents of the packed resource.
971 /** SHA1 message digest of the stream's uncompressed contents. */
972 uint8_t sha1_hash[20];
974 /** Which part number of the split WIM this stream is in. This should
975 * be the same as the part number provided by wimlib_get_wim_info(). */
976 uint32_t part_number;
978 /** Number of times this stream is referenced over all WIM images. */
979 uint32_t reference_count;
981 /** 1 if this stream is compressed. */
982 uint32_t is_compressed : 1;
984 /** 1 if this stream is a metadata resource rather than a file resource.
986 uint32_t is_metadata : 1;
988 uint32_t is_free : 1;
989 uint32_t is_spanned : 1;
991 /** 1 if this stream was not found in the lookup table of the
992 * ::WIMStruct. This normally implies a missing call to
993 * wimlib_reference_resource_files() or wimlib_reference_resources().
995 uint32_t is_missing : 1;
997 /** 1 if this stream is located in a packed resource which may contain
998 * other streams (all compressed together) as well. */
1001 uint32_t reserved_flags : 26;
1003 /** If @p packed is 1, then this will specify the offset of the packed
1004 * resource in the WIM. */
1005 uint64_t raw_resource_offset_in_wim;
1007 /** If @p is_packed_streams is 1, then this will specify the compressed
1008 * size of the packed resource in the WIM. */
1009 uint64_t raw_resource_compressed_size;
1011 uint64_t reserved[2];
1014 /** A stream of a file in the WIM. */
1015 struct wimlib_stream_entry {
1016 /** Name of the stream, or NULL if the stream is unnamed. */
1017 const wimlib_tchar *stream_name;
1018 /** Location, size, etc. of the stream within the WIM file. */
1019 struct wimlib_resource_entry resource;
1020 uint64_t reserved[4];
1023 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1024 * Roughly, the information about a "file" in the WIM--- but really a directory
1025 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1026 * field can be used to distinguish actual file inodes. */
1027 struct wimlib_dir_entry {
1028 /** Name of the file, or NULL if this file is unnamed (only possible for
1029 * the root directory) */
1030 const wimlib_tchar *filename;
1032 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1034 const wimlib_tchar *dos_name;
1036 /** Full path to this file within the WIM image. */
1037 const wimlib_tchar *full_path;
1039 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1040 * children, ..., etc. */
1043 /** Pointer to the security descriptor for this file, in Windows
1044 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1045 * security descriptor. */
1046 const char *security_descriptor;
1048 /** Length of the above security descriptor. */
1049 size_t security_descriptor_size;
1051 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1052 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1053 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1054 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1055 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1056 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1057 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1058 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1059 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1060 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1061 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1062 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1063 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1064 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1065 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1066 /** File attributes, such as whether the file is a directory or not.
1067 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1068 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1069 * on other platforms. */
1070 uint32_t attributes;
1072 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1073 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1074 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1075 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1076 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1077 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1078 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1079 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1080 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1081 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1082 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1083 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1084 * attributes), this will give the reparse tag. This tells you whether
1085 * the reparse point is a symbolic link, junction point, or some other,
1086 * more unusual kind of reparse point. */
1087 uint32_t reparse_tag;
1089 /* Number of (hard) links to this file. */
1092 /** Number of named data streams that this file has. Normally 0. */
1093 uint32_t num_named_streams;
1095 /** Roughly, the inode number of this file. However, it may be 0 if
1096 * @p num_links == 1. */
1097 uint64_t hard_link_group_id;
1099 /** Time this file was created. */
1100 struct timespec creation_time;
1102 /** Time this file was last written to. */
1103 struct timespec last_write_time;
1105 /** Time this file was last accessed. */
1106 struct timespec last_access_time;
1107 uint64_t reserved[16];
1109 /** Array of streams that make up this file. The first entry will
1110 * always exist and will correspond to the unnamed data stream (default
1111 * file contents), so it will have @p stream_name == @c NULL. There
1112 * will then be @p num_named_streams additional entries that specify the
1113 * named data streams, if any, each of which will have @p stream_name !=
1115 struct wimlib_stream_entry streams[];
1119 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1122 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1126 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1129 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1132 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1133 * just on the specified path. */
1134 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1136 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1137 * itself; only its children (in the case of a non-empty directory) */
1138 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1140 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1141 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1142 * table of the ::WIMStruct. The default behavior without this flag is to fill
1143 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1144 * wimlib_resource_entry::is_missing "is_missing" flag. */
1145 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1149 /** @ingroup G_modifying_wims
1152 /** Directly capture a NTFS volume rather than a generic directory. This flag
1153 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1154 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1155 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1157 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1158 * with ::WIMLIB_ADD_FLAG_NTFS. */
1159 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1161 /** Call the progress function with the message
1162 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
1163 * be scanned, or when a directory or file is being excluded from capture. */
1164 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1166 /** Mark the image being added as the bootable image of the WIM. */
1167 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1169 /** Store the UNIX owner, group, and mode. This is done by adding a special
1170 * alternate data stream to each regular file, symbolic link, and directory to
1171 * contain this information. Please note that this flag is for convenience
1172 * only; Microsoft's @a imagex.exe will not understand this special information.
1173 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1174 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1176 /** Do not capture security descriptors. Only has an effect in NTFS capture
1177 * mode, or in Win32 native builds. */
1178 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1180 /** Fail immediately if the full security descriptor of any file or directory
1181 * cannot be accessed. Only has an effect in Win32 native builds. The default
1182 * behavior without this flag is to first try omitting the SACL from the
1183 * security descriptor, then to try omitting the security descriptor entirely.
1185 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1187 /** Call the progress function with the message
1188 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1189 * capture. This is a subset of the messages provided by
1190 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1191 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1193 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1194 * in the case of Windows) that point inside the directory being captured to
1195 * instead be absolute relative to the directory being captured, rather than the
1196 * current root; also exclude absolute symbolic links that point outside the
1197 * directory tree being captured.
1199 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1200 * the WIM header or if this is the first image being added.
1201 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1202 * reparse point fixups enabled and currently cannot be unset. */
1203 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1205 /** Don't do reparse point fixups. The default behavior is described in the
1206 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1207 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1209 /** Do not automatically exclude unsupported files or directories from capture;
1210 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1211 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1212 * such a file is encountered. */
1213 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1215 /** Automatically select a capture configuration appropriate for capturing
1216 * filesystems containing Windows operating systems. When this flag is
1217 * specified, the corresponding @p config parameter or member must be @c NULL.
1219 * Currently, selecting this capture configuration will cause the following
1220 * files and directories to be excluded from capture:
1225 * - "\System Volume Information"
1229 * Note that the default behavior--- that is, when this flag is not specified
1230 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1231 * no files are excluded from capture.
1233 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1235 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1236 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1237 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1238 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1239 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1240 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1241 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1242 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1243 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1244 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1245 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1246 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1247 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1250 /** @ingroup G_modifying_wims
1253 /** Do not issue an error if the path to delete does not exist. */
1254 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1256 /** Delete the file or directory tree recursively; if not specified, an error is
1257 * issued if the path to delete is a directory. */
1258 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1261 /** @ingroup G_modifying_wims
1265 * If a single image is being exported, mark it bootable in the destination WIM.
1266 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1267 * the image in the source WIM (if any) that is marked as bootable is also
1268 * marked as bootable in the destination WIM.
1270 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1272 /** Give the exported image(s) no names. Avoids problems with image name
1275 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1277 /** Give the exported image(s) no descriptions. */
1278 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1281 /** @ingroup G_extracting_wims
1284 /** Extract the image directly to a NTFS volume rather than a generic directory.
1285 * This mode is only available if wimlib was compiled with libntfs-3g support;
1286 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1287 * extraction target will be interpreted as the path to a NTFS volume image (as
1288 * a regular file or block device) rather than a directory. It will be opened
1289 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1290 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1291 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1292 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1294 /** When identical files are extracted from the WIM, always hard link them
1296 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1298 /** When identical files are extracted from the WIM, always symlink them
1300 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1302 /** This flag no longer does anything but is reserved for future use. */
1303 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1305 /** Read the WIM file sequentially while extracting the image. As of wimlib
1306 * v1.6.0 this is the default behavior, and this flag no longer does anything.
1308 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1310 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1311 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1313 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1315 /** Do not extract security descriptors. */
1316 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1318 /** Fail immediately if the full security descriptor of any file or directory
1319 * cannot be set exactly as specified in the WIM file. On Windows, the default
1320 * behavior without this flag is to fall back to setting the security descriptor
1321 * with the SACL omitted, then only the default inherited security descriptor,
1322 * if we do not have permission to set the desired one. */
1323 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1325 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1326 * reparse-point fixups on, so absolute symbolic links or junction points will
1327 * be fixed to be absolute relative to the actual extraction root. Reparse
1328 * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1329 * header. This flag may only be specified when extracting a full image (not a
1330 * file or directory tree within one). */
1331 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1333 /** Force reparse-point fixups on extraction off, regardless of the state of the
1334 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1335 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1337 /** Extract the specified file to standard output. This is only valid in an
1338 * extraction command that specifies the extraction of a regular file in the WIM
1340 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1342 /** Instead of ignoring files and directories with names that cannot be
1343 * represented on the current platform (note: Windows has more restrictions on
1344 * filenames than POSIX-compliant systems), try to replace characters or append
1345 * junk to the names so that they can be extracted in some form. */
1346 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1348 /** On Windows, when there exist two or more files with the same case
1349 * insensitive name but different case sensitive names, try to extract them all
1350 * by appending junk to the end of them, rather than arbitrarily extracting only
1352 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1354 /** Do not ignore failure to set timestamps on extracted files. */
1355 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1357 /** Do not ignore failure to set short names on extracted files. */
1358 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1360 /** Do not ignore failure to extract symbolic links (and junction points, on
1361 * Windows) due to permissions problems. By default, such failures are ignored
1362 * since the default configuration of Windows only allows the Administrator to
1363 * create symbolic links. */
1364 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1366 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1367 * behavior is currently less than satisfactory. Do not use (yet). */
1368 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1370 /** Perform the extraction ordered by the tree of files to extract rather than
1371 * how the underlying streams are arranged in the WIM file. For regular WIM
1372 * files this may decrease or increase performance, depending on various
1373 * factors. For WIM files containing packed streams this will decrease
1375 #define WIMLIB_EXTRACT_FLAG_FILE_ORDER 0x00020000
1378 /** @ingroup G_mounting_wim_images
1381 /** Mount the WIM image read-write rather than the default of read-only. */
1382 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1384 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1385 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1387 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1388 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1390 /** Access alternate data streams in the mounted WIM image through extended file
1391 * attributes. This is the default mode. */
1392 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1394 /** Access alternate data streams in the mounted WIM image by specifying the
1395 * file name, a colon, then the alternate file stream name. */
1396 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1398 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1399 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1400 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1402 /** Allow other users to see the mounted filesystem. (this passes the @c
1403 * allow_other option to FUSE mount) */
1404 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1407 /** @ingroup G_creating_and_opening_wims
1410 /** Verify the WIM contents against the WIM's integrity table, if present. This
1411 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1412 * checksummed and checked against the SHA1 message digests specified in the
1413 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1414 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1415 * integrity table is invalid). */
1416 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1418 /** Issue an error if the WIM is part of a split WIM. Software can provide
1419 * this flag for convenience if it explicitly does not want to support split
1421 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1423 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1424 * is not. A WIM is considered writable only if it is writable at the
1425 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1426 * header, and is not part of a spanned set. It is not required to provide this
1427 * flag before attempting to make changes to the WIM, but with this flag you get
1428 * an error sooner rather than later. */
1429 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1432 /** @ingroup G_mounting_wim_images
1435 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1436 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1438 /** Unless this flag is given, changes to a read-write mounted WIM are
1439 * discarded. Ignored for read-only mounts. */
1440 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1442 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1443 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1445 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1446 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1448 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1449 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1452 /** @ingroup G_modifying_wims
1455 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1456 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1457 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1460 /** @ingroup G_writing_and_overwriting_wims
1463 /** Include an integrity table in the WIM.
1465 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1466 * an integrity table if and only if one was present before. For WIMs created
1467 * with wimlib_create_new_wim(), the default behavior is to not include an
1468 * integrity table. */
1469 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1471 /** Do not include an integrity table in the new WIM file. This is the default
1472 * behavior, unless the WIM already included an integrity table. */
1473 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1475 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1476 * images from it can be applied directly from a pipe using
1477 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1478 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1479 * with this flag will not be compatible with Microsoft's software.
1481 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1482 * WIM as pipable if and only if it was pipable before. For WIMs created with
1483 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1485 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1487 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1488 * WIM was pipable already. */
1489 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1491 /** Recompress all resources, even if they could otherwise be copied from a
1492 * different WIM with the same compression type (in the case of
1493 * wimlib_export_image() being called previously). This flag is also valid in
1494 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1495 * in the joined WIM file will be recompressed. */
1496 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1498 /** Call fsync() just before the WIM file is closed. */
1499 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1501 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1502 * data to it if possible. */
1503 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1505 /** wimlib_overwrite() only: Specifying this flag overrides the default
1506 * behavior of wimlib_overwrite() after one or more calls to
1507 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1508 * only minimal changes to correctly remove the image from the WIM will be
1509 * taken. In particular, all streams will be left alone, even if they are no
1510 * longer referenced. This is probably not what you want, because almost no
1511 * space will be saved by deleting an image in this way. */
1512 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1514 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1515 * flag is set in the WIM header. This can be used in combination with
1516 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1517 * set the readonly flag on the on-disk WIM file. */
1518 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1520 /** Do not include non-metadata resources already present in other WIMs. This
1521 * flag can be used to write a "delta" WIM after resources from the WIM on which
1522 * the delta is to be based were referenced with
1523 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1524 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1526 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1527 * are already present (not in external resource WIMs) and their reference
1528 * counts are correct, so the code does not need to recalculate which streams
1529 * are referenced. This is for optimization purposes only, since with this flag
1530 * specified, the metadata resources may not need to be decompressed and parsed.
1532 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1533 * already implied for wimlib_overwrite(). */
1534 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1536 #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
1538 /** When writing streams in the resulting WIM file, pack multiple streams into a
1539 * single WIM resource instead of compressing them independently. This tends to
1540 * produce a better compression ratio at the cost of less random access.
1541 * Furthermore, WIMs created with this flag are only compatible with wimlib
1542 * v1.6.0 or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup
1543 * only and <b>not including ImageX and Dism</b>. WIMs created with this flag
1544 * use version number 3584 in their header instead of 68864. If this flag is
1545 * passed to wimlib_overwrite() and the WIM did not previously contain packed
1546 * streams, the WIM's version number will be changed to 3584 and the new streams
1547 * will be written packed. */
1548 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1550 /** Compress all streams independently. This produces a WIM optimized for
1551 * random access and compatibility, as noted in the documentation for
1552 * ::WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS. For wimlib_write(), this is the
1553 * default behavior. For wimlib_overwrite(), this is the default if the WIM file
1554 * did not already contain packed streams. Also, for wimlib_overwrite(), if the
1555 * WIM already contained packed streams, specifying this flag but not
1556 * ::WIMLIB_WRITE_FLAG_REBUILD will cause new streams to be written unpacked,
1557 * but the WIM itself will not be rebuilt and may still contain packed streams.
1559 #define WIMLIB_WRITE_FLAG_NO_PACK_STREAMS 0x00002000
1562 /** @ingroup G_general
1565 /** Assume that strings are represented in UTF-8, even if this is not the
1566 * locale's character encoding. This flag is ignored on Windows, where wimlib
1567 * always uses UTF-16LE. */
1568 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1570 /** Windows-only: do not attempt to acquire additional privileges (currently
1571 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1572 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1573 * for the case where the calling program manages these privileges itself.
1574 * Note: no error is issued if privileges cannot be acquired, although related
1575 * errors may be reported later, depending on if the operations performed
1576 * actually require additional privileges or not. */
1577 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1579 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1580 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1581 * to read all possible data and metadata for a capture operation could not be
1582 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1584 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1586 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1587 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1588 * to restore all possible data and metadata for an apply operation could not be
1589 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1591 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1594 /** @ingroup G_nonstandalone_wims
1597 /** wimlib_reference_resource_files() only: Enable shell-style filename
1599 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1601 /** wimlib_reference_resource_files() only: Issue an error
1602 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1603 * default behavior without this flag is to issue no error at that point, but
1604 * then attempt to open the glob as a literal path, which of course will fail
1605 * anyway if no file exists at that path. No effect if
1606 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. */
1607 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1610 /** @ingroup G_modifying_wims
1613 /** The specific type of update to perform. */
1614 enum wimlib_update_op {
1615 /** Add a new file or directory tree to the WIM image in a
1616 * certain location. */
1617 WIMLIB_UPDATE_OP_ADD = 0,
1619 /** Delete a file or directory tree from the WIM image. */
1620 WIMLIB_UPDATE_OP_DELETE,
1622 /** Rename a file or directory tree in the WIM image. */
1623 WIMLIB_UPDATE_OP_RENAME,
1626 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1627 struct wimlib_add_command {
1628 /** Filesystem path to the file or directory tree to
1630 wimlib_tchar *fs_source_path;
1631 /** Path, specified from the root of the WIM image, at
1632 * which to add the file or directory tree within the
1634 wimlib_tchar *wim_target_path;
1636 /** Configuration for excluded files. @c NULL means
1637 * exclude no files (use no configuration), unless
1638 * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1640 struct wimlib_capture_config *config;
1642 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1646 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1647 struct wimlib_delete_command {
1648 /** Path, specified from the root of the WIM image, for
1649 * the file or directory tree within the WIM image to be
1651 wimlib_tchar *wim_path;
1652 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1656 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1657 struct wimlib_rename_command {
1658 /** Path, specified from the root of the WIM image, for
1659 * the source file or directory tree within the WIM
1661 wimlib_tchar *wim_source_path;
1662 /** Path, specified from the root of the WIM image, for
1663 * the destination file or directory tree within the WIM
1665 wimlib_tchar *wim_target_path;
1666 /** Reserved; set to 0. */
1670 /** Specification of an update to perform on a WIM image. */
1671 struct wimlib_update_command {
1673 enum wimlib_update_op op;
1676 struct wimlib_add_command add;
1677 struct wimlib_delete_command delete_; /* Underscore is for C++
1679 struct wimlib_rename_command rename;
1684 /** @ingroup G_extracting_wims
1687 /** Specification of a file or directory tree to extract from a WIM image. Used
1688 * in calls to wimlib_extract_files(). */
1689 struct wimlib_extract_command {
1690 /** Path to file or directory tree within the WIM image to extract. It
1691 * must be provided as an absolute path from the root of the WIM image.
1692 * The path separators may be either forward slashes or backslashes. */
1693 wimlib_tchar *wim_source_path;
1695 /** Filesystem path to extract the file or directory tree to. */
1696 wimlib_tchar *fs_dest_path;
1698 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1703 /** @ingroup G_compression
1706 /** LZX compression parameters to pass to wimlib_lzx_alloc_context(). */
1707 struct wimlib_lzx_params {
1708 /** Must be set to the size of this structure, in bytes. */
1709 uint32_t size_of_this;
1711 /** Relatively fast LZX compression algorithm with a decent compression
1712 * ratio; the suggested default. */
1713 #define WIMLIB_LZX_ALGORITHM_FAST 0
1715 /** Slower LZX compression algorithm that provides a better compression
1717 #define WIMLIB_LZX_ALGORITHM_SLOW 1
1719 /** Algorithm to use to perform the compression: either
1720 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
1721 * format is still LZX; this refers to the method the code will use to
1722 * perform LZX-compatible compression. */
1723 uint32_t algorithm : 3;
1725 /** If set to 1, the default parameters for the specified algorithm are
1726 * used rather than the ones specified in the following union. */
1727 uint32_t use_defaults : 1;
1730 /** Parameters for the fast algorithm. */
1731 struct wimlib_lzx_fast_params {
1732 uint32_t fast_reserved1[10];
1735 /** Parameters for the slow algorithm. */
1736 struct wimlib_lzx_slow_params {
1737 /** If set to 1, the compressor can output length 2
1738 * matches. If set 0, the compressor only outputs
1739 * matches of length 3 or greater. Suggested value: 1
1741 uint32_t use_len2_matches : 1;
1743 uint32_t slow_reserved1 : 31;
1745 /** Matches with length (in bytes) longer than this
1746 * value are immediately taken without spending time on
1747 * minimum-cost measurements. Suggested value: 32. */
1748 uint32_t num_fast_bytes;
1750 /** Number of passes to compute a match/literal sequence
1751 * for each LZX block. This is for an iterative
1752 * algorithm that attempts to minimize the cost of the
1753 * match/literal sequence by using a cost model provided
1754 * by the previous iteration. Must be at least 1.
1755 * Suggested value: 2. */
1756 uint32_t num_optim_passes;
1758 /** Reserved; set to 0. */
1759 uint32_t slow_reserved_blocksplit;
1761 /** Maximum depth to search for matches at each
1762 * position. Suggested value: 50. */
1763 uint32_t max_search_depth;
1765 /** Maximum number of potentially good matches to
1766 * consider for each position. Suggested value: 3. */
1767 uint32_t max_matches_per_pos;
1769 uint32_t slow_reserved2[2];
1771 /** Assumed cost of a main symbol with zero frequency.
1772 * Must be at least 1 and no more than 16. Suggested
1774 uint8_t main_nostat_cost;
1776 /** Assumed cost of a length symbol with zero frequency.
1777 * Must be at least 1 and no more than 16. Suggested
1779 uint8_t len_nostat_cost;
1781 /** Assumed cost of an aligned symbol with zero
1782 * frequency. Must be at least 1 and no more than 8.
1783 * Suggested value: 7. */
1784 uint8_t aligned_nostat_cost;
1786 uint8_t slow_reserved3[5];
1791 /** Opaque LZX compression context. */
1792 struct wimlib_lzx_context;
1795 /** @ingroup G_general
1799 * Possible values of the error code returned by many functions in wimlib.
1801 * See the documentation for each wimlib function to see specifically what error
1802 * codes can be returned by a given function, and what they mean.
1804 enum wimlib_error_code {
1805 WIMLIB_ERR_SUCCESS = 0,
1806 WIMLIB_ERR_ALREADY_LOCKED,
1807 WIMLIB_ERR_DECOMPRESSION,
1808 WIMLIB_ERR_DELETE_STAGING_DIR,
1809 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1812 WIMLIB_ERR_FUSERMOUNT,
1813 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1814 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1815 WIMLIB_ERR_IMAGE_COUNT,
1816 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1817 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1818 WIMLIB_ERR_INTEGRITY,
1819 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1820 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1821 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1822 WIMLIB_ERR_INVALID_HEADER,
1823 WIMLIB_ERR_INVALID_IMAGE,
1824 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1825 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1826 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1827 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1828 WIMLIB_ERR_INVALID_OVERLAY,
1829 WIMLIB_ERR_INVALID_PARAM,
1830 WIMLIB_ERR_INVALID_PART_NUMBER,
1831 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1832 WIMLIB_ERR_INVALID_REPARSE_DATA,
1833 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1834 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1835 WIMLIB_ERR_INVALID_UTF16_STRING,
1836 WIMLIB_ERR_INVALID_UTF8_STRING,
1837 WIMLIB_ERR_IS_DIRECTORY,
1838 WIMLIB_ERR_IS_SPLIT_WIM,
1839 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1841 WIMLIB_ERR_METADATA_NOT_FOUND,
1846 WIMLIB_ERR_NOTEMPTY,
1847 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1848 WIMLIB_ERR_NOT_A_WIM_FILE,
1849 WIMLIB_ERR_NOT_PIPABLE,
1850 WIMLIB_ERR_NO_FILENAME,
1854 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1856 WIMLIB_ERR_READLINK,
1859 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1860 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1861 WIMLIB_ERR_RESOURCE_ORDER,
1862 WIMLIB_ERR_SET_ATTRIBUTES,
1863 WIMLIB_ERR_SET_REPARSE_DATA,
1864 WIMLIB_ERR_SET_SECURITY,
1865 WIMLIB_ERR_SET_SHORT_NAME,
1866 WIMLIB_ERR_SET_TIMESTAMPS,
1867 WIMLIB_ERR_SPLIT_INVALID,
1870 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1871 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1872 WIMLIB_ERR_UNKNOWN_VERSION,
1873 WIMLIB_ERR_UNSUPPORTED,
1874 WIMLIB_ERR_UNSUPPORTED_FILE,
1875 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1876 WIMLIB_ERR_WIM_IS_READONLY,
1882 /** Used to indicate no WIM image or an invalid WIM image. */
1883 #define WIMLIB_NO_IMAGE 0
1885 /** Used to specify all images in the WIM. */
1886 #define WIMLIB_ALL_IMAGES (-1)
1889 * @ingroup G_modifying_wims
1891 * Appends an empty image to a WIM file. This empty image will initially
1892 * contain no files or directories, although if written without further
1893 * modifications, a root directory will be created automatically for it. After
1894 * calling this function, you can use wimlib_update_image() to add files to the
1895 * new WIM image. This gives you slightly more control over making the new
1896 * image compared to calling wimlib_add_image() or
1897 * wimlib_add_image_multisource() directly.
1900 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1903 * Name to give the new image. If @c NULL or empty, the new image is given
1904 * no name. If nonempty, it must specify a name that does not already
1906 * @param new_idx_ret
1907 * If non-<code>NULL</code>, the index of the newly added image is returned
1910 * @return 0 on success; nonzero on failure. The possible error codes are:
1912 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1913 * There is already an image in @p wim named @p name.
1914 * @retval ::WIMLIB_ERR_NOMEM
1915 * Failed to allocate the memory needed to add the new image.
1916 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1917 * The WIM file is considered read-only because of any of the reasons
1918 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1922 wimlib_add_empty_image(WIMStruct *wim,
1923 const wimlib_tchar *name,
1927 * @ingroup G_modifying_wims
1929 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1931 * The directory tree or NTFS volume is scanned immediately to load the dentry
1932 * tree into memory, and file attributes and symbolic links are read. However,
1933 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1936 * See the manual page for the @b wimlib-imagex program for more information
1937 * about the "normal" capture mode versus the NTFS capture mode (entered by
1938 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1940 * Note that @b no changes are committed to the underlying WIM file (if
1941 * any) until wimlib_write() or wimlib_overwrite() is called.
1944 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1947 * A path to a directory or unmounted NTFS volume that will be captured as
1950 * Name to give the new image. If @c NULL or empty, the new image is given
1951 * no name. If nonempty, it must specify a name that does not already
1954 * Capture configuration that specifies files, directories, or path globs
1955 * to exclude from being captured. If @c NULL, a dummy configuration where
1956 * no paths are treated specially is used.
1958 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1959 * @param progress_func
1960 * If non-NULL, a function that will be called periodically with the
1961 * progress of the current operation. The progress messages that will be
1962 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1963 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1964 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1966 * @return 0 on success; nonzero on error. On error, changes to @p wim are
1967 * discarded so that it appears to be in the same state as when this function
1970 * This function is implemented by calling wimlib_add_empty_image(), then
1971 * calling wimlib_update_image() with a single "add" command, so any error code
1972 * returned by wimlib_add_empty_image() may be returned, as well as any error
1973 * codes returned by wimlib_update_image() other than ones documented as only
1974 * being returned specifically by an update involving delete or rename commands.
1977 wimlib_add_image(WIMStruct *wim,
1978 const wimlib_tchar *source,
1979 const wimlib_tchar *name,
1980 const struct wimlib_capture_config *config,
1982 wimlib_progress_func_t progress_func);
1985 * @ingroup G_modifying_wims
1987 * This function is equivalent to wimlib_add_image() except it allows for
1988 * multiple sources to be combined into a single WIM image. This is done by
1989 * specifying the @p sources and @p num_sources parameters instead of the @p
1990 * source parameter of wimlib_add_image(). The rest of the parameters are the
1991 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1992 * capture</b> for full details on how this mode works.
1994 * In addition to the error codes that wimlib_add_image() can return,
1995 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1996 * when trying to overlay a non-directory on a directory or when otherwise
1997 * trying to overlay multiple conflicting files to the same location in the WIM
1998 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1999 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2000 * was not exactly one capture source with the target being the root directory.
2001 * (In this respect, there is no advantage to using
2002 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2005 wimlib_add_image_multisource(WIMStruct *wim,
2006 const struct wimlib_capture_source *sources,
2008 const wimlib_tchar *name,
2009 const struct wimlib_capture_config *config,
2011 wimlib_progress_func_t progress_func);
2014 * @ingroup G_creating_and_opening_wims
2016 * Creates a ::WIMStruct for a new WIM file.
2018 * This only creates an in-memory structure for a WIM that initially contains no
2019 * images. No on-disk file is created until wimlib_write() is called.
2022 * The type of compression to be used in the new WIM file. Must be
2023 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
2024 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
2026 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2027 * written to the memory location pointed to by this paramater. The
2028 * ::WIMStruct must be freed using using wimlib_free() when finished with
2030 * @return 0 on success; nonzero on error.
2031 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2032 * @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
2033 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
2034 * @retval ::WIMLIB_ERR_NOMEM
2035 * Failed to allocate needed memory.
2038 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2041 * @ingroup G_modifying_wims
2043 * Deletes an image, or all images, from a WIM file.
2045 * All streams referenced by the image(s) being deleted are removed from the
2046 * lookup table of the WIM if they are not referenced by any other images in the
2049 * Please note that @b no changes are committed to the underlying WIM file (if
2050 * any) until wimlib_write() or wimlib_overwrite() is called.
2053 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2056 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2058 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2059 * to be left unmodified only if @p image specified a single image. If instead
2060 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2061 * possible for some but not all of the images to have been deleted when a
2062 * failure status is returned.
2064 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2065 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2066 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2067 * The WIM file is considered read-only because of any of the reasons
2068 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2071 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2072 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2073 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2074 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2075 * different reasons) to read the metadata resource for an image that needed to
2079 wimlib_delete_image(WIMStruct *wim, int image);
2082 * @ingroup G_modifying_wims
2084 * Exports an image, or all the images, from a WIM file, into another WIM file.
2086 * The destination image is made to share the same dentry tree and security data
2087 * structure as the source image. This places some restrictions on additional
2088 * functions that may be called. wimlib_mount_image() may not be called on
2089 * either the source image or the destination image without an intervening call
2090 * to a function that un-shares the images, such as wimlib_free() on @p
2091 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2092 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2093 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2094 * have references back to @p src_wim.
2096 * If this function fails, all changes to @p dest_wim are rolled back.
2098 * Please note that no changes are committed to the underlying WIM file of @p
2099 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2102 * The WIM from which to export the images, specified as a pointer to the
2103 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2104 * split WIM. In the case of a WIM file that is not standalone, this
2105 * ::WIMStruct must have had any needed external resources previously
2106 * referenced using wimlib_reference_resources() or
2107 * wimlib_reference_resource_files().
2109 * The image to export from @p src_wim, as either a 1-based image index to
2110 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2112 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2115 * For single-image exports, the name to give the exported image in @p
2116 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2117 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2118 * that case, the names are all taken from @p src_wim. This parameter is
2119 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2120 * @param dest_description
2121 * For single-image exports, the description to give the exported image in
2122 * the new WIM file. If left @c NULL, the description from @p src_wim is
2123 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2124 * NULL; in that case, the description are all taken from @p src_wim. This
2125 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2126 * @param export_flags
2127 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2128 * @param progress_func
2129 * Currently ignored, but reserved for a function that will be called with
2130 * information about the operation. Use NULL if no additional information
2133 * @return 0 on success; nonzero on error.
2134 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2135 * One or more of the names being given to an exported image was already in
2136 * use in the destination WIM.
2137 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2138 * @p src_image does not exist in @p src_wim and was not
2139 * ::WIMLIB_ALL_IMAGES.
2140 * @retval ::WIMLIB_ERR_INVALID_PARAM
2141 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2142 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2144 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2145 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2146 * example, one of them was a non-first part of a split WIM.
2147 * @retval ::WIMLIB_ERR_NOMEM
2148 * Failed to allocate needed memory.
2149 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2150 * A resource that needed to be exported could not be found in either the
2151 * source or destination WIMs. This error can occur if, for example, @p
2152 * src_wim is part of a split WIM but needed resources from the other split
2153 * WIM parts were not referenced with wimlib_reference_resources() or
2154 * wimlib_reference_resource_files() before the call to
2155 * wimlib_export_image().
2156 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2157 * @p dest_wim is considered read-only because of any of the reasons
2158 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2161 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2162 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2163 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2164 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2165 * different reasons) to read the metadata resource for an image in @p src_wim
2166 * that needed to be exported.
2169 wimlib_export_image(WIMStruct *src_wim, int src_image,
2170 WIMStruct *dest_wim,
2171 const wimlib_tchar *dest_name,
2172 const wimlib_tchar *dest_description,
2174 wimlib_progress_func_t progress_func);
2177 * @ingroup G_extracting_wims
2179 * Extract zero or more files or directory trees from a WIM image.
2181 * This generalizes the single-image extraction functionality of
2182 * wimlib_extract_image() to allow extracting only the specified subsets of the
2186 * The WIM from which to extract the files, specified as a pointer to the
2187 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2188 * split WIM. In the case of a WIM file that is not standalone, this
2189 * ::WIMStruct must have had any needed external resources previously
2190 * referenced using wimlib_reference_resources() or
2191 * wimlib_reference_resource_files().
2194 * The 1-based number of the image in @p wim from which the files or
2195 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
2198 * An array of ::wimlib_extract_command structures that specifies the
2199 * extractions to perform.
2202 * Number of commands in the @p cmds array.
2204 * @param default_extract_flags
2205 * Default extraction flags; the behavior shall be as if these flags had
2206 * been specified in the ::wimlib_extract_command.extract_flags member in
2207 * each extraction command, in combination with any flags already present.
2209 * @param progress_func
2210 * If non-NULL, a function that will be called periodically with the
2211 * progress of the current operation.
2213 * @return 0 on success; nonzero on error. The possible error codes include
2214 * most of those documented as returned by wimlib_extract_image() as well as the
2215 * following additional error codes:
2217 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2218 * @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
2220 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2221 * The ::wimlib_extract_command.wim_source_path member in one of the
2222 * extract commands did not exist in the WIM.
2223 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2224 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
2225 * in which ::wimlib_extract_command.wim_source_path existed but was not a
2226 * regular file or directory.
2227 * @retval ::WIMLIB_ERR_INVALID_PARAM
2228 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
2229 * specified for some commands but not all; or
2230 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
2231 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
2232 * for a command in which ::wimlib_extract_command.wim_source_path did not
2233 * specify the root directory of the WIM image.
2236 wimlib_extract_files(WIMStruct *wim,
2238 const struct wimlib_extract_command *cmds,
2240 int default_extract_flags,
2241 wimlib_progress_func_t progress_func);
2244 * @ingroup G_extracting_wims
2246 * Extracts an image, or all images, from a WIM to a directory or directly to a
2247 * NTFS volume image.
2249 * The exact behavior of how wimlib extracts files from a WIM image is
2250 * controllable by the @p extract_flags parameter, but there also are
2251 * differences depending on the platform (UNIX-like vs Windows). See the manual
2252 * page for <b>wimlib-imagex apply</b> for more information, including about the
2253 * special "NTFS volume extraction mode" entered by providing
2254 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2256 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
2257 * returned if any resulting SHA1 message digests do not match the values
2258 * provided in the WIM file. Therefore, if this function is successful, you can
2259 * be fairly sure that any compressed data in the WIM was uncompressed
2263 * The WIM from which to extract the image(s), specified as a pointer to
2264 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2265 * of a split WIM. In the case of a WIM file that is not standalone, this
2266 * ::WIMStruct must have had any needed external resources previously
2267 * referenced using wimlib_reference_resources() or
2268 * wimlib_reference_resource_files().
2270 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
2271 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
2272 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2274 * Directory to extract the WIM image(s) to (created if it does not already
2275 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
2276 * path to the unmounted NTFS volume to extract the image to.
2277 * @param extract_flags
2278 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
2279 * @param progress_func
2280 * If non-NULL, a function that will be called periodically with the
2281 * progress of the current operation.
2283 * @return 0 on success; nonzero on error.
2284 * @retval ::WIMLIB_ERR_DECOMPRESSION
2285 * Failed to decompress a resource to be extracted.
2286 * @retval ::WIMLIB_ERR_INVALID_PARAM
2287 * Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
2288 * were specified in @p extract_flags; or both
2289 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
2290 * specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
2291 * ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
2292 * ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
2293 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
2294 * @p image was ::WIMLIB_ALL_IMAGES.
2295 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2296 * The SHA1 message digest of an extracted stream did not match the SHA1
2297 * message digest given in the WIM file.
2298 * @retval ::WIMLIB_ERR_LINK
2299 * Failed to create a symbolic link or a hard link.
2300 * @retval ::WIMLIB_ERR_MKDIR
2301 * Failed create a directory.
2302 * @retval ::WIMLIB_ERR_NOMEM
2303 * Failed to allocate needed memory.
2304 * @retval ::WIMLIB_ERR_OPEN
2305 * Could not create a file, or failed to open an already-extracted file.
2306 * @retval ::WIMLIB_ERR_READ
2307 * Failed to read data from the WIM file associated with @p wim.
2308 * @retval ::WIMLIB_ERR_READLINK
2309 * Failed to determine the target of a symbolic link in the WIM.
2310 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2311 * Failed to fix the target of an absolute symbolic link (e.g. if the
2312 * target would have exceeded the maximum allowed length). (Only if
2313 * reparse data was supported by the extraction mode and
2314 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
2315 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2316 * One of the files or directories that needed to be extracted referenced a
2317 * stream not present in the WIM's lookup table (or in any of the lookup
2318 * tables of the split WIM parts).
2319 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2320 * Failed to set attributes on a file.
2321 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2322 * Failed to set reparse data on a file (only if reparse data was supported
2323 * by the extraction mode).
2324 * @retval ::WIMLIB_ERR_SET_SECURITY
2325 * Failed to set security descriptor on a file
2326 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2328 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2329 * Failed to set the short name of a file (only if
2330 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2331 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2332 * Failed to set timestamps on a file (only if
2333 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2334 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2335 * Unexpected end-of-file occurred when reading data from the WIM file
2336 * associated with @p wim.
2337 * @retval ::WIMLIB_ERR_UNSUPPORTED
2338 * A requested extraction flag, or the data or metadata that must be
2339 * extracted to support it, is unsupported in the build and configuration
2340 * of wimlib, or on the current platform or extraction mode or target
2341 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2342 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2343 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2344 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2345 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2346 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2347 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2349 * ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
2350 * or more files with short names, but extracting short names is not
2351 * supported --- on Windows, this occurs if the target volume does not
2352 * support short names, while on non-Windows, this occurs if
2353 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2354 * @retval ::WIMLIB_ERR_WRITE
2355 * Failed to write data to a file being extracted.
2357 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2358 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2359 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2360 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2361 * different reasons) to read the metadata resource for an image that needed to
2365 wimlib_extract_image(WIMStruct *wim, int image,
2366 const wimlib_tchar *target,
2368 wimlib_progress_func_t progress_func);
2371 * @ingroup G_extracting_wims
2373 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
2374 * pipable WIM is being sent.
2376 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2377 * about pipable WIMs.
2379 * This function operates in a special way to read the WIM fully sequentially.
2380 * As a result, there is no ::WIMStruct is made visible to library users, and
2381 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2382 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2383 * seekable file, not a pipe.)
2386 * File descriptor, which may be a pipe, opened for reading and positioned
2387 * at the start of the pipable WIM.
2388 * @param image_num_or_name
2389 * String that specifies the 1-based index or name of the image to extract.
2390 * It is translated to an image index using the same rules that
2391 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2392 * only a single image (not all images) can be specified. Alternatively,
2393 * specify @p NULL here to use the first image in the WIM if it contains
2394 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2396 * Same as the corresponding parameter to wimlib_extract_image().
2397 * @param extract_flags
2398 * Same as the corresponding parameter to wimlib_extract_image(), except
2399 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
2400 * always implied, since data is always read from @p pipe_fd sequentially
2401 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
2402 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2403 * @param progress_func
2404 * Same as the corresponding parameter to wimlib_extract_image(), except
2405 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2408 * @return 0 on success; nonzero on error. The possible error codes include
2409 * those returned by wimlib_extract_image() as well as the following:
2411 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2412 * Data read from the pipable WIM was invalid.
2413 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2414 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2417 wimlib_extract_image_from_pipe(int pipe_fd,
2418 const wimlib_tchar *image_num_or_name,
2419 const wimlib_tchar *target, int extract_flags,
2420 wimlib_progress_func_t progress_func);
2423 * @ingroup G_wim_information
2425 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2426 * includes a string of XML that describes the images contained in the WIM.
2428 * See wimlib_get_xml_data() to read the XML data into memory instead.
2431 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2432 * have to be standalone (e.g. it could be part of a split WIM).
2434 * @c stdout, or a FILE* opened for writing, to extract the data to.
2436 * @return 0 on success; nonzero on error.
2437 * @retval ::WIMLIB_ERR_INVALID_PARAM
2438 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2439 * @retval ::WIMLIB_ERR_NOMEM
2440 * @retval ::WIMLIB_ERR_READ
2441 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2442 * Failed to read the XML data from the WIM.
2443 * @retval ::WIMLIB_ERR_WRITE
2444 * Failed to completely write the XML data to @p fp.
2447 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2450 * @ingroup G_general
2452 * Frees all memory allocated for a WIMStruct and closes all files associated
2456 * Pointer to the ::WIMStruct for a WIM file.
2458 * @return This function has no return value.
2461 wimlib_free(WIMStruct *wim);
2464 * @ingroup G_general
2466 * Converts a ::wimlib_compression_type value into a string.
2469 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2470 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2473 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2476 extern const wimlib_tchar *
2477 wimlib_get_compression_type_string(int ctype);
2480 * @ingroup G_general
2482 * Converts an error code into a string describing it.
2485 * The error code returned by one of wimlib's functions.
2488 * Pointer to a statically allocated string describing the error code,
2489 * or @c NULL if the error code is not valid.
2491 extern const wimlib_tchar *
2492 wimlib_get_error_string(enum wimlib_error_code code);
2495 * @ingroup G_wim_information
2497 * Returns the description of the specified image.
2500 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2501 * to be standalone (e.g. it could be part of a split WIM).
2503 * The number of the image, numbered starting at 1.
2506 * The description of the image, or @c NULL if there is no such image, or
2507 * @c NULL if the specified image has no description. The description
2508 * string is in library-internal memory and may not be modified or freed;
2509 * in addition, the string will become invalid if the description of the
2510 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2512 extern const wimlib_tchar *
2513 wimlib_get_image_description(const WIMStruct *wim, int image);
2516 * @ingroup G_wim_information
2518 * Returns the name of the specified image.
2521 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2522 * to be standalone (e.g. it could be part of a split WIM).
2524 * The number of the image, numbered starting at 1.
2527 * The name of the image, or @c NULL if there is no such image, or an empty
2528 * string if the image is unnamed. The name string is in
2529 * library-internal memory and may not be modified or freed; in addition,
2530 * the string will become invalid if the name of the image is changed, the
2531 * image is deleted, or the ::WIMStruct is destroyed.
2533 extern const wimlib_tchar *
2534 wimlib_get_image_name(const WIMStruct *wim, int image);
2538 * @ingroup G_wim_information
2540 * Get basic information about a WIM file.
2543 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2544 * to be standalone (e.g. it could be part of a split WIM).
2546 * A ::wimlib_wim_info structure that will be filled in with information
2547 * about the WIM file.
2552 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2555 * @ingroup G_wim_information
2557 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2558 * includes a string of XML that describes the images contained in the WIM.
2560 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2564 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2565 * have to be standalone (e.g. it could be part of a split WIM).
2567 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2568 * XML data is written to this location.
2569 * @param bufsize_ret
2570 * The size of the XML data in bytes is written to this location.
2572 * @return 0 on success; nonzero on error.
2573 * @retval ::WIMLIB_ERR_INVALID_PARAM
2574 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2575 * @p buf_ret or @p bufsize_ret was @c NULL.
2576 * @retval ::WIMLIB_ERR_NOMEM
2577 * @retval ::WIMLIB_ERR_READ
2578 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2579 * Failed to read the XML data from the WIM.
2582 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2585 * @ingroup G_general
2587 * Initialization function for wimlib. Call before using any other wimlib
2588 * function except wimlib_set_print_errors(). If not done manually, this
2589 * function will be called automatically with @p init_flags set to
2590 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.
2593 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2595 * @return 0 on success; nonzero on failure. Currently, only the following
2596 * error code is defined:
2598 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2599 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2600 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2601 * init_flags, but the corresponding privileges could not be acquired.
2604 wimlib_global_init(int init_flags);
2607 * @ingroup G_general
2609 * Cleanup function for wimlib. You are not required to call this function, but
2610 * it will release any global resources allocated by the library.
2613 wimlib_global_cleanup(void);
2616 * @ingroup G_wim_information
2618 * Determines if an image name is already used by some image in the WIM.
2621 * Pointer to the ::WIMStruct for a WIM file.
2623 * The name to check.
2626 * @c true if there is already an image in @p wim named @p name; @c false
2627 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2628 * the empty string, @c false is returned.
2631 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2634 * @ingroup G_wim_information
2636 * Iterate through a file or directory tree in the WIM image. By specifying
2637 * appropriate flags and a callback function, you can get the attributes of a
2638 * file in the WIM, get a directory listing, or even get a listing of the entire
2642 * The WIM containing the image(s) over which to iterate, specified as a
2643 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2644 * or part 1 of a split WIM. In the case of a WIM file that is not
2645 * standalone, this ::WIMStruct should have had any needed external
2646 * resources previously referenced using wimlib_reference_resources() or
2647 * wimlib_reference_resource_files(). If not, see
2648 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2649 * the behavior when resources are missing.
2652 * The 1-based number of the image in @p wim that contains the files or
2653 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2654 * iteration on all images in the WIM.
2657 * Path in the WIM image at which to do the iteration.
2660 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2663 * A callback function that will receive each directory entry.
2666 * An extra parameter that will always be passed to the callback function
2669 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2670 * first nonzero value that was returned from @p cb. However, additional error
2671 * codes may be returned, including the following:
2673 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2674 * @p path did not exist in the WIM image.
2675 * @retval ::WIMLIB_ERR_NOMEM
2676 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2678 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2679 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2680 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2681 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2682 * different reasons) to read the metadata resource for an image over which
2683 * iteration needed to be done.
2686 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2688 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2691 * @ingroup G_wim_information
2693 * Iterate through the lookup table of a WIM file. This can be used to directly
2694 * get a listing of the unique resources contained in a WIM file over all
2695 * images. Both file resources and metadata resources are included. However,
2696 * only resources actually included in the file represented by @a wim, plus
2697 * explicitly referenced external resources (via wimlib_reference_resources() or
2698 * wimlib_reference_resource_files()) are included in the iteration. For
2699 * example, if @p wim represents just one part of a split WIM, then only
2700 * resources in that part will be included, unless other resources were
2701 * explicitly referenced.
2704 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2705 * to be standalone (e.g. it could be part of a split WIM).
2708 * Reserved; set to 0.
2711 * A callback function that will receive each resource.
2714 * An extra parameter that will always be passed to the callback function
2717 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2718 * that was returned from @p cb.
2721 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2722 wimlib_iterate_lookup_table_callback_t cb,
2726 * @ingroup G_nonstandalone_wims
2728 * Joins a split WIM into a stand-alone one-part WIM.
2731 * An array of strings that gives the filenames of all parts of the split
2732 * WIM. No specific order is required, but all parts must be included with
2735 * Number of filenames in @p swms.
2736 * @param swm_open_flags
2737 * Open flags for the split WIM parts (e.g.
2738 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2739 * @param wim_write_flags
2740 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2741 * be used to write the joined WIM.
2742 * @param output_path
2743 * The path to write the joined WIM file to.
2744 * @param progress_func
2745 * If non-NULL, a function that will be called periodically with the
2746 * progress of the current operation.
2748 * @return 0 on success; nonzero on error. This function may return most error
2749 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2750 * as the following error code:
2752 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2753 * The split WIMs do not form a valid WIM because they do not include all
2754 * the parts of the original WIM, there are duplicate parts, or not all the
2755 * parts have the same GUID and compression type.
2757 * Note: wimlib is generalized enough that this function is not actually needed
2758 * to join a split WIM; instead, you could open the first part of the split WIM,
2759 * then reference the other parts with wimlib_reference_resource_files(), then
2760 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2761 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2765 wimlib_join(const wimlib_tchar * const *swms,
2767 const wimlib_tchar *output_path,
2769 int wim_write_flags,
2770 wimlib_progress_func_t progress_func);
2773 * @ingroup G_compression
2775 * Decompresses a block of LZMS-compressed data.
2777 * This function is exported for convenience only and should only be used by
2778 * library clients looking to make use of wimlib's compression code for another
2781 * This decompressor only implements "raw" decompression, which decompresses a
2782 * single LZMS-compressed block. This behavior is the same as that of
2783 * Decompress() in the Windows 8 compression API when using a compression handle
2784 * created with CreateDecompressor() with the Algorithm parameter specified as
2785 * COMPRESS_ALGORITHM_LZMS | COMPRESS_RAW. Presumably, non-raw LZMS data
2786 * is a container format from which the locations and sizes (both compressed and
2787 * uncompressed) of the constituent blocks can be determined.
2789 * This function should not be called for blocks with compressed size equal to
2790 * uncompressed size, since such blocks are actually stored uncompressed.
2792 * @param compressed_data
2793 * Pointer to the compressed data.
2795 * @param compressed_len
2796 * Length of the compressed data, in bytes.
2798 * @param uncompressed_data
2799 * Pointer to the buffer into which to write the uncompressed data.
2801 * @param uncompressed_len
2802 * Length of the uncompressed data.
2805 * 0 on success; non-zero on failure.
2808 wimlib_lzms_decompress(const void *compressed_data, unsigned compressed_len,
2809 void *uncompressed_data, unsigned uncompressed_len);
2812 * @ingroup G_compression
2814 * Compress a chunk of a WIM resource using LZX compression.
2816 * This function is exported for convenience only and should only be used by
2817 * library clients looking to make use of wimlib's compression code for another
2821 * Uncompressed data of the chunk.
2823 * Size of the uncompressed chunk, in bytes.
2825 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2828 * The size of the compressed data written to @p out in bytes, or 0 if the
2829 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2831 * As a special requirement, the compression code is optimized for the WIM
2832 * format and therefore requires (@p chunk_size <= 32768).
2835 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out)
2839 * @ingroup G_compression
2841 * Equivalent to wimlib_lzx_compress(), but uses the specified compression
2842 * context, allocated by wimlib_lzx_alloc_context().
2845 wimlib_lzx_compress2(const void *chunk, unsigned chunk_size, void *out,
2846 struct wimlib_lzx_context *ctx);
2849 * @ingroup G_compression
2851 * Allocate a LZX compression context using the specified parameters.
2853 * This function is exported for convenience only and should only be used by
2854 * library clients looking to make use of wimlib's compression code for another
2857 * @param window_size
2858 * Size of the LZX window. Must be a power of 2 between 2^15 and 2^21,
2862 * Compression parameters to use, or @c NULL to use the default parameters.
2865 * A pointer to either @c NULL or an existing ::wimlib_lzx_context. If
2866 * <code>*ctx_ret == NULL</code>, the new context is allocated. If
2867 * <code>*ctx_ret != NULL</code>, the existing context is re-used if
2868 * possible. Alternatively, this argument can itself be @c NULL to
2869 * indicate that only parameter validation is to be performed.
2871 * @return 0 on success; nonzero on error.
2873 * @retval ::WIMLIB_ERR_INVALID_PARAM
2874 * The window size or compression parameters were invalid.
2875 * @retval ::WIMLIB_ERR_NOMEM
2876 * Not enough memory to allocate the compression context.
2879 wimlib_lzx_alloc_context(uint32_t window_size,
2880 const struct wimlib_lzx_params *params,
2881 struct wimlib_lzx_context **ctx_pp);
2884 * @ingroup G_compression
2886 * Decompresses a block of LZX-compressed data as used in the WIM file format.
2888 * Note that this will NOT work unmodified for LZX as used in the cabinet
2889 * format, which is not the same as in the WIM format!
2891 * This function is exported for convenience only and should only be used by
2892 * library clients looking to make use of wimlib's compression code for another
2895 * @param compressed_data
2896 * Pointer to the compressed data.
2898 * @param compressed_len
2899 * Length of the compressed data, in bytes.
2901 * @param uncompressed_data
2902 * Pointer to the buffer into which to write the uncompressed data.
2904 * @param uncompressed_len
2905 * Length of the uncompressed data. It must be 32768 bytes or less.
2908 * 0 on success; non-zero on failure.
2911 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2912 void *uncompressed_data, unsigned uncompressed_len);
2915 * @ingroup G_compression
2917 * Equivalent to wimlib_lzx_decompress(), except the window size is specified in
2918 * @p max_window_size as any power of 2 between 2^15 and 2^21, inclusively, and
2919 * @p uncompressed_len may be any size less than or equal to @p max_window_size.
2922 wimlib_lzx_decompress2(const void *compressed_data, unsigned compressed_len,
2923 void *uncompressed_data, unsigned uncompressed_len,
2924 uint32_t max_window_size);
2927 * @ingroup G_compression
2929 * Free the specified LZX compression context, allocated with
2930 * wimlib_lzx_alloc_context().
2933 wimlib_lzx_free_context(struct wimlib_lzx_context *ctx);
2936 * @ingroup G_compression
2938 * Set the global default LZX compression parameters.
2941 * The LZX compression parameters to set. These default parameters will be
2942 * used by any calls to wimlib_lzx_alloc_context() with @c NULL LZX
2943 * parameters specified, as well as by any future compression performed by
2944 * the library itself. Passing @p NULL here resets the default LZX
2945 * parameters to their original value.
2947 * @return 0 on success; nonzero on error.
2949 * @retval ::WIMLIB_ERR_INVALID_PARAM
2950 * The compression parameters were invalid.
2953 wimlib_lzx_set_default_params(const struct wimlib_lzx_params *params);
2956 * @ingroup G_compression
2958 * Free the specified LZX compression context, allocated with
2959 * wimlib_lzx_alloc_context().
2962 wimlib_lzx_free_context(struct wimlib_lzx_context *ctx);
2966 * @ingroup G_mounting_wim_images
2968 * Mounts an image in a WIM file on a directory read-only or read-write.
2970 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2971 * supported if wimlib was configured with @c --without-fuse. This includes
2972 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2975 * Calling this function daemonizes the process, unless
2976 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2977 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2978 * to the WIM are staged in a temporary directory.
2980 * It is safe to mount multiple images from the same underlying WIM file
2981 * read-only at the same time, but only if different ::WIMStruct's are used. It
2982 * is @b not safe to mount multiple images from the same WIM file read-write at
2985 * wimlib_mount_image() cannot be used on an image that was exported with
2986 * wimlib_export_image() while the dentry trees for both images are still in
2987 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2988 * that already has modifications pending (e.g. an image added with
2989 * wimlib_add_image()).
2992 * Pointer to the ::WIMStruct containing the image to be mounted.
2994 * The number of the image to mount, indexed starting from it. It must be
2995 * an existing, single image.
2997 * The path to an existing empty directory to mount the image on.
2998 * @param mount_flags
2999 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
3000 * @param staging_dir
3001 * If non-NULL, the name of a directory in which the staging directory will
3002 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
3003 * in @p mount_flags. If left @c NULL, the staging directory is created in
3004 * the same directory as the WIM file that @p wim was originally read from.
3006 * @return 0 on success; nonzero on error.
3008 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3009 * A read-write mount was requested, but an an exclusive advisory lock on
3010 * the on-disk WIM file could not be acquired because another thread or
3011 * process has mounted an image from the WIM read-write or is currently
3012 * modifying the WIM in-place.
3013 * @retval ::WIMLIB_ERR_FUSE
3014 * A non-zero status was returned by @c fuse_main().
3015 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3016 * @p image does not specify an existing, single image in @p wim.
3017 * @retval ::WIMLIB_ERR_INVALID_PARAM
3018 * @p image is shared among multiple ::WIMStruct's as a result of a call to
3019 * wimlib_export_image(), or @p image has been added with
3020 * wimlib_add_image().
3021 * @retval ::WIMLIB_ERR_MKDIR
3022 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3023 * staging directory could not be created.
3024 * @retval ::WIMLIB_ERR_NOTDIR
3025 * Could not determine the current working directory.
3026 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3027 * One of the dentries in the image referenced a stream not present in the
3028 * WIM's lookup table (or in any of the lookup tables of the split WIM
3030 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3031 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
3032 * wim is considered read-only because of any of the reasons mentioned in
3033 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3034 * @retval ::WIMLIB_ERR_UNSUPPORTED
3035 * Mounting is not supported, either because the platform is Windows, or
3036 * because the platform is UNIX-like and wimlib was compiled with @c
3039 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3040 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3041 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3042 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3043 * different reasons) to read the metadata resource for the image to mount.
3046 wimlib_mount_image(WIMStruct *wim,
3048 const wimlib_tchar *dir,
3050 const wimlib_tchar *staging_dir);
3053 * @ingroup G_creating_and_opening_wims
3055 * Opens a WIM file and creates a ::WIMStruct for it.
3058 * The path to the WIM file to open.
3061 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3063 * @param progress_func
3064 * If non-NULL, a function that will be called periodically with the
3065 * progress of the current operation. Currently, the only messages sent
3066 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
3067 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
3070 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3071 * is written to the memory location pointed to by this parameter. The
3072 * ::WIMStruct can be freed using using wimlib_free() when finished with
3075 * @return 0 on success; nonzero on error.
3076 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3077 * The WIM is not the non-first part of a split WIM, and the number of
3078 * metadata resources found in the WIM did not match the image count given
3079 * in the WIM header, or the number of <IMAGE> elements in the XML
3080 * data for the WIM did not match the image count given in the WIM header.
3081 * @retval ::WIMLIB_ERR_INTEGRITY
3082 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3083 * wim_file contains an integrity table, but the SHA1 message digest for a
3084 * chunk of the WIM does not match the corresponding message digest given
3085 * in the integrity table.
3086 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3087 * Resources in @p wim_file are compressed, but the chunk size was invalid
3088 * for the WIM's compression format.
3089 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3090 * The header of @p wim_file says that resources in the WIM are compressed,
3091 * but the header flag indicating LZX or XPRESS compression is not set.
3092 * @retval ::WIMLIB_ERR_INVALID_HEADER
3093 * The header of @p wim_file was otherwise invalid.
3094 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3095 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3096 * wim_file contains an integrity table, but the integrity table is
3098 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3099 * The lookup table for the WIM contained duplicate entries that are not
3100 * for metadata resources, or it contained an entry with a SHA1 message
3101 * digest of all 0's.
3102 * @retval ::WIMLIB_ERR_INVALID_PARAM
3103 * @p wim_ret was @c NULL.
3104 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3105 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3106 * specified in @p open_flags.
3107 * @retval ::WIMLIB_ERR_NOMEM
3108 * Failed to allocated needed memory.
3109 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3110 * @p wim_file does not begin with the expected magic characters.
3111 * @retval ::WIMLIB_ERR_OPEN
3112 * Failed to open the file @p wim_file for reading.
3113 * @retval ::WIMLIB_ERR_READ
3114 * Failed to read data from @p wim_file.
3115 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3116 * Unexpected end-of-file while reading data from @p wim_file.
3117 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3118 * A number other than 0x10d00 is written in the version field of the WIM
3119 * header of @p wim_file. (May be a pre-Vista WIM.)
3120 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3121 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3122 * considered read-only because of any of the reasons mentioned in the
3123 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3124 * @retval ::WIMLIB_ERR_XML
3125 * The XML data for @p wim_file is invalid.
3128 wimlib_open_wim(const wimlib_tchar *wim_file,
3130 WIMStruct **wim_ret,
3131 wimlib_progress_func_t progress_func);
3134 * @ingroup G_writing_and_overwriting_wims
3136 * Overwrites the file that the WIM was originally read from, with changes made.
3137 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3138 * rather than wimlib_create_new_wim().
3140 * There are two ways that a WIM may be overwritten. The first is to do a full
3141 * rebuild. In this mode, the new WIM is written to a temporary file and then
3142 * renamed to the original file after it is has been completely written. The
3143 * temporary file is made in the same directory as the original WIM file. A
3144 * full rebuild may take a while, but can be used even if images have been
3145 * modified or deleted, will produce a WIM with no holes, and has little chance
3146 * of unintentional data loss because the temporary WIM is fsync()ed before
3147 * being renamed to the original WIM.
3149 * The second way to overwrite a WIM is by appending to the end of it and
3150 * overwriting the header. This can be much faster than a full rebuild, but the
3151 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3152 * begins with writing any new file resources *after* everything in the old WIM,
3153 * even though this will leave a hole where the old lookup table, XML data, and
3154 * integrity were. This is done so that the WIM remains valid even if the
3155 * operation is aborted mid-write. The WIM header is only overwritten at the
3156 * very last moment, and up until that point the WIM will be seen as the old
3159 * By default, wimlib_overwrite() does the append-style overwrite described
3160 * above, unless resources in the WIM are arranged in an unusual way or if
3161 * images have been deleted from the WIM. Use the flag
3162 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3163 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3164 * images have been deleted from the WIM.
3166 * In the temporary-file overwrite mode, no changes are made to the WIM on
3167 * failure, and the temporary file is deleted if possible. Abnormal termination
3168 * of the program will result in the temporary file being orphaned. In the
3169 * direct append mode, the WIM is truncated to the original length on failure;
3170 * and while abnormal termination of the program will result in extra data
3171 * appended to the original WIM, it should still be a valid WIM.
3173 * If this function completes successfully, no more functions should be called
3174 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3175 * the WIM file anew.
3178 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3179 * been in-memory changes made to it, which are then reflected in the
3181 * @param write_flags
3182 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3183 * @param num_threads
3184 * Number of threads to use for compression (see wimlib_write()).
3185 * @param progress_func
3186 * If non-NULL, a function that will be called periodically with the
3187 * progress of the current operation.
3189 * @return 0 on success; nonzero on error. This function may return most error
3190 * codes returned by wimlib_write() as well as the following error codes:
3192 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3193 * The WIM was going to be modified in-place (with no temporary file), but
3194 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3195 * because another thread or process has mounted an image from the WIM
3196 * read-write or is currently modifying the WIM in-place.
3197 * @retval ::WIMLIB_ERR_NO_FILENAME
3198 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3199 * than a WIM read with wimlib_open_wim().
3200 * @retval ::WIMLIB_ERR_RENAME
3201 * The temporary file that the WIM was written to could not be renamed to
3202 * the original filename of @p wim.
3203 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3204 * The WIM file is considered read-only because of any of the reasons
3205 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3209 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3210 wimlib_progress_func_t progress_func);
3213 * @ingroup G_wim_information
3215 * Prints information about one image, or all images, contained in a WIM.
3218 * Pointer to the ::WIMStruct for a WIM file.
3220 * The image about which to print information. Can be the number of an
3221 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3224 * @return This function has no return value. No error checking is done when
3225 * printing the information. If @p image is invalid, an error message is
3229 wimlib_print_available_images(const WIMStruct *wim, int image);
3232 * @ingroup G_wim_information
3234 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3235 * in a way that can be accessed programatically.
3238 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3241 * @ingroup G_wim_information
3243 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
3244 * information in a way that can be accessed programatically.
3247 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
3250 * @ingroup G_nonstandalone_wims
3252 * Reference resources from other WIM files or split WIM parts. This function
3253 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3254 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3255 * from other files, before calling a function such as wimlib_extract_image()
3256 * that requires the resources to be present.
3259 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3260 * necessarily "standalone". In the case of split WIMs, this should be the
3261 * first part, since only the first part contains the metadata resources.
3262 * In the case of delta WIMs, this should be the delta WIM rather than the
3263 * WIM on which it is based.
3264 * @param resource_wimfiles_or_globs
3265 * Array of paths to WIM files and/or split WIM parts to reference.
3266 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3267 * ref_flags, these are treated as globs rather than literal paths. That
3268 * is, using this function you can specify zero or more globs, each of
3269 * which expands to one or more literal paths.
3271 * Number of entries in @p resource_wimfiles_or_globs.
3273 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3274 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3276 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3277 * pass to internal calls to wimlib_open_wim() on the reference files.
3278 * @param progress_func
3279 * Passed to internal calls to wimlib_open_wim() on the reference files.
3281 * @return 0 on success; nonzero on error.
3283 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3284 * One of the specified globs did not match any paths (only with both
3285 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3286 * specified in @p ref_flags).
3287 * @retval ::WIMLIB_ERR_NOMEM
3288 * Failed to allocate memory.
3289 * @retval ::WIMLIB_ERR_READ
3290 * I/O or permissions error while processing a file glob.
3292 * This function can additionally return most values that can be returned by
3293 * wimlib_open_wim().
3296 wimlib_reference_resource_files(WIMStruct *wim,
3297 const wimlib_tchar * const *resource_wimfiles_or_globs,
3301 wimlib_progress_func_t progress_func);
3304 * @ingroup G_nonstandalone_wims
3306 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3307 * where the caller must open the ::WIMStruct for each referenced file itself.
3310 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3311 * necessarily "standalone". In the case of split WIMs, this should be the
3312 * first part, since only the first part contains the metadata resources.
3313 * @param resource_wims
3314 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3315 * split WIM parts to reference.
3316 * @param num_resource_wims
3317 * Number of entries in @p resource_wims.
3319 * Currently ignored (set to 0).
3321 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3322 * @p resource_wims are referenced internally by @p wim and must not be freed
3323 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3324 * been freed with wimlib_free(), or immediately before freeing @p wim with
3327 * @retval ::WIMLIB_ERR_INVALID_PARAM
3328 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3329 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3330 * @retval ::WIMLIB_ERR_NOMEM
3331 * Failed to allocate memory.
3334 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3335 unsigned num_resource_wims, int ref_flags);
3338 * @ingroup G_modifying_wims
3340 * Declares that a newly added image is mostly the same as a prior image, but
3341 * captured at a later point in time, possibly with some modifications in the
3342 * intervening time. This is designed to be used in incremental backups of the
3343 * same filesystem or directory tree.
3345 * This function compares the metadata of the directory tree of the newly added
3346 * image against that of the old image. Any files that are present in both the
3347 * newly added image and the old image and have timestamps that indicate they
3348 * haven't been modified are deemed not to have been modified and have their
3349 * SHA1 message digest copied from the old image. Because of this and because
3350 * WIM uses single-instance streams, such files need not be read from the
3351 * filesystem when the WIM is being written or overwritten. Note that these
3352 * unchanged files will still be "archived" and will be logically present in the
3353 * new image; the optimization is that they don't need to actually be read from
3354 * the filesystem because the WIM already contains them.
3356 * This function is provided to optimize incremental backups. The resulting WIM
3357 * file will still be the same regardless of whether this function is called.
3358 * (This is, however, assuming that timestamps have not been manipulated or
3359 * unmaintained as to trick this function into thinking a file has not been
3360 * modified when really it has. To partly guard against such cases, other
3361 * metadata such as file sizes will be checked as well.)
3363 * This function must be called after adding the new image (e.g. with
3364 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3365 * wimlib_overwrite()).
3368 * Pointer to the ::WIMStruct for a WIM.
3370 * 1-based index in the WIM of the newly added image. This image can have
3371 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3372 * wimlib_add_empty_image() followed by wimlib_update_image().
3373 * @param template_wim
3374 * The ::WIMStruct for the WIM containing the template image. This can be
3375 * the same as @p wim, or it can be a different ::WIMStruct.
3376 * @param template_image
3377 * 1-based index in the WIM of a template image that reflects a prior state
3378 * of the directory tree being captured.
3380 * Reserved; must be 0.
3381 * @param progress_func
3382 * Currently ignored, but reserved for a function that will be called with
3383 * information about the operation. Use NULL if no additional information
3386 * @return 0 on success; nonzero on error.
3388 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3389 * @p new_image and/or @p template_image were not a valid image indices in
3391 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3392 * The specified ::WIMStruct did not actually contain the metadata resource
3393 * for the new or template image; for example, it was a non-first part of a
3395 * @retval ::WIMLIB_ERR_NOMEM
3396 * Failed to allocate needed memory.
3397 * @retval ::WIMLIB_ERR_INVALID_PARAM
3398 * @p new_image was equal to @p template_image, or @p new_image specified
3399 * an image that had not been modified since opening the WIM.
3401 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3402 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3403 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3404 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3405 * different reasons) to read the metadata resource for the template image.
3408 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3409 WIMStruct *template_wim, int template_image,
3410 int flags, wimlib_progress_func_t progress_func);
3413 * @ingroup G_wim_information
3415 * Translates a string specifying the name or number of an image in the WIM into
3416 * the number of the image. The images are numbered starting at 1.
3419 * Pointer to the ::WIMStruct for a WIM.
3420 * @param image_name_or_num
3421 * A string specifying the name or number of an image in the WIM. If it
3422 * parses to a positive integer, this integer is taken to specify the
3423 * number of the image, indexed starting at 1. Otherwise, it is taken to
3424 * be the name of an image, as given in the XML data for the WIM file. It
3425 * also may be the keyword "all" or the string "*", both of which will
3426 * resolve to ::WIMLIB_ALL_IMAGES.
3428 * There is no way to search for an image actually named "all", "*", or an
3429 * integer number, or an image that has no name. However, you can use
3430 * wimlib_get_image_name() to get the name of any image.
3433 * If the string resolved to a single existing image, the number of that
3434 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3435 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3436 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3437 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3438 * images in @p wim has no name.
3441 wimlib_resolve_image(WIMStruct *wim,
3442 const wimlib_tchar *image_name_or_num);
3445 * @ingroup G_modifying_wims
3447 * Changes the description of an image in the WIM.
3450 * Pointer to the ::WIMStruct for a WIM.
3452 * The number of the image for which to change the description.
3453 * @param description
3454 * The new description to give the image. It may be @c NULL, which
3455 * indicates that the image is to be given no description.
3457 * @return 0 on success; nonzero on error.
3458 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3459 * @p image does not specify a single existing image in @p wim.
3460 * @retval ::WIMLIB_ERR_NOMEM
3461 * Failed to allocate the memory needed to duplicate the @p description
3463 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3464 * @p wim is considered read-only because of any of the reasons mentioned
3465 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3468 wimlib_set_image_descripton(WIMStruct *wim, int image,
3469 const wimlib_tchar *description);
3472 * @ingroup G_writing_and_overwriting_wims
3474 * Set the compression chunk size of a WIM to use in subsequent calls to
3475 * wimlib_write() or wimlib_overwrite().
3477 * A compression chunk size will result in a greater compression ratio, but the
3478 * speed of random access to the WIM will be reduced, and the effect of an
3479 * increased compression chunk size is limited by the size of each file being
3482 * <b>WARNING: Changing the compression chunk size to any value other than the
3483 * default of 32768 bytes eliminates compatibility with Microsoft's software,
3484 * except when increasing the XPRESS chunk size before Windows 8. Chunk sizes
3485 * other than 32768 are also incompatible with wimlib v1.5.3 and earlier.</b>
3488 * ::WIMStruct for a WIM.
3489 * @param out_chunk_size
3490 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3491 * on the compression format. The XPRESS compression format supports chunk
3492 * sizes that are powers of 2 with exponents between 15 and 26 inclusively,
3493 * whereas the LZX compression format supports chunk sizes that are powers
3494 * of 2 with exponents between 15 and 21 inclusively.
3496 * @return 0 on success; nonzero on error.
3498 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3499 * @p ctype is not a supported chunk size.
3502 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3505 * @ingroup G_writing_and_overwriting_wims
3507 * Set the compression type of a WIM to use in subsequent calls to
3508 * wimlib_write() or wimlib_overwrite().
3511 * ::WIMStruct for a WIM.
3513 * The compression type to set (one of ::wimlib_compression_type). If this
3514 * compression type is incompatible with the current output chunk size
3515 * (either the default or as set with wimlib_set_output_chunk_size()), the
3516 * output chunk size is reset to the default for that compression type.
3518 * @return 0 on success; nonzero on error.
3520 * @retval ::WIMLIB_ERR_INVALID_PARAM
3521 * @p ctype did not specify a valid compression type.
3524 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3527 * @ingroup G_modifying_wims
3529 * Set basic information about a WIM.
3532 * Pointer to the ::WIMStruct for a WIM.
3534 * A struct ::wimlib_wim_info that contains the information to set. Only
3535 * the information explicitly specified in the @p which flags need be
3538 * Flags that specify which information to set. This is a bitwise OR of
3539 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3540 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3542 * @return 0 on success; nonzero on failure.
3543 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3544 * The WIM file is considered read-only because of any of the reasons
3545 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3546 * flag. However, as a special case, if you are using
3547 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3548 * function will not fail due to the readonly flag being previously set.
3549 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3550 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3551 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3555 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3559 * @ingroup G_modifying_wims
3561 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3562 * (something like "Core" or "Ultimate")
3565 * Pointer to the ::WIMStruct for a WIM.
3567 * The number of the image for which to change the description.
3569 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3570 * indicates that the image is to be given no \<FLAGS\> element.
3572 * @return 0 on success; nonzero on error.
3573 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3574 * @p image does not specify a single existing image in @p wim.
3575 * @retval ::WIMLIB_ERR_NOMEM
3576 * Failed to allocate the memory needed to duplicate the @p flags string.
3577 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3578 * @p wim is considered read-only because of any of the reasons mentioned
3579 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3582 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3585 * @ingroup G_modifying_wims
3587 * Changes the name of an image in the WIM.
3590 * Pointer to the ::WIMStruct for a WIM.
3592 * The number of the image for which to change the name.
3594 * New name to give the new image. If @c NULL or empty, the new image is
3595 * given no name. If nonempty, it must specify a name that does not
3596 * already exist in @p wim.
3598 * @return 0 on success; nonzero on error.
3599 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3600 * There is already an image named @p name in @p wim.
3601 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3602 * @p image does not specify a single existing image in @p wim.
3603 * @retval ::WIMLIB_ERR_NOMEM
3604 * Failed to allocate the memory needed to duplicate the @p name string.
3605 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3606 * @p wim is considered read-only because of any of the reasons mentioned
3607 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3610 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3613 * @ingroup G_general
3615 * Set the functions that wimlib uses to allocate and free memory.
3617 * These settings are global and not per-WIM.
3619 * The default is to use the default @c malloc() and @c free() from the C
3622 * Please note that some external functions, such as those in @c libntfs-3g, may
3623 * use the standard memory allocation functions.
3625 * @param malloc_func
3626 * A function equivalent to @c malloc() that wimlib will use to allocate
3627 * memory. If @c NULL, the allocator function is set back to the default
3628 * @c malloc() from the C library.
3630 * A function equivalent to @c free() that wimlib will use to free memory.
3631 * If @c NULL, the free function is set back to the default @c free() from
3633 * @param realloc_func
3634 * A function equivalent to @c realloc() that wimlib will use to reallocate
3635 * memory. If @c NULL, the free function is set back to the default @c
3636 * realloc() from the C library.
3637 * @return 0 on success; nonzero on error.
3638 * @retval ::WIMLIB_ERR_UNSUPPORTED
3639 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
3640 * so custom memory allocators are unsupported.
3643 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3644 void (*free_func)(void *),
3645 void *(*realloc_func)(void *, size_t));
3648 * @ingroup G_general
3650 * Sets whether wimlib is to print error messages to @c stderr when a function
3651 * fails. These error messages may provide information that cannot be
3652 * determined only from the error code that is returned. Not every error will
3653 * result in an error message being printed.
3655 * This setting is global and not per-WIM.
3657 * By default, error messages are not printed.
3659 * This can be called before wimlib_global_init().
3661 * @param show_messages
3662 * @c true if error messages are to be printed; @c false if error messages
3663 * are not to be printed.
3665 * @return 0 on success; nonzero on error.
3666 * @retval ::WIMLIB_ERR_UNSUPPORTED
3667 * @p show_messages was @c true, but wimlib was compiled with the @c
3668 * --without-error-messages option. Therefore, error messages cannot be
3672 wimlib_set_print_errors(bool show_messages);
3675 * @ingroup G_nonstandalone_wims
3677 * Splits a WIM into multiple parts.
3680 * The ::WIMStruct for the WIM to split.
3682 * Name of the SWM file to create. This will be the name of the first
3683 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3684 * appended before the suffix.
3686 * The maximum size per part, in bytes. Unfortunately, it is not
3687 * guaranteed that this will really be the maximum size per part, because
3688 * some file resources in the WIM may be larger than this size, and the WIM
3689 * file format provides no way to split up file resources among multiple
3691 * @param write_flags
3692 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3693 * flags will be used to write each split WIM part. Specify 0 here to get
3694 * the default behavior.
3695 * @param progress_func
3696 * If non-NULL, a function that will be called periodically with the
3697 * progress of the current operation
3698 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3699 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3701 * @return 0 on success; nonzero on error. This function may return most error
3702 * codes that can be returned by wimlib_write() as well as the following error
3705 * @retval ::WIMLIB_ERR_INVALID_PARAM
3706 * @p swm_name was not a nonempty string, or @p part_size was 0.
3708 * Note: the WIM's uncompressed and compressed resources are not checksummed
3709 * when they are copied from the joined WIM to the split WIM parts, nor are
3710 * compressed resources re-compressed (unless explicitly requested with
3711 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3714 wimlib_split(WIMStruct *wim,
3715 const wimlib_tchar *swm_name,
3718 wimlib_progress_func_t progress_func);
3721 * @ingroup G_mounting_wim_images
3723 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3725 * The image to unmount is specified by the path to the mountpoint, not the
3726 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3727 * touched and also may have been allocated in a different process.
3729 * To unmount the image, the process calling this function communicates with the
3730 * process that is managing the mounted WIM image. This function blocks until it
3731 * is known whether the unmount succeeded or failed. In the case of a
3732 * read-write mounted WIM, the unmount is not considered to have succeeded until
3733 * all changes have been saved to the underlying WIM file.
3736 * The directory that the WIM image was mounted on.
3737 * @param unmount_flags
3738 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3739 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3740 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3742 * @param progress_func
3743 * If non-NULL, a function that will be called periodically with the
3744 * progress of the current operation. Currently, only
3745 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3747 * @return 0 on success; nonzero on error.
3749 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3750 * The filesystem daemon was unable to remove the staging directory and the
3751 * temporary files that it contains.
3752 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3753 * The filesystem daemon appears to have terminated before sending an exit
3755 * @retval ::WIMLIB_ERR_FORK
3756 * Could not @c fork() the process.
3757 * @retval ::WIMLIB_ERR_FUSERMOUNT
3758 * The @b fusermount program could not be executed or exited with a failure
3760 * @retval ::WIMLIB_ERR_MQUEUE
3761 * Could not open a POSIX message queue to communicate with the filesystem
3762 * daemon servicing the mounted filesystem, could not send a message
3763 * through the queue, or could not receive a message through the queue.
3764 * @retval ::WIMLIB_ERR_NOMEM
3765 * Failed to allocate needed memory.
3766 * @retval ::WIMLIB_ERR_OPEN
3767 * The filesystem daemon could not open a temporary file for writing the
3769 * @retval ::WIMLIB_ERR_READ
3770 * A read error occurred when the filesystem daemon tried to a file from
3771 * the staging directory
3772 * @retval ::WIMLIB_ERR_RENAME
3773 * The filesystem daemon failed to rename the newly written WIM file to the
3774 * original WIM file.
3775 * @retval ::WIMLIB_ERR_UNSUPPORTED
3776 * Mounting is not supported, either because the platform is Windows, or
3777 * because the platform is UNIX-like and wimlib was compiled with @c
3779 * @retval ::WIMLIB_ERR_WRITE
3780 * A write error occurred when the filesystem daemon was writing to the new
3781 * WIM file, or the filesystem daemon was unable to flush changes that had
3782 * been made to files in the staging directory.
3785 wimlib_unmount_image(const wimlib_tchar *dir,
3787 wimlib_progress_func_t progress_func);
3790 * @ingroup G_modifying_wims
3792 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3795 * Pointer to the ::WIMStruct for the WIM file to update.
3797 * The 1-based index of the image in the WIM to update. It cannot be
3798 * ::WIMLIB_ALL_IMAGES.
3800 * An array of ::wimlib_update_command's that specify the update operations
3803 * Number of commands in @p cmds.
3804 * @param update_flags
3805 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3806 * @param progress_func
3807 * If non-NULL, a function that will be called periodically with the
3808 * progress of the current operation.
3810 * @return 0 on success; nonzero on error. On failure, some but not all of the
3811 * update commands may have been executed. No individual update command will
3812 * have been partially executed. Possible error codes include:
3814 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3815 * The capture configuration structure specified for an add command was
3817 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3818 * @p image did not specify a single, existing image in @p wim.
3819 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3820 * Attempted to perform an add command that conflicted with previously
3821 * existing files in the WIM when an overlay was attempted.
3822 * @retval ::WIMLIB_ERR_INVALID_PARAM
3823 * An unknown operation type was specified in the update commands; or,
3824 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3825 * in the @p add_flags, but the same image had previously already been
3826 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3827 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3828 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3829 * specified in the @p add_flags for an add command in which @p
3830 * wim_target_path was not the root directory of the WIM image.
3831 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3832 * (Windows only): While executing an add command, tried to capture a
3833 * reparse point with invalid data.
3834 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3835 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3836 * for a WIM path that corresponded to a directory; or, a rename command
3837 * attempted to rename a directory to a non-directory.
3838 * @retval ::WIMLIB_ERR_NOMEM
3839 * Failed to allocate needed memory.
3840 * @retval ::WIMLIB_ERR_NOTDIR
3841 * A rename command attempted to rename a directory to a non-directory; or,
3842 * an add command was executed that attempted to set the root of the WIM
3843 * image as a non-directory; or, a path component used as a directory in a
3844 * rename command was not, in fact, a directory.
3845 * @retval ::WIMLIB_ERR_NOTEMPTY
3846 * A rename command attempted to rename a directory to a non-empty
3848 * @retval ::WIMLIB_ERR_NTFS_3G
3849 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3850 * error occurred while reading data from the NTFS volume using libntfs-3g.
3851 * @retval ::WIMLIB_ERR_OPEN
3852 * Failed to open a file to be captured while executing an add command.
3853 * @retval ::WIMLIB_ERR_OPENDIR
3854 * Failed to open a directory to be captured while executing an add command.
3855 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3856 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3857 * WIM path that did not exist; or, a rename command attempted to rename a
3858 * file that does not exist.
3859 * @retval ::WIMLIB_ERR_READ
3860 * While executing an add command, failed to read data from a file or
3861 * directory to be captured.
3862 * @retval ::WIMLIB_ERR_READLINK
3863 * While executing an add command, failed to read the target of a symbolic
3864 * link or junction point.
3865 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3866 * (Windows only) Failed to perform a reparse point fixup because of
3867 * problems with the data of a reparse point.
3868 * @retval ::WIMLIB_ERR_STAT
3869 * While executing an add command, failed to get attributes for a file or
3871 * @retval ::WIMLIB_ERR_UNSUPPORTED
3872 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3873 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3874 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3875 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3876 * add_flags for an update command.
3877 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3878 * While executing an add command, attempted to capture a file that was not
3879 * a supported file type (e.g. a device file). Only if
3880 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3881 * for an update command.
3882 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3883 * The WIM file is considered read-only because of any of the reasons
3884 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3887 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3888 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3889 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3890 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3891 * different reasons) to read the metadata resource for an image that needed to
3895 wimlib_update_image(WIMStruct *wim,
3897 const struct wimlib_update_command *cmds,
3900 wimlib_progress_func_t progress_func);
3903 * @ingroup G_writing_and_overwriting_wims
3905 * Writes a WIM to a file.
3907 * This brings in resources from any external locations, such as directory trees
3908 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3909 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3911 * By default, the new WIM file is written as stand-alone. Using the
3912 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3913 * instead. However, this function cannot directly write a "split" WIM; use
3914 * wimlib_split() for that.
3917 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3918 * changes made to it, which are then reflected in the output file.
3920 * The path to the file to write the WIM to.
3922 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3923 * images are to be included in the new on-disk WIM file. If for some
3924 * reason you only want to include a single image, specify the index of
3925 * that image instead.
3926 * @param write_flags
3927 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3928 * @param num_threads
3929 * Number of threads to use for compressing data. If 0, the number of
3930 * threads is taken to be the number of online processors. Note: if no
3931 * data compression needs to be done, no additional threads will be created
3932 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3933 * exporting an image from a compressed WIM to another WIM of the same
3934 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3936 * @param progress_func
3937 * If non-NULL, a function that will be called periodically with the
3938 * progress of the current operation. The possible messages are
3939 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3940 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3941 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3943 * @return 0 on success; nonzero on error.
3945 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3946 * @p image does not specify a single existing image in @p wim, and is not
3947 * ::WIMLIB_ALL_IMAGES.
3948 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3949 * A file that had previously been scanned for inclusion in the WIM by
3950 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3951 * message digest check.
3952 * @retval ::WIMLIB_ERR_INVALID_PARAM
3953 * @p path was @c NULL.
3954 * @retval ::WIMLIB_ERR_NOMEM
3955 * Failed to allocate needed memory.
3956 * @retval ::WIMLIB_ERR_OPEN
3957 * Failed to open @p path for writing, or some file resources in @p wim
3958 * refer to files in the outside filesystem, and one of these files could
3959 * not be opened for reading.
3960 * @retval ::WIMLIB_ERR_READ
3961 * An error occurred when trying to read data from the WIM file associated
3962 * with @p wim, or some file resources in @p wim refer to files in the
3963 * outside filesystem, and a read error occurred when reading one of these
3965 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3966 * A stream that needed to be written could not be found in the stream
3967 * lookup table of @p wim. This error can occur if, for example, @p wim is
3968 * part of a split WIM but needed resources from the other split WIM parts
3969 * were not referenced with wimlib_reference_resources() or
3970 * wimlib_reference_resource_files() before the call to wimlib_write().
3971 * @retval ::WIMLIB_ERR_WRITE
3972 * An error occurred when trying to write data to the new WIM file.
3974 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3975 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3976 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3977 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3978 * different reasons) to read the metadata resource for an image that needed to
3982 wimlib_write(WIMStruct *wim,
3983 const wimlib_tchar *path,
3986 unsigned num_threads,
3987 wimlib_progress_func_t progress_func);
3990 * @ingroup G_writing_and_overwriting_wims
3992 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3993 * file descriptor, which need not be seekable if the write is done in a special
3994 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3995 * write_flags. This can, for example, allow capturing a WIM image and
3996 * streaming it over the network. See the documentation for
3997 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3999 * The file descriptor @p fd will @b not be closed when the write is complete;
4000 * the calling code is responsible for this.
4002 * Returns 0 on success; nonzero on failure. The possible error codes include
4003 * those that can be returned by wimlib_write() as well as the following:
4005 * @retval ::WIMLIB_ERR_INVALID_PARAM
4006 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
4007 * specified in @p write_flags.
4010 wimlib_write_to_fd(WIMStruct *wim,
4014 unsigned num_threads,
4015 wimlib_progress_func_t progress_func);
4018 * @ingroup G_compression
4020 * Compress a chunk of data using XPRESS compression.
4022 * This function is exported for convenience only and should only be used by
4023 * library clients looking to make use of wimlib's compression code for another
4026 * As of wimlib v1.6.0, this function can be used with @p chunk_size greater
4027 * than 32768 bytes and is only limited by available memory. However, the
4028 * XPRESS format itself still caps match offsets to 65535, so if a larger chunk
4029 * size is chosen, then the matching will effectively occur in a sliding window
4033 * Uncompressed data of the chunk.
4035 * Size of the uncompressed chunk, in bytes.
4037 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
4040 * The size of the compressed data written to @p out in bytes, or 0 if the
4041 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
4044 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
4047 * @ingroup G_compression
4049 * Decompresses a chunk of XPRESS-compressed data.
4051 * This function is exported for convenience only and should only be used by
4052 * library clients looking to make use of wimlib's compression code for another
4055 * @param compressed_data
4056 * Pointer to the compressed data.
4058 * @param compressed_len
4059 * Length of the compressed data, in bytes.
4061 * @param uncompressed_data
4062 * Pointer to the buffer into which to write the uncompressed data.
4064 * @param uncompressed_len
4065 * Length of the uncompressed data.
4068 * 0 on success; non-zero on failure.
4071 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
4072 void *uncompressed_data, unsigned uncompressed_len);
4078 #endif /* _WIMLIB_H */