3 * @brief External header for wimlib.
5 * This file contains extensive comments for generating documentation with
6 * Doxygen. The built HTML documentation can be viewed at
7 * http://wimlib.sourceforge.net. Make sure to see the <a
8 * href="modules.html">Modules page</a> to make more sense of the declarations
13 * Copyright (C) 2012, 2013, 2014 Eric Biggers
15 * This file is part of wimlib, a library for working with WIM files.
17 * wimlib is free software; you can redistribute it and/or modify it under the
18 * terms of the GNU General Public License as published by the Free
19 * Software Foundation; either version 3 of the License, or (at your option)
22 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
23 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
24 * A PARTICULAR PURPOSE. See the GNU General Public License for more
27 * You should have received a copy of the GNU General Public License
28 * along with wimlib; if not, see http://www.gnu.org/licenses/.
34 * @section sec_intro Introduction
36 * This is the documentation for the library interface of wimlib 1.6.2, a C
37 * library for creating, modifying, extracting, and mounting files in the
38 * Windows Imaging Format. This documentation is intended for developers only.
39 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
40 * program, please see the README file or manual pages.
42 * @section sec_installing_and_compiling Installing and Compiling
44 * wimlib uses the GNU autotools, so, on UNIX-like systems, it should be easy to
45 * install with <code>configure && make && sudo make install</code>; however,
46 * please see the README for more information about installing it.
48 * To use wimlib in your program after installing it, include wimlib.h and link
49 * your program with @c -lwim.
51 * As of wimlib 1.5.0, wimlib.h is also compatible with C++.
53 * Note: before calling any other function declared in wimlib.h,
54 * wimlib_global_init() can (and in some cases, must) be called. See its
55 * documentation for more details.
57 * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
59 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. There are
60 * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
61 * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
62 * which creates a new ::WIMStruct that initially contains no images and does
63 * not yet have a backing on-disk file. See @ref G_creating_and_opening_wims
66 * A WIM file, represented by a ::WIMStruct, contains zero or more images.
67 * Images can be extracted (or "applied") using wimlib_extract_image(), added
68 * (or "captured" or "appended") using wimlib_add_image(), deleted using
69 * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
70 * modified using wimlib_update_image(). However, changes made to a WIM
71 * represented by a ::WIMStruct have no persistent effect until the WIM is
72 * actually written to an on-disk file. This can be done using wimlib_write(),
73 * but if the WIM was originally opened using wimlib_open_wim(), then
74 * wimlib_overwrite() can be used instead. See @ref G_extracting_wims, @ref
75 * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
77 * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
78 * files is a multi-step process. For example, to add, or "append" an image to
79 * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
80 * append</b>, you must call the following functions:
82 * 1. wimlib_open_wim()
83 * 2. wimlib_add_image()
84 * 3. wimlib_overwrite()
86 * This design is very much on purpose as it makes the library more useful in
87 * general by allowing functions to be composed in different ways. For example,
88 * you can make multiple changes to a WIM and commit them all to the underlying
89 * file in only one overwrite operation, which is more efficient.
91 * @section sec_cleaning_up Cleaning up
93 * After you are done with any ::WIMStruct, you can call wimlib_free() to free
94 * all resources associated with it. Also, when you are completely done with
95 * using wimlib in your program, you can call wimlib_global_cleanup() to free
96 * any other resources allocated by the library.
98 * @section sec_error_handling Error Handling
100 * Most functions in wimlib return 0 on success and a positive error code on
101 * failure. Use wimlib_get_error_string() to get a string that describes an
102 * error code. wimlib also can print error messages to standard error itself
103 * when an error happens, and these may be more informative than the error code;
104 * to enable this, call wimlib_set_print_errors(). Please note that this is for
105 * convenience only, and some errors can occur without a message being printed.
106 * Currently, error messages and strings (as well as all documentation, for that
107 * matter) are only available in English.
109 * @section sec_encodings Locales and character encodings
111 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
112 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
115 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
116 * and the encoding is UTF-16LE.
118 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
119 * and the encoding is the locale-dependent multibyte encoding. I recommend you
120 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
121 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
122 * call wimlib_global_init() after having set your desired locale.
124 * @section sec_advanced Additional information and features
127 * @subsection subsec_mounting_wim_images Mounting WIM images
129 * See @ref G_mounting_wim_images.
131 * @subsection subsec_progress_functions Progress Messages
133 * See @ref G_progress.
135 * @subsection subsec_non_standalone_wims Non-standalone WIMs
137 * See @ref G_nonstandalone_wims.
139 * @subsection subsec_pipable_wims Pipable WIMs
141 * wimlib supports a special "pipable" WIM format which unfortunately is @b not
142 * compatible with Microsoft's software. To create a pipable WIM, call
143 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
144 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
145 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
146 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
147 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
148 * s using a seekable file descriptor using the regular function calls (e.g.
149 * wimlib_open_wim(), wimlib_extract_image()).
151 * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
152 * capture</b> for more information about pipable WIMs.
154 * @subsection subsec_thread_safety Thread Safety
156 * wimlib is thread-safe, with the following exceptions:
157 * - Different threads cannot operate on the same ::WIMStruct at the same time;
158 * they must use different ::WIMStruct's.
159 * - You must call wimlib_global_init() in one thread before calling any other
161 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
162 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
163 * concurrently in the same process, will daemonize the entire process when it
164 * does so for the first time. This includes changing the working directory
165 * to the root directory.
167 * @subsection subsec_limitations Limitations
169 * This section documents some technical limitations of wimlib not already
170 * documented in the man page for @b wimlib-imagex.
172 * - The old WIM format from Vista pre-releases is not supported.
173 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
174 * functionality other than that already present in @b ImageX, that allows you
175 * to make certain Windows-specific modifications to a Windows PE image, such
176 * as adding a driver or Windows component. Such a tool could be implemented
179 * @subsection more_info More information
181 * You are advised to read the README as well as the manual pages for
182 * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
183 * the API documentation.
186 /** @defgroup G_general General
188 * @brief Declarations and structures shared across the library.
191 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
193 * @brief Create new WIMs and open existing WIMs.
196 /** @defgroup G_wim_information Retrieving WIM information and directory listings
198 * @brief Retrieve information about a WIM or WIM image.
201 /** @defgroup G_modifying_wims Modifying WIMs
203 * @brief Make changes to a WIM.
205 * @section sec_adding_images Capturing and adding WIM images
207 * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
208 * appending an image to an existing WIM is a multi-step process, but at its
209 * core is wimlib_add_image() or an equivalent function. Normally,
210 * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
211 * ::WIMStruct as a new image. However, when supported by the build of the
212 * library, there is also a special NTFS volume capture mode (entered when
213 * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
214 * from an unmounted NTFS volume.
216 * Another function, wimlib_add_image_multisource() is also provided. It
217 * generalizes wimlib_add_image() to allow combining multiple files or directory
218 * trees into a single WIM image in a configurable way.
220 * For maximum customization of WIM image creation, it is also possible to add a
221 * completely empty WIM image with wimlib_add_empty_image(), then update it with
222 * wimlib_update_image(). (This is in fact what wimlib_add_image() and
223 * wimlib_add_image_multisource() do internally.)
225 * Note that some details of how image addition/capture works are documented
226 * more fully in the manual page for <b>wimlib-imagex capture</b>.
228 * @section sec_deleting_images Deleting WIM images
230 * wimlib_delete_image() can delete an image from a ::WIMStruct. But as usual,
231 * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
232 * be made persistent in an on-disk WIM file.
234 * @section sec_exporting_images Exporting WIM images
236 * wimlib_export_image() can copy, or "export", an image from one WIM to
239 * @section sec_other_modifications Other modifications
241 * wimlib_update_image() can add, delete, and rename files in a WIM image.
243 * wimlib_set_image_name(), wimlib_set_image_descripton(), and
244 * wimlib_set_image_flags() can change other image metadata.
246 * wimlib_set_wim_info() can change information about the WIM file itself, such
250 /** @defgroup G_extracting_wims Extracting WIMs
252 * @brief Extract files, directories, and images from a WIM.
254 * wimlib_extract_image() extracts, or "applies", an image from a WIM,
255 * represented by a ::WIMStruct. This normally extracts the image to a
256 * directory, but when supported by the build of the library there is also a
257 * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
258 * is specified) that allows extracting a WIM image directly to an unmounted
259 * NTFS volume. Various other flags allow further customization of image
262 * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
263 * of (possibly wildcard) paths from a WIM image.
265 * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
266 * over a pipe; see @ref subsec_pipable_wims.
268 * Some details of how WIM extraction works are documented more fully in the
269 * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
272 /** @defgroup G_mounting_wim_images Mounting WIM images
274 * @brief Mount and unmount WIM images.
276 * On UNIX-like systems supporting FUSE (such as Linux), wimlib supports
277 * mounting images from WIM files either read-only or read-write. To mount an
278 * image, call wimlib_mount_image(). To unmount an image, call
279 * wimlib_unmount_image(). Mounting can be done without root privileges because
280 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
281 * compiled with the <code>--without-fuse</code> flag, these functions will be
282 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED. Note that mounting an
283 * image read-write is an alternative to calling wimlib_update_image().
286 /** @defgroup G_progress Progress Messages
288 * @brief Track the progress of long WIM operations.
290 * When operating on large archives, operations such as extraction will
291 * naturally take a while to complete. Because of this and to improve the
292 * potential user-friendliness of library clients, a number of functions take a
293 * pointer to a progress function of type ::wimlib_progress_func_t. This
294 * function will be called periodically during the WIM operation(s) to report on
295 * the progress of the operation (for example, how many bytes have been written
299 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
301 * @brief Write and overwrite on-disk WIM files.
303 * As described in @ref sec_basic_wim_handling_concepts, these functions are
304 * critical to the design of the library as they allow new or modified WIMs to
305 * actually be written to on-disk files. Generally, wimlib_write() is the
306 * function you need to call to write a new WIM file, and wimlib_overwrite() is
307 * the function you need to call to persistently update an existing WIM file.
310 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
312 * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
314 * Normally, ::WIMStruct represents a WIM file, but there's a bit more to it
315 * than that. Normally, WIM files are "standalone". However, WIM files can
316 * also be arranged in non-standalone ways, such as a set of on-disk files that
317 * together form a single "split WIM" or "delta WIM". Such arrangements are
318 * fully supported by wimlib. However, as a result, in such cases a ::WIMStruct
319 * created from one of these on-disk files initially only partially represents
320 * the full WIM and needs to, in effect, be logically combined with other
321 * ::WIMStruct's before performing certain operations, such as extracting files
322 * with wimlib_extract_image() or wimlib_extract_paths(). This is done by
323 * calling wimlib_reference_resource_files() or wimlib_reference_resources().
325 * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
326 * specialized function (wimlib_split()) is needed to create a split WIM.
335 #include <inttypes.h>
338 /** @ingroup G_general
341 /** Major version of the library (for example, the 1 in 1.2.5). */
342 #define WIMLIB_MAJOR_VERSION 1
344 /** Minor version of the library (for example, the 2 in 1.2.5). */
345 #define WIMLIB_MINOR_VERSION 6
347 /** Patch version of the library (for example, the 5 in 1.2.5). */
348 #define WIMLIB_PATCH_VERSION 2
355 /** @ingroup G_general
359 * Opaque structure that represents a WIM file. This is an in-memory structure
360 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
361 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
362 * continuing to exist so that data can be read from it as needed.
364 * Most functions in this library will work the same way regardless of whether a
365 * given ::WIMStruct was obtained through wimlib_open_wim() or
366 * wimlib_create_new_wim(). Exceptions are documented.
368 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
369 * file from a ::WIMStruct.
371 * See @ref sec_basic_wim_handling_concepts for more information.
373 #ifndef WIMLIB_WIMSTRUCT_DECLARED
374 typedef struct WIMStruct WIMStruct;
375 #define WIMLIB_WIMSTRUCT_DECLARED
379 typedef wchar_t wimlib_tchar;
381 /** See @ref sec_encodings */
382 typedef char wimlib_tchar;
386 /** Path separator for WIM paths passed back to progress callbacks. */
387 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
388 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
390 /** Path separator for WIM paths passed back to progress callbacks. */
391 # define WIMLIB_WIM_PATH_SEPARATOR '/'
392 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
396 # define _wimlib_deprecated __attribute__((deprecated))
398 # define _wimlib_deprecated
401 #define WIMLIB_GUID_LEN 16
404 * Specifies the compression type of a WIM file.
406 enum wimlib_compression_type {
407 /** An invalid compression type. */
408 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
410 /** The WIM does not include any compressed resources. */
411 WIMLIB_COMPRESSION_TYPE_NONE = 0,
413 /** Compressed resources in the WIM use XPRESS compression. */
414 WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
416 /** Compressed resources in the WIM use LZX compression. */
417 WIMLIB_COMPRESSION_TYPE_LZX = 2,
419 /** Compressed resources in the WIM use LZMS compression. Note: LZMS
420 * compression is only compatible with wimlib v1.6.0 and later and with
421 * WIMGAPI Windows 8 and later (and some restrictions apply on the
423 WIMLIB_COMPRESSION_TYPE_LZMS = 3,
427 /** @ingroup G_progress
430 /** Possible values of the first parameter to the user-supplied
431 * ::wimlib_progress_func_t progress function */
432 enum wimlib_progress_msg {
434 /** A WIM image is about to be extracted. @p info will point to
435 * ::wimlib_progress_info.extract. This message is received once per
436 * image for calls to wimlib_extract_image() and
437 * wimlib_extract_image_from_pipe(). */
438 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
440 /** One or more file or directory trees within a WIM image is about to
441 * be extracted. @p info will point to ::wimlib_progress_info.extract.
442 * This message is received only once per wimlib_extract_paths() and
443 * wimlib_extract_pathlist(), since wimlib combines all paths into a
444 * single extraction operation for optimization purposes. */
445 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
447 /** The directory structure and other preliminary metadata is about to
448 * be extracted. @p info will point to ::wimlib_progress_info.extract.
449 * This message is received once after either
450 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN or
451 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
452 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
454 /** Confirms that the directory structure and other preliminary metadata
455 * has been successfully extracted. @p info will point to
456 * ::wimlib_progress_info.extract. This message is paired with a
457 * preceding ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN message.
459 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
461 /** File data is currently being extracted. @p info will point to
462 * ::wimlib_progress_info.extract. This is the main message to track
463 * the progress of an extraction operation. */
464 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
466 /** Starting to read a new part of a split pipable WIM over the pipe.
467 * @p info will point to ::wimlib_progress_info.extract. */
468 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
470 /** All data for WIM files and directories have been extracted, and
471 * final metadata such as timestamps is about to be extracted. @p info
472 * will point to ::wimlib_progress_info.extract. This message is
473 * received once before ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END or
474 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END. */
475 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
477 /** Confirms that the image has been successfully extracted. @p info
478 * will point to ::wimlib_progress_info.extract. This is paired with
479 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN. */
480 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
482 /** Confirms that the files or directory trees have been successfully
483 * extracted. @p info will point to ::wimlib_progress_info.extract.
484 * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN. */
485 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
487 /** The directory or NTFS volume is about to be scanned for metadata.
488 * @p info will point to ::wimlib_progress_info.scan. This message is
489 * received once per call to wimlib_add_image(), or once per capture
490 * source passed to wimlib_add_image_multisource(), or once per add
491 * command passed to wimlib_update_image(). */
492 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
494 /** A directory or file has been scanned. @p info will point to
495 * ::wimlib_progress_info.scan, and its @p cur_path member will be
496 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
498 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
500 /** Confirms that the directory or NTFS volume has been successfully
501 * scanned. @p info will point to ::wimlib_progress_info.scan. This is
502 * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
503 * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
505 WIMLIB_PROGRESS_MSG_SCAN_END,
507 /** File resources ("streams") are currently being written to the WIM.
508 * @p info will point to ::wimlib_progress_info.write_streams. This
509 * message may be received many times while the WIM file is being
510 * written or appended to with wimlib_write(), wimlib_overwrite(), or
511 * wimlib_write_to_fd(). */
512 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
514 /** Per-image metadata is about to be written to the WIM file. @p info
515 * will not be valid. */
516 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
518 /** Confirms that per-image metadata has been successfully been written
519 * to the WIM file. @p info will not be valid. This message is paired
520 * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
522 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
524 /** wimlib_overwrite() has successfully renamed the temporary file to
525 * the original WIM file, thereby committing the update. @p info will
526 * point to ::wimlib_progress_info.rename. Note: this message is not
527 * received if wimlib_overwrite() chose to append to the WIM file
529 WIMLIB_PROGRESS_MSG_RENAME,
531 /** The contents of the WIM file are being checked against the integrity
532 * table. @p info will point to ::wimlib_progress_info.integrity. This
533 * message is only received (and may be received many times) when
534 * wimlib_open_wim() is called with the
535 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. */
536 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
538 /** An integrity table is being calculated for the WIM being written.
539 * @p info will point to ::wimlib_progress_info.integrity. This message
540 * is only received (and may be received many times) when a WIM file is
541 * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
542 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
545 WIMLIB_PROGRESS_MSG_RESERVED,
547 /** A wimlib_split() operation is in progress, and a new split part is
548 * about to be started. @p info will point to
549 * ::wimlib_progress_info.split. */
550 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
552 /** A wimlib_split() operation is in progress, and a split part has been
553 * finished. @p info will point to ::wimlib_progress_info.split. */
554 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
556 /** A WIM update command is just about to be executed. @p info will
557 * point to ::wimlib_progress_info.update. This message is received
558 * once per update command when wimlib_update_image() is called with the
559 * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
560 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
562 /** A WIM update command has just been executed. @p info will point to
563 * ::wimlib_progress_info.update. This message is received once per
564 * update command when wimlib_update_image() is called with the flag
565 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS. */
566 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
568 /** A file in the WIM image is being replaced as a result of a
569 * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
570 * This is only received when ::WIMLIB_ADD_FLAG_VERBOSE is also
571 * specified in the add command. */
572 WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM,
575 /** A pointer to this union is passed to the user-supplied
576 * ::wimlib_progress_func_t progress function. One (or none) of the structures
577 * contained in this union will be applicable for the operation
578 * (::wimlib_progress_msg) indicated in the first argument to the progress
580 union wimlib_progress_info {
582 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
583 * document them if they aren't given a name... */
585 /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. This is
586 * the primary message for tracking the progress of writing a WIM file.
588 struct wimlib_progress_info_write_streams {
589 /** Total number of uncompressed bytes of stream data being
590 * written. This can be thought of as the total uncompressed
591 * size of the files being archived, with some caveats. WIM
592 * files use single-instance streams, so the size provided here
593 * only counts distinct streams, except for the following
594 * exception: the size provided here may include the sizes of
595 * all newly added (e.g. with wimlib_add_image() streams,
596 * pending automatic de-duplication during the write operation
597 * itself. When each such stream de-duplication occurs, this
598 * number will be decreased by the size of the duplicate stream
599 * that need not be written.
601 * In the case of a wimlib_overwrite() that the library opted to
602 * perform in-place, both @p total_streams and @p total_bytes
603 * will only count the streams actually being written and not
604 * pre-existing streams in the WIM file. */
605 uint64_t total_bytes;
607 /** Total number of streams being written. This can be thought
608 * of as the total number of files being archived, with some
609 * caveats. In general, a single file or directory may contain
610 * multiple data streams, each of which will be represented
611 * separately in this number. Furthermore, WIM files use
612 * single-instance streams, so the stream count provided here
613 * only counts distinct streams, except for the following
614 * exception: the stream count provided here may include newly
615 * added (e.g. with wimlib_add_image() streams, pending
616 * automatic de-duplication during the write operation itself.
617 * When each such stream de-duplication occurs, this number will
618 * be decreased by 1 to account for the duplicate stream that
619 * need not be written. */
620 uint64_t total_streams;
622 /** Number of uncompressed bytes of stream data that have been
623 * written so far. This number be 0 initially, and will be
624 * equal to @p total_bytes at the end of the write operation.
625 * Note that @p total_bytes (but not @p completed_bytes) may
626 * decrease throughout the write operation due to the discovery
627 * of stream duplications. */
628 uint64_t completed_bytes;
630 /** Number of streams that have been written so far. This
631 * number will be 0 initially, and will be equal to @p
632 * total_streams at the end of the write operation. Note that
633 * @p total_streams (but not @p completed_streams) may decrease
634 * throughout the write operation due to the discovery of stream
637 * For applications that wish to calculate a simple "percent
638 * complete" for the write operation, it will likely be more
639 * accurate to calculate the percentage from @p completed_bytes
640 * and @p total_bytes rather than @p completed_streams and
641 * @p total_streams because the time for the operation to
642 * complete is mainly determined by the number of bytes that
643 * need to be read, compressed, and written, not just the number
644 * of files being archived. */
645 uint64_t completed_streams;
647 /** Number of threads that are being used to compress streams,
648 * or 1 if streams are being written uncompressed. */
649 uint32_t num_threads;
651 /** The compression type being used to write the streams, as one
652 * of the ::wimlib_compression_type constants. */
653 int32_t compression_type;
655 /** Number of split WIM parts from which streams are being
656 * written (may be 0 if irrelevant). */
657 uint32_t total_parts;
659 /** This is currently broken and will always be 0. */
660 uint32_t completed_parts;
663 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
664 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
665 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
666 struct wimlib_progress_info_scan {
667 /** Top-level directory being scanned; or, when capturing a NTFS
668 * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
669 * to the file or block device that contains the NTFS volume
671 const wimlib_tchar *source;
673 /** Path to the file (or directory) that has been scanned, valid
674 * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. When capturing a NTFS
675 * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
676 * relative to the root of the NTFS volume. */
677 const wimlib_tchar *cur_path;
679 /** Dentry scan status, valid on
680 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY. */
682 /** The file looks okay and will be captured. */
683 WIMLIB_SCAN_DENTRY_OK = 0,
685 /** File is being excluded from capture due to the
686 * capture configuration. */
687 WIMLIB_SCAN_DENTRY_EXCLUDED,
689 /** File is being excluded from capture due to being
690 * unsupported (e.g. an encrypted or device file). */
691 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
693 /** The file is an absolute symbolic link or junction
694 * point and it is being excluded from capture because
695 * it points outside of the capture directory and
696 * reparse-point fixups are enabled. (Reparse point
697 * fixups can be disabled by using the flag
698 * ::WIMLIB_ADD_FLAG_NORPFIX.) */
699 WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK,
703 /** Target path in the WIM image. Only valid on
704 * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
705 * ::WIMLIB_PROGRESS_MSG_SCAN_END. If capturing a full
706 * image, this will be the empty string; otherwise it
707 * will name the place in the WIM image at which the
708 * directory tree is being added. */
709 const wimlib_tchar *wim_target_path;
711 /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
712 * of @p WIMLIB_SCAN_DENTRY_EXCLUDED_SYMLINK, this is
713 * the target of the absolute symbolic link or junction
715 const wimlib_tchar *symlink_target;
718 /** Number of directories scanned so far, including the root
719 * directory but excluding any unsupported/excluded directories.
721 * Details: On Windows and in NTFS capture mode, a reparse point
722 * counts as a directory if and only if it has
723 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
724 * counts as a directory if and only if when fully dereferenced
725 * it points to an accessible directory. If a file has multiple
726 * names (hard links), it is only counted one time. */
727 uint64_t num_dirs_scanned;
729 /** Number of non-directories scanned so far, excluding any
730 * unsupported/excluded files.
732 * Details: On Windows and in NTFS capture mode, a reparse point
733 * counts as a non-directory if and only if it does not have
734 * FILE_ATTRIBUTE_DIRECTORY set. Otherwise, a symbolic link
735 * counts as a non-directory if and only if when fully
736 * dereferenced it points to a non-directory or its target is
737 * inaccessible. If a file has multiple names (hard links), it
738 * is only counted one time. */
739 uint64_t num_nondirs_scanned;
741 /** Number of bytes of file data that have been detected so far.
743 * Details: This data may not actually have been read yet, and
744 * it will not actually be written to the WIM file until
745 * wimlib_write() or wimlib_overwrite() has been called. Data
746 * from excluded files is not counted. This number includes
747 * default file contents as well as named data streams and
748 * reparse point data. The size of reparse point data is
749 * tallied after any reparse-point fixups, and in the case of
750 * capturing a symbolic link on a UNIX-like system, the creation
751 * of the reparse point data itself. If a file has multiple
752 * names (hard links), its size(s) are only counted one time.
753 * On Windows, encrypted files have their encrypted size
754 * counted, not their unencrypted size; however, compressed
755 * files have their uncompressed size counted. */
756 uint64_t num_bytes_scanned;
759 /** Valid on messages
760 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
761 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
762 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
763 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
764 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
765 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
766 * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
767 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END, and
768 * ::WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS.
770 * Note: most of the time of an extraction operation will be spent
771 * extracting streams, and the application will receive
772 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time. Using @p
773 * completed_bytes and @p total_bytes, the application can calculate a
774 * percentage complete. However, note that this message does not, in
775 * general, actually provide information about which "file" is currently
776 * being extracted. This is because wimlib, by default, extracts the
777 * individual data streams in whichever order it determines to be the
780 struct wimlib_progress_info_extract {
781 /** Number of the image from which files are being extracted
785 /** Extraction flags being used. */
786 uint32_t extract_flags;
788 /** Full path to the WIM file from which files are being
789 * extracted, or @c NULL if the WIMStruct has no associated
791 const wimlib_tchar *wimfile_name;
793 /** Name of the image from which files are being extracted, or
794 * the empty string if the image is unnamed. */
795 const wimlib_tchar *image_name;
797 /** Path to the directory or NTFS volume to which the files are
798 * being extracted. */
799 const wimlib_tchar *target;
802 const wimlib_tchar *reserved;
804 /** Number of bytes of uncompressed data that will be extracted.
805 * If a file has multiple names (hard links), its size (or
806 * sizes, in the case of named data streams) is only counted one
807 * time. For "reparse points" and symbolic links, the size to
808 * be extracted is the size of the reparse data buffer.
810 * This number will stay constant throughout the extraction. */
811 uint64_t total_bytes;
813 /** Number of bytes of uncompressed data that have been
814 * extracted so far. This initially be 0 and will equal to @p
815 * total_bytes at the end of the extraction. */
816 uint64_t completed_bytes;
818 /** Number of (not necessarily unique) streams that will be
819 * extracted. This may be more or less than the number of
820 * "files" to be extracted due to hard links as well as
821 * potentially multiple streams per file (named data streams).
822 * A "stream" may be the default contents of a file, a named
823 * data stream, or a reparse data buffer. */
824 uint64_t num_streams;
826 /** This will be the empty string. */
827 const wimlib_tchar *extract_root_wim_source_path;
829 /** Currently only used for
830 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
831 uint32_t part_number;
833 /** Currently only used for
834 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
835 uint32_t total_parts;
837 /** Currently only used for
838 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
839 uint8_t guid[WIMLIB_GUID_LEN];
842 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
843 struct wimlib_progress_info_rename {
844 /** Name of the temporary file that the WIM was written to. */
845 const wimlib_tchar *from;
847 /** Name of the original WIM file to which the temporary file is
849 const wimlib_tchar *to;
852 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
853 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
854 struct wimlib_progress_info_update {
855 /** Pointer to the update command that will be executed or has
856 * just been executed. */
857 const struct wimlib_update_command *command;
859 /** Number of update commands that have been completed so far.
861 size_t completed_commands;
863 /** Number of update commands that are being executed as part of
864 * this call to wimlib_update_image(). */
865 size_t total_commands;
868 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
869 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
870 struct wimlib_progress_info_integrity {
871 /** Number of bytes from the end of the WIM header to the end of
872 * the lookup table (the area that is covered by the SHA1
873 * integrity checks.) */
874 uint64_t total_bytes;
876 /** Number of bytes that have been SHA1-summed so far. Will be
877 * 0 initially, and equal @p total_bytes at the end. */
878 uint64_t completed_bytes;
880 /** Number of chunks that the checksummed region is divided
882 uint32_t total_chunks;
884 /** Number of chunks that have been SHA1-summed so far. Will
885 * be 0 initially, and equal to @p total_chunks at the end. */
886 uint32_t completed_chunks;
888 /** Size of the chunks used for the integrity calculation. */
891 /** Filename of the WIM (only valid if the message is
892 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
893 const wimlib_tchar *filename;
896 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
897 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
898 struct wimlib_progress_info_split {
899 /** Total size of the original WIM's file and metadata resources
901 uint64_t total_bytes;
903 /** Number of bytes of file and metadata resources that have
904 * been copied out of the original WIM so far. Will be 0
905 * initially, and equal to @p total_bytes at the end. */
906 uint64_t completed_bytes;
908 /** Number of the split WIM part that is about to be started
909 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
910 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
911 unsigned cur_part_number;
913 /** Total number of split WIM parts that are being written. */
914 unsigned total_parts;
916 /** Name of the split WIM part that is about to be started
917 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
918 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
919 const wimlib_tchar *part_name;
922 /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM */
923 struct wimlib_progress_info_replace {
924 /** Path to the file in the WIM image that is being replaced */
925 const wimlib_tchar *path_in_wim;
929 /** A user-supplied function that will be called periodically during certain WIM
930 * operations. The first argument will be the type of operation that is being
931 * performed or is about to be started or has been completed. The second
932 * argument will be a pointer to one of a number of structures depending on the
933 * first argument. It may be @c NULL for some message types.
935 * The return value of the progress function is currently ignored, but it may do
936 * something in the future. (Set it to 0 for now.)
938 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
939 const union wimlib_progress_info *info);
942 /** @ingroup G_modifying_wims
945 /** An array of these structures is passed to wimlib_add_image_multisource() to
946 * specify the sources from which to create a WIM image. */
947 struct wimlib_capture_source {
948 /** Absolute or relative path to a file or directory on the external
949 * filesystem to be included in the WIM image. */
950 wimlib_tchar *fs_source_path;
952 /** Destination path in the WIM image. Leading and trailing slashes are
953 * ignored. The empty string or @c NULL means the root directory of the
955 wimlib_tchar *wim_target_path;
957 /** Reserved; set to 0. */
961 /** Set or unset the WIM header flag that marks it read-only
962 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
963 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
964 * is distinct from basic file permissions; this flag can be set on a WIM file
965 * that is physically writable. If this flag is set, all further operations to
966 * modify the WIM will fail, except calling wimlib_overwrite() with
967 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
968 * allows you to set this flag persistently on the underlying WIM file.
970 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
972 /** Set the GUID (globally unique identifier) of the WIM file to the value
973 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
974 #define WIMLIB_CHANGE_GUID 0x00000002
976 /** Change the bootable image of the WIM to the value specified in
977 * ::wimlib_wim_info.boot_index of the @p info parameter. */
978 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
980 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
981 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
982 * indicates whether an image in the WIM has been captured with reparse-point
983 * fixups enabled. wimlib also treats this flag as specifying whether to do
984 * reparse-point fixups by default when capturing or applying WIM images. */
985 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
988 /** @ingroup G_wim_information
991 /** General information about a WIM file. */
992 struct wimlib_wim_info {
994 /** Globally unique identifier for the WIM file. Note: all parts of a
995 * split WIM should have an identical value in this field. */
996 uint8_t guid[WIMLIB_GUID_LEN];
998 /** Number of images in the WIM. */
999 uint32_t image_count;
1001 /** 1-based index of the bootable image in the WIM, or 0 if no image is
1003 uint32_t boot_index;
1005 /** Version of the WIM file. */
1006 uint32_t wim_version;
1008 /** Chunk size used for compression. */
1009 uint32_t chunk_size;
1011 /** For split WIMs, the 1-based index of this part within the split WIM;
1013 uint16_t part_number;
1015 /** For split WIMs, the total number of parts in the split WIM;
1017 uint16_t total_parts;
1019 /** One of the ::wimlib_compression_type values that specifies the
1020 * method used to compress resources in the WIM. */
1021 int32_t compression_type;
1023 /** Size of the WIM file in bytes, excluding the XML data and integrity
1025 uint64_t total_bytes;
1027 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
1028 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1029 * this will always be 0, even if the ::WIMStruct was written to
1030 * somewhere by calling wimlib_write() with the
1031 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1032 uint32_t has_integrity_table : 1;
1034 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1035 * wimlib_create_new_wim(). */
1036 uint32_t opened_from_file : 1;
1038 /** 1 if the WIM is considered readonly for any reason. */
1039 uint32_t is_readonly : 1;
1041 /** 1 if reparse-point fixups are supposedly enabled for one or more
1042 * images in the WIM. */
1043 uint32_t has_rpfix : 1;
1045 /** 1 if the WIM is marked as read-only. */
1046 uint32_t is_marked_readonly : 1;
1048 /** 1 if the WIM is part of a spanned set. */
1049 uint32_t spanned : 1;
1051 uint32_t write_in_progress : 1;
1052 uint32_t metadata_only : 1;
1053 uint32_t resource_only : 1;
1055 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
1056 uint32_t pipable : 1;
1057 uint32_t reserved_flags : 22;
1058 uint32_t reserved[9];
1061 /** Information about a unique stream in the WIM file. (A stream is the same
1062 * thing as a "resource", except in the case of packed resources.) */
1063 struct wimlib_resource_entry {
1064 /** Uncompressed size of the stream in bytes. */
1065 uint64_t uncompressed_size;
1067 /** Compressed size of the stream in bytes. This will be the same as @p
1068 * uncompressed_size if the stream is uncompressed. Or, if @p
1069 * is_packed_streams is 1, this will be 0. */
1070 uint64_t compressed_size;
1072 /** Offset, in bytes, of this stream from the start of the WIM file. Or
1073 * if @p packed is 1, then this is actually the offset at which this
1074 * stream begins in the uncompressed contents of the packed resource.
1078 /** SHA1 message digest of the stream's uncompressed contents. */
1079 uint8_t sha1_hash[20];
1081 /** Which part number of the split WIM this stream is in. This should
1082 * be the same as the part number provided by wimlib_get_wim_info(). */
1083 uint32_t part_number;
1085 /** Number of times this stream is referenced over all WIM images. */
1086 uint32_t reference_count;
1088 /** 1 if this stream is compressed. */
1089 uint32_t is_compressed : 1;
1091 /** 1 if this stream is a metadata resource rather than a file resource.
1093 uint32_t is_metadata : 1;
1095 uint32_t is_free : 1;
1096 uint32_t is_spanned : 1;
1098 /** 1 if this stream was not found in the lookup table of the
1099 * ::WIMStruct. This normally implies a missing call to
1100 * wimlib_reference_resource_files() or wimlib_reference_resources().
1102 uint32_t is_missing : 1;
1104 /** 1 if this stream is located in a packed resource which may contain
1105 * other streams (all compressed together) as well. */
1106 uint32_t packed : 1;
1108 uint32_t reserved_flags : 26;
1110 /** If @p packed is 1, then this will specify the offset of the packed
1111 * resource in the WIM. */
1112 uint64_t raw_resource_offset_in_wim;
1114 /** If @p is_packed_streams is 1, then this will specify the compressed
1115 * size of the packed resource in the WIM. */
1116 uint64_t raw_resource_compressed_size;
1118 uint64_t reserved[2];
1121 /** A stream of a file in the WIM. */
1122 struct wimlib_stream_entry {
1123 /** Name of the stream, or NULL if the stream is unnamed. */
1124 const wimlib_tchar *stream_name;
1125 /** Location, size, etc. of the stream within the WIM file. */
1126 struct wimlib_resource_entry resource;
1127 uint64_t reserved[4];
1130 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1131 * Roughly, the information about a "file" in the WIM--- but really a directory
1132 * entry ("dentry") because hard links are allowed. The hard_link_group_id
1133 * field can be used to distinguish actual file inodes. */
1134 struct wimlib_dir_entry {
1135 /** Name of the file, or NULL if this file is unnamed (only possible for
1136 * the root directory) */
1137 const wimlib_tchar *filename;
1139 /** 8.3 DOS name of this file, or NULL if this file has no such name.
1141 const wimlib_tchar *dos_name;
1143 /** Full path to this file within the WIM image. */
1144 const wimlib_tchar *full_path;
1146 /** Depth of this directory entry, where 0 is the root, 1 is the root's
1147 * children, ..., etc. */
1150 /** Pointer to the security descriptor for this file, in Windows
1151 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1152 * security descriptor. */
1153 const char *security_descriptor;
1155 /** Length of the above security descriptor. */
1156 size_t security_descriptor_size;
1158 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
1159 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
1160 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
1161 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
1162 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
1163 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
1164 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
1165 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
1166 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1167 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1168 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
1169 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
1170 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1171 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1172 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
1173 /** File attributes, such as whether the file is a directory or not.
1174 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1175 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1176 * on other platforms. */
1177 uint32_t attributes;
1179 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
1180 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
1181 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
1182 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
1183 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
1184 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
1185 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
1186 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
1187 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
1188 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
1189 #define WIMLIB_REPARSE_TAG_WOF 0x80000017
1190 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
1191 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
1192 * attributes), this will give the reparse tag. This tells you whether
1193 * the reparse point is a symbolic link, junction point, or some other,
1194 * more unusual kind of reparse point. */
1195 uint32_t reparse_tag;
1197 /* Number of (hard) links to this file. */
1200 /** Number of named data streams that this file has. Normally 0. */
1201 uint32_t num_named_streams;
1203 /** Roughly, the inode number of this file. However, it may be 0 if
1204 * @p num_links == 1. */
1205 uint64_t hard_link_group_id;
1207 /** Time this file was created. */
1208 struct timespec creation_time;
1210 /** Time this file was last written to. */
1211 struct timespec last_write_time;
1213 /** Time this file was last accessed. */
1214 struct timespec last_access_time;
1215 uint64_t reserved[16];
1217 /** Array of streams that make up this file. The first entry will
1218 * always exist and will correspond to the unnamed data stream (default
1219 * file contents), so it will have @p stream_name == @c NULL. There
1220 * will then be @p num_named_streams additional entries that specify the
1221 * named data streams, if any, each of which will have @p stream_name !=
1223 struct wimlib_stream_entry streams[];
1227 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
1230 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1234 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
1237 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1240 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1241 * just on the specified path. */
1242 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1244 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1245 * itself; only its children (in the case of a non-empty directory) */
1246 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
1248 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1249 * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1250 * table of the ::WIMStruct. The default behavior without this flag is to fill
1251 * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1252 * wimlib_resource_entry::is_missing "is_missing" flag. */
1253 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED 0x00000004
1257 /** @ingroup G_modifying_wims
1260 /** Directly capture a NTFS volume rather than a generic directory. This flag
1261 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1262 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
1263 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
1265 /** Follow symlinks; archive and dump the files they point to. Cannot be used
1266 * with ::WIMLIB_ADD_FLAG_NTFS. */
1267 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
1269 /** Call the progress function with the message
1270 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1272 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
1274 /** Mark the image being added as the bootable image of the WIM. Not valid for
1275 * wimlib_update_image(). */
1276 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
1278 /** Store the UNIX owner, group, and mode. This is done by adding a special
1279 * alternate data stream to each regular file, symbolic link, and directory to
1280 * contain this information. Please note that this flag is for convenience
1281 * only; Microsoft's implementation will not understand this special
1282 * information. This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
1283 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
1285 /** Do not capture security descriptors. Only has an effect in NTFS capture
1286 * mode, or in Windows native builds. */
1287 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
1289 /** Fail immediately if the full security descriptor of any file or directory
1290 * cannot be accessed. Only has an effect in Windows native builds. The
1291 * default behavior without this flag is to first try omitting the SACL from the
1292 * security descriptor, then to try omitting the security descriptor entirely.
1294 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
1296 /** Call the progress function with the message
1297 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1298 * capture. This is a subset of the messages provided by
1299 * ::WIMLIB_ADD_FLAG_VERBOSE. */
1300 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
1302 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
1303 * in the case of Windows) that point inside the directory being captured to
1304 * instead be absolute relative to the directory being captured, rather than the
1305 * current root; also exclude absolute symbolic links that point outside the
1306 * directory tree being captured.
1308 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
1309 * the WIM header or if this is the first image being added.
1310 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
1311 * reparse point fixups enabled and currently cannot be unset. */
1312 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
1314 /** Don't do reparse point fixups. The default behavior is described in the
1315 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
1316 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
1318 /** Do not automatically exclude unsupported files or directories from capture;
1319 * e.g. encrypted directories in NTFS-3g capture mode, or device files and FIFOs
1320 * on UNIX-like systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when
1321 * such a file is encountered. */
1322 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
1325 * Automatically select a capture configuration appropriate for capturing
1326 * filesystems containing Windows operating systems. For example,
1327 * "pagefile.sys" and "System Volume Information" will be excluded.
1329 * When this flag is specified, the corresponding @p config parameter or member
1332 * Note that the default behavior--- that is, when this flag is not specified
1333 * and @p config is @c NULL--- is to use no capture configuration, meaning that
1334 * no files are excluded from capture.
1336 #define WIMLIB_ADD_FLAG_WINCONFIG 0x00000800
1339 * Capture image as WIMBoot compatible. In addition, if no capture
1340 * configuration file is explicitly specified use the capture configuration file
1341 * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1342 * <c>$SOURCE</c> is the directory being captured; or, if a capture
1343 * configuration file is explicitly specified, use it and also place it at
1344 * /Windows/System32/WimBootCompress.ini in the WIM image.
1346 * Note: this will not by itself change the compression type. Before writing
1347 * the WIM file, it's recommended to also do:
1350 * wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1351 * wimlib_set_output_chunk_size(wim, 4096);
1354 * since that makes access to the data faster (at the cost of a worse
1355 * compression ratio compared to the 32768-byte LZX chunks usually used).
1357 #define WIMLIB_ADD_FLAG_WIMBOOT 0x00001000
1360 * If the add command involves adding a non-directory file to a location at
1361 * which there already exists a nondirectory file in the WIM image, issue
1362 * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file. This only has an
1363 * effect when updating an existing image with wimlib_update_image().
1364 * This was the default behavior in wimlib v1.6.2 and earlier.
1366 #define WIMLIB_ADD_FLAG_NO_REPLACE 0x00002000
1368 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
1369 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
1370 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
1371 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
1372 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
1373 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
1374 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
1375 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1376 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
1377 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
1378 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1379 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1380 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG WIMLIB_ADD_FLAG_WINCONFIG
1381 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT WIMLIB_ADD_FLAG_WIMBOOT
1385 /** @ingroup G_modifying_wims
1388 /** Do not issue an error if the path to delete does not exist. */
1389 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1391 /** Delete the file or directory tree recursively; if not specified, an error is
1392 * issued if the path to delete is a directory. */
1393 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1396 /** @ingroup G_modifying_wims
1400 * If a single image is being exported, mark it bootable in the destination WIM.
1401 * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1402 * the image in the source WIM (if any) that is marked as bootable is also
1403 * marked as bootable in the destination WIM.
1405 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1407 /** Give the exported image(s) no names. Avoids problems with image name
1410 #define WIMLIB_EXPORT_FLAG_NO_NAMES 0x00000002
1412 /** Give the exported image(s) no descriptions. */
1413 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS 0x00000004
1416 /** @ingroup G_extracting_wims
1419 /** Extract the image directly to a NTFS volume rather than a generic directory.
1420 * This mode is only available if wimlib was compiled with libntfs-3g support;
1421 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1422 * extraction target will be interpreted as the path to a NTFS volume image (as
1423 * a regular file or block device) rather than a directory. It will be opened
1424 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1425 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1426 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1427 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1429 /** When identical files are extracted from the WIM, always hard link them
1430 * together. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_SYMLINK.
1432 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1434 /** When identical files are extracted from the WIM, always symlink them
1435 * together. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_HARDLINK.
1437 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1439 /** This flag no longer does anything but is reserved for future use. */
1440 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1442 /** Read the WIM file sequentially while extracting the image. As of wimlib
1443 * v1.6.0 this is the default behavior, and this flag no longer does anything.
1445 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1447 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA. Only
1448 * valid on UNIX-like platforms, and when ::WIMLIB_EXTRACT_FLAG_NTFS was not
1450 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1452 /** Do not extract security descriptors. This flag cannot be combined with
1453 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS. */
1454 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1456 /** Fail immediately if the full security descriptor of any file or directory
1457 * cannot be set exactly as specified in the WIM file. On Windows, the default
1458 * behavior without this flag when wimlib does not have permission to set the
1459 * correct security descriptor is to fall back to setting the security
1460 * descriptor with the SACL omitted, then with the DACL omitted, then with the
1461 * owner omitted, then not at all. This flag cannot be combined with
1462 * ::WIMLIB_EXTRACT_FLAG_NO_ACLS. */
1463 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1465 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1466 * reparse-point fixups on, so absolute symbolic links or junction points will
1467 * be fixed to be absolute relative to the actual extraction root. Reparse-
1468 * point fixups are done by default for wimlib_extract_image() and
1469 * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1470 * header. This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX. */
1471 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1473 /** Force reparse-point fixups on extraction off, regardless of the state of the
1474 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. This flag cannot be combined
1475 * with ::WIMLIB_EXTRACT_FLAG_RPFIX. */
1476 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1478 /** Extract the paths, each of which must name a regular file, to standard
1479 * output. Not valid for wimlib_extract_image() and
1480 * wimlib_extract_image_from_pipe(). */
1481 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1483 /** Instead of ignoring files and directories with names that cannot be
1484 * represented on the current platform (note: Windows has more restrictions on
1485 * filenames than POSIX-compliant systems), try to replace characters or append
1486 * junk to the names so that they can be extracted in some form. */
1487 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1489 /** On Windows, when there exist two or more files with the same case
1490 * insensitive name but different case sensitive names, try to extract them all
1491 * by appending junk to the end of them, rather than arbitrarily extracting only
1493 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1495 /** Do not ignore failure to set timestamps on extracted files. */
1496 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1498 /** Do not ignore failure to set short names on extracted files. */
1499 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1501 /** Do not ignore failure to extract symbolic links (and junction points, on
1502 * Windows) due to permissions problems. By default, such failures are ignored
1503 * since the default configuration of Windows only allows the Administrator to
1504 * create symbolic links. */
1505 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1507 /** TODO: this flag is intended to allow resuming an aborted extraction, but the
1508 * behavior is currently less than satisfactory. Do not use (yet). */
1509 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1511 /** Perform the extraction ordered by the tree of files to extract rather than
1512 * how the underlying streams are arranged in the WIM file. For regular WIM
1513 * files this may decrease or increase performance, depending on various
1514 * factors. For WIM files containing packed streams this will decrease
1516 #define WIMLIB_EXTRACT_FLAG_FILE_ORDER 0x00020000
1518 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Treat the
1519 * paths to extract as wildcard patterns ("globs") which may contain the
1520 * wildcard characters @c ? and @c *. The @c ? character matches any
1521 * non-path-separator character, whereas the @c * character matches zero or more
1522 * non-path-separator characters. Consequently, each glob may match zero or
1523 * more actual paths in the WIM image. By default, if a glob does not match any
1524 * files, a warning but not an error will be issued, even if the glob did not
1525 * actually contain wildcard characters. Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
1526 * to get an error instead. */
1527 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS 0x00040000
1529 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1530 * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1531 * one of the provided globs did not match a file. */
1532 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB 0x00080000
1534 /** Do not extract Windows file attributes such as readonly, hidden, etc. */
1535 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES 0x00100000
1537 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only: Do not
1538 * preserve the directory structure of the archive when extracting --- that is,
1539 * place each extracted file or directory tree directly in the target directory.
1541 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE 0x00200000
1543 /** Windows only: Extract files as "pointers" back to the WIM archive. See the
1544 * documentation for the <b>--wimboot</b> option of <b>wimlib-imagex apply</b>
1545 * for more information. */
1546 #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000
1549 /** @ingroup G_mounting_wim_images
1552 /** Mount the WIM image read-write rather than the default of read-only. */
1553 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1555 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1556 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1558 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1559 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1561 /** Access alternate data streams in the mounted WIM image through extended file
1562 * attributes. This is the default mode. */
1563 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1565 /** Access alternate data streams in the mounted WIM image by specifying the
1566 * file name, a colon, then the alternate file stream name. */
1567 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1569 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1570 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1571 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1573 /** Allow other users to see the mounted filesystem. (this passes the @c
1574 * allow_other option to FUSE mount) */
1575 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1578 /** @ingroup G_creating_and_opening_wims
1581 /** Verify the WIM contents against the WIM's integrity table, if present. This
1582 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1583 * checksummed and checked against the SHA1 message digests specified in the
1584 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1585 * mismatches (or, ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE is returned if the
1586 * integrity table is invalid). */
1587 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1589 /** Issue an error if the WIM is part of a split WIM. Software can provide
1590 * this flag for convenience if it explicitly does not want to support split
1592 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT 0x00000002
1594 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1595 * is not. A WIM is considered writable only if it is writable at the
1596 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1597 * header, and is not part of a spanned set. It is not required to provide this
1598 * flag before attempting to make changes to the WIM, but with this flag you get
1599 * an error sooner rather than later. */
1600 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1603 /** @ingroup G_mounting_wim_images
1606 /** See ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY. */
1607 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1609 /** Unless this flag is given, changes to a read-write mounted WIM are
1610 * discarded. Ignored for read-only mounts. */
1611 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1613 /** See ::WIMLIB_WRITE_FLAG_REBUILD. */
1614 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1616 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1617 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1619 /** Do a "lazy" unmount (detach filesystem immediately, even if busy). */
1620 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1622 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
1623 * image, causes the modified image to be committed as a new, unnamed image
1624 * appended to the archive. The original image will be unmodified. */
1625 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE 0x00000020
1628 /** @ingroup G_modifying_wims
1631 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1632 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1633 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1636 /** @ingroup G_writing_and_overwriting_wims
1639 /** Include an integrity table in the WIM.
1641 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1642 * an integrity table if and only if one was present before. For WIMs created
1643 * with wimlib_create_new_wim(), the default behavior is to not include an
1644 * integrity table. */
1645 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1647 /** Do not include an integrity table in the new WIM file. This is the default
1648 * behavior, unless the WIM already included an integrity table. */
1649 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1651 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1652 * images from it can be applied directly from a pipe using
1653 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1654 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1655 * with this flag will not be compatible with Microsoft's software.
1657 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1658 * WIM as pipable if and only if it was pipable before. For WIMs created with
1659 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1661 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1663 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1664 * WIM was pipable already. */
1665 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1667 /** Recompress all resources, even if they could otherwise be copied from a
1668 * different WIM with the same compression type (in the case of
1669 * wimlib_export_image() being called previously). This flag is also valid in
1670 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1671 * in the joined WIM file will be recompressed. */
1672 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1674 /** Call fsync() just before the WIM file is closed. */
1675 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1677 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1678 * data to it if possible. */
1679 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1681 /** wimlib_overwrite() only: Specifying this flag overrides the default
1682 * behavior of wimlib_overwrite() after one or more calls to
1683 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1684 * only minimal changes to correctly remove the image from the WIM will be
1685 * taken. In particular, all streams will be left alone, even if they are no
1686 * longer referenced. This is probably not what you want, because almost no
1687 * space will be saved by deleting an image in this way. */
1688 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1690 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1691 * flag is set in the WIM header. This can be used in combination with
1692 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1693 * set the readonly flag on the on-disk WIM file. */
1694 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1696 /** Do not include non-metadata resources already present in other WIMs. This
1697 * flag can be used to write a "delta" WIM after resources from the WIM on which
1698 * the delta is to be based were referenced with
1699 * wimlib_reference_resource_files() or wimlib_reference_resources(). */
1700 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS 0x00000200
1702 /** Asserts that for writes of all WIM images, all streams needed for the WIM
1703 * are already present (not in external resource WIMs) and their reference
1704 * counts are correct, so the code does not need to recalculate which streams
1705 * are referenced. This is for optimization purposes only, since with this flag
1706 * specified, the metadata resources may not need to be decompressed and parsed.
1708 * This flag can be passed to wimlib_write() and wimlib_write_to_fd(), but is
1709 * already implied for wimlib_overwrite(). */
1710 #define WIMLIB_WRITE_FLAG_STREAMS_OK 0x00000400
1712 #define WIMLIB_WRITE_FLAG_RESERVED 0x00000800
1715 * When writing streams in the resulting WIM file, pack multiple streams into a
1716 * single WIM resource instead of compressing them independently. This tends to
1717 * produce a better compression ratio at the cost of less random access.
1718 * However, WIMs created with this flag are only compatible with wimlib v1.6.0
1719 * or later and WIMGAPI Windows 8 or later, seemingly for Windows Setup only and
1720 * <b>not including ImageX and Dism</b>. WIMs created with this flag must use
1721 * version number 3584 in their header instead of 68864.
1723 * If this flag is passed to wimlib_overwrite() and the WIM did not previously
1724 * contain packed streams, the WIM's version number will be changed to 3584 and
1725 * the new streams will be written packed. Use ::WIMLIB_WRITE_FLAG_REBUILD to
1726 * force the WIM to be fully rebuilt. */
1727 #define WIMLIB_WRITE_FLAG_PACK_STREAMS 0x00001000
1730 /** @ingroup G_general
1733 /** Assume that strings are represented in UTF-8, even if this is not the
1734 * locale's character encoding. This flag is ignored on Windows, where wimlib
1735 * always uses UTF-16LE. */
1736 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1738 /** Windows-only: do not attempt to acquire additional privileges (currently
1739 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1740 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1741 * for the case where the calling program manages these privileges itself.
1742 * Note: no error is issued if privileges cannot be acquired, although related
1743 * errors may be reported later, depending on if the operations performed
1744 * actually require additional privileges or not. */
1745 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1747 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1748 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1749 * to read all possible data and metadata for a capture operation could not be
1750 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
1752 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES 0x00000004
1754 /** Windows only: If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
1755 * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
1756 * to restore all possible data and metadata for an apply operation could not be
1757 * acquired. Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
1759 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES 0x00000008
1761 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
1763 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE 0x00000010
1765 /** Default to interpreting WIM paths case insensitively (default on Windows).
1766 * This does not apply to mounted images. */
1767 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE 0x00000020
1770 /** @ingroup G_nonstandalone_wims
1773 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
1774 * Ignored by wimlib_reference_resources(). */
1775 #define WIMLIB_REF_FLAG_GLOB_ENABLE 0x00000001
1777 /** For wimlib_reference_resource_files(), issue an error
1778 * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files. The
1779 * default behavior without this flag is to issue no error at that point, but
1780 * then attempt to open the glob as a literal path, which of course will fail
1781 * anyway if no file exists at that path. No effect if
1782 * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified. Ignored by
1783 * wimlib_reference_resources(). */
1784 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH 0x00000002
1787 /** @ingroup G_modifying_wims
1790 /** The specific type of update to perform. */
1791 enum wimlib_update_op {
1792 /** Add a new file or directory tree to the WIM image in a
1793 * certain location. */
1794 WIMLIB_UPDATE_OP_ADD = 0,
1796 /** Delete a file or directory tree from the WIM image. */
1797 WIMLIB_UPDATE_OP_DELETE,
1799 /** Rename a file or directory tree in the WIM image. */
1800 WIMLIB_UPDATE_OP_RENAME,
1803 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1804 struct wimlib_add_command {
1805 /** Filesystem path to the file or directory tree to
1807 wimlib_tchar *fs_source_path;
1808 /** Path, specified from the root of the WIM image, at
1809 * which to add the file or directory tree within the
1811 wimlib_tchar *wim_target_path;
1813 /** Path to capture configuration file to use, or @c NULL for default.
1815 wimlib_tchar *config_file;
1817 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1821 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1822 struct wimlib_delete_command {
1823 /** Path, specified from the root of the WIM image, for
1824 * the file or directory tree within the WIM image to be
1826 wimlib_tchar *wim_path;
1827 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1831 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1832 struct wimlib_rename_command {
1833 /** Path, specified from the root of the WIM image, for
1834 * the source file or directory tree within the WIM
1836 wimlib_tchar *wim_source_path;
1837 /** Path, specified from the root of the WIM image, for
1838 * the destination file or directory tree within the WIM
1840 wimlib_tchar *wim_target_path;
1841 /** Reserved; set to 0. */
1845 /** Specification of an update to perform on a WIM image. */
1846 struct wimlib_update_command {
1848 enum wimlib_update_op op;
1851 struct wimlib_add_command add;
1852 struct wimlib_delete_command delete_; /* Underscore is for C++
1854 struct wimlib_rename_command rename;
1859 /** @ingroup G_general
1863 * Possible values of the error code returned by many functions in wimlib.
1865 * See the documentation for each wimlib function to see specifically what error
1866 * codes can be returned by a given function, and what they mean.
1868 enum wimlib_error_code {
1869 WIMLIB_ERR_SUCCESS = 0,
1870 WIMLIB_ERR_ALREADY_LOCKED,
1871 WIMLIB_ERR_DECOMPRESSION,
1872 WIMLIB_ERR_DELETE_STAGING_DIR,
1873 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1876 WIMLIB_ERR_FUSERMOUNT,
1877 WIMLIB_ERR_GLOB_HAD_NO_MATCHES,
1878 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1879 WIMLIB_ERR_IMAGE_COUNT,
1880 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1881 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES,
1882 WIMLIB_ERR_INTEGRITY,
1883 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1884 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1885 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1886 WIMLIB_ERR_INVALID_HEADER,
1887 WIMLIB_ERR_INVALID_IMAGE,
1888 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1889 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1890 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1891 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1892 WIMLIB_ERR_INVALID_OVERLAY,
1893 WIMLIB_ERR_INVALID_PARAM,
1894 WIMLIB_ERR_INVALID_PART_NUMBER,
1895 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1896 WIMLIB_ERR_INVALID_REPARSE_DATA,
1897 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1898 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1899 WIMLIB_ERR_INVALID_UTF16_STRING,
1900 WIMLIB_ERR_INVALID_UTF8_STRING,
1901 WIMLIB_ERR_IS_DIRECTORY,
1902 WIMLIB_ERR_IS_SPLIT_WIM,
1903 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1905 WIMLIB_ERR_METADATA_NOT_FOUND,
1910 WIMLIB_ERR_NOTEMPTY,
1911 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1912 WIMLIB_ERR_NOT_A_WIM_FILE,
1913 WIMLIB_ERR_NOT_PIPABLE,
1914 WIMLIB_ERR_NO_FILENAME,
1918 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1920 WIMLIB_ERR_READLINK,
1923 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1924 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1925 WIMLIB_ERR_RESOURCE_ORDER,
1926 WIMLIB_ERR_SET_ATTRIBUTES,
1927 WIMLIB_ERR_SET_REPARSE_DATA,
1928 WIMLIB_ERR_SET_SECURITY,
1929 WIMLIB_ERR_SET_SHORT_NAME,
1930 WIMLIB_ERR_SET_TIMESTAMPS,
1931 WIMLIB_ERR_SPLIT_INVALID,
1934 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1935 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1936 WIMLIB_ERR_UNKNOWN_VERSION,
1937 WIMLIB_ERR_UNSUPPORTED,
1938 WIMLIB_ERR_UNSUPPORTED_FILE,
1939 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1940 WIMLIB_ERR_WIM_IS_READONLY,
1943 WIMLIB_ERR_WIM_IS_ENCRYPTED,
1948 /** Used to indicate no WIM image or an invalid WIM image. */
1949 #define WIMLIB_NO_IMAGE 0
1951 /** Used to specify all images in the WIM. */
1952 #define WIMLIB_ALL_IMAGES (-1)
1957 * @ingroup G_modifying_wims
1959 * Appends an empty image to a WIM file. This empty image will initially
1960 * contain no files or directories, although if written without further
1961 * modifications, a root directory will be created automatically for it. After
1962 * calling this function, you can use wimlib_update_image() to add files to the
1963 * new WIM image. This gives you slightly more control over making the new
1964 * image compared to calling wimlib_add_image() or
1965 * wimlib_add_image_multisource() directly.
1968 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1971 * Name to give the new image. If @c NULL or empty, the new image is given
1972 * no name. If nonempty, it must specify a name that does not already
1974 * @param new_idx_ret
1975 * If non-<code>NULL</code>, the index of the newly added image is returned
1978 * @return 0 on success; nonzero on failure. The possible error codes are:
1980 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1981 * There is already an image in @p wim named @p name.
1982 * @retval ::WIMLIB_ERR_NOMEM
1983 * Failed to allocate the memory needed to add the new image.
1984 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1985 * The WIM file is considered read-only because of any of the reasons
1986 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1990 wimlib_add_empty_image(WIMStruct *wim,
1991 const wimlib_tchar *name,
1995 * @ingroup G_modifying_wims
1997 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1999 * The directory tree or NTFS volume is scanned immediately to load the dentry
2000 * tree into memory, and file attributes and symbolic links are read. However,
2001 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2004 * See the manual page for the @b wimlib-imagex program for more information
2005 * about the "normal" capture mode versus the NTFS capture mode (entered by
2006 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2008 * Note that @b no changes are committed to the underlying WIM file (if
2009 * any) until wimlib_write() or wimlib_overwrite() is called.
2012 * Pointer to the ::WIMStruct for a WIM file to which the image will be
2015 * A path to a directory or unmounted NTFS volume that will be captured as
2018 * Name to give the new image. If @c NULL or empty, the new image is given
2019 * no name. If nonempty, it must specify a name that does not already
2021 * @param config_file
2022 * Path to capture configuration file, or @c NULL. This file may specify,
2023 * among other things, which files to exclude from capture. See the man
2024 * page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2025 * details of the file format. If @c NULL, the default capture
2026 * configuration shall be used. Ordinarily, the default capture
2027 * configuration will result in no files being excluded from capture purely
2028 * based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2029 * ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2031 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2032 * @param progress_func
2033 * If non-NULL, a function that will be called periodically with the
2034 * progress of the current operation. The progress messages that will be
2035 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
2036 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
2037 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2039 * @return 0 on success; nonzero on error. On error, changes to @p wim are
2040 * discarded so that it appears to be in the same state as when this function
2043 * This function is implemented by calling wimlib_add_empty_image(), then
2044 * calling wimlib_update_image() with a single "add" command, so any error code
2045 * returned by wimlib_add_empty_image() may be returned, as well as any error
2046 * codes returned by wimlib_update_image() other than ones documented as only
2047 * being returned specifically by an update involving delete or rename commands.
2050 wimlib_add_image(WIMStruct *wim,
2051 const wimlib_tchar *source,
2052 const wimlib_tchar *name,
2053 const wimlib_tchar *config_file,
2055 wimlib_progress_func_t progress_func);
2058 * @ingroup G_modifying_wims
2060 * This function is equivalent to wimlib_add_image() except it allows for
2061 * multiple sources to be combined into a single WIM image. This is done by
2062 * specifying the @p sources and @p num_sources parameters instead of the @p
2063 * source parameter of wimlib_add_image(). The rest of the parameters are the
2064 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
2065 * capture</b> for full details on how this mode works.
2067 * In addition to the error codes that wimlib_add_image() can return,
2068 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2069 * when trying to overlay a non-directory on a directory or when otherwise
2070 * trying to overlay multiple conflicting files to the same location in the WIM
2071 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
2072 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2073 * was not exactly one capture source with the target being the root directory.
2074 * (In this respect, there is no advantage to using
2075 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2078 wimlib_add_image_multisource(WIMStruct *wim,
2079 const struct wimlib_capture_source *sources,
2081 const wimlib_tchar *name,
2082 const wimlib_tchar *config_file,
2084 wimlib_progress_func_t progress_func);
2087 * @ingroup G_creating_and_opening_wims
2089 * Creates a ::WIMStruct for a new WIM file.
2091 * This only creates an in-memory structure for a WIM that initially contains no
2092 * images. No on-disk file is created until wimlib_write() is called.
2095 * The type of compression to be used in the new WIM file, as one of the
2096 * ::wimlib_compression_type constants.
2098 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2099 * written to the memory location pointed to by this paramater. The
2100 * ::WIMStruct must be freed using using wimlib_free() when finished with
2102 * @return 0 on success; nonzero on error.
2103 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2104 * @p ctype was not a supported compression type.
2105 * @retval ::WIMLIB_ERR_NOMEM
2106 * Failed to allocate needed memory.
2109 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2112 * @ingroup G_modifying_wims
2114 * Deletes an image, or all images, from a WIM file.
2116 * All streams referenced by the image(s) being deleted are removed from the
2117 * lookup table of the WIM if they are not referenced by any other images in the
2120 * Please note that @b no changes are committed to the underlying WIM file (if
2121 * any) until wimlib_write() or wimlib_overwrite() is called.
2124 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2127 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2129 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
2130 * to be left unmodified only if @p image specified a single image. If instead
2131 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2132 * possible for some but not all of the images to have been deleted when a
2133 * failure status is returned.
2135 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2136 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2137 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2138 * The WIM file is considered read-only because of any of the reasons
2139 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2142 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2143 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2144 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2145 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2146 * different reasons) to read the metadata resource for an image that needed to
2150 wimlib_delete_image(WIMStruct *wim, int image);
2153 * @ingroup G_modifying_wims
2155 * Exports an image, or all the images, from a WIM file, into another WIM file.
2157 * The destination image is made to share the same dentry tree and security data
2158 * structure as the source image. This places some restrictions on additional
2159 * functions that may be called. wimlib_mount_image() may not be called on
2160 * either the source image or the destination image without an intervening call
2161 * to a function that un-shares the images, such as wimlib_free() on @p
2162 * dest_wim, or wimlib_delete_image() on either the source or destination image.
2163 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
2164 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
2165 * have references back to @p src_wim.
2167 * If this function fails, all changes to @p dest_wim are rolled back.
2169 * Please note that no changes are committed to the underlying WIM file of @p
2170 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2173 * The WIM from which to export the images, specified as a pointer to the
2174 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2175 * split WIM. In the case of a WIM file that is not standalone, this
2176 * ::WIMStruct must have had any needed external resources previously
2177 * referenced using wimlib_reference_resources() or
2178 * wimlib_reference_resource_files().
2180 * The image to export from @p src_wim, as either a 1-based image index to
2181 * export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2183 * Pointer to the ::WIMStruct for a WIM that will receive the images being
2186 * For single-image exports, the name to give the exported image in @p
2187 * dest_wim. If left @c NULL, the name from @p src_wim is used. For
2188 * ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2189 * that case, the names are all taken from @p src_wim. This parameter is
2190 * overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2191 * @param dest_description
2192 * For single-image exports, the description to give the exported image in
2193 * the new WIM file. If left @c NULL, the description from @p src_wim is
2194 * used. For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2195 * NULL; in that case, the description are all taken from @p src_wim. This
2196 * parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2197 * @param export_flags
2198 * Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2199 * @param progress_func
2200 * Currently ignored, but reserved for a function that will be called with
2201 * information about the operation. Use NULL if no additional information
2204 * @return 0 on success; nonzero on error.
2205 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2206 * One or more of the names being given to an exported image was already in
2207 * use in the destination WIM.
2208 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2209 * @p src_image does not exist in @p src_wim and was not
2210 * ::WIMLIB_ALL_IMAGES.
2211 * @retval ::WIMLIB_ERR_INVALID_PARAM
2212 * @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2213 * ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2215 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2216 * Either @p src_wim or @p dest_wim did not contain metadata resources; for
2217 * example, one of them was a non-first part of a split WIM.
2218 * @retval ::WIMLIB_ERR_NOMEM
2219 * Failed to allocate needed memory.
2220 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2221 * A resource that needed to be exported could not be found in either the
2222 * source or destination WIMs. This error can occur if, for example, @p
2223 * src_wim is part of a split WIM but needed resources from the other split
2224 * WIM parts were not referenced with wimlib_reference_resources() or
2225 * wimlib_reference_resource_files() before the call to
2226 * wimlib_export_image().
2227 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2228 * @p dest_wim is considered read-only because of any of the reasons
2229 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2232 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2233 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2234 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2235 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2236 * different reasons) to read the metadata resource for an image in @p src_wim
2237 * that needed to be exported.
2240 wimlib_export_image(WIMStruct *src_wim, int src_image,
2241 WIMStruct *dest_wim,
2242 const wimlib_tchar *dest_name,
2243 const wimlib_tchar *dest_description,
2245 wimlib_progress_func_t progress_func);
2249 * @ingroup G_extracting_wims
2251 * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2254 * The exact behavior of how wimlib extracts files from a WIM image is
2255 * controllable by the @p extract_flags parameter, but there also are
2256 * differences depending on the platform (UNIX-like vs Windows). See the manual
2257 * page for <b>wimlib-imagex apply</b> for more information, including about the
2258 * special "NTFS volume extraction mode" entered by providing
2259 * ::WIMLIB_EXTRACT_FLAG_NTFS.
2262 * The WIM from which to extract the image(s), specified as a pointer to
2263 * the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2264 * of a split WIM. In the case of a WIM file that is not standalone, this
2265 * ::WIMStruct must have had any needed external resources previously
2266 * referenced using wimlib_reference_resources() or
2267 * wimlib_reference_resource_files().
2269 * The image to extract, specified as either the 1-based index of a single
2270 * image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2271 * to be extracted. ::WIMLIB_ALL_IMAGES cannot be used if
2272 * ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2274 * Directory to extract the WIM image(s) to; or, with
2275 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2276 * the unmounted NTFS volume to which to extract the image.
2277 * @param extract_flags
2278 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2279 * @param progress_func
2280 * If non-NULL, a function that will be called periodically with the
2281 * progress of the current operation. The main message to look for is
2282 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2285 * @return 0 on success; nonzero on error.
2286 * @retval ::WIMLIB_ERR_DECOMPRESSION
2287 * Failed to decompress data contained in the WIM.
2288 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2289 * The metadata for one of the images to extract was invalid.
2290 * @retval ::WIMLIB_ERR_INVALID_PARAM
2291 * The extraction flags were invalid; more details may be found in the
2292 * documentation for the specific extraction flags that were specified. Or
2293 * @p target was @c NULL or the empty string, or @p wim was @c NULL.
2294 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2295 * The SHA1 message digest of an extracted stream did not match the SHA1
2296 * message digest given in the WIM.
2297 * @retval ::WIMLIB_ERR_LINK
2298 * Failed to create a symbolic link or a hard link.
2299 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2300 * The metadata resource for one of the images to extract was not found.
2301 * This can happen if @p wim represents a non-first part of a split WIM.
2302 * @retval ::WIMLIB_ERR_MKDIR
2303 * Failed create a directory.
2304 * @retval ::WIMLIB_ERR_NOMEM
2305 * Failed to allocate needed memory.
2306 * @retval ::WIMLIB_ERR_OPEN
2307 * Could not create a file, or failed to open an already-extracted file.
2308 * @retval ::WIMLIB_ERR_READ
2309 * Failed to read data from the WIM.
2310 * @retval ::WIMLIB_ERR_READLINK
2311 * Failed to determine the target of a symbolic link in the WIM.
2312 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2313 * Failed to fix the target of an absolute symbolic link (e.g. if the
2314 * target would have exceeded the maximum allowed length). (Only if
2315 * reparse data was supported by the extraction mode and
2316 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2318 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2319 * One of the files or directories that needed to be extracted referenced a
2320 * stream not present in the WIM's lookup table (or in any of the lookup
2321 * tables of the split WIM parts).
2322 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2323 * Failed to set attributes on a file.
2324 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2325 * Failed to set reparse data on a file (only if reparse data was supported
2326 * by the extraction mode).
2327 * @retval ::WIMLIB_ERR_SET_SECURITY
2328 * Failed to set security descriptor on a file
2329 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
2331 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2332 * Failed to set the short name of a file (only if
2333 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
2334 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2335 * Failed to set timestamps on a file (only if
2336 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
2337 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2338 * Unexpected end-of-file occurred when reading data from the WIM.
2339 * @retval ::WIMLIB_ERR_UNSUPPORTED
2340 * A requested extraction flag, or the data or metadata that must be
2341 * extracted to support it, is unsupported in the build and configuration
2342 * of wimlib, or on the current platform or extraction mode or target
2343 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2344 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2345 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2346 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
2347 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
2348 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
2349 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2350 * extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2351 * image contains one or more files with short names, but extracting short
2352 * names is not supported --- on Windows, this occurs if the target volume
2353 * does not support short names, while on non-Windows, this occurs if
2354 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2355 * @retval ::WIMLIB_ERR_WIMBOOT
2356 * ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2357 * there was a problem creating WIMBoot pointer files.
2358 * @retval ::WIMLIB_ERR_WRITE
2359 * Failed to write data to a file being extracted.
2362 wimlib_extract_image(WIMStruct *wim, int image,
2363 const wimlib_tchar *target,
2365 wimlib_progress_func_t progress_func);
2368 * @ingroup G_extracting_wims
2370 * Since wimlib v1.5.0: Extract one image from a pipe on which a pipable WIM is
2373 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
2374 * about pipable WIMs.
2376 * This function operates in a special way to read the WIM fully sequentially.
2377 * As a result, there is no ::WIMStruct is made visible to library users, and
2378 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
2379 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2380 * seekable file, not a pipe.)
2383 * File descriptor, which may be a pipe, opened for reading and positioned
2384 * at the start of the pipable WIM.
2385 * @param image_num_or_name
2386 * String that specifies the 1-based index or name of the image to extract.
2387 * It is translated to an image index using the same rules that
2388 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
2389 * only a single image (not all images) can be specified. Alternatively,
2390 * specify @p NULL here to use the first image in the WIM if it contains
2391 * exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2393 * Same as the corresponding parameter to wimlib_extract_image().
2394 * @param extract_flags
2395 * Same as the corresponding parameter to wimlib_extract_image(), except
2396 * that ::WIMLIB_EXTRACT_FLAG_FILE_ORDER cannot be specified and will
2397 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
2398 * @param progress_func
2399 * Same as the corresponding parameter to wimlib_extract_image(), except
2400 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
2401 * received by the progress function.
2403 * @return 0 on success; nonzero on error. The possible error codes include
2404 * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2407 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2408 * Data read from the pipable WIM was invalid.
2409 * @retval ::WIMLIB_ERR_NOT_PIPABLE
2410 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
2413 wimlib_extract_image_from_pipe(int pipe_fd,
2414 const wimlib_tchar *image_num_or_name,
2415 const wimlib_tchar *target, int extract_flags,
2416 wimlib_progress_func_t progress_func);
2419 * @ingroup G_extracting_wims
2421 * Since wimlib v1.6.0: Similar to wimlib_extract_paths(), but the paths to
2422 * extract from the WIM image are specified in the UTF-8 text file named by @p
2423 * path_list_file which itself contains the list of paths to use, one per line.
2424 * Leading and trailing whitespace, and otherwise empty lines and lines
2425 * beginning with the ';' character are ignored. No quotes are needed as paths
2426 * are otherwise delimited by the newline character.
2428 * The error codes are the same as those returned by wimlib_extract_paths(),
2429 * except that wimlib_extract_pathlist() returns an appropriate error code if it
2430 * cannot read the path list file (::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2431 * ::WIMLIB_ERR_READ, ::WIMLIB_ERR_NOMEM, or ::WIMLIB_ERR_INVALID_UTF8_STRING).
2434 wimlib_extract_pathlist(WIMStruct *wim, int image,
2435 const wimlib_tchar *target,
2436 const wimlib_tchar *path_list_file,
2438 wimlib_progress_func_t progress_func);
2441 * @ingroup G_extracting_wims
2443 * Since wimlib v1.6.0: Extract zero or more paths (files or directory trees)
2444 * from the specified WIM image.
2446 * By default, each path will be extracted to a corresponding subdirectory of
2447 * the target based on its location in the WIM image. For example, if one of
2448 * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2449 * the file will be extracted to "outdir/Windows/explorer.exe". This behavior
2450 * can be changed by providing the flag
2451 * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2452 * or directory tree to be placed directly in the target directory --- so the
2453 * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2455 * Symbolic links will not be dereferenced when paths in the WIM image are
2459 * WIM from which to extract the paths, specified as a pointer to the
2460 * ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2461 * split WIM. In the case of a WIM file that is not standalone, this
2462 * ::WIMStruct must have had any needed external resources previously
2463 * referenced using wimlib_reference_resources() or
2464 * wimlib_reference_resource_files().
2466 * 1-based index of the WIM image from which to extract the paths.
2468 * Array of paths to extract. Each element must be the absolute path to a
2469 * file or directory within the WIM image. Separators may be either
2470 * forwards or backwards slashes, and leading path separators are optional.
2471 * The paths will be interpreted either case-sensitively (UNIX default) or
2472 * case-insensitively (Windows default); this can be changed by
2473 * wimlib_global_init().
2475 * By default, the characters @c * and @c ? are interpreted literally.
2476 * This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2479 * By default, if any paths to extract do not exist, the error code
2480 * ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned. This behavior changes if
2481 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2483 * Number of paths specified in @p paths.
2485 * Directory to which to extract the paths; or with
2486 * ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
2487 * unmounted NTFS volume to which to extract the paths. Unlike the @p
2488 * paths being extracted, the @p target must be native path. On UNIX-like
2489 * systems it may not contain backslashes, for example.
2490 * @param extract_flags
2491 * Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2492 * @param progress_func
2493 * If non-NULL, a function that will be called periodically with the
2494 * progress of the current operation. The main message to look for is
2495 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS; however, there are others as
2496 * well. Note: because the extraction code is stream-based and not
2497 * file-based, there is no way to get information about which path is
2498 * currently being extracted, but based on byte count you can still
2499 * calculate an approximate percentage complete for the extraction overall
2500 * which may be all you really need anyway.
2502 * @return 0 on success; nonzero on error. Most of the error codes are the same
2503 * as those returned by wimlib_extract_image(). Below, some of the error codes
2504 * returned in situations specific to path-mode extraction are documented:
2506 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2507 * @p image was ::WIMLIB_ALL_IMAGES or was otherwise not a valid single
2509 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2510 * One of the paths to extract did not exist in the WIM image. This error
2511 * code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
2512 * specified in @p extract_flags, or if both
2513 * ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
2514 * were specified in @p extract_flags.
2515 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
2516 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
2517 * one of the paths to extract did not name a regular file.
2520 wimlib_extract_paths(WIMStruct *wim,
2522 const wimlib_tchar *target,
2523 const wimlib_tchar * const *paths,
2526 wimlib_progress_func_t progress_func);
2529 * @ingroup G_wim_information
2531 * Extracts the XML data of a WIM file to a file stream. Every WIM file
2532 * includes a string of XML that describes the images contained in the WIM.
2534 * See wimlib_get_xml_data() to read the XML data into memory instead.
2537 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2538 * have to be standalone (e.g. it could be part of a split WIM).
2540 * @c stdout, or a FILE* opened for writing, to extract the data to.
2542 * @return 0 on success; nonzero on error.
2543 * @retval ::WIMLIB_ERR_INVALID_PARAM
2544 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
2545 * @retval ::WIMLIB_ERR_NOMEM
2546 * @retval ::WIMLIB_ERR_READ
2547 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2548 * Failed to read the XML data from the WIM.
2549 * @retval ::WIMLIB_ERR_WRITE
2550 * Failed to completely write the XML data to @p fp.
2553 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
2556 * @ingroup G_general
2558 * Frees all memory allocated for a WIMStruct and closes all files associated
2562 * Pointer to the ::WIMStruct for a WIM file.
2564 * @return This function has no return value.
2567 wimlib_free(WIMStruct *wim);
2570 * @ingroup G_general
2572 * Converts a ::wimlib_compression_type value into a string.
2575 * The ::wimlib_compression_type value to convert.
2578 * A statically allocated string naming the compression algorithm,
2579 * such as "None", "LZX", "XPRESS", or "Invalid".
2581 extern const wimlib_tchar *
2582 wimlib_get_compression_type_string(int ctype);
2585 * @ingroup G_general
2587 * Converts an error code into a string describing it.
2590 * The error code returned by one of wimlib's functions.
2593 * Pointer to a statically allocated string describing the error code,
2594 * or @c NULL if the error code is not valid.
2596 extern const wimlib_tchar *
2597 wimlib_get_error_string(enum wimlib_error_code code);
2600 * @ingroup G_wim_information
2602 * Returns the description of the specified image.
2605 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2606 * to be standalone (e.g. it could be part of a split WIM).
2608 * The number of the image, numbered starting at 1.
2611 * The description of the image, or @c NULL if there is no such image, or
2612 * @c NULL if the specified image has no description. The description
2613 * string is in library-internal memory and may not be modified or freed;
2614 * in addition, the string will become invalid if the description of the
2615 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2617 extern const wimlib_tchar *
2618 wimlib_get_image_description(const WIMStruct *wim, int image);
2621 * @ingroup G_wim_information
2623 * Returns the name of the specified image.
2626 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2627 * to be standalone (e.g. it could be part of a split WIM).
2629 * The number of the image, numbered starting at 1.
2632 * The name of the image, or @c NULL if there is no such image, or an empty
2633 * string if the image is unnamed. The name string is in
2634 * library-internal memory and may not be modified or freed; in addition,
2635 * the string will become invalid if the name of the image is changed, the
2636 * image is deleted, or the ::WIMStruct is destroyed.
2638 extern const wimlib_tchar *
2639 wimlib_get_image_name(const WIMStruct *wim, int image);
2642 * @ingroup G_general
2644 * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
2645 * the major version, the next 10 bits contain the minor version, and the low 10
2646 * bits contain the patch version.
2648 * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
2649 * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
2650 * corresponding header file.
2653 wimlib_get_version(void);
2656 * @ingroup G_wim_information
2658 * Get basic information about a WIM file.
2661 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2662 * to be standalone (e.g. it could be part of a split WIM).
2664 * A ::wimlib_wim_info structure that will be filled in with information
2665 * about the WIM file.
2670 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2673 * @ingroup G_wim_information
2675 * Read the XML data of a WIM file into an in-memory buffer. Every WIM file
2676 * includes a string of XML that describes the images contained in the WIM.
2678 * See wimlib_extract_xml_data() to extract the XML data to a file stream
2682 * Pointer to the ::WIMStruct for a WIM file, which does not necessarily
2683 * have to be standalone (e.g. it could be part of a split WIM).
2685 * On success, a pointer to an allocated buffer containing the raw UTF16-LE
2686 * XML data is written to this location.
2687 * @param bufsize_ret
2688 * The size of the XML data in bytes is written to this location.
2690 * @return 0 on success; nonzero on error.
2691 * @retval ::WIMLIB_ERR_INVALID_PARAM
2692 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
2693 * @p buf_ret or @p bufsize_ret was @c NULL.
2694 * @retval ::WIMLIB_ERR_NOMEM
2695 * @retval ::WIMLIB_ERR_READ
2696 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2697 * Failed to read the XML data from the WIM.
2700 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
2703 * @ingroup G_general
2705 * Initialization function for wimlib. Call before using any other wimlib
2706 * function except wimlib_set_print_errors(). If not done manually, this
2707 * function will be called automatically with @p init_flags set to
2708 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8. This function does nothing if called again
2709 * after it has already successfully run.
2712 * Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
2714 * @return 0 on success; nonzero on failure. Currently, only the following
2715 * error code is defined:
2717 * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
2718 * ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
2719 * ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
2720 * init_flags, but the corresponding privileges could not be acquired.
2723 wimlib_global_init(int init_flags);
2726 * @ingroup G_general
2728 * Cleanup function for wimlib. You are not required to call this function, but
2729 * it will release any global resources allocated by the library.
2732 wimlib_global_cleanup(void);
2735 * @ingroup G_wim_information
2737 * Determines if an image name is already used by some image in the WIM.
2740 * Pointer to the ::WIMStruct for a WIM file.
2742 * The name to check.
2745 * @c true if there is already an image in @p wim named @p name; @c false
2746 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2747 * the empty string, @c false is returned.
2750 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2753 * @ingroup G_wim_information
2755 * Iterate through a file or directory tree in the WIM image. By specifying
2756 * appropriate flags and a callback function, you can get the attributes of a
2757 * file in the WIM, get a directory listing, or even get a listing of the entire
2761 * The WIM containing the image(s) over which to iterate, specified as a
2762 * pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
2763 * or part 1 of a split WIM. In the case of a WIM file that is not
2764 * standalone, this ::WIMStruct should have had any needed external
2765 * resources previously referenced using wimlib_reference_resources() or
2766 * wimlib_reference_resource_files(). If not, see
2767 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
2768 * the behavior when resources are missing.
2771 * The 1-based number of the image in @p wim that contains the files or
2772 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2773 * iteration on all images in the WIM.
2776 * Path in the WIM image at which to do the iteration.
2779 * Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
2782 * A callback function that will receive each directory entry.
2785 * An extra parameter that will always be passed to the callback function
2788 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2789 * first nonzero value that was returned from @p cb. However, additional error
2790 * codes may be returned, including the following:
2792 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2793 * @p path did not exist in the WIM image.
2794 * @retval ::WIMLIB_ERR_NOMEM
2795 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2797 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2798 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2799 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2800 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2801 * different reasons) to read the metadata resource for an image over which
2802 * iteration needed to be done.
2805 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2807 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2810 * @ingroup G_wim_information
2812 * Iterate through the lookup table of a WIM file. This can be used to directly
2813 * get a listing of the unique resources contained in a WIM file over all
2814 * images. Both file resources and metadata resources are included. However,
2815 * only resources actually included in the file represented by @a wim, plus
2816 * explicitly referenced external resources (via wimlib_reference_resources() or
2817 * wimlib_reference_resource_files()) are included in the iteration. For
2818 * example, if @p wim represents just one part of a split WIM, then only
2819 * resources in that part will be included, unless other resources were
2820 * explicitly referenced.
2823 * Pointer to the ::WIMStruct for a WIM file that does not necessarily have
2824 * to be standalone (e.g. it could be part of a split WIM).
2827 * Reserved; set to 0.
2830 * A callback function that will receive each resource.
2833 * An extra parameter that will always be passed to the callback function
2836 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2837 * that was returned from @p cb.
2840 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2841 wimlib_iterate_lookup_table_callback_t cb,
2845 * @ingroup G_nonstandalone_wims
2847 * Joins a split WIM into a stand-alone one-part WIM.
2850 * An array of strings that gives the filenames of all parts of the split
2851 * WIM. No specific order is required, but all parts must be included with
2854 * Number of filenames in @p swms.
2855 * @param swm_open_flags
2856 * Open flags for the split WIM parts (e.g.
2857 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
2858 * @param wim_write_flags
2859 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2860 * be used to write the joined WIM.
2861 * @param output_path
2862 * The path to write the joined WIM file to.
2863 * @param progress_func
2864 * If non-NULL, a function that will be called periodically with the
2865 * progress of the current operation.
2867 * @return 0 on success; nonzero on error. This function may return most error
2868 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2869 * as the following error code:
2871 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2872 * The split WIMs do not form a valid WIM because they do not include all
2873 * the parts of the original WIM, there are duplicate parts, or not all the
2874 * parts have the same GUID and compression type.
2876 * Note: wimlib is generalized enough that this function is not actually needed
2877 * to join a split WIM; instead, you could open the first part of the split WIM,
2878 * then reference the other parts with wimlib_reference_resource_files(), then
2879 * write the joined WIM using wimlib_write(). However, wimlib_join() provides
2880 * an easy-to-use wrapper around this that has some advantages (e.g. extra
2884 wimlib_join(const wimlib_tchar * const *swms,
2886 const wimlib_tchar *output_path,
2888 int wim_write_flags,
2889 wimlib_progress_func_t progress_func);
2893 * @ingroup G_mounting_wim_images
2895 * Mounts an image in a WIM file on a directory read-only or read-write.
2897 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2898 * supported if wimlib was configured with @c --without-fuse. This includes
2899 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2902 * Calling this function daemonizes the process, unless
2903 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2904 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2905 * to the WIM are staged in a temporary directory.
2907 * It is safe to mount multiple images from the same underlying WIM file
2908 * read-only at the same time, but only if different ::WIMStruct's are used. It
2909 * is @b not safe to mount multiple images from the same WIM file read-write at
2912 * wimlib_mount_image() cannot be used on an image that was exported with
2913 * wimlib_export_image() while the dentry trees for both images are still in
2914 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2915 * that already has modifications pending (e.g. an image added with
2916 * wimlib_add_image()).
2919 * Pointer to the ::WIMStruct containing the image to be mounted.
2921 * The number of the image to mount, indexed starting from it. It must be
2922 * an existing, single image.
2924 * The path to an existing empty directory to mount the image on.
2925 * @param mount_flags
2926 * Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.
2927 * @param staging_dir
2928 * If non-NULL, the name of a directory in which the staging directory will
2929 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2930 * in @p mount_flags. If left @c NULL, the staging directory is created in
2931 * the same directory as the WIM file that @p wim was originally read from.
2933 * @return 0 on success; nonzero on error.
2935 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2936 * A read-write mount was requested, but an an exclusive advisory lock on
2937 * the on-disk WIM file could not be acquired because another thread or
2938 * process has mounted an image from the WIM read-write or is currently
2939 * modifying the WIM in-place.
2940 * @retval ::WIMLIB_ERR_FUSE
2941 * A non-zero status was returned by @c fuse_main().
2942 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2943 * @p image does not specify an existing, single image in @p wim.
2944 * @retval ::WIMLIB_ERR_INVALID_PARAM
2945 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2946 * wimlib_export_image(), or @p image has been added with
2947 * wimlib_add_image().
2948 * @retval ::WIMLIB_ERR_MKDIR
2949 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2950 * staging directory could not be created.
2951 * @retval ::WIMLIB_ERR_NOTDIR
2952 * Could not determine the current working directory.
2953 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2954 * One of the dentries in the image referenced a stream not present in the
2955 * WIM's lookup table (or in any of the lookup tables of the split WIM
2957 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2958 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2959 * wim is considered read-only because of any of the reasons mentioned in
2960 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2961 * @retval ::WIMLIB_ERR_UNSUPPORTED
2962 * Mounting is not supported, either because the platform is Windows, or
2963 * because the platform is UNIX-like and wimlib was compiled with @c
2966 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2967 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2968 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2969 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2970 * different reasons) to read the metadata resource for the image to mount.
2973 wimlib_mount_image(WIMStruct *wim,
2975 const wimlib_tchar *dir,
2977 const wimlib_tchar *staging_dir);
2980 * @ingroup G_creating_and_opening_wims
2982 * Opens a WIM file and creates a ::WIMStruct for it.
2985 * The path to the WIM file to open.
2988 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2990 * @param progress_func
2991 * If non-NULL, a function that will be called periodically with the
2992 * progress of the current operation. Currently, the only messages sent
2993 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2994 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2997 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2998 * is written to the memory location pointed to by this parameter. The
2999 * ::WIMStruct can be freed using using wimlib_free() when finished with
3002 * @return 0 on success; nonzero on error.
3003 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3004 * The WIM is not the non-first part of a split WIM, and the number of
3005 * metadata resources found in the WIM did not match the image count given
3006 * in the WIM header, or the number of <IMAGE> elements in the XML
3007 * data for the WIM did not match the image count given in the WIM header.
3008 * @retval ::WIMLIB_ERR_INTEGRITY
3009 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3010 * wim_file contains an integrity table, but the SHA1 message digest for a
3011 * chunk of the WIM does not match the corresponding message digest given
3012 * in the integrity table.
3013 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3014 * Resources in @p wim_file are compressed, but the chunk size was invalid
3015 * for the WIM's compression type.
3016 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3017 * The header of @p wim_file says that resources in the WIM are compressed,
3018 * but the header flag for a recognized compression type is not set.
3019 * @retval ::WIMLIB_ERR_INVALID_HEADER
3020 * The header of @p wim_file was otherwise invalid.
3021 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3022 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
3023 * wim_file contains an integrity table, but the integrity table is
3025 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3026 * The lookup table for the WIM was invalid.
3027 * @retval ::WIMLIB_ERR_INVALID_PARAM
3028 * @p wim_ret was @c NULL.
3029 * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3030 * @p wim_file is a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3031 * specified in @p open_flags.
3032 * @retval ::WIMLIB_ERR_NOMEM
3033 * Failed to allocated needed memory.
3034 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3035 * @p wim_file does not begin with the expected magic characters.
3036 * @retval ::WIMLIB_ERR_OPEN
3037 * Failed to open the file @p wim_file for reading.
3038 * @retval ::WIMLIB_ERR_READ
3039 * Failed to read data from @p wim_file.
3040 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3041 * Unexpected end-of-file while reading data from @p wim_file.
3042 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3043 * The WIM version number was not recognized. (May be a pre-Vista WIM.)
3044 * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3045 * The WIM cannot be opened because it contains encrypted segments. (It
3046 * may be a Windows 8 "ESD" file).
3047 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3048 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3049 * considered read-only because of any of the reasons mentioned in the
3050 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3051 * @retval ::WIMLIB_ERR_XML
3052 * The XML data for @p wim_file is invalid.
3055 wimlib_open_wim(const wimlib_tchar *wim_file,
3057 WIMStruct **wim_ret,
3058 wimlib_progress_func_t progress_func);
3061 * @ingroup G_writing_and_overwriting_wims
3063 * Overwrites the file that the WIM was originally read from, with changes made.
3064 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3065 * rather than wimlib_create_new_wim().
3067 * There are two ways that a WIM may be overwritten. The first is to do a full
3068 * rebuild. In this mode, the new WIM is written to a temporary file and then
3069 * renamed to the original file after it is has been completely written. The
3070 * temporary file is made in the same directory as the original WIM file. A
3071 * full rebuild may take a while, but can be used even if images have been
3072 * modified or deleted, will produce a WIM with no holes, and has little chance
3073 * of unintentional data loss because the temporary WIM is fsync()ed before
3074 * being renamed to the original WIM.
3076 * The second way to overwrite a WIM is by appending to the end of it and
3077 * overwriting the header. This can be much faster than a full rebuild, but the
3078 * disadvantage is that some space will be wasted. Writing a WIM in this mode
3079 * begins with writing any new file resources *after* everything in the old WIM,
3080 * even though this will leave a hole where the old lookup table, XML data, and
3081 * integrity were. This is done so that the WIM remains valid even if the
3082 * operation is aborted mid-write. The WIM header is only overwritten at the
3083 * very last moment, and up until that point the WIM will be seen as the old
3086 * By default, wimlib_overwrite() does the append-style overwrite described
3087 * above, unless resources in the WIM are arranged in an unusual way or if
3088 * images have been deleted from the WIM. Use the flag
3089 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3090 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3091 * images have been deleted from the WIM.
3093 * In the temporary-file overwrite mode, no changes are made to the WIM on
3094 * failure, and the temporary file is deleted if possible. Abnormal termination
3095 * of the program will result in the temporary file being orphaned. In the
3096 * direct append mode, the WIM is truncated to the original length on failure;
3097 * and while abnormal termination of the program will result in extra data
3098 * appended to the original WIM, it should still be a valid WIM.
3100 * If this function completes successfully, no more functions should be called
3101 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
3102 * the WIM file anew.
3105 * Pointer to the ::WIMStruct for the WIM file to write. There may have
3106 * been in-memory changes made to it, which are then reflected in the
3108 * @param write_flags
3109 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3110 * @param num_threads
3111 * Number of threads to use for compression (see wimlib_write()).
3112 * @param progress_func
3113 * If non-NULL, a function that will be called periodically with the
3114 * progress of the current operation.
3116 * @return 0 on success; nonzero on error. This function may return most error
3117 * codes returned by wimlib_write() as well as the following error codes:
3119 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3120 * The WIM was going to be modified in-place (with no temporary file), but
3121 * an exclusive advisory lock on the on-disk WIM file could not be acquired
3122 * because another thread or process has mounted an image from the WIM
3123 * read-write or is currently modifying the WIM in-place.
3124 * @retval ::WIMLIB_ERR_NO_FILENAME
3125 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
3126 * than a WIM read with wimlib_open_wim().
3127 * @retval ::WIMLIB_ERR_RENAME
3128 * The temporary file that the WIM was written to could not be renamed to
3129 * the original filename of @p wim.
3130 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3131 * The WIM file is considered read-only because of any of the reasons
3132 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3136 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
3137 wimlib_progress_func_t progress_func);
3140 * @ingroup G_wim_information
3142 * Prints information about one image, or all images, contained in a WIM.
3145 * Pointer to the ::WIMStruct for a WIM file.
3147 * The image about which to print information. Can be the number of an
3148 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3151 * @return This function has no return value. No error checking is done when
3152 * printing the information. If @p image is invalid, an error message is
3156 wimlib_print_available_images(const WIMStruct *wim, int image);
3159 * @ingroup G_wim_information
3161 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3162 * in a way that can be accessed programatically.
3165 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3168 * @ingroup G_nonstandalone_wims
3170 * Reference resources from other WIM files or split WIM parts. This function
3171 * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3172 * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3173 * from other files, before calling a function such as wimlib_extract_image()
3174 * that requires the resources to be present.
3177 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3178 * necessarily "standalone". In the case of split WIMs, this should be the
3179 * first part, since only the first part contains the metadata resources.
3180 * In the case of delta WIMs, this should be the delta WIM rather than the
3181 * WIM on which it is based.
3182 * @param resource_wimfiles_or_globs
3183 * Array of paths to WIM files and/or split WIM parts to reference.
3184 * Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3185 * ref_flags, these are treated as globs rather than literal paths. That
3186 * is, using this function you can specify zero or more globs, each of
3187 * which expands to one or more literal paths.
3189 * Number of entries in @p resource_wimfiles_or_globs.
3191 * Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3192 * ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3194 * Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3195 * pass to internal calls to wimlib_open_wim() on the reference files.
3196 * @param progress_func
3197 * Passed to internal calls to wimlib_open_wim() on the reference files.
3199 * @return 0 on success; nonzero on error.
3201 * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3202 * One of the specified globs did not match any paths (only with both
3203 * ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3204 * specified in @p ref_flags).
3205 * @retval ::WIMLIB_ERR_NOMEM
3206 * Failed to allocate memory.
3207 * @retval ::WIMLIB_ERR_READ
3208 * I/O or permissions error while processing a file glob.
3210 * This function can additionally return most values that can be returned by
3211 * wimlib_open_wim().
3214 wimlib_reference_resource_files(WIMStruct *wim,
3215 const wimlib_tchar * const *resource_wimfiles_or_globs,
3219 wimlib_progress_func_t progress_func);
3222 * @ingroup G_nonstandalone_wims
3224 * Similar to wimlib_reference_resource_files(), but operates at a lower level
3225 * where the caller must open the ::WIMStruct for each referenced file itself.
3228 * The ::WIMStruct for a WIM that contains metadata resources, but is not
3229 * necessarily "standalone". In the case of split WIMs, this should be the
3230 * first part, since only the first part contains the metadata resources.
3231 * @param resource_wims
3232 * Array of pointers to the ::WIMStruct's for additional resource WIMs or
3233 * split WIM parts to reference.
3234 * @param num_resource_wims
3235 * Number of entries in @p resource_wims.
3237 * Currently ignored (set to 0).
3239 * @return 0 on success; nonzero on error. On success, the ::WIMStruct's of the
3240 * @p resource_wims are referenced internally by @p wim and must not be freed
3241 * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3242 * been freed with wimlib_free(), or immediately before freeing @p wim with
3245 * @retval ::WIMLIB_ERR_INVALID_PARAM
3246 * @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3247 * resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3248 * @retval ::WIMLIB_ERR_NOMEM
3249 * Failed to allocate memory.
3252 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3253 unsigned num_resource_wims, int ref_flags);
3256 * @ingroup G_modifying_wims
3258 * Declares that a newly added image is mostly the same as a prior image, but
3259 * captured at a later point in time, possibly with some modifications in the
3260 * intervening time. This is designed to be used in incremental backups of the
3261 * same filesystem or directory tree.
3263 * This function compares the metadata of the directory tree of the newly added
3264 * image against that of the old image. Any files that are present in both the
3265 * newly added image and the old image and have timestamps that indicate they
3266 * haven't been modified are deemed not to have been modified and have their
3267 * SHA1 message digest copied from the old image. Because of this and because
3268 * WIM uses single-instance streams, such files need not be read from the
3269 * filesystem when the WIM is being written or overwritten. Note that these
3270 * unchanged files will still be "archived" and will be logically present in the
3271 * new image; the optimization is that they don't need to actually be read from
3272 * the filesystem because the WIM already contains them.
3274 * This function is provided to optimize incremental backups. The resulting WIM
3275 * file will still be the same regardless of whether this function is called.
3276 * (This is, however, assuming that timestamps have not been manipulated or
3277 * unmaintained as to trick this function into thinking a file has not been
3278 * modified when really it has. To partly guard against such cases, other
3279 * metadata such as file sizes will be checked as well.)
3281 * This function must be called after adding the new image (e.g. with
3282 * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3283 * wimlib_overwrite()).
3286 * Pointer to the ::WIMStruct for a WIM.
3288 * 1-based index in the WIM of the newly added image. This image can have
3289 * been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3290 * wimlib_add_empty_image() followed by wimlib_update_image().
3291 * @param template_wim
3292 * The ::WIMStruct for the WIM containing the template image. This can be
3293 * the same as @p wim, or it can be a different ::WIMStruct.
3294 * @param template_image
3295 * 1-based index in the WIM of a template image that reflects a prior state
3296 * of the directory tree being captured.
3298 * Reserved; must be 0.
3299 * @param progress_func
3300 * Currently ignored, but reserved for a function that will be called with
3301 * information about the operation. Use NULL if no additional information
3304 * @return 0 on success; nonzero on error.
3306 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3307 * @p new_image and/or @p template_image were not a valid image indices in
3309 * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3310 * The specified ::WIMStruct did not actually contain the metadata resource
3311 * for the new or template image; for example, it was a non-first part of a
3313 * @retval ::WIMLIB_ERR_NOMEM
3314 * Failed to allocate needed memory.
3315 * @retval ::WIMLIB_ERR_INVALID_PARAM
3316 * @p new_image was equal to @p template_image, or @p new_image specified
3317 * an image that had not been modified since opening the WIM.
3319 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3320 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3321 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3322 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3323 * different reasons) to read the metadata resource for the template image.
3326 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3327 WIMStruct *template_wim, int template_image,
3328 int flags, wimlib_progress_func_t progress_func);
3331 * @ingroup G_wim_information
3333 * Translates a string specifying the name or number of an image in the WIM into
3334 * the number of the image. The images are numbered starting at 1.
3337 * Pointer to the ::WIMStruct for a WIM.
3338 * @param image_name_or_num
3339 * A string specifying the name or number of an image in the WIM. If it
3340 * parses to a positive integer, this integer is taken to specify the
3341 * number of the image, indexed starting at 1. Otherwise, it is taken to
3342 * be the name of an image, as given in the XML data for the WIM file. It
3343 * also may be the keyword "all" or the string "*", both of which will
3344 * resolve to ::WIMLIB_ALL_IMAGES.
3346 * There is no way to search for an image actually named "all", "*", or an
3347 * integer number, or an image that has no name. However, you can use
3348 * wimlib_get_image_name() to get the name of any image.
3351 * If the string resolved to a single existing image, the number of that
3352 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
3353 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
3354 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
3355 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3356 * images in @p wim has no name.
3359 wimlib_resolve_image(WIMStruct *wim,
3360 const wimlib_tchar *image_name_or_num);
3363 * @ingroup G_modifying_wims
3365 * Changes the description of an image in the WIM.
3368 * Pointer to the ::WIMStruct for a WIM.
3370 * The number of the image for which to change the description.
3371 * @param description
3372 * The new description to give the image. It may be @c NULL, which
3373 * indicates that the image is to be given no description.
3375 * @return 0 on success; nonzero on error.
3376 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3377 * @p image does not specify a single existing image in @p wim.
3378 * @retval ::WIMLIB_ERR_NOMEM
3379 * Failed to allocate the memory needed to duplicate the @p description
3381 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3382 * @p wim is considered read-only because of any of the reasons mentioned
3383 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3386 wimlib_set_image_descripton(WIMStruct *wim, int image,
3387 const wimlib_tchar *description);
3390 * @ingroup G_writing_and_overwriting_wims
3392 * Set the compression chunk size of a WIM to use in subsequent calls to
3393 * wimlib_write() or wimlib_overwrite().
3395 * For compatibility reasons, using this function is not generally recommended.
3396 * See the documentation for the @c --chunk-size option of <b>wimlib-imagex
3397 * capture</b> for more information.
3399 * A larger compression chunk size will likely result in a better compression
3400 * ratio, but the speed of random access to the WIM will be reduced.
3401 * Furthermore, the effect of a larger compression chunk size is limited by the
3402 * size of each stream ("file") being compressed.
3405 * ::WIMStruct for a WIM.
3407 * The chunk size (in bytes) to set. The valid chunk sizes are dependent
3408 * on the compression format; see the documentation for the @c --chunk-size
3409 * option of <b>wimlib-imagex capture</b> for more information. As a
3410 * special case, if @p chunk_size is specified as 0, the chunk size is set
3411 * to the default for the currently selected output compression type.
3413 * @return 0 on success; nonzero on error.
3415 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3416 * @p chunk_size is not a supported chunk size for the currently selected
3417 * output compression type.
3420 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3423 * @ingroup G_writing_and_overwriting_wims
3425 * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
3429 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
3432 * @ingroup G_writing_and_overwriting_wims
3434 * Set the compression type of a WIM to use in subsequent calls to
3435 * wimlib_write() or wimlib_overwrite().
3438 * ::WIMStruct for a WIM.
3440 * The compression type to set (one of ::wimlib_compression_type). If this
3441 * compression type is incompatible with the current output chunk size
3442 * (either the default or as set with wimlib_set_output_chunk_size()), the
3443 * output chunk size is reset to the default for that compression type.
3445 * @return 0 on success; nonzero on error.
3447 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3448 * @p ctype did not specify a valid compression type.
3451 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
3454 * @ingroup G_writing_and_overwriting_wims
3456 * Similar to wimlib_set_output_compression_type(), but set the compression type
3457 * for writing packed streams (solid blocks).
3460 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
3463 * @ingroup G_modifying_wims
3465 * Set basic information about a WIM.
3468 * Pointer to the ::WIMStruct for a WIM.
3470 * A struct ::wimlib_wim_info that contains the information to set. Only
3471 * the information explicitly specified in the @p which flags need be
3474 * Flags that specify which information to set. This is a bitwise OR of
3475 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
3476 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
3478 * @return 0 on success; nonzero on failure.
3479 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3480 * The WIM file is considered read-only because of any of the reasons
3481 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3482 * flag. However, as a special case, if you are using
3483 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
3484 * function will not fail due to the readonly flag being previously set.
3485 * @retval ::WIMLIB_ERR_IMAGE_COUNT
3486 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
3487 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
3491 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
3495 * @ingroup G_modifying_wims
3497 * Changes what is written in the \<FLAGS\> element in the WIM XML data
3498 * (something like "Core" or "Ultimate")
3501 * Pointer to the ::WIMStruct for a WIM.
3503 * The number of the image for which to change the description.
3505 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
3506 * indicates that the image is to be given no \<FLAGS\> element.
3508 * @return 0 on success; nonzero on error.
3509 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3510 * @p image does not specify a single existing image in @p wim.
3511 * @retval ::WIMLIB_ERR_NOMEM
3512 * Failed to allocate the memory needed to duplicate the @p flags string.
3513 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3514 * @p wim is considered read-only because of any of the reasons mentioned
3515 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3518 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
3521 * @ingroup G_modifying_wims
3523 * Changes the name of an image in the WIM.
3526 * Pointer to the ::WIMStruct for a WIM.
3528 * The number of the image for which to change the name.
3530 * New name to give the new image. If @c NULL or empty, the new image is
3531 * given no name. If nonempty, it must specify a name that does not
3532 * already exist in @p wim.
3534 * @return 0 on success; nonzero on error.
3535 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
3536 * There is already an image named @p name in @p wim.
3537 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3538 * @p image does not specify a single existing image in @p wim.
3539 * @retval ::WIMLIB_ERR_NOMEM
3540 * Failed to allocate the memory needed to duplicate the @p name string.
3541 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3542 * @p wim is considered read-only because of any of the reasons mentioned
3543 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3546 wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
3549 * @ingroup G_general
3551 * Set the functions that wimlib uses to allocate and free memory.
3553 * These settings are global and not per-WIM.
3555 * The default is to use the default @c malloc() and @c free() from the C
3558 * Please note that some external functions, such as those in @c libntfs-3g, may
3559 * use the standard memory allocation functions.
3561 * @param malloc_func
3562 * A function equivalent to @c malloc() that wimlib will use to allocate
3563 * memory. If @c NULL, the allocator function is set back to the default
3564 * @c malloc() from the C library.
3566 * A function equivalent to @c free() that wimlib will use to free memory.
3567 * If @c NULL, the free function is set back to the default @c free() from
3569 * @param realloc_func
3570 * A function equivalent to @c realloc() that wimlib will use to reallocate
3571 * memory. If @c NULL, the free function is set back to the default @c
3572 * realloc() from the C library.
3576 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
3577 void (*free_func)(void *),
3578 void *(*realloc_func)(void *, size_t));
3581 * @ingroup G_general
3583 * Sets whether wimlib is to print error messages to @c stderr when a function
3584 * fails. These error messages may provide information that cannot be
3585 * determined only from the error code that is returned. Not every error will
3586 * result in an error message being printed.
3588 * This setting is global and not per-WIM.
3590 * By default, error messages are not printed.
3592 * This can be called before wimlib_global_init().
3594 * @param show_messages
3595 * @c true if error messages are to be printed; @c false if error messages
3596 * are not to be printed.
3598 * @return 0 on success; nonzero on error.
3599 * @retval ::WIMLIB_ERR_UNSUPPORTED
3600 * @p show_messages was @c true, but wimlib was compiled with the @c
3601 * --without-error-messages option. Therefore, error messages cannot be
3605 wimlib_set_print_errors(bool show_messages);
3608 * @ingroup G_nonstandalone_wims
3610 * Splits a WIM into multiple parts.
3613 * The ::WIMStruct for the WIM to split.
3615 * Name of the SWM file to create. This will be the name of the first
3616 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
3617 * appended before the suffix.
3619 * The maximum size per part, in bytes. Unfortunately, it is not
3620 * guaranteed that this will really be the maximum size per part, because
3621 * some file resources in the WIM may be larger than this size, and the WIM
3622 * file format provides no way to split up file resources among multiple
3624 * @param write_flags
3625 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
3626 * flags will be used to write each split WIM part. Specify 0 here to get
3627 * the default behavior.
3628 * @param progress_func
3629 * If non-NULL, a function that will be called periodically with the
3630 * progress of the current operation
3631 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
3632 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
3634 * @return 0 on success; nonzero on error. This function may return most error
3635 * codes that can be returned by wimlib_write() as well as the following error
3638 * @retval ::WIMLIB_ERR_INVALID_PARAM
3639 * @p swm_name was not a nonempty string, or @p part_size was 0.
3641 * Note: the WIM's uncompressed and compressed resources are not checksummed
3642 * when they are copied from the joined WIM to the split WIM parts, nor are
3643 * compressed resources re-compressed (unless explicitly requested with
3644 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
3647 wimlib_split(WIMStruct *wim,
3648 const wimlib_tchar *swm_name,
3651 wimlib_progress_func_t progress_func);
3654 * @ingroup G_mounting_wim_images
3656 * Unmounts a WIM image that was mounted using wimlib_mount_image().
3658 * The image to unmount is specified by the path to the mountpoint, not the
3659 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
3660 * touched and also may have been allocated in a different process.
3662 * To unmount the image, the process calling this function communicates with the
3663 * process that is managing the mounted WIM image. This function blocks until it
3664 * is known whether the unmount succeeded or failed. In the case of a
3665 * read-write mounted WIM, the unmount is not considered to have succeeded until
3666 * all changes have been saved to the underlying WIM file.
3669 * The directory that the WIM image was mounted on.
3670 * @param unmount_flags
3671 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
3672 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
3673 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
3675 * @param progress_func
3676 * If non-NULL, a function that will be called periodically with the
3677 * progress of the current operation. Currently, only
3678 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
3680 * @return 0 on success; nonzero on error.
3682 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
3683 * The filesystem daemon was unable to remove the staging directory and the
3684 * temporary files that it contains.
3685 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
3686 * The filesystem daemon appears to have terminated before sending an exit
3688 * @retval ::WIMLIB_ERR_FORK
3689 * Could not @c fork() the process.
3690 * @retval ::WIMLIB_ERR_FUSERMOUNT
3691 * The @b fusermount program could not be executed or exited with a failure
3693 * @retval ::WIMLIB_ERR_MQUEUE
3694 * Could not open a POSIX message queue to communicate with the filesystem
3695 * daemon servicing the mounted filesystem, could not send a message
3696 * through the queue, or could not receive a message through the queue.
3697 * @retval ::WIMLIB_ERR_NOMEM
3698 * Failed to allocate needed memory.
3699 * @retval ::WIMLIB_ERR_OPEN
3700 * The filesystem daemon could not open a temporary file for writing the
3702 * @retval ::WIMLIB_ERR_READ
3703 * A read error occurred when the filesystem daemon tried to a file from
3704 * the staging directory
3705 * @retval ::WIMLIB_ERR_RENAME
3706 * The filesystem daemon failed to rename the newly written WIM file to the
3707 * original WIM file.
3708 * @retval ::WIMLIB_ERR_UNSUPPORTED
3709 * Mounting is not supported, either because the platform is Windows, or
3710 * because the platform is UNIX-like and wimlib was compiled with @c
3712 * @retval ::WIMLIB_ERR_WRITE
3713 * A write error occurred when the filesystem daemon was writing to the new
3714 * WIM file, or the filesystem daemon was unable to flush changes that had
3715 * been made to files in the staging directory.
3718 wimlib_unmount_image(const wimlib_tchar *dir,
3720 wimlib_progress_func_t progress_func);
3723 * @ingroup G_modifying_wims
3725 * Update a WIM image by adding, deleting, and/or renaming files or directories.
3728 * Pointer to the ::WIMStruct for the WIM file to update.
3730 * The 1-based index of the image in the WIM to update. It cannot be
3731 * ::WIMLIB_ALL_IMAGES.
3733 * An array of ::wimlib_update_command's that specify the update operations
3736 * Number of commands in @p cmds.
3737 * @param update_flags
3738 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
3739 * @param progress_func
3740 * If non-NULL, a function that will be called periodically with the
3741 * progress of the current operation.
3743 * @return 0 on success; nonzero on error. On failure, all update commands will
3744 * be rolled back, and no visible changes shall have been made to @p wim.
3745 * Possible error codes include:
3747 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
3748 * The capture configuration structure specified for an add command was
3750 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3751 * @p image did not specify a single, existing image in @p wim.
3752 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
3753 * Attempted to perform an add command that conflicted with previously
3754 * existing files in the WIM when an overlay was attempted.
3755 * @retval ::WIMLIB_ERR_INVALID_PARAM
3756 * An unknown operation type was specified in the update commands; or,
3757 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
3758 * in the @p add_flags, but the same image had previously already been
3759 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
3760 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
3761 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
3762 * specified in the @p add_flags for an add command in which @p
3763 * wim_target_path was not the root directory of the WIM image.
3764 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
3765 * (Windows only): While executing an add command, tried to capture a
3766 * reparse point with invalid data.
3767 * @retval ::WIMLIB_ERR_IS_DIRECTORY
3768 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
3769 * for a WIM path that corresponded to a directory; or, a rename command
3770 * attempted to rename a directory to a non-directory.
3771 * @retval ::WIMLIB_ERR_NOMEM
3772 * Failed to allocate needed memory.
3773 * @retval ::WIMLIB_ERR_NOTDIR
3774 * A rename command attempted to rename a directory to a non-directory; or,
3775 * an add command was executed that attempted to set the root of the WIM
3776 * image as a non-directory; or, a path component used as a directory in a
3777 * rename command was not, in fact, a directory.
3778 * @retval ::WIMLIB_ERR_NOTEMPTY
3779 * A rename command attempted to rename a directory to a non-empty
3781 * @retval ::WIMLIB_ERR_NTFS_3G
3782 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
3783 * error occurred while reading data from the NTFS volume using libntfs-3g.
3784 * @retval ::WIMLIB_ERR_OPEN
3785 * Failed to open a file to be captured while executing an add command.
3786 * @retval ::WIMLIB_ERR_OPENDIR
3787 * Failed to open a directory to be captured while executing an add command.
3788 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3789 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
3790 * WIM path that did not exist; or, a rename command attempted to rename a
3791 * file that does not exist.
3792 * @retval ::WIMLIB_ERR_READ
3793 * While executing an add command, failed to read data from a file or
3794 * directory to be captured.
3795 * @retval ::WIMLIB_ERR_READLINK
3796 * While executing an add command, failed to read the target of a symbolic
3797 * link or junction point.
3798 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
3799 * (Windows only) Failed to perform a reparse point fixup because of
3800 * problems with the data of a reparse point.
3801 * @retval ::WIMLIB_ERR_STAT
3802 * While executing an add command, failed to get attributes for a file or
3804 * @retval ::WIMLIB_ERR_UNSUPPORTED
3805 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
3806 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3807 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3808 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
3809 * add_flags for an update command.
3810 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
3811 * While executing an add command, attempted to capture a file that was not
3812 * a supported file type (e.g. a device file). Only if
3813 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
3814 * for an update command.
3815 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3816 * The WIM file is considered read-only because of any of the reasons
3817 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3820 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3821 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3822 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3823 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3824 * different reasons) to read the metadata resource for an image that needed to
3828 wimlib_update_image(WIMStruct *wim,
3830 const struct wimlib_update_command *cmds,
3833 wimlib_progress_func_t progress_func);
3836 * @ingroup G_writing_and_overwriting_wims
3838 * Writes a WIM to a file.
3840 * This brings in resources from any external locations, such as directory trees
3841 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3842 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3844 * By default, the new WIM file is written as stand-alone. Using the
3845 * ::WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS flag, a "delta" WIM can be written
3846 * instead. However, this function cannot directly write a "split" WIM; use
3847 * wimlib_split() for that.
3850 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3851 * changes made to it, which are then reflected in the output file.
3853 * The path to the file to write the WIM to.
3855 * Normally, specify ::WIMLIB_ALL_IMAGES here. This indicates that all
3856 * images are to be included in the new on-disk WIM file. If for some
3857 * reason you only want to include a single image, specify the index of
3858 * that image instead.
3859 * @param write_flags
3860 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3861 * @param num_threads
3862 * Number of threads to use for compressing data. If 0, the number of
3863 * threads is taken to be the number of online processors. Note: if no
3864 * data compression needs to be done, no additional threads will be created
3865 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3866 * exporting an image from a compressed WIM to another WIM of the same
3867 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3869 * @param progress_func
3870 * If non-NULL, a function that will be called periodically with the
3871 * progress of the current operation. The possible messages are
3872 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3873 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3874 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3876 * @return 0 on success; nonzero on error.
3878 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3879 * @p image does not specify a single existing image in @p wim, and is not
3880 * ::WIMLIB_ALL_IMAGES.
3881 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3882 * A file that had previously been scanned for inclusion in the WIM by
3883 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3884 * message digest check.
3885 * @retval ::WIMLIB_ERR_INVALID_PARAM
3886 * @p path was @c NULL.
3887 * @retval ::WIMLIB_ERR_NOMEM
3888 * Failed to allocate needed memory.
3889 * @retval ::WIMLIB_ERR_OPEN
3890 * Failed to open @p path for writing, or some file resources in @p wim
3891 * refer to files in the outside filesystem, and one of these files could
3892 * not be opened for reading.
3893 * @retval ::WIMLIB_ERR_READ
3894 * An error occurred when trying to read data from the WIM file associated
3895 * with @p wim, or some file resources in @p wim refer to files in the
3896 * outside filesystem, and a read error occurred when reading one of these
3898 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
3899 * A stream that needed to be written could not be found in the stream
3900 * lookup table of @p wim. This error can occur if, for example, @p wim is
3901 * part of a split WIM but needed resources from the other split WIM parts
3902 * were not referenced with wimlib_reference_resources() or
3903 * wimlib_reference_resource_files() before the call to wimlib_write().
3904 * @retval ::WIMLIB_ERR_WRITE
3905 * An error occurred when trying to write data to the new WIM file.
3907 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3908 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3909 * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3910 * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3911 * different reasons) to read the metadata resource for an image that needed to
3915 wimlib_write(WIMStruct *wim,
3916 const wimlib_tchar *path,
3919 unsigned num_threads,
3920 wimlib_progress_func_t progress_func);
3923 * @ingroup G_writing_and_overwriting_wims
3925 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3926 * file descriptor, which need not be seekable if the write is done in a special
3927 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3928 * write_flags. This can, for example, allow capturing a WIM image and
3929 * streaming it over the network. See the documentation for
3930 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3932 * The file descriptor @p fd will @b not be closed when the write is complete;
3933 * the calling code is responsible for this.
3935 * Returns 0 on success; nonzero on failure. The possible error codes include
3936 * those that can be returned by wimlib_write() as well as the following:
3938 * @retval ::WIMLIB_ERR_INVALID_PARAM
3939 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3940 * specified in @p write_flags.
3943 wimlib_write_to_fd(WIMStruct *wim,
3947 unsigned num_threads,
3948 wimlib_progress_func_t progress_func);
3951 * @defgroup G_compression Compression and decompression functions
3953 * @brief Functions for LZX, XPRESS, and LZMS compression and decompression,
3954 * exported for convenience only, as they are already used by wimlib internally
3957 * These functions can be used for general-purpose lossless data compression,
3958 * but some limitations apply; for example, none of the compressors or
3959 * decompressors currently support sliding windows, and there also exist
3960 * slightly different variants of these formats that are not supported
3966 /** Header for compression parameters to pass to wimlib_create_compressor() or
3967 * wimlib_set_default_compressor_params(). */
3968 struct wimlib_compressor_params_header {
3969 /** Size of the parameters, in bytes. */
3973 /** Header for decompression parameters to pass to wimlib_create_decompressor()
3974 * or wimlib_set_default_decompressor_params() */
3975 struct wimlib_decompressor_params_header {
3976 /** Size of the parameters, in bytes. */
3980 /** LZX compression parameters that can optionally be passed to
3981 * wimlib_create_compressor() with the compression type
3982 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
3983 struct wimlib_lzx_compressor_params {
3984 /** hdr.size Must be set to the size of this structure, in bytes. */
3985 struct wimlib_compressor_params_header hdr;
3987 /** Relatively fast LZX compression algorithm with a decent compression
3988 * ratio; the suggested default. */
3989 #define WIMLIB_LZX_ALGORITHM_FAST 0
3991 /** Slower LZX compression algorithm that provides a better compression
3993 #define WIMLIB_LZX_ALGORITHM_SLOW 1
3995 /** Algorithm to use to perform the compression: either
3996 * ::WIMLIB_LZX_ALGORITHM_FAST or ::WIMLIB_LZX_ALGORITHM_SLOW. The
3997 * format is still LZX; this refers to the method the code will use to
3998 * perform LZX-compatible compression. */
3999 uint32_t algorithm : 3;
4001 /** If set to 1, the default parameters for the specified algorithm are
4002 * used rather than the ones specified in the following union. */
4003 uint32_t use_defaults : 1;
4006 /** Parameters for the fast algorithm. */
4007 struct wimlib_lzx_fast_params {
4008 uint32_t fast_reserved1[10];
4011 /** Parameters for the slow algorithm. */
4012 struct wimlib_lzx_slow_params {
4013 /** If set to 1, the compressor can output length 2
4014 * matches. If set 0, the compressor only outputs
4015 * matches of length 3 or greater. Suggested value: 1
4017 uint32_t use_len2_matches : 1;
4019 uint32_t slow_reserved1 : 31;
4021 /** Matches with length (in bytes) greater than or equal
4022 * to this value are immediately taken without spending
4023 * time on minimum-cost measurements. Suggested value:
4025 uint32_t nice_match_length;
4027 /** Number of passes to compute a match/literal sequence
4028 * for each LZX block. This is for an iterative
4029 * algorithm that attempts to minimize the cost of the
4030 * match/literal sequence by using a cost model provided
4031 * by the previous iteration. Must be at least 1.
4032 * Suggested value: 2. */
4033 uint32_t num_optim_passes;
4035 /** Reserved; set to 0. */
4036 uint32_t slow_reserved_blocksplit;
4038 /** Maximum depth to search for matches at each
4039 * position. Suggested value: 50. */
4040 uint32_t max_search_depth;
4042 /** Maximum number of potentially good matches to
4043 * consider for each position. Suggested value: 3. */
4044 uint32_t max_matches_per_pos;
4046 uint32_t slow_reserved2[2];
4048 /** Assumed cost of a main symbol with zero frequency.
4049 * Must be at least 1 and no more than 16. Suggested
4051 uint8_t main_nostat_cost;
4053 /** Assumed cost of a length symbol with zero frequency.
4054 * Must be at least 1 and no more than 16. Suggested
4056 uint8_t len_nostat_cost;
4058 /** Assumed cost of an aligned symbol with zero
4059 * frequency. Must be at least 1 and no more than 8.
4060 * Suggested value: 7. */
4061 uint8_t aligned_nostat_cost;
4063 uint8_t slow_reserved3[5];
4068 /** LZMS compression parameters that can optionally be passed to
4069 * wimlib_create_compressor() with the compression type
4070 * ::WIMLIB_COMPRESSION_TYPE_LZMS. */
4071 struct wimlib_lzms_compressor_params {
4072 /** hdr.size Must be set to the size of this structure, in bytes. */
4073 struct wimlib_compressor_params_header hdr;
4075 /** Minimum match length to output. This must be at least 2. Suggested
4077 uint32_t min_match_length;
4079 /** Maximum match length to output. This must be at least @p
4080 * min_match_length. Suggested value: @p UINT32_MAX. */
4081 uint32_t max_match_length;
4083 /** Matches with length (in bytes) greater than or equal to this value
4084 * are immediately taken without spending time on minimum-cost
4085 * measurements. The minimum of @p max_match_length and @p
4086 * nice_match_length may not exceed 65536. Suggested value: 32. */
4087 uint32_t nice_match_length;
4089 /** Maximum depth to search for matches at each position. Suggested
4091 uint32_t max_search_depth;
4093 /** Maximum number of potentially good matches to consider at each
4094 * position. Suggested value: 3. */
4095 uint32_t max_matches_per_pos;
4097 /** Length of the array for the near-optimal LZ parsing algorithm. This
4098 * must be at least 1. Suggested value: 1024. */
4099 uint32_t optim_array_length;
4101 uint64_t reserved2[4];
4104 /** Opaque compressor handle. */
4105 struct wimlib_compressor;
4107 /** Opaque decompressor handle. */
4108 struct wimlib_decompressor;
4111 * Set the default compression parameters for the specified compression type.
4112 * This will affect both explicit and wimlib-internal calls to
4113 * wimlib_create_compressor().
4116 * Compression type for which to set the default compression parameters.
4118 * Compression-type specific parameters. This may be @c NULL, in which
4119 * case the "default default" parameters are restored.
4121 * @return 0 on success; nonzero on error.
4123 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4124 * @p ctype was not a supported compression type.
4125 * @retval ::WIMLIB_ERR_INVALID_PARAM
4126 * @p params were invalid.
4127 * @retval ::WIMLIB_ERR_NOMEM
4128 * Not enough memory to duplicate the parameters (perhaps @c params->size
4132 wimlib_set_default_compressor_params(enum wimlib_compression_type ctype,
4133 const struct wimlib_compressor_params_header *params);
4136 * Returns the approximate number of bytes needed to allocate a compressor with
4137 * wimlib_create_compressor() for the specified compression type, block size,
4138 * and parameters. @p params may be @c NULL, in which case the current default
4139 * parameters for @p ctype are used. Returns 0 if the compression type or
4140 * parameters are invalid.
4143 wimlib_get_compressor_needed_memory(enum wimlib_compression_type ctype,
4144 size_t max_block_size,
4145 const struct wimlib_compressor_params_header *params);
4148 * Allocate a compressor for the specified compression type using the specified
4152 * Compression type for which to create the compressor.
4153 * @param max_block_size
4154 * Maximum block size to support. The exact meaning and allowed values for
4155 * this parameter depend on the compression type, but it at least specifies
4156 * the maximum allowed value for @p uncompressed_size to wimlib_compress().
4157 * @param extra_params
4158 * An optional pointer to extra compressor parameters for the specified
4159 * compression type. For LZX, a pointer to ::wimlib_lzx_compressor_params
4160 * may be specified here. If left @c NULL, the default parameters are
4162 * @param compressor_ret
4163 * A location into which to return the pointer to the allocated compressor,
4164 * which can be used for any number of calls to wimlib_compress() before
4165 * being freed with wimlib_free_compressor().
4167 * @return 0 on success; nonzero on error.
4169 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4170 * @p ctype was not a supported compression type.
4171 * @retval ::WIMLIB_ERR_INVALID_PARAM
4172 * The compression parameters were invalid.
4173 * @retval ::WIMLIB_ERR_NOMEM
4174 * Insufficient memory to allocate the compressor.
4177 wimlib_create_compressor(enum wimlib_compression_type ctype,
4178 size_t max_block_size,
4179 const struct wimlib_compressor_params_header *extra_params,
4180 struct wimlib_compressor **compressor_ret);
4183 * Losslessly compress a block of data using a compressor previously created
4184 * with wimlib_create_compressor().
4186 * @param uncompressed_data
4187 * Buffer containing the data to compress.
4188 * @param uncompressed_size
4189 * Size, in bytes, of the data to compress.
4190 * @param compressed_data
4191 * Buffer into which to write the compressed data.
4192 * @param compressed_size_avail
4193 * Number of bytes available in @p compressed_data.
4195 * A compressor previously allocated with wimlib_create_compressor().
4198 * The size of the compressed data, in bytes, or 0 if the input data could
4199 * not be compressed to @p compressed_size_avail or fewer bytes.
4202 wimlib_compress(const void *uncompressed_data, size_t uncompressed_size,
4203 void *compressed_data, size_t compressed_size_avail,
4204 struct wimlib_compressor *compressor);
4207 * Free a compressor previously allocated with wimlib_create_compressor().
4210 * The compressor to free.
4213 wimlib_free_compressor(struct wimlib_compressor *compressor);
4216 * Set the default decompression parameters for the specified compression type.
4217 * This will affect both explicit and wimlib-internal calls to
4218 * wimlib_create_decompressor().
4221 * Compression type for which to set the default decompression parameters.
4223 * Compression-type specific parameters. This may be @c NULL, in which
4224 * case the "default default" parameters are restored.
4226 * @return 0 on success; nonzero on error.
4228 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4229 * @p ctype was not a supported compression type.
4230 * @retval ::WIMLIB_ERR_NOMEM
4231 * Not enough memory to duplicate the parameters (perhaps @c params->size
4235 wimlib_set_default_decompressor_params(enum wimlib_compression_type ctype,
4236 const struct wimlib_decompressor_params_header *params);
4239 * Allocate a decompressor for the specified compression type using the
4240 * specified parameters.
4243 * Compression type for which to create the decompressor.
4244 * @param max_block_size
4245 * Maximum block size to support. The exact meaning and allowed values for
4246 * this parameter depend on the compression type, but it at least specifies
4247 * the maximum allowed value for @p uncompressed_size to
4248 * wimlib_decompress().
4249 * @param extra_params
4250 * An optional pointer to extra decompressor parameters for the specified
4251 * compression type. If @c NULL, the default parameters are used.
4252 * @param decompressor_ret
4253 * A location into which to return the pointer to the allocated
4254 * decompressor, which can be used for any number of calls to
4255 * wimlib_decompress() before being freed with wimlib_free_decompressor().
4257 * @return 0 on success; nonzero on error.
4259 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4260 * @p ctype was not a supported compression type.
4261 * @retval ::WIMLIB_ERR_INVALID_PARAM
4262 * The decompression parameters were invalid.
4263 * @retval ::WIMLIB_ERR_NOMEM
4264 * Insufficient memory to allocate the decompressor.
4267 wimlib_create_decompressor(enum wimlib_compression_type ctype,
4268 size_t max_block_size,
4269 const struct wimlib_decompressor_params_header *extra_params,
4270 struct wimlib_decompressor **decompressor_ret);
4273 * Decompress a block of data using a decompressor previously created with
4274 * wimlib_create_decompressor().
4276 * @param compressed_data
4277 * Buffer containing the data to decompress.
4278 * @param compressed_size
4279 * Size, in bytes, of the data to decompress.
4280 * @param uncompressed_data
4281 * Buffer into which to write the uncompressed data.
4282 * @param uncompressed_size
4283 * Size, in bytes, of the data when uncompressed.
4284 * @param decompressor
4285 * A decompressor previously allocated with wimlib_create_decompressor().
4287 * @return 0 on success; nonzero on error.
4290 wimlib_decompress(const void *compressed_data, size_t compressed_size,
4291 void *uncompressed_data, size_t uncompressed_size,
4292 struct wimlib_decompressor *decompressor);
4295 * Free a decompressor previously allocated with wimlib_create_decompressor().
4297 * @param decompressor
4298 * The decompressor to free.
4301 wimlib_free_decompressor(struct wimlib_decompressor *decompressor);
4313 #endif /* _WIMLIB_H */