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 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
174 * functionality other than that already present in @b ImageX, that allows you
175 * to make certain Windows-specific modifications to a Windows PE image, such
176 * as adding a driver or Windows component. Such a tool could be implemented
179 * @subsection more_info More information
181 * You are advised to read the README as well as the manual pages for
182 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
183 * the API documentation.
186 /** @defgroup G_general General
188 * @brief Declarations and structures shared across the library.
191 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
193 * @brief Create new WIMs and open existing WIMs.
196 /** @defgroup G_wim_information Retrieving WIM information and directory listings
198 * @brief Retrieve information about a WIM or WIM image.
201 /** @defgroup G_modifying_wims Modifying WIMs
203 * @brief Make changes to a WIM.
205 * @section sec_adding_images Capturing and adding WIM images
207 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
208 * appending an image to an existing WIM is a multi-step process, but at its
209 * core is wimlib_add_image() or an equivalent function. Normally,
210 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
211 * ::WIMStruct as a new image. However, when supported by the build of the
212 * library, there is also a special NTFS volume capture mode (entered when
213 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
214 * from an unmounted NTFS volume.
216 * Another function, wimlib_add_image_multisource() is also provided. It
217 * generalizes wimlib_add_image() to allow combining multiple files or directory
218 * trees into a single WIM image in a configurable way.
220 * For maximum customization of WIM image creation, it is also possible to add a
221 * completely empty WIM image with wimlib_add_empty_image(), then update it with
222 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
223 * wimlib_add_image_multisource() do internally.)
225 * Note that some details of how image addition/capture works are documented
226 * more fully in the manual page for <b>wimlib-imagex capture</b>.
228 * @section sec_deleting_images Deleting WIM images
230 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
231 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
232 * be made persistent in an on-disk WIM file.
234 * @section sec_exporting_images Exporting WIM images
236 * wimlib_export_image() can copy, or "export", an image from one WIM to
239 * @section sec_other_modifications Other modifications
241 * wimlib_update_image() can add, delete, and rename files in a WIM image.
243 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
244 * wimlib_set_image_flags() can change other image metadata.
246 * wimlib_set_wim_info() can change information about the WIM file itself, such
250 /** @defgroup G_extracting_wims Extracting WIMs
252 * @brief Extract files, directories, and images from a WIM.
254 * wimlib_extract_image() extracts, or "applies", an image from a WIM
255 * (represented, as usual, by a ::WIMStruct). This normally extracts the image
256 * to a directory, but when supported by the build of the library there is also
257 * a special NTFS volume extraction mode (entered when
258 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified) that allows extracting a WIM image
259 * directly to an unmounted NTFS volume. Various other flags allow further
260 * customization of image extraction.
262 * Another function, wimlib_extract_files(), is also provided. It can extract
263 * certain files or directories from a WIM image, instead of a full image.
265 * A third function, wimlib_extract_image_from_pipe(), allows an image to be
266 * extracted from a pipable WIM sent over a pipe; see @ref subsec_pipable_wims.
268 * Note that some details of how image extraction/application works are
269 * documented more fully in the manual pages for <b>wimlib-imagex apply</b> and
270 * <b>wimlib-imagex extract</b>.
273 /** @defgroup G_mounting_wim_images Mounting WIM images
275 * @brief Mount and unmount WIM images.
277 * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
278 * mounting images from WIM files either read-only or read-write. To mount an
279 * image, call wimlib_mount_image(). To unmount an image, call
280 * wimlib_unmount_image(). Mounting can be done without root privileges because
281 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
282 * compiled with the <code>--without-fuse</code> flag, these functions will be
283 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED. Note that mounting an
284 * image read-write is an alternative to calling wimlib_update_image().
287 /** @defgroup G_progress Progress Messages
289 * @brief Track the progress of long WIM operations.
291 * When operating on large archives, operations such as extraction will
292 * naturally take a while to complete. Because of this and to improve the
293 * potential user-friendliness of library clients, a number of functions take a
294 * pointer to a progress function of type ::wimlib_progress_func_t. This
295 * function will be called periodically during the WIM operation(s) to report on
296 * the progress of the operation (for example, how many bytes have been written
300 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
302 * @brief Write and overwrite on-disk WIM files.
304 * As described in @ref sec_basic_wim_handling_concepts, these functions are
305 * critical to the design of the library as they allow new or modified WIMs to
306 * actually be written to on-disk files. Generally, wimlib_write() is the
307 * function you need to call to write a new WIM file, and wimlib_overwrite() is
308 * the function you need to call to persistently update an existing WIM file.
311 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
313 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
315 * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it
316 * than that. Normally, WIM files are "standalone". However, WIM files can
317 * also be arranged in non-standalone ways, such as a set of on-disk files that
318 * together form a single "split WIM" or "delta WIM". Such arrangements are
319 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
320 * created from one of these on-disk files initially only partially represents
321 * the full WIM and needs to, in effect, be logically combined with other
322 * ::WIMStruct's before performing certain operations, such as extracting files
323 * with wimlib_extract_image() or wimlib_extract_files(). This is done by
324 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
326 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
327 * specialized function (wimlib_split()) is needed to create a split WIM.
336 #include <inttypes.h>
339 /** @ingroup G_general
342 /** Major version of the library (for example, the 1 in 1.2.5). */
343 #define WIMLIB_MAJOR_VERSION 1
345 /** Minor version of the library (for example, the 2 in 1.2.5). */
346 #define WIMLIB_MINOR_VERSION 5
348 /** Patch version of the library (for example, the 5 in 1.2.5). */
349 #define WIMLIB_PATCH_VERSION 3
356 /** @ingroup G_general
360 * Opaque structure that represents a WIM file. This is an in-memory structure
361 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
362 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
363 * continuing to exist so that data can be read from it as needed.
365 * Most functions in this library will work the same way regardless of whether a
366 * given ::WIMStruct was obtained through wimlib_open_wim() or
367 * wimlib_create_new_wim(). Exceptions are documented.
369 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
370 * file from a ::WIMStruct.
372 * See @ref sec_basic_wim_handling_concepts for more information.
374 #ifndef WIMLIB_WIMSTRUCT_DECLARED
375 typedef struct WIMStruct WIMStruct;
376 #define WIMLIB_WIMSTRUCT_DECLARED
380 typedef wchar_t wimlib_tchar;
382 /** See @ref sec_encodings */
383 typedef char wimlib_tchar;
387 /** Path separator for WIM paths passed back to progress callbacks. */
388 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
389 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
391 /** Path separator for WIM paths passed back to progress callbacks. */
392 # define WIMLIB_WIM_PATH_SEPARATOR '/'
393 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
397 # define _wimlib_deprecated __attribute__((deprecated))
399 # define _wimlib_deprecated
402 #define WIMLIB_GUID_LEN 16
405 * Specifies the compression type of a WIM file.
407 enum wimlib_compression_type {
408 /** An invalid compression type. */
409 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
411 /** The WIM does not include any compressed resources. */
412 WIMLIB_COMPRESSION_TYPE_NONE = 0,
414 /** Compressed resources in the WIM use LZX compression. */
415 WIMLIB_COMPRESSION_TYPE_LZX = 1,
417 /** Compressed resources in the WIM use XPRESS compression. */
418 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
420 /** Compressed resources in the WIM use LZMS compression. Note: LZMS
421 * compression is only compatible with wimlib v1.6.0 and later and with
422 * WIMGAPI Windows 8 and later (and some restrictions apply on the
424 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
428 /** @ingroup G_progress
431 /** Possible values of the first parameter to the user-supplied
432 * ::wimlib_progress_func_t progress function */
433 enum wimlib_progress_msg {
435 /** A WIM image is about to be extracted. @p info will point to
436 * ::wimlib_progress_info.extract. */
437 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
439 /** A file or directory tree within a WIM image (not the full image) is
440 * about to be extracted. @p info will point to
441 * ::wimlib_progress_info.extract. */
442 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
444 /** The directory structure of the WIM image is about to be extracted.
445 * @p info will point to ::wimlib_progress_info.extract. */
446 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
448 /** The directory structure of the WIM image has been successfully
449 * extracted. @p info will point to ::wimlib_progress_info.extract. */
450 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
452 /** The WIM image's files resources are currently being extracted. @p
453 * info will point to ::wimlib_progress_info.extract. */
454 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
456 /** Starting to read a new part of a split pipable WIM over the pipe.
457 * @p info will point to ::wimlib_progress_info.extract. */
458 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
460 /** All the WIM files and directories have been extracted, and
461 * timestamps are about to be applied. @p info will point to
462 * ::wimlib_progress_info.extract. */
463 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
465 /** A WIM image has been successfully extracted. @p info will point to
466 * ::wimlib_progress_info.extract. */
467 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
469 /** A file or directory tree within a WIM image (not the full image) has
470 * been successfully extracted. @p info will point to
471 * ::wimlib_progress_info.extract. */
472 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
474 /** The directory or NTFS volume is about to be scanned to build a tree
475 * of WIM dentries in-memory. @p info will point to
476 * ::wimlib_progress_info.scan. */
477 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
479 /** A directory or file is being scanned. @p info will point to
480 * ::wimlib_progress_info.scan, and its @p cur_path member will be
481 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
482 * is passed to wimlib_add_image(). */
483 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
485 /** The directory or NTFS volume has been successfully scanned, and a
486 * tree of WIM dentries has been built in-memory. @p info will point to
487 * ::wimlib_progress_info.scan. */
488 WIMLIB_PROGRESS_MSG_SCAN_END,
491 * File resources are currently being written to the WIM.
492 * @p info will point to ::wimlib_progress_info.write_streams. */
493 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
496 * The metadata resource for each image is about to be written to the
497 * WIM. @p info will not be valid. */
498 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
501 * The metadata resource for each image has successfully been writen to
502 * the WIM. @p info will not be valid. */
503 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
506 * The temporary file has successfully been renamed to the original WIM
507 * file. Only happens when wimlib_overwrite() is called and the
508 * overwrite is not done in-place.
509 * @p info will point to ::wimlib_progress_info.rename. */
510 WIMLIB_PROGRESS_MSG_RENAME,
512 /** The contents of the WIM are being checked against the integrity
513 * table. Only happens when wimlib_open_wim() is called with the
514 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @p info will point to
515 * ::wimlib_progress_info.integrity. */
516 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
518 /** An integrity table is being calculated for the WIM being written.
519 * Only happens when wimlib_write() or wimlib_overwrite() is called with
520 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @p info will point to
521 * ::wimlib_progress_info.integrity. */
522 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
524 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
525 * but in wimlib v1.5.0 this was removed to simplify the code and now
526 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
527 WIMLIB_PROGRESS_MSG_RESERVED,
529 /** A wimlib_split() operation is in progress, and a new split part is
530 * about to be started. @p info will point to
531 * ::wimlib_progress_info.split. */
532 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
534 /** A wimlib_split() operation is in progress, and a split part has been
535 * finished. @p info will point to ::wimlib_progress_info.split. */
536 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
539 * A WIM update command is just about to be executed; @p info will point
540 * to ::wimlib_progress_info.update.
542 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
545 * A WIM update command has just been executed; @p info will point to
546 * ::wimlib_progress_info.update.
548 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
552 /** A pointer to this union is passed to the user-supplied
553 * ::wimlib_progress_func_t progress function. One (or none) of the structures
554 * contained in this union will be applicable for the operation
555 * (::wimlib_progress_msg) indicated in the first argument to the progress
557 union wimlib_progress_info {
559 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
560 * document them if they aren't given a name... */
562 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
563 struct wimlib_progress_info_write_streams {
564 /** Number of bytes that are going to be written for all the
565 * streams combined. This is the amount in uncompressed data.
566 * (The actual number of bytes will be less if the data is being
567 * written compressed.) */
568 uint64_t total_bytes;
570 /** Number of streams that are going to be written. */
571 uint64_t total_streams;
573 /** Number of uncompressed bytes that have been written so far.
574 * Will be 0 initially, and equal to @p total_bytes at the end.
576 uint64_t completed_bytes;
578 /** Number of streams that have been written. Will be 0
579 * initially, and equal to @p total_streams at the end. */
580 uint64_t completed_streams;
582 /** Number of threads that are being used to compress resources
583 * (if applicable). */
584 unsigned num_threads;
586 /** The compression type being used to write the streams; either
587 * ::WIMLIB_COMPRESSION_TYPE_NONE,
588 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
589 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
590 int compression_type;
592 /** Number of split WIM parts from which streams are being
593 * written (may be 0 if irrelevant). */
594 unsigned total_parts;
596 /** Number of split WIM parts from which streams have been
597 * written (may be 0 if irrelevant). */
598 unsigned completed_parts;
601 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
602 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
603 struct wimlib_progress_info_scan {
604 /** Directory or NTFS volume that is being scanned. */
605 const wimlib_tchar *source;
607 /** Path to the file or directory that is about to be scanned,
608 * relative to the root of the image capture or the NTFS volume.
610 const wimlib_tchar *cur_path;
613 /** File or directory looks okay and will be captured. */
614 WIMLIB_SCAN_DENTRY_OK = 0,
616 /** File or directory is being excluded from capture due
617 * to the capture configuration file, or being an
618 * absolute symbolic link that points outside of the
619 * capture directory without ::WIMLIB_ADD_FLAG_NORPFIX.
621 WIMLIB_SCAN_DENTRY_EXCLUDED,
623 /** File or directory is being excluded from capture due
624 * to being unsupported (e.g. an encrypted or device
626 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
629 /** Target path in the WIM. Only valid on messages
630 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
631 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
632 const wimlib_tchar *wim_target_path;
634 /** Number of directories scanned so far, including the root
635 * directory but excluding any unsupported/excluded directories.
637 uint64_t num_dirs_scanned;
639 /** Number of non-directories scanned so far, excluding any
640 * unsupported/excluded files. */
641 uint64_t num_nondirs_scanned;
643 /** Number of bytes of file data that have been detected so far.
644 * This data may not actually have been read yet, and it will
645 * not actually be written to the WIM file until wimlib_write()
646 * or wimlib_overwrite() has been called. */
647 uint64_t num_bytes_scanned;
650 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
651 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
652 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
653 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
654 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
655 struct wimlib_progress_info_extract {
656 /** Number of the image being extracted (1-based). */
659 /** Flags passed to to wimlib_extract_image() */
662 /** Full path to the WIM file being extracted. */
663 const wimlib_tchar *wimfile_name;
665 /** Name of the image being extracted. */
666 const wimlib_tchar *image_name;
668 /** Directory or NTFS volume to which the image is being
670 const wimlib_tchar *target;
673 const wimlib_tchar *cur_path;
675 /** Number of bytes of uncompressed data that will be extracted.
676 * Takes into account hard links (they are not counted for each
678 uint64_t total_bytes;
680 /** Number of bytes that have been written so far. Will be 0
681 * initially, and equal to @p total_bytes at the end. */
682 uint64_t completed_bytes;
684 /** Number of streams that will be extracted. This may more or
685 * less than the number of "files" to be extracted due to
686 * special cases (hard links, symbolic links, and alternate data
688 uint64_t num_streams;
690 /** Path to the root dentry within the WIM for the tree that is
691 * being extracted. Will be the empty string when extracting a
693 const wimlib_tchar *extract_root_wim_source_path;
695 /** Currently only used for
696 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
698 unsigned part_number;
700 /** Currently only used for
701 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
702 unsigned total_parts;
704 /** Currently only used for
705 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
706 uint8_t guid[WIMLIB_GUID_LEN];
709 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
710 struct wimlib_progress_info_rename {
711 /** Name of the temporary file that the WIM was written to. */
712 const wimlib_tchar *from;
714 /** Name of the original WIM file to which the temporary file is
716 const wimlib_tchar *to;
719 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
720 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
721 struct wimlib_progress_info_update {
722 /** Pointer to the update command that will be executed or has
723 * just been executed. */
724 const struct wimlib_update_command *command;
726 /** Number of update commands that have been completed so far.
728 size_t completed_commands;
730 /** Number of update commands that are being executed as part of
731 * this call to wimlib_update_image(). */
732 size_t total_commands;
735 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
736 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
737 struct wimlib_progress_info_integrity {
738 /** Number of bytes from the end of the WIM header to the end of
739 * the lookup table (the area that is covered by the SHA1
740 * integrity checks.) */
741 uint64_t total_bytes;
743 /** Number of bytes that have been SHA1-summed so far. Will be
744 * 0 initially, and equal @p total_bytes at the end. */
745 uint64_t completed_bytes;
747 /** Number of chunks that the checksummed region is divided
749 uint32_t total_chunks;
751 /** Number of chunks that have been SHA1-summed so far. Will
752 * be 0 initially, and equal to @p total_chunks at the end. */
753 uint32_t completed_chunks;
755 /** Size of the chunks used for the integrity calculation. */
758 /** Filename of the WIM (only valid if the message is
759 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
760 const wimlib_tchar *filename;
763 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
764 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
765 struct wimlib_progress_info_split {
766 /** Total size of the original WIM's file and metadata resources
768 uint64_t total_bytes;
770 /** Number of bytes of file and metadata resources that have
771 * been copied out of the original WIM so far. Will be 0
772 * initially, and equal to @p total_bytes at the end. */
773 uint64_t completed_bytes;
775 /** Number 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 unsigned cur_part_number;
780 /** Total number of split WIM parts that are being written. */
781 unsigned total_parts;
783 /** Name of the split WIM part that is about to be started
784 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
785 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
786 const wimlib_tchar *part_name;
790 /** A user-supplied function that will be called periodically during certain WIM
791 * operations. The first argument will be the type of operation that is being
792 * performed or is about to be started or has been completed. The second
793 * argument will be a pointer to one of a number of structures depending on the
794 * first argument. It may be @c NULL for some message types.
796 * The return value of the progress function is currently ignored, but it may do
797 * something in the future. (Set it to 0 for now.)
799 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
800 const union wimlib_progress_info *info);
803 /** @ingroup G_modifying_wims
806 /** An array of these structures is passed to wimlib_add_image_multisource() to
807 * specify the sources from which to create a WIM image. */
808 struct wimlib_capture_source {
809 /** Absolute or relative path to a file or directory on the external
810 * filesystem to be included in the WIM image. */
811 wimlib_tchar *fs_source_path;
813 /** Destination path in the WIM image. Leading and trailing slashes are
814 * ignored. The empty string or @c NULL means the root directory of the
816 wimlib_tchar *wim_target_path;
818 /** Reserved; set to 0. */
822 /** Structure that specifies a list of path patterns. */
823 struct wimlib_pattern_list {
824 /** Array of patterns. The patterns may be modified by library code,
825 * but the @p pats pointer itself will not. See the man page for
826 * <b>wimlib-imagex capture</b> for more information about allowed
830 /** Number of patterns in the @p pats array. */
833 /** Ignored; may be used by the calling code. */
834 size_t num_allocated_pats;
837 /** A structure that contains lists of wildcards that match paths to treat
838 * specially when capturing a WIM image. */
839 struct wimlib_capture_config {
840 /** Paths matching any pattern this list are excluded from being
841 * captured, except if the same path appears in @p
842 * exclusion_exception_pats. */
843 struct wimlib_pattern_list exclusion_pats;
845 /** Paths matching any pattern in this list are never excluded from
847 struct wimlib_pattern_list exclusion_exception_pats;
849 /** Reserved for future capture configuration options. */
850 struct wimlib_pattern_list reserved1;
852 /** Reserved for future capture configuration options. */
853 struct wimlib_pattern_list reserved2;
855 /** Library internal use only. */
856 wimlib_tchar *_prefix;
858 /** Library internal use only. */
859 size_t _prefix_num_tchars;
862 /** Set or unset the WIM header flag that marks it read-only
863 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
864 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
865 * is distinct from basic file permissions; this flag can be set on a WIM file
866 * that is physically writable. If this flag is set, all further operations to
867 * modify the WIM will fail, except calling wimlib_overwrite() with
868 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
869 * allows you to set this flag persistently on the underlying WIM file.
871 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
873 /** Set the GUID (globally unique identifier) of the WIM file to the value
874 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
875 #define WIMLIB_CHANGE_GUID 0x00000002
877 /** Change the bootable image of the WIM to the value specified in
878 * ::wimlib_wim_info.boot_index of the @p info parameter. */
879 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
881 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
882 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
883 * indicates whether an image in the WIM has been captured with reparse-point
884 * fixups enabled. wimlib also treats this flag as specifying whether to do
885 * reparse-point fixups by default when capturing or applying WIM images. */
886 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
889 /** @ingroup G_wim_information
892 /** General information about a WIM file. */
893 struct wimlib_wim_info {
895 /** Globally unique identifier for the WIM file. Note: all parts of a
896 * split WIM should have an identical value in this field. */
897 uint8_t guid[WIMLIB_GUID_LEN];
899 /** Number of images in the WIM. */
900 uint32_t image_count;
902 /** 1-based index of the bootable image in the WIM, or 0 if no image is
906 /** Version of the WIM file. */
907 uint32_t wim_version;
909 /** Chunk size used for compression. */
912 /** For split WIMs, the 1-based index of this part within the split WIM;
914 uint16_t part_number;
916 /** For split WIMs, the total number of parts in the split WIM;
918 uint16_t total_parts;
920 /** One of the ::wimlib_compression_type values that specifies the
921 * method used to compress resources in the WIM. */
922 int32_t compression_type;
924 /** Size of the WIM file in bytes, excluding the XML data and integrity
926 uint64_t total_bytes;
928 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
929 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
930 * this will always be 0, even if the ::WIMStruct was written to
931 * somewhere by calling wimlib_write() with the
932 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
933 uint32_t has_integrity_table : 1;
935 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
936 * wimlib_create_new_wim(). */
937 uint32_t opened_from_file : 1;
939 /** 1 if the WIM is considered readonly for any reason. */
940 uint32_t is_readonly : 1;
942 /** 1 if reparse-point fixups are supposedly enabled for one or more
943 * images in the WIM. */
944 uint32_t has_rpfix : 1;
946 /** 1 if the WIM is marked as read-only. */
947 uint32_t is_marked_readonly : 1;
949 /** 1 if the WIM is part of a spanned set. */
950 uint32_t spanned : 1;
952 uint32_t write_in_progress : 1;
953 uint32_t metadata_only : 1;
954 uint32_t resource_only : 1;
956 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
957 uint32_t pipable : 1;
958 uint32_t reserved_flags : 22;
959 uint32_t reserved[9];
962 /** Information about a unique stream in the WIM file. (A stream is the same
963 * thing as a "resource", except in the case of packed resources.) */
964 struct wimlib_resource_entry {
965 /** Uncompressed size of the stream in bytes. */
966 uint64_t uncompressed_size;
968 /** Compressed size of the stream in bytes. This will be the same as @p
969 * uncompressed_size if the stream is uncompressed. Or, if @p
970 * is_packed_streams is 1, this will be 0. */
971 uint64_t compressed_size;
973 /** Offset, in bytes, of this stream from the start of the WIM file. Or
974 * if @p packed is 1, then this is actually the offset at which this
975 * stream begins in the uncompressed contents of the packed resource.
979 /** SHA1 message digest of the stream's uncompressed contents. */
980 uint8_t sha1_hash[20];
982 /** Which part number of the split WIM this stream is in. This should
983 * be the same as the part number provided by wimlib_get_wim_info(). */
984 uint32_t part_number;
986 /** Number of times this stream is referenced over all WIM images. */
987 uint32_t reference_count;
989 /** 1 if this stream is compressed. */
990 uint32_t is_compressed : 1;
992 /** 1 if this stream is a metadata resource rather than a file resource.
994 uint32_t is_metadata : 1;
996 uint32_t is_free : 1;
997 uint32_t is_spanned : 1;
999 /** 1 if this stream was not found in the lookup table of the
1000 * ::WIMStruct. This normally implies a missing call to
1001 * wimlib_reference_resource_files() or wimlib_reference_resources().
1003 uint32_t is_missing : 1;
1005 /** 1 if this stream is located in a packed resource which may contain
1006 * other streams (all compressed together) as well. */
1007 uint32_t packed : 1;
1009 uint32_t reserved_flags : 26;
1011 /** If @p packed is 1, then this will specify the offset of the packed
1012 * resource in the WIM. */
1013 uint64_t raw_resource_offset_in_wim;
1015 /** If @p is_packed_streams is 1, then this will specify the compressed
1016 * size of the packed resource in the WIM. */
1017 uint64_t raw_resource_compressed_size;
1019 uint64_t reserved[2];
1022 /** A stream of a file in the WIM. */
1023 struct wimlib_stream_entry {
1024 /** Name of the stream, or NULL if the stream is unnamed. */
1025 const wimlib_tchar *stream_name;
1026 /** Location, size, etc. of the stream within the WIM file. */
1027 struct wimlib_resource_entry resource;
1028 uint64_t reserved[4];
1031 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1032 * Roughly, the information about a "file" in the WIM--- but really a directory
1033 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1034 * field can be used to distinguish actual file inodes. */
1035 struct wimlib_dir_entry {
1036 /** Name of the file, or NULL if this file is unnamed (only possible for
1037 * the root directory) */
1038 const wimlib_tchar *filename;
1040 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1042 const wimlib_tchar *dos_name;
1044 /** Full path to this file within the WIM image. */
1045 const wimlib_tchar *full_path;
1047 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1048 * children, ..., etc. */
1051 /** Pointer to the security descriptor for this file, in Windows
1052 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1053 * security descriptor. */
1054 const char *security_descriptor;
1056 /** Length of the above security descriptor. */
1057 size_t security_descriptor_size;
1059 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1060 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1061 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1062 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1063 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1064 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1065 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1066 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1067 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1068 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1069 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1070 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1071 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1072 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1073 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1074 /** File attributes, such as whether the file is a directory or not.
1075 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1076 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1077 * on other platforms. */
1078 uint32_t attributes;
1080 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1081 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1082 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1083 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1084 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1085 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1086 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1087 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1088 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1089 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1090 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1091 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1092 * attributes), this will give the reparse tag. This tells you whether
1093 * the reparse point is a symbolic link, junction point, or some other,
1094 * more unusual kind of reparse point. */
1095 uint32_t reparse_tag;
1097 /* Number of (hard) links to this file. */
1100 /** Number of named data streams that this file has. Normally 0. */
1101 uint32_t num_named_streams;
1103 /** Roughly, the inode number of this file. However, it may be 0 if
1104 * @p num_links == 1. */
1105 uint64_t hard_link_group_id;
1107 /** Time this file was created. */
1108 struct timespec creation_time;
1110 /** Time this file was last written to. */
1111 struct timespec last_write_time;
1113 /** Time this file was last accessed. */
1114 struct timespec last_access_time;
1115 uint64_t reserved[16];
1117 /** Array of streams that make up this file. The first entry will
1118 * always exist and will correspond to the unnamed data stream (default
1119 * file contents), so it will have @p stream_name == @c NULL. There
1120 * will then be @p num_named_streams additional entries that specify the
1121 * named data streams, if any, each of which will have @p stream_name !=
1123 struct wimlib_stream_entry streams[];
1127 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1130 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1134 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1137 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1140 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1141 * just on the specified path. */
1142 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1144 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1145 * itself; only its children (in the case of a non-empty directory) */
1146 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1148 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1149 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1150 * table of the ::WIMStruct. The default behavior without this flag is to fill
1151 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1152 * wimlib_resource_entry::is_missing "is_missing" flag. */
1153 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1157 /** @ingroup G_modifying_wims
1160 /** Directly capture a NTFS volume rather than a generic directory. This flag
1161 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1162 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1163 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1165 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1166 * with ::WIMLIB_ADD_FLAG_NTFS. */
1167 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1169 /** Call the progress function with the message
1170 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
1171 * be scanned, or when a directory or file is being excluded from capture. */
1172 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1174 /** Mark the image being added as the bootable image of the WIM. */
1175 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1177 /** Store the UNIX owner, group, and mode. This is done by adding a special
1178 * alternate data stream to each regular file, symbolic link, and directory to
1179 * contain this information. Please note that this flag is for convenience
1180 * only; Microsoft's @a imagex.exe will not understand this special information.
1181 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1182 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1184 /** Do not capture security descriptors. Only has an effect in NTFS capture
1185 * mode, or in Win32 native builds. */
1186 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1188 /** Fail immediately if the full security descriptor of any file or directory
1189 * cannot be accessed. Only has an effect in Win32 native builds. The default
1190 * behavior without this flag is to first try omitting the SACL from the
1191 * security descriptor, then to try omitting the security descriptor entirely.
1193 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1195 /** Call the progress function with the message
1196 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1197 * capture. This is a subset of the messages provided by
1198 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1199 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1201 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1202 * in the case of Windows) that point inside the directory being captured to
1203 * instead be absolute relative to the directory being captured, rather than the
1204 * current root; also exclude absolute symbolic links that point outside the
1205 * directory tree being captured.
1207 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1208 * the WIM header or if this is the first image being added.
1209 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1210 * reparse point fixups enabled and currently cannot be unset. */
1211 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1213 /** Don't do reparse point fixups. The default behavior is described in the
1214 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1215 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1217 /** Do not automatically exclude unsupported files or directories from capture;
1218 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1219 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1220 * such a file is encountered. */
1221 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1223 /** Automatically select a capture configuration appropriate for capturing
1224 * filesystems containing Windows operating systems. When this flag is
1225 * specified, the corresponding @p config parameter or member must be @c NULL.
1227 * Currently, selecting this capture configuration will cause the following
1228 * files and directories to be excluded from capture:
1233 * - "\System Volume Information"
1237 * Note that the default behavior--- that is, when this flag is not specified
1238 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1239 * no files are excluded from capture.
1241 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1243 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1244 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1245 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1246 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1247 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1248 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1249 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1250 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1251 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1252 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1253 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1254 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1255 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1258 /** @ingroup G_modifying_wims
1261 /** Do not issue an error if the path to delete does not exist. */
1262 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1264 /** Delete the file or directory tree recursively; if not specified, an error is
1265 * issued if the path to delete is a directory. */
1266 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1269 /** @ingroup G_modifying_wims
1273 * If a single image is being exported, mark it bootable in the destination WIM.
1274 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1275 * the image in the source WIM (if any) that is marked as bootable is also
1276 * marked as bootable in the destination WIM.
1278 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1280 /** Give the exported image(s) no names. Avoids problems with image name
1283 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1285 /** Give the exported image(s) no descriptions. */
1286 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1289 /** @ingroup G_extracting_wims
1292 /** Extract the image directly to a NTFS volume rather than a generic directory.
1293 * This mode is only available if wimlib was compiled with libntfs-3g support;
1294 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1295 * extraction target will be interpreted as the path to a NTFS volume image (as
1296 * a regular file or block device) rather than a directory. It will be opened
1297 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1298 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1299 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1300 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1302 /** When identical files are extracted from the WIM, always hard link them
1304 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1306 /** When identical files are extracted from the WIM, always symlink them
1308 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1310 /** This flag no longer does anything but is reserved for future use. */
1311 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1313 /** Read the WIM file sequentially while extracting the image. As of wimlib
1314 * v1.6.0 this is the default behavior, and this flag no longer does anything.
1316 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1318 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1319 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1321 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1323 /** Do not extract security descriptors. */
1324 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1326 /** Fail immediately if the full security descriptor of any file or directory
1327 * cannot be set exactly as specified in the WIM file. On Windows, the default
1328 * behavior without this flag is to fall back to setting the security descriptor
1329 * with the SACL omitted, then only the default inherited security descriptor,
1330 * if we do not have permission to set the desired one. */
1331 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1333 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1334 * reparse-point fixups on, so absolute symbolic links or junction points will
1335 * be fixed to be absolute relative to the actual extraction root. Reparse
1336 * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1337 * header. This flag may only be specified when extracting a full image (not a
1338 * file or directory tree within one). */
1339 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1341 /** Force reparse-point fixups on extraction off, regardless of the state of the
1342 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1343 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1345 /** Extract the specified file to standard output. This is only valid in an
1346 * extraction command that specifies the extraction of a regular file in the WIM
1348 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1350 /** Instead of ignoring files and directories with names that cannot be
1351 * represented on the current platform (note: Windows has more restrictions on
1352 * filenames than POSIX-compliant systems), try to replace characters or append
1353 * junk to the names so that they can be extracted in some form. */
1354 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1356 /** On Windows, when there exist two or more files with the same case
1357 * insensitive name but different case sensitive names, try to extract them all
1358 * by appending junk to the end of them, rather than arbitrarily extracting only
1360 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1362 /** Do not ignore failure to set timestamps on extracted files. */
1363 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1365 /** Do not ignore failure to set short names on extracted files. */
1366 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1368 /** Do not ignore failure to extract symbolic links (and junction points, on
1369 * Windows) due to permissions problems. By default, such failures are ignored
1370 * since the default configuration of Windows only allows the Administrator to
1371 * create symbolic links. */
1372 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1374 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1375 * behavior is currently less than satisfactory. Do not use (yet). */
1376 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1378 /** Perform the extraction ordered by the tree of files to extract rather than
1379 * how the underlying streams are arranged in the WIM file. For regular WIM
1380 * files this may decrease or increase performance, depending on various
1381 * factors. For WIM files containing packed streams this will decrease
1383 #define WIMLIB_EXTRACT_FLAG_FILE_ORDER 0x00020000
1386 /** @ingroup G_mounting_wim_images
1389 /** Mount the WIM image read-write rather than the default of read-only. */
1390 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1392 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1393 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1395 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1396 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1398 /** Access alternate data streams in the mounted WIM image through extended file
1399 * attributes. This is the default mode. */
1400 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1402 /** Access alternate data streams in the mounted WIM image by specifying the
1403 * file name, a colon, then the alternate file stream name. */
1404 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1406 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1407 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1408 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1410 /** Allow other users to see the mounted filesystem. (this passes the @c
1411 * allow_other option to FUSE mount) */
1412 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1415 /** @ingroup G_creating_and_opening_wims
1418 /** Verify the WIM contents against the WIM's integrity table, if present. This
1419 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1420 * checksummed and checked against the SHA1 message digests specified in the
1421 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1422 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1423 * integrity table is invalid). */
1424 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1426 /** Issue an error if the WIM is part of a split WIM. Software can provide
1427 * this flag for convenience if it explicitly does not want to support split
1429 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1431 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1432 * is not. A WIM is considered writable only if it is writable at the
1433 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1434 * header, and is not part of a spanned set. It is not required to provide this
1435 * flag before attempting to make changes to the WIM, but with this flag you get
1436 * an error sooner rather than later. */
1437 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1440 /** @ingroup G_mounting_wim_images
1443 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1444 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1446 /** Unless this flag is given, changes to a read-write mounted WIM are
1447 * discarded. Ignored for read-only mounts. */
1448 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1450 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1451 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1453 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1454 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1456 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1457 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1460 /** @ingroup G_modifying_wims
1463 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1464 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1465 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1468 /** @ingroup G_writing_and_overwriting_wims
1471 /** Include an integrity table in the WIM.
1473 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1474 * an integrity table if and only if one was present before. For WIMs created
1475 * with wimlib_create_new_wim(), the default behavior is to not include an
1476 * integrity table. */
1477 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1479 /** Do not include an integrity table in the new WIM file. This is the default
1480 * behavior, unless the WIM already included an integrity table. */
1481 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1483 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1484 * images from it can be applied directly from a pipe using
1485 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1486 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1487 * with this flag will not be compatible with Microsoft's software.
1489 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1490 * WIM as pipable if and only if it was pipable before. For WIMs created with
1491 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1493 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1495 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1496 * WIM was pipable already. */
1497 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1499 /** Recompress all resources, even if they could otherwise be copied from a
1500 * different WIM with the same compression type (in the case of
1501 * wimlib_export_image() being called previously). This flag is also valid in
1502 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1503 * in the joined WIM file will be recompressed. */
1504 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1506 /** Call fsync() just before the WIM file is closed. */
1507 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1509 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1510 * data to it if possible. */
1511 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1513 /** wimlib_overwrite() only: Specifying this flag overrides the default
1514 * behavior of wimlib_overwrite() after one or more calls to
1515 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1516 * only minimal changes to correctly remove the image from the WIM will be
1517 * taken. In particular, all streams will be left alone, even if they are no
1518 * longer referenced. This is probably not what you want, because almost no
1519 * space will be saved by deleting an image in this way. */
1520 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1522 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1523 * flag is set in the WIM header. This can be used in combination with
1524 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1525 * set the readonly flag on the on-disk WIM file. */
1526 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1528 /** Do not include non-metadata resources already present in other WIMs. This
1529 * flag can be used to write a "delta" WIM after resources from the WIM on which
1530 * the delta is to be based were referenced with
1531 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1532 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1534 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1535 * are already present (not in external resource WIMs) and their reference
1536 * counts are correct, so the code does not need to recalculate which streams
1537 * are referenced. This is for optimization purposes only, since with this flag
1538 * specified, the metadata resources may not need to be decompressed and parsed.
1540 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1541 * already implied for wimlib_overwrite(). */
1542 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1544 #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
1546 /** When writing streams in the resulting WIM file, pack multiple streams into a
1547 * single WIM resource instead of compressing them independently. This tends to
1548 * produce a better compression ratio at the cost of less random access.
1549 * Furthermore, WIMs created with this flag are only compatible with wimlib
1550 * v1.6.0 or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup
1551 * only and <b>not including ImageX and Dism</b>. WIMs created with this flag
1552 * use version number 3584 in their header instead of 68864. If this flag is
1553 * passed to wimlib_overwrite() and the WIM did not previously contain packed
1554 * streams, the WIM's version number will be changed to 3584 and the new streams
1555 * will be written packed. */
1556 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1558 /** Compress all streams independently. This produces a WIM optimized for
1559 * random access and compatibility, as noted in the documentation for
1560 * ::WIMLIB_WRITE_RESOURCE_FLAG_PACK_STREAMS. For wimlib_write(), this is the
1561 * default behavior. For wimlib_overwrite(), this is the default if the WIM file
1562 * did not already contain packed streams. Also, for wimlib_overwrite(), if the
1563 * WIM already contained packed streams, specifying this flag but not
1564 * ::WIMLIB_WRITE_FLAG_REBUILD will cause new streams to be written unpacked,
1565 * but the WIM itself will not be rebuilt and may still contain packed streams.
1567 #define WIMLIB_WRITE_FLAG_NO_PACK_STREAMS 0x00002000
1570 /** @ingroup G_general
1573 /** Assume that strings are represented in UTF-8, even if this is not the
1574 * locale's character encoding. This flag is ignored on Windows, where wimlib
1575 * always uses UTF-16LE. */
1576 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1578 /** Windows-only: do not attempt to acquire additional privileges (currently
1579 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1580 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1581 * for the case where the calling program manages these privileges itself.
1582 * Note: no error is issued if privileges cannot be acquired, although related
1583 * errors may be reported later, depending on if the operations performed
1584 * actually require additional privileges or not. */
1585 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1587 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1588 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1589 * to read all possible data and metadata for a capture operation could not be
1590 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1592 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1594 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1595 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1596 * to restore all possible data and metadata for an apply operation could not be
1597 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1599 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1602 /** @ingroup G_nonstandalone_wims
1605 /** wimlib_reference_resource_files() only: Enable shell-style filename
1607 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1609 /** wimlib_reference_resource_files() only: Issue an error
1610 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1611 * default behavior without this flag is to issue no error at that point, but
1612 * then attempt to open the glob as a literal path, which of course will fail
1613 * anyway if no file exists at that path. No effect if
1614 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. */
1615 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1618 /** @ingroup G_modifying_wims
1621 /** The specific type of update to perform. */
1622 enum wimlib_update_op {
1623 /** Add a new file or directory tree to the WIM image in a
1624 * certain location. */
1625 WIMLIB_UPDATE_OP_ADD = 0,
1627 /** Delete a file or directory tree from the WIM image. */
1628 WIMLIB_UPDATE_OP_DELETE,
1630 /** Rename a file or directory tree in the WIM image. */
1631 WIMLIB_UPDATE_OP_RENAME,
1634 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1635 struct wimlib_add_command {
1636 /** Filesystem path to the file or directory tree to
1638 wimlib_tchar *fs_source_path;
1639 /** Path, specified from the root of the WIM image, at
1640 * which to add the file or directory tree within the
1642 wimlib_tchar *wim_target_path;
1644 /** Configuration for excluded files. @c NULL means
1645 * exclude no files (use no configuration), unless
1646 * ::WIMLIB_ADD_FLAG_WINCONFIG is specified in @p
1648 struct wimlib_capture_config *config;
1650 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1654 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1655 struct wimlib_delete_command {
1656 /** Path, specified from the root of the WIM image, for
1657 * the file or directory tree within the WIM image to be
1659 wimlib_tchar *wim_path;
1660 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1664 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1665 struct wimlib_rename_command {
1666 /** Path, specified from the root of the WIM image, for
1667 * the source file or directory tree within the WIM
1669 wimlib_tchar *wim_source_path;
1670 /** Path, specified from the root of the WIM image, for
1671 * the destination file or directory tree within the WIM
1673 wimlib_tchar *wim_target_path;
1674 /** Reserved; set to 0. */
1678 /** Specification of an update to perform on a WIM image. */
1679 struct wimlib_update_command {
1681 enum wimlib_update_op op;
1684 struct wimlib_add_command add;
1685 struct wimlib_delete_command delete_; /* Underscore is for C++
1687 struct wimlib_rename_command rename;
1692 /** @ingroup G_extracting_wims
1695 /** Specification of a file or directory tree to extract from a WIM image. Used
1696 * in calls to wimlib_extract_files(). */
1697 struct wimlib_extract_command {
1698 /** Path to file or directory tree within the WIM image to extract. It
1699 * must be provided as an absolute path from the root of the WIM image.
1700 * The path separators may be either forward slashes or backslashes. */
1701 wimlib_tchar *wim_source_path;
1703 /** Filesystem path to extract the file or directory tree to. */
1704 wimlib_tchar *fs_dest_path;
1706 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1712 /** @ingroup G_general
1716 * Possible values of the error code returned by many functions in wimlib.
1718 * See the documentation for each wimlib function to see specifically what error
1719 * codes can be returned by a given function, and what they mean.
1721 enum wimlib_error_code {
1722 WIMLIB_ERR_SUCCESS = 0,
1723 WIMLIB_ERR_ALREADY_LOCKED,
1724 WIMLIB_ERR_DECOMPRESSION,
1725 WIMLIB_ERR_DELETE_STAGING_DIR,
1726 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1729 WIMLIB_ERR_FUSERMOUNT,
1730 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1731 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1732 WIMLIB_ERR_IMAGE_COUNT,
1733 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1734 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1735 WIMLIB_ERR_INTEGRITY,
1736 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1737 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1738 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1739 WIMLIB_ERR_INVALID_HEADER,
1740 WIMLIB_ERR_INVALID_IMAGE,
1741 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1742 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1743 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1744 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1745 WIMLIB_ERR_INVALID_OVERLAY,
1746 WIMLIB_ERR_INVALID_PARAM,
1747 WIMLIB_ERR_INVALID_PART_NUMBER,
1748 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1749 WIMLIB_ERR_INVALID_REPARSE_DATA,
1750 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1751 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1752 WIMLIB_ERR_INVALID_UTF16_STRING,
1753 WIMLIB_ERR_INVALID_UTF8_STRING,
1754 WIMLIB_ERR_IS_DIRECTORY,
1755 WIMLIB_ERR_IS_SPLIT_WIM,
1756 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1758 WIMLIB_ERR_METADATA_NOT_FOUND,
1763 WIMLIB_ERR_NOTEMPTY,
1764 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1765 WIMLIB_ERR_NOT_A_WIM_FILE,
1766 WIMLIB_ERR_NOT_PIPABLE,
1767 WIMLIB_ERR_NO_FILENAME,
1771 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1773 WIMLIB_ERR_READLINK,
1776 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1777 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1778 WIMLIB_ERR_RESOURCE_ORDER,
1779 WIMLIB_ERR_SET_ATTRIBUTES,
1780 WIMLIB_ERR_SET_REPARSE_DATA,
1781 WIMLIB_ERR_SET_SECURITY,
1782 WIMLIB_ERR_SET_SHORT_NAME,
1783 WIMLIB_ERR_SET_TIMESTAMPS,
1784 WIMLIB_ERR_SPLIT_INVALID,
1787 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1788 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1789 WIMLIB_ERR_UNKNOWN_VERSION,
1790 WIMLIB_ERR_UNSUPPORTED,
1791 WIMLIB_ERR_UNSUPPORTED_FILE,
1792 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1793 WIMLIB_ERR_WIM_IS_READONLY,
1799 /** Used to indicate no WIM image or an invalid WIM image. */
1800 #define WIMLIB_NO_IMAGE 0
1802 /** Used to specify all images in the WIM. */
1803 #define WIMLIB_ALL_IMAGES (-1)
1806 * @ingroup G_modifying_wims
1808 * Appends an empty image to a WIM file. This empty image will initially
1809 * contain no files or directories, although if written without further
1810 * modifications, a root directory will be created automatically for it. After
1811 * calling this function, you can use wimlib_update_image() to add files to the
1812 * new WIM image. This gives you slightly more control over making the new
1813 * image compared to calling wimlib_add_image() or
1814 * wimlib_add_image_multisource() directly.
1817 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1820 * Name to give the new image. If @c NULL or empty, the new image is given
1821 * no name. If nonempty, it must specify a name that does not already
1823 * @param new_idx_ret
1824 * If non-<code>NULL</code>, the index of the newly added image is returned
1827 * @return 0 on success; nonzero on failure. The possible error codes are:
1829 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1830 * There is already an image in @p wim named @p name.
1831 * @retval ::WIMLIB_ERR_NOMEM
1832 * Failed to allocate the memory needed to add the new image.
1833 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1834 * The WIM file is considered read-only because of any of the reasons
1835 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1839 wimlib_add_empty_image(WIMStruct *wim,
1840 const wimlib_tchar *name,
1844 * @ingroup G_modifying_wims
1846 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1848 * The directory tree or NTFS volume is scanned immediately to load the dentry
1849 * tree into memory, and file attributes and symbolic links are read. However,
1850 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1853 * See the manual page for the @b wimlib-imagex program for more information
1854 * about the "normal" capture mode versus the NTFS capture mode (entered by
1855 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1857 * Note that @b no changes are committed to the underlying WIM file (if
1858 * any) until wimlib_write() or wimlib_overwrite() is called.
1861 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1864 * A path to a directory or unmounted NTFS volume that will be captured as
1867 * Name to give the new image. If @c NULL or empty, the new image is given
1868 * no name. If nonempty, it must specify a name that does not already
1871 * Capture configuration that specifies files, directories, or path globs
1872 * to exclude from being captured. If @c NULL, a dummy configuration where
1873 * no paths are treated specially is used.
1875 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1876 * @param progress_func
1877 * If non-NULL, a function that will be called periodically with the
1878 * progress of the current operation. The progress messages that will be
1879 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1880 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1881 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1883 * @return 0 on success; nonzero on error. On error, changes to @p wim are
1884 * discarded so that it appears to be in the same state as when this function
1887 * This function is implemented by calling wimlib_add_empty_image(), then
1888 * calling wimlib_update_image() with a single "add" command, so any error code
1889 * returned by wimlib_add_empty_image() may be returned, as well as any error
1890 * codes returned by wimlib_update_image() other than ones documented as only
1891 * being returned specifically by an update involving delete or rename commands.
1894 wimlib_add_image(WIMStruct *wim,
1895 const wimlib_tchar *source,
1896 const wimlib_tchar *name,
1897 const struct wimlib_capture_config *config,
1899 wimlib_progress_func_t progress_func);
1902 * @ingroup G_modifying_wims
1904 * This function is equivalent to wimlib_add_image() except it allows for
1905 * multiple sources to be combined into a single WIM image. This is done by
1906 * specifying the @p sources and @p num_sources parameters instead of the @p
1907 * source parameter of wimlib_add_image(). The rest of the parameters are the
1908 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1909 * capture</b> for full details on how this mode works.
1911 * In addition to the error codes that wimlib_add_image() can return,
1912 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1913 * when trying to overlay a non-directory on a directory or when otherwise
1914 * trying to overlay multiple conflicting files to the same location in the WIM
1915 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1916 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1917 * was not exactly one capture source with the target being the root directory.
1918 * (In this respect, there is no advantage to using
1919 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1922 wimlib_add_image_multisource(WIMStruct *wim,
1923 const struct wimlib_capture_source *sources,
1925 const wimlib_tchar *name,
1926 const struct wimlib_capture_config *config,
1928 wimlib_progress_func_t progress_func);
1931 * @ingroup G_creating_and_opening_wims
1933 * Creates a ::WIMStruct for a new WIM file.
1935 * This only creates an in-memory structure for a WIM that initially contains no
1936 * images. No on-disk file is created until wimlib_write() is called.
1939 * The type of compression to be used in the new WIM file. Must be
1940 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1941 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1943 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1944 * written to the memory location pointed to by this paramater. The
1945 * ::WIMStruct must be freed using using wimlib_free() when finished with
1947 * @return 0 on success; nonzero on error.
1948 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1949 * @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1950 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1951 * @retval ::WIMLIB_ERR_NOMEM
1952 * Failed to allocate needed memory.
1955 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1958 * @ingroup G_modifying_wims
1960 * Deletes an image, or all images, from a WIM file.
1962 * All streams referenced by the image(s) being deleted are removed from the
1963 * lookup table of the WIM if they are not referenced by any other images in the
1966 * Please note that @b no changes are committed to the underlying WIM file (if
1967 * any) until wimlib_write() or wimlib_overwrite() is called.
1970 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1973 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1975 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
1976 * to be left unmodified only if @p image specified a single image. If instead
1977 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
1978 * possible for some but not all of the images to have been deleted when a
1979 * failure status is returned.
1981 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1982 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1983 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1984 * The WIM file is considered read-only because of any of the reasons
1985 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1988 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1989 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
1990 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
1991 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
1992 * different reasons) to read the metadata resource for an image that needed to
1996 wimlib_delete_image(WIMStruct *wim, int image);
1999 * @ingroup G_modifying_wims
2001 * Exports an image, or all the images, from a WIM file, into another WIM file.
2003 * The destination image is made to share the same dentry tree and security data
2004 * structure as the source image. This places some restrictions on additional
2005 * functions that may be called. wimlib_mount_image() may not be called on
2006 * either the source image or the destination image without an intervening call
2007 * to a function that un-shares the images, such as wimlib_free() on @p
2008 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2009 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2010 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2011 * have references back to @p src_wim.
2013 * If this function fails, all changes to @p dest_wim are rolled back.
2015 * Please note that no changes are committed to the underlying WIM file of @p
2016 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2019 * The WIM from which to export the images, specified as a pointer to the
2020 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2021 * split WIM. In the case of a WIM file that is not standalone, this
2022 * ::WIMStruct must have had any needed external resources previously
2023 * referenced using wimlib_reference_resources() or
2024 * wimlib_reference_resource_files().
2026 * The image to export from @p src_wim, as either a 1-based image index to
2027 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2029 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2032 * For single-image exports, the name to give the exported image in @p
2033 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2034 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2035 * that case, the names are all taken from @p src_wim. This parameter is
2036 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2037 * @param dest_description
2038 * For single-image exports, the description to give the exported image in
2039 * the new WIM file. If left @c NULL, the description from @p src_wim is
2040 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2041 * NULL; in that case, the description are all taken from @p src_wim. This
2042 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2043 * @param export_flags
2044 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2045 * @param progress_func
2046 * Currently ignored, but reserved for a function that will be called with
2047 * information about the operation. Use NULL if no additional information
2050 * @return 0 on success; nonzero on error.
2051 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2052 * One or more of the names being given to an exported image was already in
2053 * use in the destination WIM.
2054 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2055 * @p src_image does not exist in @p src_wim and was not
2056 * ::WIMLIB_ALL_IMAGES.
2057 * @retval ::WIMLIB_ERR_INVALID_PARAM
2058 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2059 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2061 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2062 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2063 * example, one of them was a non-first part of a split WIM.
2064 * @retval ::WIMLIB_ERR_NOMEM
2065 * Failed to allocate needed memory.
2066 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2067 * A resource that needed to be exported could not be found in either the
2068 * source or destination WIMs. This error can occur if, for example, @p
2069 * src_wim is part of a split WIM but needed resources from the other split
2070 * WIM parts were not referenced with wimlib_reference_resources() or
2071 * wimlib_reference_resource_files() before the call to
2072 * wimlib_export_image().
2073 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2074 * @p dest_wim is considered read-only because of any of the reasons
2075 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2078 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2079 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2080 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2081 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2082 * different reasons) to read the metadata resource for an image in @p src_wim
2083 * that needed to be exported.
2086 wimlib_export_image(WIMStruct *src_wim, int src_image,
2087 WIMStruct *dest_wim,
2088 const wimlib_tchar *dest_name,
2089 const wimlib_tchar *dest_description,
2091 wimlib_progress_func_t progress_func);
2094 * @ingroup G_extracting_wims
2096 * Extract zero or more files or directory trees from a WIM image.
2098 * This generalizes the single-image extraction functionality of
2099 * wimlib_extract_image() to allow extracting only the specified subsets of the
2103 * The WIM from which to extract the files, specified as a pointer to the
2104 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2105 * split WIM. In the case of a WIM file that is not standalone, this
2106 * ::WIMStruct must have had any needed external resources previously
2107 * referenced using wimlib_reference_resources() or
2108 * wimlib_reference_resource_files().
2111 * The 1-based number of the image in @p wim from which the files or
2112 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
2115 * An array of ::wimlib_extract_command structures that specifies the
2116 * extractions to perform.
2119 * Number of commands in the @p cmds array.
2121 * @param default_extract_flags
2122 * Default extraction flags; the behavior shall be as if these flags had
2123 * been specified in the ::wimlib_extract_command.extract_flags member in
2124 * each extraction command, in combination with any flags already present.
2126 * @param progress_func
2127 * If non-NULL, a function that will be called periodically with the
2128 * progress of the current operation.
2130 * @return 0 on success; nonzero on error. The possible error codes include
2131 * most of those documented as returned by wimlib_extract_image() as well as the
2132 * following additional error codes:
2134 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2135 * @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
2137 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2138 * The ::wimlib_extract_command.wim_source_path member in one of the
2139 * extract commands did not exist in the WIM.
2140 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2141 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
2142 * in which ::wimlib_extract_command.wim_source_path existed but was not a
2143 * regular file or directory.
2144 * @retval ::WIMLIB_ERR_INVALID_PARAM
2145 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
2146 * specified for some commands but not all; or
2147 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
2148 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
2149 * for a command in which ::wimlib_extract_command.wim_source_path did not
2150 * specify the root directory of the WIM image.
2153 wimlib_extract_files(WIMStruct *wim,
2155 const struct wimlib_extract_command *cmds,
2157 int default_extract_flags,
2158 wimlib_progress_func_t progress_func);
2161 * @ingroup G_extracting_wims
2163 * Extracts an image, or all images, from a WIM to a directory or directly to a
2164 * NTFS volume image.
2166 * The exact behavior of how wimlib extracts files from a WIM image is
2167 * controllable by the @p extract_flags parameter, but there also are
2168 * differences depending on the platform (UNIX-like vs Windows). See the manual
2169 * page for <b>wimlib-imagex apply</b> for more information, including about the
2170 * special "NTFS volume extraction mode" entered by providing
2171 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2173 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
2174 * returned if any resulting SHA1 message digests do not match the values
2175 * provided in the WIM file. Therefore, if this function is successful, you can
2176 * be fairly sure that any compressed data in the WIM was uncompressed
2180 * The WIM from which to extract the image(s), specified as a pointer to
2181 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2182 * of a split WIM. In the case of a WIM file that is not standalone, this
2183 * ::WIMStruct must have had any needed external resources previously
2184 * referenced using wimlib_reference_resources() or
2185 * wimlib_reference_resource_files().
2187 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
2188 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
2189 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2191 * Directory to extract the WIM image(s) to (created if it does not already
2192 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
2193 * path to the unmounted NTFS volume to extract the image to.
2194 * @param extract_flags
2195 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
2196 * @param progress_func
2197 * If non-NULL, a function that will be called periodically with the
2198 * progress of the current operation.
2200 * @return 0 on success; nonzero on error.
2201 * @retval ::WIMLIB_ERR_DECOMPRESSION
2202 * Failed to decompress a resource to be extracted.
2203 * @retval ::WIMLIB_ERR_INVALID_PARAM
2204 * Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
2205 * were specified in @p extract_flags; or both
2206 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
2207 * specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
2208 * ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
2209 * ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
2210 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
2211 * @p image was ::WIMLIB_ALL_IMAGES.
2212 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2213 * The SHA1 message digest of an extracted stream did not match the SHA1
2214 * message digest given in the WIM file.
2215 * @retval ::WIMLIB_ERR_LINK
2216 * Failed to create a symbolic link or a hard link.
2217 * @retval ::WIMLIB_ERR_MKDIR
2218 * Failed create a directory.
2219 * @retval ::WIMLIB_ERR_NOMEM
2220 * Failed to allocate needed memory.
2221 * @retval ::WIMLIB_ERR_OPEN
2222 * Could not create a file, or failed to open an already-extracted file.
2223 * @retval ::WIMLIB_ERR_READ
2224 * Failed to read data from the WIM file associated with @p wim.
2225 * @retval ::WIMLIB_ERR_READLINK
2226 * Failed to determine the target of a symbolic link in the WIM.
2227 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2228 * Failed to fix the target of an absolute symbolic link (e.g. if the
2229 * target would have exceeded the maximum allowed length). (Only if
2230 * reparse data was supported by the extraction mode and
2231 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
2232 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2233 * One of the files or directories that needed to be extracted referenced a
2234 * stream not present in the WIM's lookup table (or in any of the lookup
2235 * tables of the split WIM parts).
2236 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2237 * Failed to set attributes on a file.
2238 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2239 * Failed to set reparse data on a file (only if reparse data was supported
2240 * by the extraction mode).
2241 * @retval ::WIMLIB_ERR_SET_SECURITY
2242 * Failed to set security descriptor on a file
2243 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2245 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2246 * Failed to set the short name of a file (only if
2247 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2248 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2249 * Failed to set timestamps on a file (only if
2250 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2251 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2252 * Unexpected end-of-file occurred when reading data from the WIM file
2253 * associated with @p wim.
2254 * @retval ::WIMLIB_ERR_UNSUPPORTED
2255 * A requested extraction flag, or the data or metadata that must be
2256 * extracted to support it, is unsupported in the build and configuration
2257 * of wimlib, or on the current platform or extraction mode or target
2258 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2259 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2260 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2261 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2262 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2263 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2264 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2266 * ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
2267 * or more files with short names, but extracting short names is not
2268 * supported --- on Windows, this occurs if the target volume does not
2269 * support short names, while on non-Windows, this occurs if
2270 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2271 * @retval ::WIMLIB_ERR_WRITE
2272 * Failed to write data to a file being extracted.
2274 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2275 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2276 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2277 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2278 * different reasons) to read the metadata resource for an image that needed to
2282 wimlib_extract_image(WIMStruct *wim, int image,
2283 const wimlib_tchar *target,
2285 wimlib_progress_func_t progress_func);
2288 * @ingroup G_extracting_wims
2290 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
2291 * pipable WIM is being sent.
2293 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2294 * about pipable WIMs.
2296 * This function operates in a special way to read the WIM fully sequentially.
2297 * As a result, there is no ::WIMStruct is made visible to library users, and
2298 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2299 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2300 * seekable file, not a pipe.)
2303 * File descriptor, which may be a pipe, opened for reading and positioned
2304 * at the start of the pipable WIM.
2305 * @param image_num_or_name
2306 * String that specifies the 1-based index or name of the image to extract.
2307 * It is translated to an image index using the same rules that
2308 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2309 * only a single image (not all images) can be specified. Alternatively,
2310 * specify @p NULL here to use the first image in the WIM if it contains
2311 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2313 * Same as the corresponding parameter to wimlib_extract_image().
2314 * @param extract_flags
2315 * Same as the corresponding parameter to wimlib_extract_image(), except
2316 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
2317 * always implied, since data is always read from @p pipe_fd sequentially
2318 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
2319 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2320 * @param progress_func
2321 * Same as the corresponding parameter to wimlib_extract_image(), except
2322 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2325 * @return 0 on success; nonzero on error. The possible error codes include
2326 * those returned by wimlib_extract_image() as well as the following:
2328 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2329 * Data read from the pipable WIM was invalid.
2330 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2331 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2334 wimlib_extract_image_from_pipe(int pipe_fd,
2335 const wimlib_tchar *image_num_or_name,
2336 const wimlib_tchar *target, int extract_flags,
2337 wimlib_progress_func_t progress_func);
2340 * @ingroup G_wim_information
2342 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2343 * includes a string of XML that describes the images contained in the WIM.
2345 * See wimlib_get_xml_data() to read the XML data into memory instead.
2348 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2349 * have to be standalone (e.g. it could be part of a split WIM).
2351 * @c stdout, or a FILE* opened for writing, to extract the data to.
2353 * @return 0 on success; nonzero on error.
2354 * @retval ::WIMLIB_ERR_INVALID_PARAM
2355 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2356 * @retval ::WIMLIB_ERR_NOMEM
2357 * @retval ::WIMLIB_ERR_READ
2358 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2359 * Failed to read the XML data from the WIM.
2360 * @retval ::WIMLIB_ERR_WRITE
2361 * Failed to completely write the XML data to @p fp.
2364 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2367 * @ingroup G_general
2369 * Frees all memory allocated for a WIMStruct and closes all files associated
2373 * Pointer to the ::WIMStruct for a WIM file.
2375 * @return This function has no return value.
2378 wimlib_free(WIMStruct *wim);
2381 * @ingroup G_general
2383 * Converts a ::wimlib_compression_type value into a string.
2386 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2387 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2390 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2393 extern const wimlib_tchar *
2394 wimlib_get_compression_type_string(int ctype);
2397 * @ingroup G_general
2399 * Converts an error code into a string describing it.
2402 * The error code returned by one of wimlib's functions.
2405 * Pointer to a statically allocated string describing the error code,
2406 * or @c NULL if the error code is not valid.
2408 extern const wimlib_tchar *
2409 wimlib_get_error_string(enum wimlib_error_code code);
2412 * @ingroup G_wim_information
2414 * Returns the description of the specified image.
2417 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2418 * to be standalone (e.g. it could be part of a split WIM).
2420 * The number of the image, numbered starting at 1.
2423 * The description of the image, or @c NULL if there is no such image, or
2424 * @c NULL if the specified image has no description. The description
2425 * string is in library-internal memory and may not be modified or freed;
2426 * in addition, the string will become invalid if the description of the
2427 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2429 extern const wimlib_tchar *
2430 wimlib_get_image_description(const WIMStruct *wim, int image);
2433 * @ingroup G_wim_information
2435 * Returns the name of the specified image.
2438 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2439 * to be standalone (e.g. it could be part of a split WIM).
2441 * The number of the image, numbered starting at 1.
2444 * The name of the image, or @c NULL if there is no such image, or an empty
2445 * string if the image is unnamed. The name string is in
2446 * library-internal memory and may not be modified or freed; in addition,
2447 * the string will become invalid if the name of the image is changed, the
2448 * image is deleted, or the ::WIMStruct is destroyed.
2450 extern const wimlib_tchar *
2451 wimlib_get_image_name(const WIMStruct *wim, int image);
2455 * @ingroup G_wim_information
2457 * Get basic information about a WIM file.
2460 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2461 * to be standalone (e.g. it could be part of a split WIM).
2463 * A ::wimlib_wim_info structure that will be filled in with information
2464 * about the WIM file.
2469 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2472 * @ingroup G_wim_information
2474 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2475 * includes a string of XML that describes the images contained in the WIM.
2477 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2481 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2482 * have to be standalone (e.g. it could be part of a split WIM).
2484 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2485 * XML data is written to this location.
2486 * @param bufsize_ret
2487 * The size of the XML data in bytes is written to this location.
2489 * @return 0 on success; nonzero on error.
2490 * @retval ::WIMLIB_ERR_INVALID_PARAM
2491 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2492 * @p buf_ret or @p bufsize_ret was @c NULL.
2493 * @retval ::WIMLIB_ERR_NOMEM
2494 * @retval ::WIMLIB_ERR_READ
2495 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2496 * Failed to read the XML data from the WIM.
2499 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2502 * @ingroup G_general
2504 * Initialization function for wimlib. Call before using any other wimlib
2505 * function except wimlib_set_print_errors(). If not done manually, this
2506 * function will be called automatically with @p init_flags set to
2507 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.
2510 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2512 * @return 0 on success; nonzero on failure. Currently, only the following
2513 * error code is defined:
2515 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2516 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2517 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2518 * init_flags, but the corresponding privileges could not be acquired.
2521 wimlib_global_init(int init_flags);
2524 * @ingroup G_general
2526 * Cleanup function for wimlib. You are not required to call this function, but
2527 * it will release any global resources allocated by the library.
2530 wimlib_global_cleanup(void);
2533 * @ingroup G_wim_information
2535 * Determines if an image name is already used by some image in the WIM.
2538 * Pointer to the ::WIMStruct for a WIM file.
2540 * The name to check.
2543 * @c true if there is already an image in @p wim named @p name; @c false
2544 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2545 * the empty string, @c false is returned.
2548 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2551 * @ingroup G_wim_information
2553 * Iterate through a file or directory tree in the WIM image. By specifying
2554 * appropriate flags and a callback function, you can get the attributes of a
2555 * file in the WIM, get a directory listing, or even get a listing of the entire
2559 * The WIM containing the image(s) over which to iterate, specified as a
2560 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2561 * or part 1 of a split WIM. In the case of a WIM file that is not
2562 * standalone, this ::WIMStruct should have had any needed external
2563 * resources previously referenced using wimlib_reference_resources() or
2564 * wimlib_reference_resource_files(). If not, see
2565 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2566 * the behavior when resources are missing.
2569 * The 1-based number of the image in @p wim that contains the files or
2570 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2571 * iteration on all images in the WIM.
2574 * Path in the WIM image at which to do the iteration.
2577 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2580 * A callback function that will receive each directory entry.
2583 * An extra parameter that will always be passed to the callback function
2586 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2587 * first nonzero value that was returned from @p cb. However, additional error
2588 * codes may be returned, including the following:
2590 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2591 * @p path did not exist in the WIM image.
2592 * @retval ::WIMLIB_ERR_NOMEM
2593 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2595 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2596 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2597 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2598 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2599 * different reasons) to read the metadata resource for an image over which
2600 * iteration needed to be done.
2603 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2605 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2608 * @ingroup G_wim_information
2610 * Iterate through the lookup table of a WIM file. This can be used to directly
2611 * get a listing of the unique resources contained in a WIM file over all
2612 * images. Both file resources and metadata resources are included. However,
2613 * only resources actually included in the file represented by @a wim, plus
2614 * explicitly referenced external resources (via wimlib_reference_resources() or
2615 * wimlib_reference_resource_files()) are included in the iteration. For
2616 * example, if @p wim represents just one part of a split WIM, then only
2617 * resources in that part will be included, unless other resources were
2618 * explicitly referenced.
2621 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2622 * to be standalone (e.g. it could be part of a split WIM).
2625 * Reserved; set to 0.
2628 * A callback function that will receive each resource.
2631 * An extra parameter that will always be passed to the callback function
2634 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2635 * that was returned from @p cb.
2638 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2639 wimlib_iterate_lookup_table_callback_t cb,
2643 * @ingroup G_nonstandalone_wims
2645 * Joins a split WIM into a stand-alone one-part WIM.
2648 * An array of strings that gives the filenames of all parts of the split
2649 * WIM. No specific order is required, but all parts must be included with
2652 * Number of filenames in @p swms.
2653 * @param swm_open_flags
2654 * Open flags for the split WIM parts (e.g.
2655 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2656 * @param wim_write_flags
2657 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2658 * be used to write the joined WIM.
2659 * @param output_path
2660 * The path to write the joined WIM file to.
2661 * @param progress_func
2662 * If non-NULL, a function that will be called periodically with the
2663 * progress of the current operation.
2665 * @return 0 on success; nonzero on error. This function may return most error
2666 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2667 * as the following error code:
2669 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2670 * The split WIMs do not form a valid WIM because they do not include all
2671 * the parts of the original WIM, there are duplicate parts, or not all the
2672 * parts have the same GUID and compression type.
2674 * Note: wimlib is generalized enough that this function is not actually needed
2675 * to join a split WIM; instead, you could open the first part of the split WIM,
2676 * then reference the other parts with wimlib_reference_resource_files(), then
2677 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2678 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2682 wimlib_join(const wimlib_tchar * const *swms,
2684 const wimlib_tchar *output_path,
2686 int wim_write_flags,
2687 wimlib_progress_func_t progress_func);
2691 * @ingroup G_mounting_wim_images
2693 * Mounts an image in a WIM file on a directory read-only or read-write.
2695 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2696 * supported if wimlib was configured with @c --without-fuse. This includes
2697 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2700 * Calling this function daemonizes the process, unless
2701 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2702 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2703 * to the WIM are staged in a temporary directory.
2705 * It is safe to mount multiple images from the same underlying WIM file
2706 * read-only at the same time, but only if different ::WIMStruct's are used. It
2707 * is @b not safe to mount multiple images from the same WIM file read-write at
2710 * wimlib_mount_image() cannot be used on an image that was exported with
2711 * wimlib_export_image() while the dentry trees for both images are still in
2712 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2713 * that already has modifications pending (e.g. an image added with
2714 * wimlib_add_image()).
2717 * Pointer to the ::WIMStruct containing the image to be mounted.
2719 * The number of the image to mount, indexed starting from it. It must be
2720 * an existing, single image.
2722 * The path to an existing empty directory to mount the image on.
2723 * @param mount_flags
2724 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2725 * @param staging_dir
2726 * If non-NULL, the name of a directory in which the staging directory will
2727 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2728 * in @p mount_flags. If left @c NULL, the staging directory is created in
2729 * the same directory as the WIM file that @p wim was originally read from.
2731 * @return 0 on success; nonzero on error.
2733 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2734 * A read-write mount was requested, but an an exclusive advisory lock on
2735 * the on-disk WIM file could not be acquired because another thread or
2736 * process has mounted an image from the WIM read-write or is currently
2737 * modifying the WIM in-place.
2738 * @retval ::WIMLIB_ERR_FUSE
2739 * A non-zero status was returned by @c fuse_main().
2740 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2741 * @p image does not specify an existing, single image in @p wim.
2742 * @retval ::WIMLIB_ERR_INVALID_PARAM
2743 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2744 * wimlib_export_image(), or @p image has been added with
2745 * wimlib_add_image().
2746 * @retval ::WIMLIB_ERR_MKDIR
2747 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2748 * staging directory could not be created.
2749 * @retval ::WIMLIB_ERR_NOTDIR
2750 * Could not determine the current working directory.
2751 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2752 * One of the dentries in the image referenced a stream not present in the
2753 * WIM's lookup table (or in any of the lookup tables of the split WIM
2755 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2756 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2757 * wim is considered read-only because of any of the reasons mentioned in
2758 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2759 * @retval ::WIMLIB_ERR_UNSUPPORTED
2760 * Mounting is not supported, either because the platform is Windows, or
2761 * because the platform is UNIX-like and wimlib was compiled with @c
2764 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2765 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2766 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2767 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2768 * different reasons) to read the metadata resource for the image to mount.
2771 wimlib_mount_image(WIMStruct *wim,
2773 const wimlib_tchar *dir,
2775 const wimlib_tchar *staging_dir);
2778 * @ingroup G_creating_and_opening_wims
2780 * Opens a WIM file and creates a ::WIMStruct for it.
2783 * The path to the WIM file to open.
2786 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2788 * @param progress_func
2789 * If non-NULL, a function that will be called periodically with the
2790 * progress of the current operation. Currently, the only messages sent
2791 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2792 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2795 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2796 * is written to the memory location pointed to by this parameter. The
2797 * ::WIMStruct can be freed using using wimlib_free() when finished with
2800 * @return 0 on success; nonzero on error.
2801 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2802 * The WIM is not the non-first part of a split WIM, and the number of
2803 * metadata resources found in the WIM did not match the image count given
2804 * in the WIM header, or the number of <IMAGE> elements in the XML
2805 * data for the WIM did not match the image count given in the WIM header.
2806 * @retval ::WIMLIB_ERR_INTEGRITY
2807 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2808 * wim_file contains an integrity table, but the SHA1 message digest for a
2809 * chunk of the WIM does not match the corresponding message digest given
2810 * in the integrity table.
2811 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2812 * Resources in @p wim_file are compressed, but the chunk size was invalid
2813 * for the WIM's compression format.
2814 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2815 * The header of @p wim_file says that resources in the WIM are compressed,
2816 * but the header flag indicating LZX or XPRESS compression is not set.
2817 * @retval ::WIMLIB_ERR_INVALID_HEADER
2818 * The header of @p wim_file was otherwise invalid.
2819 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2820 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2821 * wim_file contains an integrity table, but the integrity table is
2823 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2824 * The lookup table for the WIM contained duplicate entries that are not
2825 * for metadata resources, or it contained an entry with a SHA1 message
2826 * digest of all 0's.
2827 * @retval ::WIMLIB_ERR_INVALID_PARAM
2828 * @p wim_ret was @c NULL.
2829 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
2830 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
2831 * specified in @p open_flags.
2832 * @retval ::WIMLIB_ERR_NOMEM
2833 * Failed to allocated needed memory.
2834 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2835 * @p wim_file does not begin with the expected magic characters.
2836 * @retval ::WIMLIB_ERR_OPEN
2837 * Failed to open the file @p wim_file for reading.
2838 * @retval ::WIMLIB_ERR_READ
2839 * Failed to read data from @p wim_file.
2840 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2841 * Unexpected end-of-file while reading data from @p wim_file.
2842 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2843 * A number other than 0x10d00 is written in the version field of the WIM
2844 * header of @p wim_file. (May be a pre-Vista WIM.)
2845 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2846 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2847 * considered read-only because of any of the reasons mentioned in the
2848 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2849 * @retval ::WIMLIB_ERR_XML
2850 * The XML data for @p wim_file is invalid.
2853 wimlib_open_wim(const wimlib_tchar *wim_file,
2855 WIMStruct **wim_ret,
2856 wimlib_progress_func_t progress_func);
2859 * @ingroup G_writing_and_overwriting_wims
2861 * Overwrites the file that the WIM was originally read from, with changes made.
2862 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2863 * rather than wimlib_create_new_wim().
2865 * There are two ways that a WIM may be overwritten. The first is to do a full
2866 * rebuild. In this mode, the new WIM is written to a temporary file and then
2867 * renamed to the original file after it is has been completely written. The
2868 * temporary file is made in the same directory as the original WIM file. A
2869 * full rebuild may take a while, but can be used even if images have been
2870 * modified or deleted, will produce a WIM with no holes, and has little chance
2871 * of unintentional data loss because the temporary WIM is fsync()ed before
2872 * being renamed to the original WIM.
2874 * The second way to overwrite a WIM is by appending to the end of it and
2875 * overwriting the header. This can be much faster than a full rebuild, but the
2876 * disadvantage is that some space will be wasted. Writing a WIM in this mode
2877 * begins with writing any new file resources *after* everything in the old WIM,
2878 * even though this will leave a hole where the old lookup table, XML data, and
2879 * integrity were. This is done so that the WIM remains valid even if the
2880 * operation is aborted mid-write. The WIM header is only overwritten at the
2881 * very last moment, and up until that point the WIM will be seen as the old
2884 * By default, wimlib_overwrite() does the append-style overwrite described
2885 * above, unless resources in the WIM are arranged in an unusual way or if
2886 * images have been deleted from the WIM. Use the flag
2887 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2888 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2889 * images have been deleted from the WIM.
2891 * In the temporary-file overwrite mode, no changes are made to the WIM on
2892 * failure, and the temporary file is deleted if possible. Abnormal termination
2893 * of the program will result in the temporary file being orphaned. In the
2894 * direct append mode, the WIM is truncated to the original length on failure;
2895 * and while abnormal termination of the program will result in extra data
2896 * appended to the original WIM, it should still be a valid WIM.
2898 * If this function completes successfully, no more functions should be called
2899 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
2900 * the WIM file anew.
2903 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2904 * been in-memory changes made to it, which are then reflected in the
2906 * @param write_flags
2907 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
2908 * @param num_threads
2909 * Number of threads to use for compression (see wimlib_write()).
2910 * @param progress_func
2911 * If non-NULL, a function that will be called periodically with the
2912 * progress of the current operation.
2914 * @return 0 on success; nonzero on error. This function may return most error
2915 * codes returned by wimlib_write() as well as the following error codes:
2917 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2918 * The WIM was going to be modified in-place (with no temporary file), but
2919 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2920 * because another thread or process has mounted an image from the WIM
2921 * read-write or is currently modifying the WIM in-place.
2922 * @retval ::WIMLIB_ERR_NO_FILENAME
2923 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
2924 * than a WIM read with wimlib_open_wim().
2925 * @retval ::WIMLIB_ERR_RENAME
2926 * The temporary file that the WIM was written to could not be renamed to
2927 * the original filename of @p wim.
2928 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2929 * The WIM file is considered read-only because of any of the reasons
2930 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2934 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2935 wimlib_progress_func_t progress_func);
2938 * @ingroup G_wim_information
2940 * Prints information about one image, or all images, contained in a WIM.
2943 * Pointer to the ::WIMStruct for a WIM file.
2945 * The image about which to print information. Can be the number of an
2946 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2949 * @return This function has no return value. No error checking is done when
2950 * printing the information. If @p image is invalid, an error message is
2954 wimlib_print_available_images(const WIMStruct *wim, int image);
2957 * @ingroup G_wim_information
2959 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2960 * in a way that can be accessed programatically.
2963 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
2966 * @ingroup G_wim_information
2968 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2969 * information in a way that can be accessed programatically.
2972 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
2975 * @ingroup G_nonstandalone_wims
2977 * Reference resources from other WIM files or split WIM parts. This function
2978 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
2979 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
2980 * from other files, before calling a function such as wimlib_extract_image()
2981 * that requires the resources to be present.
2984 * The ::WIMStruct for a WIM that contains metadata resources, but is not
2985 * necessarily "standalone". In the case of split WIMs, this should be the
2986 * first part, since only the first part contains the metadata resources.
2987 * In the case of delta WIMs, this should be the delta WIM rather than the
2988 * WIM on which it is based.
2989 * @param resource_wimfiles_or_globs
2990 * Array of paths to WIM files and/or split WIM parts to reference.
2991 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
2992 * ref_flags, these are treated as globs rather than literal paths. That
2993 * is, using this function you can specify zero or more globs, each of
2994 * which expands to one or more literal paths.
2996 * Number of entries in @p resource_wimfiles_or_globs.
2998 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
2999 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3001 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3002 * pass to internal calls to wimlib_open_wim() on the reference files.
3003 * @param progress_func
3004 * Passed to internal calls to wimlib_open_wim() on the reference files.
3006 * @return 0 on success; nonzero on error.
3008 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3009 * One of the specified globs did not match any paths (only with both
3010 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3011 * specified in @p ref_flags).
3012 * @retval ::WIMLIB_ERR_NOMEM
3013 * Failed to allocate memory.
3014 * @retval ::WIMLIB_ERR_READ
3015 * I/O or permissions error while processing a file glob.
3017 * This function can additionally return most values that can be returned by
3018 * wimlib_open_wim().
3021 wimlib_reference_resource_files(WIMStruct *wim,
3022 const wimlib_tchar * const *resource_wimfiles_or_globs,
3026 wimlib_progress_func_t progress_func);
3029 * @ingroup G_nonstandalone_wims
3031 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3032 * where the caller must open the ::WIMStruct for each referenced file itself.
3035 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3036 * necessarily "standalone". In the case of split WIMs, this should be the
3037 * first part, since only the first part contains the metadata resources.
3038 * @param resource_wims
3039 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3040 * split WIM parts to reference.
3041 * @param num_resource_wims
3042 * Number of entries in @p resource_wims.
3044 * Currently ignored (set to 0).
3046 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3047 * @p resource_wims are referenced internally by @p wim and must not be freed
3048 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3049 * been freed with wimlib_free(), or immediately before freeing @p wim with
3052 * @retval ::WIMLIB_ERR_INVALID_PARAM
3053 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3054 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3055 * @retval ::WIMLIB_ERR_NOMEM
3056 * Failed to allocate memory.
3059 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3060 unsigned num_resource_wims, int ref_flags);
3063 * @ingroup G_modifying_wims
3065 * Declares that a newly added image is mostly the same as a prior image, but
3066 * captured at a later point in time, possibly with some modifications in the
3067 * intervening time. This is designed to be used in incremental backups of the
3068 * same filesystem or directory tree.
3070 * This function compares the metadata of the directory tree of the newly added
3071 * image against that of the old image. Any files that are present in both the
3072 * newly added image and the old image and have timestamps that indicate they
3073 * haven't been modified are deemed not to have been modified and have their
3074 * SHA1 message digest copied from the old image. Because of this and because
3075 * WIM uses single-instance streams, such files need not be read from the
3076 * filesystem when the WIM is being written or overwritten. Note that these
3077 * unchanged files will still be "archived" and will be logically present in the
3078 * new image; the optimization is that they don't need to actually be read from
3079 * the filesystem because the WIM already contains them.
3081 * This function is provided to optimize incremental backups. The resulting WIM
3082 * file will still be the same regardless of whether this function is called.
3083 * (This is, however, assuming that timestamps have not been manipulated or
3084 * unmaintained as to trick this function into thinking a file has not been
3085 * modified when really it has. To partly guard against such cases, other
3086 * metadata such as file sizes will be checked as well.)
3088 * This function must be called after adding the new image (e.g. with
3089 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3090 * wimlib_overwrite()).
3093 * Pointer to the ::WIMStruct for a WIM.
3095 * 1-based index in the WIM of the newly added image. This image can have
3096 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3097 * wimlib_add_empty_image() followed by wimlib_update_image().
3098 * @param template_wim
3099 * The ::WIMStruct for the WIM containing the template image. This can be
3100 * the same as @p wim, or it can be a different ::WIMStruct.
3101 * @param template_image
3102 * 1-based index in the WIM of a template image that reflects a prior state
3103 * of the directory tree being captured.
3105 * Reserved; must be 0.
3106 * @param progress_func
3107 * Currently ignored, but reserved for a function that will be called with
3108 * information about the operation. Use NULL if no additional information
3111 * @return 0 on success; nonzero on error.
3113 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3114 * @p new_image and/or @p template_image were not a valid image indices in
3116 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3117 * The specified ::WIMStruct did not actually contain the metadata resource
3118 * for the new or template image; for example, it was a non-first part of a
3120 * @retval ::WIMLIB_ERR_NOMEM
3121 * Failed to allocate needed memory.
3122 * @retval ::WIMLIB_ERR_INVALID_PARAM
3123 * @p new_image was equal to @p template_image, or @p new_image specified
3124 * an image that had not been modified since opening the WIM.
3126 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3127 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3128 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3129 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3130 * different reasons) to read the metadata resource for the template image.
3133 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3134 WIMStruct *template_wim, int template_image,
3135 int flags, wimlib_progress_func_t progress_func);
3138 * @ingroup G_wim_information
3140 * Translates a string specifying the name or number of an image in the WIM into
3141 * the number of the image. The images are numbered starting at 1.
3144 * Pointer to the ::WIMStruct for a WIM.
3145 * @param image_name_or_num
3146 * A string specifying the name or number of an image in the WIM. If it
3147 * parses to a positive integer, this integer is taken to specify the
3148 * number of the image, indexed starting at 1. Otherwise, it is taken to
3149 * be the name of an image, as given in the XML data for the WIM file. It
3150 * also may be the keyword "all" or the string "*", both of which will
3151 * resolve to ::WIMLIB_ALL_IMAGES.
3153 * There is no way to search for an image actually named "all", "*", or an
3154 * integer number, or an image that has no name. However, you can use
3155 * wimlib_get_image_name() to get the name of any image.
3158 * If the string resolved to a single existing image, the number of that
3159 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3160 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3161 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3162 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3163 * images in @p wim has no name.
3166 wimlib_resolve_image(WIMStruct *wim,
3167 const wimlib_tchar *image_name_or_num);
3170 * @ingroup G_modifying_wims
3172 * Changes the description of an image in the WIM.
3175 * Pointer to the ::WIMStruct for a WIM.
3177 * The number of the image for which to change the description.
3178 * @param description
3179 * The new description to give the image. It may be @c NULL, which
3180 * indicates that the image is to be given no description.
3182 * @return 0 on success; nonzero on error.
3183 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3184 * @p image does not specify a single existing image in @p wim.
3185 * @retval ::WIMLIB_ERR_NOMEM
3186 * Failed to allocate the memory needed to duplicate the @p description
3188 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3189 * @p wim is considered read-only because of any of the reasons mentioned
3190 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3193 wimlib_set_image_descripton(WIMStruct *wim, int image,
3194 const wimlib_tchar *description);
3197 * @ingroup G_writing_and_overwriting_wims
3199 * Set the compression chunk size of a WIM to use in subsequent calls to
3200 * wimlib_write() or wimlib_overwrite().
3202 * A compression chunk size will result in a greater compression ratio, but the
3203 * speed of random access to the WIM will be reduced, and the effect of an
3204 * increased compression chunk size is limited by the size of each file being
3207 * <b>WARNING: Microsoft's software is seemingly incompatible with LZX chunk
3208 * sizes other than 32768. Chunk sizes other than 32768 (for any format) are
3209 * also incompatible with wimlib v1.5.3 and earlier.</b>
3212 * ::WIMStruct for a WIM.
3213 * @param out_chunk_size
3214 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3215 * on the compression format. The XPRESS compression format supports chunk
3216 * sizes that are powers of 2 with exponents between 15 and 26 inclusively,
3217 * whereas the LZX compression format supports chunk sizes that are powers
3218 * of 2 with exponents between 15 and 21 inclusively. As a special case,
3219 * if @p out_chunk_size is specified as 0, the chunk size is set to the
3220 * default for the currently selected output compression type.
3222 * @return 0 on success; nonzero on error.
3224 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3225 * @p ctype is not a supported chunk size.
3228 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3231 * @ingroup G_writing_and_overwriting_wims
3233 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3237 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3240 * @ingroup G_writing_and_overwriting_wims
3242 * Set the compression type of a WIM to use in subsequent calls to
3243 * wimlib_write() or wimlib_overwrite().
3246 * ::WIMStruct for a WIM.
3248 * The compression type to set (one of ::wimlib_compression_type). If this
3249 * compression type is incompatible with the current output chunk size
3250 * (either the default or as set with wimlib_set_output_chunk_size()), the
3251 * output chunk size is reset to the default for that compression type.
3253 * @return 0 on success; nonzero on error.
3255 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3256 * @p ctype did not specify a valid compression type.
3259 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3262 * @ingroup G_writing_and_overwriting_wims
3264 * Similar to wimlib_set_output_compression_type(), but set the compression type
3265 * for writing packed streams.
3268 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3271 * @ingroup G_modifying_wims
3273 * Set basic information about a WIM.
3276 * Pointer to the ::WIMStruct for a WIM.
3278 * A struct ::wimlib_wim_info that contains the information to set. Only
3279 * the information explicitly specified in the @p which flags need be
3282 * Flags that specify which information to set. This is a bitwise OR of
3283 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3284 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3286 * @return 0 on success; nonzero on failure.
3287 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3288 * The WIM file is considered read-only because of any of the reasons
3289 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3290 * flag. However, as a special case, if you are using
3291 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3292 * function will not fail due to the readonly flag being previously set.
3293 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3294 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3295 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3299 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3303 * @ingroup G_modifying_wims
3305 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3306 * (something like "Core" or "Ultimate")
3309 * Pointer to the ::WIMStruct for a WIM.
3311 * The number of the image for which to change the description.
3313 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3314 * indicates that the image is to be given no \<FLAGS\> element.
3316 * @return 0 on success; nonzero on error.
3317 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3318 * @p image does not specify a single existing image in @p wim.
3319 * @retval ::WIMLIB_ERR_NOMEM
3320 * Failed to allocate the memory needed to duplicate the @p flags string.
3321 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3322 * @p wim is considered read-only because of any of the reasons mentioned
3323 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3326 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3329 * @ingroup G_modifying_wims
3331 * Changes the name of an image in the WIM.
3334 * Pointer to the ::WIMStruct for a WIM.
3336 * The number of the image for which to change the name.
3338 * New name to give the new image. If @c NULL or empty, the new image is
3339 * given no name. If nonempty, it must specify a name that does not
3340 * already exist in @p wim.
3342 * @return 0 on success; nonzero on error.
3343 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3344 * There is already an image named @p name in @p wim.
3345 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3346 * @p image does not specify a single existing image in @p wim.
3347 * @retval ::WIMLIB_ERR_NOMEM
3348 * Failed to allocate the memory needed to duplicate the @p name string.
3349 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3350 * @p wim is considered read-only because of any of the reasons mentioned
3351 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3354 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3357 * @ingroup G_general
3359 * Set the functions that wimlib uses to allocate and free memory.
3361 * These settings are global and not per-WIM.
3363 * The default is to use the default @c malloc() and @c free() from the C
3366 * Please note that some external functions, such as those in @c libntfs-3g, may
3367 * use the standard memory allocation functions.
3369 * @param malloc_func
3370 * A function equivalent to @c malloc() that wimlib will use to allocate
3371 * memory. If @c NULL, the allocator function is set back to the default
3372 * @c malloc() from the C library.
3374 * A function equivalent to @c free() that wimlib will use to free memory.
3375 * If @c NULL, the free function is set back to the default @c free() from
3377 * @param realloc_func
3378 * A function equivalent to @c realloc() that wimlib will use to reallocate
3379 * memory. If @c NULL, the free function is set back to the default @c
3380 * realloc() from the C library.
3384 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3385 void (*free_func)(void *),
3386 void *(*realloc_func)(void *, size_t));
3389 * @ingroup G_general
3391 * Sets whether wimlib is to print error messages to @c stderr when a function
3392 * fails. These error messages may provide information that cannot be
3393 * determined only from the error code that is returned. Not every error will
3394 * result in an error message being printed.
3396 * This setting is global and not per-WIM.
3398 * By default, error messages are not printed.
3400 * This can be called before wimlib_global_init().
3402 * @param show_messages
3403 * @c true if error messages are to be printed; @c false if error messages
3404 * are not to be printed.
3406 * @return 0 on success; nonzero on error.
3407 * @retval ::WIMLIB_ERR_UNSUPPORTED
3408 * @p show_messages was @c true, but wimlib was compiled with the @c
3409 * --without-error-messages option. Therefore, error messages cannot be
3413 wimlib_set_print_errors(bool show_messages);
3416 * @ingroup G_nonstandalone_wims
3418 * Splits a WIM into multiple parts.
3421 * The ::WIMStruct for the WIM to split.
3423 * Name of the SWM file to create. This will be the name of the first
3424 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3425 * appended before the suffix.
3427 * The maximum size per part, in bytes. Unfortunately, it is not
3428 * guaranteed that this will really be the maximum size per part, because
3429 * some file resources in the WIM may be larger than this size, and the WIM
3430 * file format provides no way to split up file resources among multiple
3432 * @param write_flags
3433 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3434 * flags will be used to write each split WIM part. Specify 0 here to get
3435 * the default behavior.
3436 * @param progress_func
3437 * If non-NULL, a function that will be called periodically with the
3438 * progress of the current operation
3439 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3440 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3442 * @return 0 on success; nonzero on error. This function may return most error
3443 * codes that can be returned by wimlib_write() as well as the following error
3446 * @retval ::WIMLIB_ERR_INVALID_PARAM
3447 * @p swm_name was not a nonempty string, or @p part_size was 0.
3449 * Note: the WIM's uncompressed and compressed resources are not checksummed
3450 * when they are copied from the joined WIM to the split WIM parts, nor are
3451 * compressed resources re-compressed (unless explicitly requested with
3452 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3455 wimlib_split(WIMStruct *wim,
3456 const wimlib_tchar *swm_name,
3459 wimlib_progress_func_t progress_func);
3462 * @ingroup G_mounting_wim_images
3464 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3466 * The image to unmount is specified by the path to the mountpoint, not the
3467 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3468 * touched and also may have been allocated in a different process.
3470 * To unmount the image, the process calling this function communicates with the
3471 * process that is managing the mounted WIM image. This function blocks until it
3472 * is known whether the unmount succeeded or failed. In the case of a
3473 * read-write mounted WIM, the unmount is not considered to have succeeded until
3474 * all changes have been saved to the underlying WIM file.
3477 * The directory that the WIM image was mounted on.
3478 * @param unmount_flags
3479 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3480 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3481 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3483 * @param progress_func
3484 * If non-NULL, a function that will be called periodically with the
3485 * progress of the current operation. Currently, only
3486 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3488 * @return 0 on success; nonzero on error.
3490 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3491 * The filesystem daemon was unable to remove the staging directory and the
3492 * temporary files that it contains.
3493 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3494 * The filesystem daemon appears to have terminated before sending an exit
3496 * @retval ::WIMLIB_ERR_FORK
3497 * Could not @c fork() the process.
3498 * @retval ::WIMLIB_ERR_FUSERMOUNT
3499 * The @b fusermount program could not be executed or exited with a failure
3501 * @retval ::WIMLIB_ERR_MQUEUE
3502 * Could not open a POSIX message queue to communicate with the filesystem
3503 * daemon servicing the mounted filesystem, could not send a message
3504 * through the queue, or could not receive a message through the queue.
3505 * @retval ::WIMLIB_ERR_NOMEM
3506 * Failed to allocate needed memory.
3507 * @retval ::WIMLIB_ERR_OPEN
3508 * The filesystem daemon could not open a temporary file for writing the
3510 * @retval ::WIMLIB_ERR_READ
3511 * A read error occurred when the filesystem daemon tried to a file from
3512 * the staging directory
3513 * @retval ::WIMLIB_ERR_RENAME
3514 * The filesystem daemon failed to rename the newly written WIM file to the
3515 * original WIM file.
3516 * @retval ::WIMLIB_ERR_UNSUPPORTED
3517 * Mounting is not supported, either because the platform is Windows, or
3518 * because the platform is UNIX-like and wimlib was compiled with @c
3520 * @retval ::WIMLIB_ERR_WRITE
3521 * A write error occurred when the filesystem daemon was writing to the new
3522 * WIM file, or the filesystem daemon was unable to flush changes that had
3523 * been made to files in the staging directory.
3526 wimlib_unmount_image(const wimlib_tchar *dir,
3528 wimlib_progress_func_t progress_func);
3531 * @ingroup G_modifying_wims
3533 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3536 * Pointer to the ::WIMStruct for the WIM file to update.
3538 * The 1-based index of the image in the WIM to update. It cannot be
3539 * ::WIMLIB_ALL_IMAGES.
3541 * An array of ::wimlib_update_command's that specify the update operations
3544 * Number of commands in @p cmds.
3545 * @param update_flags
3546 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3547 * @param progress_func
3548 * If non-NULL, a function that will be called periodically with the
3549 * progress of the current operation.
3551 * @return 0 on success; nonzero on error. On failure, some but not all of the
3552 * update commands may have been executed. No individual update command will
3553 * have been partially executed. Possible error codes include:
3555 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3556 * The capture configuration structure specified for an add command was
3558 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3559 * @p image did not specify a single, existing image in @p wim.
3560 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3561 * Attempted to perform an add command that conflicted with previously
3562 * existing files in the WIM when an overlay was attempted.
3563 * @retval ::WIMLIB_ERR_INVALID_PARAM
3564 * An unknown operation type was specified in the update commands; or,
3565 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3566 * in the @p add_flags, but the same image had previously already been
3567 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3568 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3569 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3570 * specified in the @p add_flags for an add command in which @p
3571 * wim_target_path was not the root directory of the WIM image.
3572 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3573 * (Windows only): While executing an add command, tried to capture a
3574 * reparse point with invalid data.
3575 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3576 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3577 * for a WIM path that corresponded to a directory; or, a rename command
3578 * attempted to rename a directory to a non-directory.
3579 * @retval ::WIMLIB_ERR_NOMEM
3580 * Failed to allocate needed memory.
3581 * @retval ::WIMLIB_ERR_NOTDIR
3582 * A rename command attempted to rename a directory to a non-directory; or,
3583 * an add command was executed that attempted to set the root of the WIM
3584 * image as a non-directory; or, a path component used as a directory in a
3585 * rename command was not, in fact, a directory.
3586 * @retval ::WIMLIB_ERR_NOTEMPTY
3587 * A rename command attempted to rename a directory to a non-empty
3589 * @retval ::WIMLIB_ERR_NTFS_3G
3590 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3591 * error occurred while reading data from the NTFS volume using libntfs-3g.
3592 * @retval ::WIMLIB_ERR_OPEN
3593 * Failed to open a file to be captured while executing an add command.
3594 * @retval ::WIMLIB_ERR_OPENDIR
3595 * Failed to open a directory to be captured while executing an add command.
3596 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3597 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3598 * WIM path that did not exist; or, a rename command attempted to rename a
3599 * file that does not exist.
3600 * @retval ::WIMLIB_ERR_READ
3601 * While executing an add command, failed to read data from a file or
3602 * directory to be captured.
3603 * @retval ::WIMLIB_ERR_READLINK
3604 * While executing an add command, failed to read the target of a symbolic
3605 * link or junction point.
3606 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3607 * (Windows only) Failed to perform a reparse point fixup because of
3608 * problems with the data of a reparse point.
3609 * @retval ::WIMLIB_ERR_STAT
3610 * While executing an add command, failed to get attributes for a file or
3612 * @retval ::WIMLIB_ERR_UNSUPPORTED
3613 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3614 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3615 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3616 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3617 * add_flags for an update command.
3618 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3619 * While executing an add command, attempted to capture a file that was not
3620 * a supported file type (e.g. a device file). Only if
3621 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3622 * for an update command.
3623 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3624 * The WIM file is considered read-only because of any of the reasons
3625 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3628 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3629 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3630 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3631 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3632 * different reasons) to read the metadata resource for an image that needed to
3636 wimlib_update_image(WIMStruct *wim,
3638 const struct wimlib_update_command *cmds,
3641 wimlib_progress_func_t progress_func);
3644 * @ingroup G_writing_and_overwriting_wims
3646 * Writes a WIM to a file.
3648 * This brings in resources from any external locations, such as directory trees
3649 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3650 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3652 * By default, the new WIM file is written as stand-alone. Using the
3653 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3654 * instead. However, this function cannot directly write a "split" WIM; use
3655 * wimlib_split() for that.
3658 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3659 * changes made to it, which are then reflected in the output file.
3661 * The path to the file to write the WIM to.
3663 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3664 * images are to be included in the new on-disk WIM file. If for some
3665 * reason you only want to include a single image, specify the index of
3666 * that image instead.
3667 * @param write_flags
3668 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3669 * @param num_threads
3670 * Number of threads to use for compressing data. If 0, the number of
3671 * threads is taken to be the number of online processors. Note: if no
3672 * data compression needs to be done, no additional threads will be created
3673 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3674 * exporting an image from a compressed WIM to another WIM of the same
3675 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3677 * @param progress_func
3678 * If non-NULL, a function that will be called periodically with the
3679 * progress of the current operation. The possible messages are
3680 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3681 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3682 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3684 * @return 0 on success; nonzero on error.
3686 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3687 * @p image does not specify a single existing image in @p wim, and is not
3688 * ::WIMLIB_ALL_IMAGES.
3689 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3690 * A file that had previously been scanned for inclusion in the WIM by
3691 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3692 * message digest check.
3693 * @retval ::WIMLIB_ERR_INVALID_PARAM
3694 * @p path was @c NULL.
3695 * @retval ::WIMLIB_ERR_NOMEM
3696 * Failed to allocate needed memory.
3697 * @retval ::WIMLIB_ERR_OPEN
3698 * Failed to open @p path for writing, or some file resources in @p wim
3699 * refer to files in the outside filesystem, and one of these files could
3700 * not be opened for reading.
3701 * @retval ::WIMLIB_ERR_READ
3702 * An error occurred when trying to read data from the WIM file associated
3703 * with @p wim, or some file resources in @p wim refer to files in the
3704 * outside filesystem, and a read error occurred when reading one of these
3706 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3707 * A stream that needed to be written could not be found in the stream
3708 * lookup table of @p wim. This error can occur if, for example, @p wim is
3709 * part of a split WIM but needed resources from the other split WIM parts
3710 * were not referenced with wimlib_reference_resources() or
3711 * wimlib_reference_resource_files() before the call to wimlib_write().
3712 * @retval ::WIMLIB_ERR_WRITE
3713 * An error occurred when trying to write data to the new WIM file.
3715 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3716 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3717 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3718 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3719 * different reasons) to read the metadata resource for an image that needed to
3723 wimlib_write(WIMStruct *wim,
3724 const wimlib_tchar *path,
3727 unsigned num_threads,
3728 wimlib_progress_func_t progress_func);
3731 * @ingroup G_writing_and_overwriting_wims
3733 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3734 * file descriptor, which need not be seekable if the write is done in a special
3735 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3736 * write_flags. This can, for example, allow capturing a WIM image and
3737 * streaming it over the network. See the documentation for
3738 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3740 * The file descriptor @p fd will @b not be closed when the write is complete;
3741 * the calling code is responsible for this.
3743 * Returns 0 on success; nonzero on failure. The possible error codes include
3744 * those that can be returned by wimlib_write() as well as the following:
3746 * @retval ::WIMLIB_ERR_INVALID_PARAM
3747 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3748 * specified in @p write_flags.
3751 wimlib_write_to_fd(WIMStruct *wim,
3755 unsigned num_threads,
3756 wimlib_progress_func_t progress_func);
3759 * @defgroup G_compression Compression and decompression functions
3761 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
3762 * exported for convenience only, as they are already used by wimlib internally
3765 * These functions can be used for general-purpose lossless data compression,
3766 * but some limitations apply; for example, none of the compressors or
3767 * decompressors currently support sliding windows, and there also exist
3768 * slightly different variants of these formats that are not supported
3773 * @ingroup G_compression
3777 /** Header for compression parameters to pass to wimlib_create_compressor() or
3778 * wimlib_set_default_compressor_params(). */
3779 struct wimlib_compressor_params_header {
3780 /** Size of the parameters, in bytes. */
3784 /** Header for decompression parameters to pass to wimlib_create_decompressor()
3785 * or wimlib_set_default_decompressor_params() */
3786 struct wimlib_decompressor_params_header {
3787 /** Size of the parameters, in bytes. */
3791 /** LZX compression parameters that can optionally be passed to
3792 * wimlib_create_compressor() with the compression type
3793 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
3794 struct wimlib_lzx_compressor_params {
3795 /** hdr.size Must be set to the size of this structure, in bytes. */
3796 struct wimlib_compressor_params_header hdr;
3798 /** Relatively fast LZX compression algorithm with a decent compression
3799 * ratio; the suggested default. */
3800 #define WIMLIB_LZX_ALGORITHM_FAST 0
3802 /** Slower LZX compression algorithm that provides a better compression
3804 #define WIMLIB_LZX_ALGORITHM_SLOW 1
3806 /** Algorithm to use to perform the compression: either
3807 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
3808 * format is still LZX; this refers to the method the code will use to
3809 * perform LZX-compatible compression. */
3810 uint32_t algorithm : 3;
3812 /** If set to 1, the default parameters for the specified algorithm are
3813 * used rather than the ones specified in the following union. */
3814 uint32_t use_defaults : 1;
3817 /** Parameters for the fast algorithm. */
3818 struct wimlib_lzx_fast_params {
3819 uint32_t fast_reserved1[10];
3822 /** Parameters for the slow algorithm. */
3823 struct wimlib_lzx_slow_params {
3824 /** If set to 1, the compressor can output length 2
3825 * matches. If set 0, the compressor only outputs
3826 * matches of length 3 or greater. Suggested value: 1
3828 uint32_t use_len2_matches : 1;
3830 uint32_t slow_reserved1 : 31;
3832 /** Matches with length (in bytes) longer than this
3833 * value are immediately taken without spending time on
3834 * minimum-cost measurements. Suggested value: 32. */
3835 uint32_t num_fast_bytes;
3837 /** Number of passes to compute a match/literal sequence
3838 * for each LZX block. This is for an iterative
3839 * algorithm that attempts to minimize the cost of the
3840 * match/literal sequence by using a cost model provided
3841 * by the previous iteration. Must be at least 1.
3842 * Suggested value: 2. */
3843 uint32_t num_optim_passes;
3845 /** Reserved; set to 0. */
3846 uint32_t slow_reserved_blocksplit;
3848 /** Maximum depth to search for matches at each
3849 * position. Suggested value: 50. */
3850 uint32_t max_search_depth;
3852 /** Maximum number of potentially good matches to
3853 * consider for each position. Suggested value: 3. */
3854 uint32_t max_matches_per_pos;
3856 uint32_t slow_reserved2[2];
3858 /** Assumed cost of a main symbol with zero frequency.
3859 * Must be at least 1 and no more than 16. Suggested
3861 uint8_t main_nostat_cost;
3863 /** Assumed cost of a length symbol with zero frequency.
3864 * Must be at least 1 and no more than 16. Suggested
3866 uint8_t len_nostat_cost;
3868 /** Assumed cost of an aligned symbol with zero
3869 * frequency. Must be at least 1 and no more than 8.
3870 * Suggested value: 7. */
3871 uint8_t aligned_nostat_cost;
3873 uint8_t slow_reserved3[5];
3878 /** Opaque compressor handle. */
3879 struct wimlib_compressor;
3881 /** Opaque decompressor handle. */
3882 struct wimlib_decompressor;
3885 * Set the default compression parameters for the specified compression type.
3886 * This will affect both explicit and wimlib-internal calls to
3887 * wimlib_create_compressor().
3890 * Compression type for which to set the default compression parameters.
3892 * Compression-type specific parameters. This may be @c NULL, in which
3893 * case the "default default" parameters are restored.
3895 * @return 0 on success; nonzero on error.
3897 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3898 * @p ctype was not a supported compression type.
3899 * @retval ::WIMLIB_ERR_NOMEM
3900 * Not enough memory to duplicate the parameters (perhaps @c params->size
3904 wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
3905 const struct wimlib_compressor_params_header *params);
3908 * Allocate a compressor for the specified compression type using the specified
3912 * Compression type for which to create the compressor.
3913 * @param max_block_size
3914 * Maximum block size to support. The exact meaning and allowed values for
3915 * this parameter depend on the compression type, but it at least specifies
3916 * the maximum allowed value for @p uncompressed_size to wimlib_compress().
3917 * @param extra_params
3918 * An optional pointer to extra compressor parameters for the specified
3919 * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params
3920 * may be specified here. If left @c NULL, the default parameters are
3922 * @param compressor_ret
3923 * A location into which to return the pointer to the allocated compressor,
3924 * which can be used for any number of calls to wimlib_compress() before
3925 * being freed with wimlib_free_compressor().
3927 * @return 0 on success; nonzero on error.
3929 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3930 * @p ctype was not a supported compression type.
3931 * @retval ::WIMLIB_ERR_INVALID_PARAM
3932 * The compression parameters were invalid.
3933 * @retval ::WIMLIB_ERR_NOMEM
3934 * Insufficient memory to allocate the compressor.
3937 wimlib_create_compressor(enum wimlib_compression_type ctype,
3938 size_t max_block_size,
3939 const struct wimlib_compressor_params_header *extra_params,
3940 struct wimlib_compressor **compressor_ret);
3943 * Losslessly compress a block of data using a compressor previously created
3944 * with wimlib_create_compressor().
3946 * @param uncompressed_data
3947 * Buffer containing the data to compress.
3948 * @param uncompressed_size
3949 * Size, in bytes, of the data to compress.
3950 * @param compressed_data
3951 * Buffer into which to write the compressed data.
3952 * @param compressed_size_avail
3953 * Number of bytes available in @p compressed_data.
3955 * A compressor previously allocated with wimlib_create_compressor().
3958 * The size of the compressed data, in bytes, or 0 if the input data could
3959 * not be compressed to @p compressed_size_avail or fewer bytes.
3962 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
3963 void *compressed_data, size_t compressed_size_avail,
3964 struct wimlib_compressor *compressor);
3967 * Free a compressor previously allocated with wimlib_create_compressor().
3970 * The compressor to free.
3973 wimlib_free_compressor(struct wimlib_compressor *compressor);
3976 * Set the default decompression parameters for the specified compression type.
3977 * This will affect both explicit and wimlib-internal calls to
3978 * wimlib_create_decompressor().
3981 * Compression type for which to set the default decompression parameters.
3983 * Compression-type specific parameters. This may be @c NULL, in which
3984 * case the "default default" parameters are restored.
3986 * @return 0 on success; nonzero on error.
3988 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3989 * @p ctype was not a supported compression type.
3990 * @retval ::WIMLIB_ERR_NOMEM
3991 * Not enough memory to duplicate the parameters (perhaps @c params->size
3995 wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
3996 const struct wimlib_decompressor_params_header *params);
3999 * Allocate a decompressor for the specified compression type using the
4000 * specified parameters.
4003 * Compression type for which to create the decompressor.
4004 * @param max_block_size
4005 * Maximum block size to support. The exact meaning and allowed values for
4006 * this parameter depend on the compression type, but it at least specifies
4007 * the maximum allowed value for @p uncompressed_size to
4008 * wimlib_decompress().
4009 * @param extra_params
4010 * An optional pointer to extra decompressor parameters for the specified
4011 * compression type. If @c NULL, the default parameters are used.
4012 * @param decompressor_ret
4013 * A location into which to return the pointer to the allocated
4014 * decompressor, which can be used for any number of calls to
4015 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4017 * @return 0 on success; nonzero on error.
4019 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4020 * @p ctype was not a supported compression type.
4021 * @retval ::WIMLIB_ERR_INVALID_PARAM
4022 * The decompression parameters were invalid.
4023 * @retval ::WIMLIB_ERR_NOMEM
4024 * Insufficient memory to allocate the decompressor.
4027 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4028 size_t max_block_size,
4029 const struct wimlib_decompressor_params_header *extra_params,
4030 struct wimlib_decompressor **decompressor_ret);
4033 * Decompress a block of data using a decompressor previously created with
4034 * wimlib_create_decompressor().
4036 * @param compressed_data
4037 * Buffer containing the data to decompress.
4038 * @param compressed_size
4039 * Size, in bytes, of the data to decompress.
4040 * @param uncompressed_data
4041 * Buffer into which to write the uncompressed data.
4042 * @param uncompressed_size
4043 * Size, in bytes, of the data when uncompressed.
4044 * @param decompressor
4045 * A decompressor previously allocated with wimlib_create_decompressor().
4047 * @return 0 on success; nonzero on error.
4050 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4051 void *uncompressed_data, size_t uncompressed_size,
4052 struct wimlib_decompressor *decompressor);
4055 * Free a decompressor previously allocated with wimlib_create_decompressor().
4057 * @param decompressor
4058 * The decompressor to free.
4061 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4064 struct wimlib_lzx_params_old;
4065 struct wimlib_lzx_context_old;
4067 /** Deprecated; do not use. */
4069 wimlib_lzx_set_default_params(const struct wimlib_lzx_params_old *params)
4072 /** Deprecated; do not use. */
4074 wimlib_lzx_alloc_context(const struct wimlib_lzx_params_old *params,
4075 struct wimlib_lzx_context_old **ctx_pp)
4078 /** Deprecated; do not use. */
4080 wimlib_lzx_free_context(struct wimlib_lzx_context_old *ctx)
4083 /** Deprecated; do not use. */
4085 wimlib_lzx_compress2(const void *udata, unsigned ulen, void *cdata,
4086 struct wimlib_lzx_context_old *ctx)
4089 /** Deprecated; do not use. */
4091 wimlib_lzx_compress(const void *udata, unsigned ulen, void *cdata)
4094 /** Deprecated; do not use. */
4096 wimlib_xpress_compress(const void *udata, unsigned ulen, void *cdata)
4099 /** Deprecated; do not use. */
4101 wimlib_lzx_decompress(const void *cdata, unsigned clen,
4102 void *udata, unsigned ulen)
4105 /** Deprecated; do not use. */
4107 wimlib_xpress_decompress(const void *cdata, unsigned clen,
4108 void *udata, unsigned ulen)
4119 #endif /* _WIMLIB_H */