76d63b26d19301a3b5a2f8231828de121f9eebc8
[wimlib] / include / wimlib.h
1 /**
2  * @file wimlib.h
3  * @brief External header for wimlib.
4  *
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
9  * in this header.
10  */
11
12 /*
13  * Copyright (C) 2012, 2013, 2014 Eric Biggers
14  *
15  * This file is part of wimlib, a library for working with WIM files.
16  *
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)
20  * any later version.
21  *
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
25  * details.
26  *
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/.
29  */
30
31 /**
32  * @mainpage
33  *
34  * This is the documentation for the library interface of wimlib 1.7.1, a C
35  * library for creating, modifying, extracting, and mounting files in the
36  * Windows Imaging Format.  This documentation is intended for developers only.
37  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38  * program, please see the manual pages and also the <a
39  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/README">README
40  * file</a>.
41  *
42  * @section sec_installing Installing
43  *
44  * @subsection UNIX
45  *
46  * Download the source code from <a
47  * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
48  * Install the library by running <c>configure && make && sudo make install</c>.
49  * See the README for information about configuration options.  To use wimlib in
50  * your program after installing it, include wimlib.h and link your program with
51  * <c>-lwim</c>.
52  *
53  * @subsection Windows
54  *
55  * Download the Windows binary distribution with the appropriate architecture
56  * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from <a
57  * href="http://sourceforge.net/projects/wimlib/files">http://sourceforge.net/projects/wimlib/files</a>.
58  * Link your program with the libwim-15.dll file.  Make sure to also download
59  * the source code so you can get wimlib.h, as it is not included in the binary
60  * distribution.  If you need to access the DLL from other programming
61  * languages, note that the calling convention is "cdecl".
62  *
63  * @section sec_examples Examples
64  *
65  * Several examples are located in the <a
66  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/examples">examples</a>
67  * directory of the source distribution.
68  *
69  * There is also the <a
70  * href="http://sourceforge.net/p/wimlib/code/ci/master/tree/programs/imagex.c">
71  * source code of <b>wimlib-imagex</b></a>, which is complicated but uses most
72  * capabilities of wimlib.
73  *
74  * @section sec_basic_wim_handling_concepts Basic WIM handling concepts
75  *
76  * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.   There are
77  * two ways to create such a structure: wimlib_open_wim(), which opens a WIM
78  * file and creates a ::WIMStruct representing it, and wimlib_create_new_wim(),
79  * which creates a new ::WIMStruct that initially contains no images and does
80  * not yet have a backing on-disk file.  See @ref G_creating_and_opening_wims
81  * for more details.
82  *
83  * A WIM file, represented by a ::WIMStruct, contains zero or more images.
84  * Images can be extracted (or "applied") using wimlib_extract_image(), added
85  * (or "captured" or "appended") using wimlib_add_image(), deleted using
86  * wimlib_delete_image(), exported using wimlib_export_image(), and updated or
87  * modified using wimlib_update_image().  However, changes made to a WIM
88  * represented by a ::WIMStruct have no persistent effect until the WIM is
89  * actually written to an on-disk file.  This can be done using wimlib_write(),
90  * but if the WIM was originally opened using wimlib_open_wim(), then
91  * wimlib_overwrite() can be used instead.  See @ref G_extracting_wims, @ref
92  * G_modifying_wims, and @ref G_writing_and_overwriting_wims for more details.
93  *
94  * Note that with this ::WIMStruct abstraction, performing many tasks on WIM
95  * files is a multi-step process.  For example, to add, or "append" an image to
96  * an existing stand-alone WIM file in a way similar to <b>wimlib-imagex
97  * append</b>, you must call the following functions:
98  *
99  * 1. wimlib_open_wim()
100  * 2. wimlib_add_image()
101  * 3. wimlib_overwrite()
102  *
103  * This design is very much on purpose as it makes the library more useful in
104  * general by allowing functions to be composed in different ways.  For example,
105  * you can make multiple changes to a WIM and commit them all to the underlying
106  * file in only one overwrite operation, which is more efficient.
107  *
108  * Note: before calling any other function declared in wimlib.h,
109  * wimlib_global_init() can (and in some cases, must) be called.  See its
110  * documentation for more details.
111  *
112  * @section sec_cleaning_up Cleaning up
113  *
114  * After you are done with any ::WIMStruct, you can call wimlib_free() to free
115  * all resources associated with it.  Also, when you are completely done with
116  * using wimlib in your program, you can call wimlib_global_cleanup() to free
117  * any other resources allocated by the library.
118  *
119  * @section sec_error_handling Error Handling
120  *
121  * Most functions in wimlib return 0 on success and a positive error code on
122  * failure.  Use wimlib_get_error_string() to get a string that describes an
123  * error code.  wimlib also can print error messages to standard error itself
124  * when an error happens, and these may be more informative than the error code;
125  * to enable this, call wimlib_set_print_errors().  Please note that this is for
126  * convenience only, and some errors can occur without a message being printed.
127  * Currently, error messages and strings (as well as all documentation, for that
128  * matter) are only available in English.
129  *
130  * @section sec_encodings Locales and character encodings
131  *
132  * To support Windows as well as UNIX-like systems, wimlib's API typically takes
133  * and returns strings of ::wimlib_tchar, which are in a platform-dependent
134  * encoding.
135  *
136  * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
137  * and the encoding is UTF-16LE.
138  *
139  * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
140  * and the encoding is the locale-dependent multibyte encoding.  I recommend you
141  * set your locale to a UTF-8 capable locale to avoid any issues.  Also, by
142  * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
143  * call wimlib_global_init() after having set your desired locale.
144  *
145  * @section sec_advanced Additional information and features
146  *
147  *
148  * @subsection subsec_mounting_wim_images Mounting WIM images
149  *
150  * See @ref G_mounting_wim_images.
151  *
152  * @subsection subsec_progress_functions Progress Messages
153  *
154  * See @ref G_progress.
155  *
156  * @subsection subsec_non_standalone_wims Non-standalone WIMs
157  *
158  * See @ref G_nonstandalone_wims.
159  *
160  * @subsection subsec_pipable_wims Pipable WIMs
161  *
162  * wimlib supports a special "pipable" WIM format which unfortunately is @b not
163  * compatible with Microsoft's software.  To create a pipable WIM, call
164  * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
165  * ::WIMLIB_WRITE_FLAG_PIPABLE specified.  Pipable WIMs are pipable in both
166  * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
167  * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
168  * a pipable WIM.  wimlib can also transparently open and operate on pipable WIM
169  * s using a seekable file descriptor using the regular function calls (e.g.
170  * wimlib_open_wim(), wimlib_extract_image()).
171  *
172  * See the documentation for the <b>--pipable</b> flag of <b>wimlib-imagex
173  * capture</b> for more information about pipable WIMs.
174  *
175  * @subsection subsec_thread_safety Thread Safety
176  *
177  * wimlib is thread-safe, with the following exceptions:
178  * - Different threads cannot operate on the same ::WIMStruct at the same time;
179  *   they must use different ::WIMStruct's.
180  * - You must call wimlib_global_init() in one thread before calling any other
181  *   functions.
182  * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
183  * - wimlib_mount_image(), while it can be used to mount multiple WIMs
184  *   concurrently in the same process, will daemonize the entire process when it
185  *   does so for the first time.  This includes changing the working directory
186  *   to the root directory.
187  *
188  * @subsection subsec_limitations Limitations
189  *
190  * This section documents some technical limitations of wimlib not already
191  * documented in the man page for @b wimlib-imagex.
192  *
193  * - The old WIM format from Vista pre-releases is not supported.
194  * - wimlib does not provide a clone of the @b PEImg tool, or the @b DISM
195  *   functionality other than that already present in @b ImageX, that allows you
196  *   to make certain Windows-specific modifications to a Windows PE image, such
197  *   as adding a driver or Windows component.  Such a tool could be implemented
198  *   on top of wimlib.
199  *
200  * @subsection more_info More information
201  *
202  * You are advised to read the README as well as the manual pages for
203  * <b>wimlib-imagex</b>, since not all relevant information is repeated here in
204  * the API documentation.
205  */
206
207 /** @defgroup G_general General
208  *
209  * @brief Declarations and structures shared across the library.
210  */
211
212 /** @defgroup G_creating_and_opening_wims Creating and Opening WIMs
213  *
214  * @brief Create new WIMs and open existing WIMs.
215  */
216
217 /** @defgroup G_wim_information Retrieving WIM information and directory listings
218  *
219  * @brief Retrieve information about a WIM or WIM image.
220  */
221
222 /** @defgroup G_modifying_wims Modifying WIMs
223  *
224  * @brief Make changes to a WIM.
225  *
226  * @section sec_adding_images Capturing and adding WIM images
227  *
228  * As described in @ref sec_basic_wim_handling_concepts, capturing a new WIM or
229  * appending an image to an existing WIM is a multi-step process, but at its
230  * core is wimlib_add_image() or an equivalent function.  Normally,
231  * wimlib_add_image() takes an on-disk directory tree and logically adds it to a
232  * ::WIMStruct as a new image.  However, when supported by the build of the
233  * library, there is also a special NTFS volume capture mode (entered when
234  * ::WIMLIB_ADD_FLAG_NTFS is specified) that allows adding the image directly
235  * from an unmounted NTFS volume.
236  *
237  * Another function, wimlib_add_image_multisource() is also provided.  It
238  * generalizes wimlib_add_image() to allow combining multiple files or directory
239  * trees into a single WIM image in a configurable way.
240  *
241  * For maximum customization of WIM image creation, it is also possible to add a
242  * completely empty WIM image with wimlib_add_empty_image(), then update it with
243  * wimlib_update_image().  (This is in fact what wimlib_add_image() and
244  * wimlib_add_image_multisource() do internally.)
245  *
246  * Note that some details of how image addition/capture works are documented
247  * more fully in the manual page for <b>wimlib-imagex capture</b>.
248  *
249  * @section sec_deleting_images Deleting WIM images
250  *
251  * wimlib_delete_image() can delete an image from a ::WIMStruct.  But as usual,
252  * wimlib_write() or wimlib_overwrite() must be called to cause the changes to
253  * be made persistent in an on-disk WIM file.
254  *
255  * @section sec_exporting_images Exporting WIM images
256  *
257  * wimlib_export_image() can copy, or "export", an image from one WIM to
258  * another.
259  *
260  * @section sec_other_modifications Other modifications
261  *
262  * wimlib_update_image() can add, delete, and rename files in a WIM image.
263  *
264  * wimlib_set_image_name(), wimlib_set_image_descripton(), and
265  * wimlib_set_image_flags() can change other image metadata.
266  *
267  * wimlib_set_wim_info() can change information about the WIM file itself, such
268  * as the boot index.
269  */
270
271 /** @defgroup G_extracting_wims Extracting WIMs
272  *
273  * @brief Extract files, directories, and images from a WIM.
274  *
275  * wimlib_extract_image() extracts, or "applies", an image from a WIM,
276  * represented by a ::WIMStruct.  This normally extracts the image to a
277  * directory, but when supported by the build of the library there is also a
278  * special NTFS volume extraction mode (entered when ::WIMLIB_EXTRACT_FLAG_NTFS
279  * is specified) that allows extracting a WIM image directly to an unmounted
280  * NTFS volume.  Various other flags allow further customization of image
281  * extraction.
282  *
283  * wimlib_extract_paths() and wimlib_extract_pathlist() allow extracting a list
284  * of (possibly wildcard) paths from a WIM image.
285  *
286  * wimlib_extract_image_from_pipe() extracts an image from a pipable WIM sent
287  * over a pipe; see @ref subsec_pipable_wims.
288  *
289  * Some details of how WIM extraction works are documented more fully in the
290  * manual pages for <b>wimlib-imagex apply</b> and <b>wimlib-imagex extract</b>.
291  */
292
293 /** @defgroup G_mounting_wim_images Mounting WIM images
294  *
295  * @brief Mount and unmount WIM images.
296  *
297  * On Linux, wimlib supports mounting images from WIM files either read-only or
298  * read-write.  To mount an image, call wimlib_mount_image().  To unmount an
299  * image, call wimlib_unmount_image().  Mounting can be done without root
300  * privileges because it is implemented using FUSE (Filesystem in Userspace).
301  *
302  * If wimlib is compiled using the <code>--without-fuse</code> flag, these
303  * functions will be available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
304  *
305  * Note: if mounting is unsupported, wimlib still provides another way to modify
306  * a WIM image (wimlib_update_image()).
307  */
308
309 /**
310  * @defgroup G_progress Progress Messages
311  *
312  * @brief Track the progress of long WIM operations.
313  *
314  * Library users can provide a progress function which will be called
315  * periodically during operations such as extracting a WIM image or writing a
316  * WIM image.  A ::WIMStruct can have a progress function of type
317  * ::wimlib_progress_func_t associated with it by calling
318  * wimlib_register_progress_function() or by opening the ::WIMStruct using
319  * wimlib_open_wim_with_progress().  Once this is done, the progress function
320  * will be called automatically during many operations, such as
321  * wimlib_extract_image() and wimlib_write().
322  *
323  * Some functions that do not operate directly on a user-provided ::WIMStruct,
324  * such as wimlib_join(), also take the progress function directly using an
325  * extended version of the function, such as wimlib_join_with_progress().
326  *
327  * In wimlib v1.7.0 and later, progress functions are no longer just
328  * unidirectional.  You can now return ::WIMLIB_PROGRESS_STATUS_ABORT to cause
329  * the current operation to be aborted.  wimlib v1.7.0 also added the third
330  * argument to ::wimlib_progress_func_t, which is a user-supplied context.
331  */
332
333 /** @defgroup G_writing_and_overwriting_wims Writing and Overwriting WIMs
334  *
335  * @brief Write and overwrite on-disk WIM files.
336  *
337  * As described in @ref sec_basic_wim_handling_concepts, these functions are
338  * fundamental to the design of the library as they allow new or modified
339  * ::WIMStruct's to actually be written to on-disk files.  Call wimlib_write()
340  * to write a new WIM file, or wimlib_overwrite() to persistently update an
341  * existing WIM file.
342  */
343
344 /** @defgroup G_nonstandalone_wims Creating and handling non-standalone WIMs
345  *
346  * @brief Create and handle non-standalone WIMs, such as split and delta WIMs.
347  *
348  * Normally, a ::WIMStruct represents a WIM file, but there's a bit more to it
349  * than that.  Normally, WIM files are "standalone".  However, WIM files can
350  * also be arranged in non-standalone ways, such as a set of on-disk files that
351  * together form a single "split WIM" or "delta WIM".  Such arrangements are
352  * fully supported by wimlib.  However, as a result, in such cases a ::WIMStruct
353  * created from one of these on-disk files initially only partially represents
354  * the full WIM and needs to, in effect, be logically combined with other
355  * ::WIMStruct's before performing certain operations, such as extracting files
356  * with wimlib_extract_image() or wimlib_extract_paths().  This is done by
357  * calling wimlib_reference_resource_files() or wimlib_reference_resources().
358  *
359  * wimlib_write() can create delta WIMs as well as standalone WIMs, but a
360  * specialized function (wimlib_split()) is needed to create a split WIM.
361  */
362
363 #ifndef _WIMLIB_H
364 #define _WIMLIB_H
365
366 #include <stdio.h>
367 #include <stddef.h>
368 #include <stdbool.h>
369 #include <inttypes.h>
370 #include <time.h>
371
372 #ifdef __GNUC__
373 #  define _wimlib_deprecated __attribute__((deprecated))
374 #else
375 #  define _wimlib_deprecated
376 #endif
377
378 /** @addtogroup G_general
379  * @{ */
380
381 /** Major version of the library (for example, the 1 in 1.2.5).  */
382 #define WIMLIB_MAJOR_VERSION 1
383
384 /** Minor version of the library (for example, the 2 in 1.2.5). */
385 #define WIMLIB_MINOR_VERSION 7
386
387 /** Patch version of the library (for example, the 5 in 1.2.5). */
388 #define WIMLIB_PATCH_VERSION 1
389
390 #ifdef __cplusplus
391 extern "C" {
392 #endif
393
394 /**
395  * Opaque structure that represents a WIM file.  This is an in-memory structure
396  * and need not correspond to a specific on-disk file.  However, a ::WIMStruct
397  * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
398  * continuing to exist so that data can be read from it as needed.
399  *
400  * Most functions in this library will work the same way regardless of whether a
401  * given ::WIMStruct was obtained through wimlib_open_wim() or
402  * wimlib_create_new_wim().  Exceptions are documented.
403  *
404  * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
405  * file from a ::WIMStruct.
406  *
407  * See @ref sec_basic_wim_handling_concepts for more information.
408  */
409 #ifndef WIMLIB_WIMSTRUCT_DECLARED
410 typedef struct WIMStruct WIMStruct;
411 #define WIMLIB_WIMSTRUCT_DECLARED
412 #endif
413
414 #ifdef __WIN32__
415 typedef wchar_t wimlib_tchar;
416 #else
417 /** See @ref sec_encodings */
418 typedef char wimlib_tchar;
419 #endif
420
421 #ifdef __WIN32__
422 /** Path separator for WIM paths passed back to progress callbacks.
423  * This is forward slash on UNIX and backslash on Windows.  */
424 #  define WIMLIB_WIM_PATH_SEPARATOR '\\'
425 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
426 #else
427 /** Path separator for WIM paths passed back to progress callbacks.
428  * This is forward slash on UNIX and backslash on Windows.  */
429 #  define WIMLIB_WIM_PATH_SEPARATOR '/'
430 #  define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
431 #endif
432
433 /** Use this to specify the root directory of the WIM image.  */
434 #define WIMLIB_WIM_ROOT_PATH WIMLIB_WIM_PATH_SEPARATOR_STRING
435
436 /** Use this to test if the specified path refers to the root directory of the
437  * WIM image.  */
438 #define WIMLIB_IS_WIM_ROOT_PATH(path) \
439                 ((path)[0] == WIMLIB_WIM_PATH_SEPARATOR &&      \
440                  (path)[1] == 0)
441
442 /** Length of a Globally Unique Identifier (GUID)  */
443 #define WIMLIB_GUID_LEN 16
444
445 /**
446  * Specifies a compression format.  Pass one of these values to
447  * wimlib_create_new_wim(), wimlib_set_output_compression_type(),
448  * wimlib_create_compressor(), or wimlib_create_decompressor().
449  *
450  * A WIM file has one default compression type and chunk size.  Normally, each
451  * resource in the WIM file is compressed with this compression type.  However,
452  * resources may be stored as uncompressed; for example, wimlib will do so if a
453  * resource does not compress to less than its original size.  In addition, a
454  * WIM with the new version number of 3584, or "ESD file", might contain solid
455  * blocks with different compression types.
456  */
457 enum wimlib_compression_type {
458         /**
459          * No compression.
460          *
461          * This is a valid argument to wimlib_create_new_wim() and
462          * wimlib_set_output_compression_type(), but not to the functions in the
463          * compression API such as wimlib_create_compressor().
464          */
465         WIMLIB_COMPRESSION_TYPE_NONE = 0,
466
467         /**
468          * The XPRESS compression format.  This format combines Lempel-Ziv
469          * factorization with Huffman encoding.  Compression and decompression
470          * are both fast.  This format supports chunk sizes that are powers of 2
471          * between <c>2^12</c> and <c>2^16</c>, inclusively.
472          *
473          * wimlib's XPRESS compressor will, with the default settings, usually
474          * produce a better compression ratio, and work more quickly, than the
475          * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
476          * Non-default compression levels are also supported.  For example,
477          * level 80 will enable two-pass optimal parsing, which is significantly
478          * slower but usually improves compression by several percent over the
479          * default level of 50.
480          *
481          * If using wimlib_create_compressor() to create an XPRESS compressor
482          * directly, the @p max_block_size parameter may be any positive value
483          * up to <c>2^16</c>.
484          */
485         WIMLIB_COMPRESSION_TYPE_XPRESS = 1,
486
487         /**
488          * The LZX compression format.  This format combines Lempel-Ziv
489          * factorization with Huffman encoding, but with more features and
490          * complexity than XPRESS.  Compression is slow to somewhat fast,
491          * depending on the settings.  Decompression is fast but slower than
492          * XPRESS.  This format supports chunk sizes that are powers of 2
493          * between <c>2^15</c> and <c>2^21</c>, inclusively.  Note: chunk sizes
494          * other than <c>2^15</c> are not compatible with the Microsoft
495          * implementation.
496          *
497          * wimlib's LZX compressor will, with the default settings, usually
498          * produce a better compression ratio, and work more quickly, than the
499          * implementation in Microsoft's WIMGAPI (as of Windows 8.1).
500          * Non-default compression levels are also supported.  For example,
501          * level 20 will provide fast compression, almost as fast as XPRESS.
502          *
503          * If using wimlib_create_compressor() to create an LZX compressor
504          * directly, the @p max_block_size parameter may be any positive value
505          * up to <c>2^21</c>.
506          */
507         WIMLIB_COMPRESSION_TYPE_LZX = 2,
508
509         /**
510          * The LZMS compression format.  This format combines Lempel-Ziv
511          * factorization with adaptive Huffman encoding and range coding.
512          * Compression and decompression are both fairly slow.  This format
513          * supports chunk sizes that are powers of 2 between <c>2^15</c> and
514          * <c>2^30</c>, inclusively.  This format is best used for large chunk
515          * sizes.  Note: LZMS compression is only compatible with wimlib v1.6.0
516          * and later, WIMGAPI Windows 8 and later, and DISM Windows 8.1 and
517          * later.  Also, chunk sizes larger than <c>2^26</c> are not compatible
518          * with the Microsoft implementation.
519          *
520          * wimlib's LZMS compressor is currently faster but will usually not
521          * compress as much as the implementation in Microsoft's WIMGAPI
522          * (Windows 8.1).
523          *
524          * If using wimlib_create_compressor() to create an LZMS compressor
525          * directly, the @p max_block_size parameter may be any positive value
526          * up to <c>2^31 - 2</c>.
527          */
528         WIMLIB_COMPRESSION_TYPE_LZMS = 3,
529 };
530
531 /** @} */
532 /** @addtogroup G_progress
533  * @{ */
534
535 /** Possible values of the first parameter to the user-supplied
536  * ::wimlib_progress_func_t progress function */
537 enum wimlib_progress_msg {
538
539         /** A WIM image is about to be extracted.  @p info will point to
540          * ::wimlib_progress_info.extract.  This message is received once per
541          * image for calls to wimlib_extract_image() and
542          * wimlib_extract_image_from_pipe().  */
543         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
544
545         /** One or more file or directory trees within a WIM image is about to
546          * be extracted.  @p info will point to ::wimlib_progress_info.extract.
547          * This message is received only once per wimlib_extract_paths() and
548          * wimlib_extract_pathlist(), since wimlib combines all paths into a
549          * single extraction operation for optimization purposes.  */
550         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN = 1,
551
552         /** This message may be sent periodically (not for every file) while
553          * files or directories are being created, prior to data stream
554          * extraction.  @p info will point to ::wimlib_progress_info.extract.
555          * In particular, the @p current_file_count and @p end_file_count
556          * members may be used to track the progress of this phase of
557          * extraction.  */
558         WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE = 3,
559
560         /** File data is currently being extracted.  @p info will point to
561          * ::wimlib_progress_info.extract.  This is the main message to track
562          * the progress of an extraction operation.  */
563         WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS = 4,
564
565         /** Starting to read a new part of a split pipable WIM over the pipe.
566          * @p info will point to ::wimlib_progress_info.extract.  */
567         WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN = 5,
568
569         /** This message may be sent periodically (not for every file) while
570          * file and directory metadata is being applied, following data stream
571          * extraction.  @p info will point to ::wimlib_progress_info.extract.
572          * In particular, the @p current_file_count and @p end_file_count
573          * members may be used to track the progress of this phase of
574          * extraction.  */
575         WIMLIB_PROGRESS_MSG_EXTRACT_METADATA = 6,
576
577         /** Confirms that the image has been successfully extracted.  @p info
578          * will point to ::wimlib_progress_info.extract.  This is paired with
579          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN.  */
580         WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END = 7,
581
582         /** Confirms that the files or directory trees have been successfully
583          * extracted.  @p info will point to ::wimlib_progress_info.extract.
584          * This is paired with ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN.  */
585         WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END = 8,
586
587         /** The directory or NTFS volume is about to be scanned for metadata.
588          * @p info will point to ::wimlib_progress_info.scan.  This message is
589          * received once per call to wimlib_add_image(), or once per capture
590          * source passed to wimlib_add_image_multisource(), or once per add
591          * command passed to wimlib_update_image().  */
592         WIMLIB_PROGRESS_MSG_SCAN_BEGIN = 9,
593
594         /** A directory or file has been scanned.  @p info will point to
595          * ::wimlib_progress_info.scan, and its @p cur_path member will be
596          * valid.  This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE has
597          * been specified.  */
598         WIMLIB_PROGRESS_MSG_SCAN_DENTRY = 10,
599
600         /** Confirms that the directory or NTFS volume has been successfully
601          * scanned.  @p info will point to ::wimlib_progress_info.scan.  This is
602          * paired with a previous ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN message,
603          * possibly with many intervening ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY
604          * messages.  */
605         WIMLIB_PROGRESS_MSG_SCAN_END = 11,
606
607         /** File resources ("streams") are currently being written to the WIM.
608          * @p info will point to ::wimlib_progress_info.write_streams.  This
609          * message may be received many times while the WIM file is being
610          * written or appended to with wimlib_write(), wimlib_overwrite(), or
611          * wimlib_write_to_fd().  */
612         WIMLIB_PROGRESS_MSG_WRITE_STREAMS = 12,
613
614         /** Per-image metadata is about to be written to the WIM file.  @p info
615          * will not be valid. */
616         WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN = 13,
617
618         /** Confirms that per-image metadata has been successfully been written
619          * to the WIM file.  @p info will not be valid.  This message is paired
620          * with a preceding ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN message.
621          */
622         WIMLIB_PROGRESS_MSG_WRITE_METADATA_END = 14,
623
624         /** wimlib_overwrite() has successfully renamed the temporary file to
625          * the original WIM file, thereby committing the update.  @p info will
626          * point to ::wimlib_progress_info.rename.  Note: this message is not
627          * received if wimlib_overwrite() chose to append to the WIM file
628          * in-place.  */
629         WIMLIB_PROGRESS_MSG_RENAME = 15,
630
631         /** The contents of the WIM file are being checked against the integrity
632          * table.  @p info will point to ::wimlib_progress_info.integrity.  This
633          * message is only received (and may be received many times) when
634          * wimlib_open_wim_with_progress() is called with the
635          * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag.  */
636         WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY = 16,
637
638         /** An integrity table is being calculated for the WIM being written.
639          * @p info will point to ::wimlib_progress_info.integrity.  This message
640          * is only received (and may be received many times) when a WIM file is
641          * being written with the flag ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY.  */
642         WIMLIB_PROGRESS_MSG_CALC_INTEGRITY = 17,
643
644         /** A wimlib_split() operation is in progress, and a new split part is
645          * about to be started.  @p info will point to
646          * ::wimlib_progress_info.split.  */
647         WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART = 19,
648
649         /** A wimlib_split() operation is in progress, and a split part has been
650          * finished. @p info will point to ::wimlib_progress_info.split.  */
651         WIMLIB_PROGRESS_MSG_SPLIT_END_PART = 20,
652
653         /** A WIM update command is just about to be executed. @p info will
654          * point to ::wimlib_progress_info.update.  This message is received
655          * once per update command when wimlib_update_image() is called with the
656          * flag ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
657         WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND = 21,
658
659         /** A WIM update command has just been executed. @p info will point to
660          * ::wimlib_progress_info.update.  This message is received once per
661          * update command when wimlib_update_image() is called with the flag
662          * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS.  */
663         WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND = 22,
664
665         /** A file in the WIM image is being replaced as a result of a
666          * ::wimlib_add_command without ::WIMLIB_ADD_FLAG_NO_REPLACE specified.
667          * @p info will point to ::wimlib_progress_info.replace.  This is only
668          * received when ::WIMLIB_ADD_FLAG_VERBOSE is also specified in the add
669          * command.  */
670         WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM = 23,
671
672         /** A WIM image is being applied with ::WIMLIB_EXTRACT_FLAG_WIMBOOT, and
673          * a file is being extracted normally (not as a WIMBoot "pointer file")
674          * due to it matching a pattern in the [PrepopulateList] section of the
675          * configuration file @c \\Windows\\System32\\WimBootCompress.ini in the
676          * WIM image.  @p info will point to
677          * ::wimlib_progress_info.wimboot_exclude.
678          */
679         WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE = 24,
680
681         /** Starting to unmount a WIM image.  @p info will point to
682          * ::wimlib_progress_info.unmount.  */
683         WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN = 25,
684
685         /** wimlib has used a file's data for the last time (including all data
686          * streams, if it has multiple).  @p info will point to
687          * ::wimlib_progress_info.done_with_file.  This message is only received
688          * if ::WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES was provided.  */
689         WIMLIB_PROGRESS_MSG_DONE_WITH_FILE = 26,
690
691         /** wimlib_verify_wim() is starting to verify the metadata for an image.
692          * @p info will point to ::wimlib_progress_info.verify_image.  */
693         WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE = 27,
694
695         /** wimlib_verify_wim() has finished verifying the metadata for an
696          * image.  @p info will point to ::wimlib_progress_info.verify_image.
697          */
698         WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE = 28,
699
700         /** wimlib_verify_wim() is verifying stream integrity.  @p info will
701          * point to ::wimlib_progress_info.verify_streams.  */
702         WIMLIB_PROGRESS_MSG_VERIFY_STREAMS = 29,
703
704         /**
705          * The progress function is being asked whether a file should be
706          * excluded from capture or not.  @p info will point to
707          * ::wimlib_progress_info.test_file_exclusion.  This is a bidirectional
708          * message that allows the progress function to set a flag if the file
709          * should be excluded.
710          *
711          * This message is only received if the flag
712          * ::WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION is used.  This method for file
713          * exclusions is independent of the "capture configuration file"
714          * mechanism.
715          */
716         WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION = 30,
717 };
718
719 /** Valid return values from user-provided progress functions
720  * (::wimlib_progress_func_t).
721  *
722  * (Note: if an invalid value is returned, ::WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS
723  * will be issued.)
724  */
725 enum wimlib_progress_status {
726
727         /** The operation should be continued.  This is the normal return value.
728          */
729         WIMLIB_PROGRESS_STATUS_CONTINUE = 0,
730
731         /** The operation should be aborted.  This will cause the current
732          * operation to fail with ::WIMLIB_ERR_ABORTED_BY_PROGRESS.  */
733         WIMLIB_PROGRESS_STATUS_ABORT    = 1,
734 };
735
736 /**
737  * A pointer to this union is passed to the user-supplied
738  * ::wimlib_progress_func_t progress function.  One (or none) of the structures
739  * contained in this union will be applicable for the operation
740  * (::wimlib_progress_msg) indicated in the first argument to the progress
741  * function. */
742 union wimlib_progress_info {
743
744         /* N.B. I wanted these to be anonymous structs, but Doxygen won't
745          * document them if they aren't given a name... */
746
747         /** Valid on the message ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.  This is
748          * the primary message for tracking the progress of writing a WIM file.
749          */
750         struct wimlib_progress_info_write_streams {
751                 /** Total number of uncompressed bytes of stream data being
752                  * written.  This can be thought of as the total uncompressed
753                  * size of the files being archived, with some caveats.  WIM
754                  * files use single-instance streams, so the size provided here
755                  * only counts distinct streams, except for the following
756                  * exception: the size provided here may include the sizes of
757                  * all newly added (e.g. with wimlib_add_image() streams,
758                  * pending automatic de-duplication during the write operation
759                  * itself.  When each such stream de-duplication occurs, this
760                  * number will be decreased by the size of the duplicate stream
761                  * that need not be written.
762                  *
763                  * In the case of a wimlib_overwrite() that the library opted to
764                  * perform in-place, both @p total_streams and @p total_bytes
765                  * will only count the streams actually being written and not
766                  * pre-existing streams in the WIM file.  */
767                 uint64_t total_bytes;
768
769                 /** Total number of streams being written.  This can be thought
770                  * of as the total number of files being archived, with some
771                  * caveats.  In general, a single file or directory may contain
772                  * multiple data streams, each of which will be represented
773                  * separately in this number.  Furthermore, WIM files use
774                  * single-instance streams, so the stream count provided here
775                  * only counts distinct streams, except for the following
776                  * exception: the stream count provided here may include newly
777                  * added (e.g. with wimlib_add_image() streams, pending
778                  * automatic de-duplication during the write operation itself.
779                  * When each such stream de-duplication occurs, this number will
780                  * be decreased by 1 to account for the duplicate stream that
781                  * need not be written.  */
782                 uint64_t total_streams;
783
784                 /** Number of uncompressed bytes of stream data that have been
785                  * written so far.  This number be 0 initially, and will be
786                  * equal to @p total_bytes at the end of the write operation.
787                  * Note that @p total_bytes (but not @p completed_bytes) may
788                  * decrease throughout the write operation due to the discovery
789                  * of stream duplications.  */
790                 uint64_t completed_bytes;
791
792                 /** Number of streams that have been written so far.  This
793                  * number will be 0 initially, and will be equal to @p
794                  * total_streams at the end of the write operation.  Note that
795                  * @p total_streams (but not @p completed_streams) may decrease
796                  * throughout the write operation due to the discovery of stream
797                  * duplications.
798                  *
799                  * For applications that wish to calculate a simple "percent
800                  * complete" for the write operation, it will likely be more
801                  * accurate to calculate the percentage from @p completed_bytes
802                  * and @p total_bytes rather than @p completed_streams and
803                  * @p total_streams because the time for the operation to
804                  * complete is mainly determined by the number of bytes that
805                  * need to be read, compressed, and written, not just the number
806                  * of files being archived.  */
807                 uint64_t completed_streams;
808
809                 /** Number of threads that are being used to compress streams,
810                  * or 1 if streams are being written uncompressed.  */
811                 uint32_t num_threads;
812
813                 /** The compression type being used to write the streams, as one
814                  * of the ::wimlib_compression_type constants.  */
815                 int32_t  compression_type;
816
817                 /** Number of split WIM parts from which streams are being
818                  * written (may be 0 if irrelevant).   */
819                 uint32_t total_parts;
820
821                 /** This is currently broken and will always be 0.  */
822                 uint32_t completed_parts;
823         } write_streams;
824
825         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
826          * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY, and
827          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  */
828         struct wimlib_progress_info_scan {
829                 /** Top-level directory being scanned; or, when capturing an NTFS
830                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this is instead the path
831                  * to the file or block device that contains the NTFS volume
832                  * being scanned.  */
833                 const wimlib_tchar *source;
834
835                 /** Path to the file (or directory) that has been scanned, valid
836                  * on ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  When capturing an NTFS
837                  * volume with ::WIMLIB_ADD_FLAG_NTFS, this path will be
838                  * relative to the root of the NTFS volume.  */
839                 const wimlib_tchar *cur_path;
840
841                 /** Dentry scan status, valid on
842                  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.  */
843                 enum {
844                         /** The file looks okay and will be captured.  */
845                         WIMLIB_SCAN_DENTRY_OK = 0,
846
847                         /** File is being excluded from capture due to the
848                          * capture configuration.  */
849                         WIMLIB_SCAN_DENTRY_EXCLUDED,
850
851                         /** File is being excluded from capture due to being
852                          * unsupported (e.g. an encrypted or device file).  */
853                         WIMLIB_SCAN_DENTRY_UNSUPPORTED,
854
855                         /** The file is an absolute symbolic link or junction
856                          * that points into the capture directory, and
857                          * reparse-point fixups are enabled, so its target is
858                          * being adjusted.  (Reparse point fixups can be
859                          * disabled with the flag ::WIMLIB_ADD_FLAG_NORPFIX.)
860                          */
861                         WIMLIB_SCAN_DENTRY_FIXED_SYMLINK,
862
863                         /** Reparse-point fixups are enabled, but the file is an
864                          * absolute symbolic link or junction that does
865                          * <b>not</b> point into the capture directory, so its
866                          * target is <b>not</b> being adjusted.  */
867                         WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK,
868                 } status;
869
870                 union {
871                         /** Target path in the WIM image.  Only valid on
872                          * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
873                          * ::WIMLIB_PROGRESS_MSG_SCAN_END.  */
874                         const wimlib_tchar *wim_target_path;
875
876                         /** For ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY and a status
877                          * of @p WIMLIB_SCAN_DENTRY_FIXED_SYMLINK or @p
878                          * WIMLIB_SCAN_DENTRY_NOT_FIXED_SYMLINK, this is the
879                          * target of the absolute symbolic link or junction.  */
880                         const wimlib_tchar *symlink_target;
881                 };
882
883                 /** Number of directories scanned so far, including the root
884                  * directory but excluding any unsupported/excluded directories.
885                  *
886                  * Details: On Windows and in NTFS capture mode, a reparse point
887                  * counts as a directory if and only if it has
888                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
889                  * counts as a directory if and only if when fully dereferenced
890                  * it points to an accessible directory.  If a file has multiple
891                  * names (hard links), it is only counted one time.  */
892                 uint64_t num_dirs_scanned;
893
894                 /** Number of non-directories scanned so far, excluding any
895                  * unsupported/excluded files.
896                  *
897                  * Details: On Windows and in NTFS capture mode, a reparse point
898                  * counts as a non-directory if and only if it does not have
899                  * FILE_ATTRIBUTE_DIRECTORY set.  Otherwise, a symbolic link
900                  * counts as a non-directory if and only if when fully
901                  * dereferenced it points to a non-directory or its target is
902                  * inaccessible.  If a file has multiple names (hard links), it
903                  * is only counted one time.  */
904                 uint64_t num_nondirs_scanned;
905
906                 /** Number of bytes of file data that have been detected so far.
907                  *
908                  * Details: This data may not actually have been read yet, and
909                  * it will not actually be written to the WIM file until
910                  * wimlib_write() or wimlib_overwrite() has been called.  Data
911                  * from excluded files is not counted.  This number includes
912                  * default file contents as well as named data streams and
913                  * reparse point data.  The size of reparse point data is
914                  * tallied after any reparse-point fixups, and in the case of
915                  * capturing a symbolic link on a UNIX-like system, the creation
916                  * of the reparse point data itself.  If a file has multiple
917                  * names (hard links), its size(s) are only counted one time.
918                  * On Windows, encrypted files have their encrypted size
919                  * counted, not their unencrypted size; however, compressed
920                  * files have their uncompressed size counted.  */
921                 uint64_t num_bytes_scanned;
922         } scan;
923
924         /** Valid on messages
925          * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
926          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
927          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
928          * ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
929          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
930          * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA,
931          * ::WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END, and
932          * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
933          *
934          * Note: most of the time of an extraction operation will be spent
935          * extracting streams, and the application will receive
936          * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS during this time.  Using @p
937          * completed_bytes and @p total_bytes, the application can calculate a
938          * percentage complete.  However, note that this message does not, in
939          * general, actually provide information about which "file" is currently
940          * being extracted.  This is because wimlib, by default, extracts the
941          * individual data streams in whichever order it determines to be the
942          * most efficient.
943          */
944         struct wimlib_progress_info_extract {
945                 /** Number of the image from which files are being extracted
946                  * (1-based).  */
947                 uint32_t image;
948
949                 /** Extraction flags being used.  */
950                 uint32_t extract_flags;
951
952                 /** Full path to the WIM file from which files are being
953                  * extracted, or @c NULL if the WIMStruct has no associated
954                  * on-disk file.  */
955                 const wimlib_tchar *wimfile_name;
956
957                 /** Name of the image from which files are being extracted, or
958                  * the empty string if the image is unnamed.  */
959                 const wimlib_tchar *image_name;
960
961                 /** Path to the directory or NTFS volume to which the files are
962                  * being extracted.  */
963                 const wimlib_tchar *target;
964
965                 /** Reserved.  */
966                 const wimlib_tchar *reserved;
967
968                 /** Number of bytes of uncompressed data that will be extracted.
969                  * If a file has multiple names (hard links), its size (or
970                  * sizes, in the case of named data streams) is only counted one
971                  * time.  For "reparse points" and symbolic links, the size to
972                  * be extracted is the size of the reparse data buffer.
973                  *
974                  * This number will stay constant throughout the extraction.  */
975                 uint64_t total_bytes;
976
977                 /** Number of bytes of uncompressed data that have been
978                  * extracted so far.  This initially be 0 and will equal to @p
979                  * total_bytes at the end of the extraction.  */
980                 uint64_t completed_bytes;
981
982                 /** Number of (not necessarily unique) streams that will be
983                  * extracted.  This may be more or less than the number of
984                  * "files" to be extracted due to hard links as well as
985                  * potentially multiple streams per file (named data streams).
986                  * A "stream" may be the default contents of a file, a named
987                  * data stream, or a reparse data buffer.  */
988                 uint64_t total_streams;
989
990                 /** Number of (not necessarily unique) streams that have been
991                  * extracted so far.  */
992                 uint64_t completed_streams;
993
994                 /** Currently only used for
995                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
996                 uint32_t part_number;
997
998                 /** Currently only used for
999                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
1000                 uint32_t total_parts;
1001
1002                 /** Currently only used for
1003                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.  */
1004                 uint8_t guid[WIMLIB_GUID_LEN];
1005
1006                 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1007                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is the
1008                  * number of files that have been processed so far.  Once the
1009                  * corresponding phase of extraction is complete, this value
1010                  * will be equal to @c end_file_count.  */
1011                 uint64_t current_file_count;
1012
1013                 /** For ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
1014                  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, this is
1015                  * total number of files that will be processed.
1016                  *
1017                  * This number is provided for informational purposes only.
1018                  * This number will not necessarily be equal to the number of
1019                  * files actually being extracted.  This is because extraction
1020                  * backends are free to implement an extraction algorithm that
1021                  * might be more efficient than processing every file in the
1022                  * "extract file structure" and "extract metadata" phases.  For
1023                  * example, the current implementation of the UNIX extraction
1024                  * backend will create files on-demand during the stream
1025                  * extraction phase. Therefore, when using that particular
1026                  * extraction backend, @p end_file_count will only include
1027                  * directories and empty files.  */
1028                 uint64_t end_file_count;
1029         } extract;
1030
1031         /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
1032         struct wimlib_progress_info_rename {
1033                 /** Name of the temporary file that the WIM was written to. */
1034                 const wimlib_tchar *from;
1035
1036                 /** Name of the original WIM file to which the temporary file is
1037                  * being renamed. */
1038                 const wimlib_tchar *to;
1039         } rename;
1040
1041         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1042          * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
1043         struct wimlib_progress_info_update {
1044                 /** Pointer to the update command that will be executed or has
1045                  * just been executed. */
1046                 const struct wimlib_update_command *command;
1047
1048                 /** Number of update commands that have been completed so far.
1049                  */
1050                 size_t completed_commands;
1051
1052                 /** Number of update commands that are being executed as part of
1053                  * this call to wimlib_update_image(). */
1054                 size_t total_commands;
1055         } update;
1056
1057         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
1058          * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
1059         struct wimlib_progress_info_integrity {
1060                 /** Number of bytes from the end of the WIM header to the end of
1061                  * the lookup table (the area that is covered by the SHA1
1062                  * integrity checks.) */
1063                 uint64_t total_bytes;
1064
1065                 /** Number of bytes that have been SHA1-summed so far.  Will be
1066                  * 0 initially, and equal @p total_bytes at the end. */
1067                 uint64_t completed_bytes;
1068
1069                 /** Number of chunks that the checksummed region is divided
1070                  * into. */
1071                 uint32_t total_chunks;
1072
1073                 /** Number of chunks that have been SHA1-summed so far.   Will
1074                  * be 0 initially, and equal to @p total_chunks at the end. */
1075                 uint32_t completed_chunks;
1076
1077                 /** Size of the chunks used for the integrity calculation. */
1078                 uint32_t chunk_size;
1079
1080                 /** Filename of the WIM (only valid if the message is
1081                  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
1082                 const wimlib_tchar *filename;
1083         } integrity;
1084
1085         /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
1086          * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
1087         struct wimlib_progress_info_split {
1088                 /** Total size of the original WIM's file and metadata resources
1089                  * (compressed). */
1090                 uint64_t total_bytes;
1091
1092                 /** Number of bytes of file and metadata resources that have
1093                  * been copied out of the original WIM so far.  Will be 0
1094                  * initially, and equal to @p total_bytes at the end. */
1095                 uint64_t completed_bytes;
1096
1097                 /** Number of the split WIM part that is about to be started
1098                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1099                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
1100                 unsigned cur_part_number;
1101
1102                 /** Total number of split WIM parts that are being written.  */
1103                 unsigned total_parts;
1104
1105                 /** Name of the split WIM part that is about to be started
1106                  * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
1107                  * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
1108                  * As of wimlib v1.7.0, the library user may change this when
1109                  * receiving ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART in order to
1110                  * cause the next split WIM part to be written to a different
1111                  * location.  */
1112                 wimlib_tchar *part_name;
1113         } split;
1114
1115         /** Valid on messages ::WIMLIB_PROGRESS_MSG_REPLACE_FILE_IN_WIM  */
1116         struct wimlib_progress_info_replace {
1117                 /** Path to the file in the WIM image that is being replaced  */
1118                 const wimlib_tchar *path_in_wim;
1119         } replace;
1120
1121         /** Valid on messages ::WIMLIB_PROGRESS_MSG_WIMBOOT_EXCLUDE  */
1122         struct wimlib_progress_info_wimboot_exclude {
1123                 /** Path to the file in the WIM image  */
1124                 const wimlib_tchar *path_in_wim;
1125
1126                 /** Path to which the file is being extracted  */
1127                 const wimlib_tchar *extraction_path;
1128         } wimboot_exclude;
1129
1130         /** Valid on messages ::WIMLIB_PROGRESS_MSG_UNMOUNT_BEGIN.  */
1131         struct wimlib_progress_info_unmount {
1132                 /** Path to directory being unmounted  */
1133                 const wimlib_tchar *mountpoint;
1134
1135                 /** Path to WIM file being unmounted  */
1136                 const wimlib_tchar *mounted_wim;
1137
1138                 /** 1-based index of image being unmounted.  */
1139                 uint32_t mounted_image;
1140
1141                 /** Flags that were passed to wimlib_mount_image() when the
1142                  * mountpoint was set up.  */
1143                 uint32_t mount_flags;
1144
1145                 /** Flags passed to wimlib_unmount_image().  */
1146                 uint32_t unmount_flags;
1147         } unmount;
1148
1149         /** Valid on messages ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE.  */
1150         struct wimlib_progress_info_done_with_file {
1151                 /* Path to the file whose data has been written to the WIM file,
1152                  * or is currently being asynchronously compressed in memory,
1153                  * and therefore is no longer needed by wimlib.
1154                  *
1155                  * WARNING: The file data will not actually be accessible in the
1156                  * WIM file until the WIM file has been completely written.
1157                  * Ordinarily you should <b>not</b> treat this message as a
1158                  * green light to go ahead and delete the specified file, since
1159                  * that would result in data loss if the WIM file cannot be
1160                  * successfully created for any reason.
1161                  *
1162                  * If a file has multiple names (hard links),
1163                  * ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE will only be received
1164                  * for one name.  Also, this message will not be received for
1165                  * empty files or reparse points (or symbolic links), unless
1166                  * they have nonempty named data streams.
1167                  */
1168                 const wimlib_tchar *path_to_file;
1169         } done_with_file;
1170
1171         /** Valid on messages ::WIMLIB_PROGRESS_MSG_BEGIN_VERIFY_IMAGE and
1172          * ::WIMLIB_PROGRESS_MSG_END_VERIFY_IMAGE.  */
1173         struct wimlib_progress_info_verify_image {
1174                 const wimlib_tchar *wimfile;
1175                 uint32_t total_images;
1176                 uint32_t current_image;
1177         } verify_image;
1178
1179         /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_STREAMS.  */
1180         struct wimlib_progress_info_verify_streams {
1181                 const wimlib_tchar *wimfile;
1182                 uint64_t total_streams;
1183                 uint64_t total_bytes;
1184                 uint64_t completed_streams;
1185                 uint64_t completed_bytes;
1186         } verify_streams;
1187
1188         /** Valid on messages ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION.  */
1189         struct wimlib_progress_info_test_file_exclusion {
1190
1191                 /**
1192                  * Path to the file for which exclusion is being tested.
1193                  *
1194                  * UNIX capture mode:  The path will be a standard relative or
1195                  * absolute UNIX filesystem path.
1196                  *
1197                  * NTFS-3g capture mode:  The path will be given relative to the
1198                  * root of the NTFS volume, with a leading slash.
1199                  *
1200                  * Windows capture mode:  The path will be a Win32 namespace
1201                  * path to the file.
1202                  */
1203                 const wimlib_tchar *path;
1204
1205                 /**
1206                  * Indicates whether the file or directory will be excluded from
1207                  * capture or not.  This will be <tt>false</tt> by default.  The
1208                  * progress function can set this to <tt>true</tt> if it decides
1209                  * that the file needs to be excluded.
1210                  */
1211                 bool will_exclude;
1212         } test_file_exclusion;
1213 };
1214
1215 /**
1216  * A user-supplied function that will be called periodically during certain WIM
1217  * operations.
1218  *
1219  * The first argument will be the type of operation that is being performed or
1220  * is about to be started or has been completed.
1221  *
1222  * The second argument will be a pointer to one of a number of structures
1223  * depending on the first argument.  It may be @c NULL for some message types.
1224  * Note that although this argument is not @c const, users should not modify it
1225  * except in explicitly documented cases.
1226  *
1227  * The third argument will be a user-supplied value that was provided when
1228  * registering or specifying the progress function.
1229  *
1230  * This function must return one of the ::wimlib_progress_status values.  By
1231  * default, you should return ::WIMLIB_PROGRESS_STATUS_CONTINUE (0).
1232  */
1233 typedef enum wimlib_progress_status
1234         (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
1235                                   union wimlib_progress_info *info,
1236                                   void *progctx);
1237
1238 /** @} */
1239 /** @addtogroup G_modifying_wims
1240  * @{ */
1241
1242 /** An array of these structures is passed to wimlib_add_image_multisource() to
1243  * specify the sources from which to create a WIM image. */
1244 struct wimlib_capture_source {
1245         /** Absolute or relative path to a file or directory on the external
1246          * filesystem to be included in the WIM image. */
1247         wimlib_tchar *fs_source_path;
1248
1249         /** Destination path in the WIM image.  Use ::WIMLIB_WIM_ROOT_PATH to
1250          * specify the root directory of the WIM image.  */
1251         wimlib_tchar *wim_target_path;
1252
1253         /** Reserved; set to 0. */
1254         long reserved;
1255 };
1256
1257 /** Set or unset the WIM header flag that marks it read-only
1258  * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
1259  * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter.  This
1260  * is distinct from basic file permissions; this flag can be set on a WIM file
1261  * that is physically writable.  If this flag is set, all further operations to
1262  * modify the WIM will fail, except calling wimlib_overwrite() with
1263  * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
1264  * allows you to set this flag persistently on the underlying WIM file.
1265  */
1266 #define WIMLIB_CHANGE_READONLY_FLAG             0x00000001
1267
1268 /** Set the GUID (globally unique identifier) of the WIM file to the value
1269  * specified in ::wimlib_wim_info.guid of the @p info parameter. */
1270 #define WIMLIB_CHANGE_GUID                      0x00000002
1271
1272 /** Change the bootable image of the WIM to the value specified in
1273  * ::wimlib_wim_info.boot_index of the @p info parameter.  */
1274 #define WIMLIB_CHANGE_BOOT_INDEX                0x00000004
1275
1276 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
1277  * in ::wimlib_wim_info.has_rpfix of the @p info parameter.  This flag generally
1278  * indicates whether an image in the WIM has been captured with reparse-point
1279  * fixups enabled.  wimlib also treats this flag as specifying whether to do
1280  * reparse-point fixups by default when capturing or applying WIM images.  */
1281 #define WIMLIB_CHANGE_RPFIX_FLAG                0x00000008
1282
1283 /** @} */
1284
1285 /** @addtogroup G_wim_information  */
1286
1287 /** @{ */
1288
1289 /** General information about a WIM file. */
1290 struct wimlib_wim_info {
1291
1292         /** Globally unique identifier for the WIM file.  Note: all parts of a
1293          * split WIM should have an identical value in this field.  */
1294         uint8_t  guid[WIMLIB_GUID_LEN];
1295
1296         /** Number of images in the WIM.  */
1297         uint32_t image_count;
1298
1299         /** 1-based index of the bootable image in the WIM, or 0 if no image is
1300          * bootable.  */
1301         uint32_t boot_index;
1302
1303         /** Version of the WIM file.  */
1304         uint32_t wim_version;
1305
1306         /** Chunk size used for compression.  */
1307         uint32_t chunk_size;
1308
1309         /** For split WIMs, the 1-based index of this part within the split WIM;
1310          * otherwise 1.  */
1311         uint16_t part_number;
1312
1313         /** For split WIMs, the total number of parts in the split WIM;
1314          * otherwise 1.  */
1315         uint16_t total_parts;
1316
1317         /** One of the ::wimlib_compression_type values that specifies the
1318          * method used to compress resources in the WIM.  */
1319         int32_t  compression_type;
1320
1321         /** Size of the WIM file in bytes, excluding the XML data and integrity
1322          * table.  */
1323         uint64_t total_bytes;
1324
1325         /** 1 if the WIM has an integrity table.  Note: if the ::WIMStruct was
1326          * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
1327          * this will always be 0, even if the ::WIMStruct was written to
1328          * somewhere by calling wimlib_write() with the
1329          * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
1330         uint32_t has_integrity_table : 1;
1331
1332         /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
1333          * wimlib_create_new_wim(). */
1334         uint32_t opened_from_file : 1;
1335
1336         /** 1 if the WIM is considered readonly for any reason. */
1337         uint32_t is_readonly : 1;
1338
1339         /** 1 if reparse-point fixups are enabled for one or more images in the
1340          * WIM.  */
1341         uint32_t has_rpfix : 1;
1342
1343         /** 1 if the WIM is marked read-only.  */
1344         uint32_t is_marked_readonly : 1;
1345
1346         /** 1 if the WIM is part of a spanned set.  */
1347         uint32_t spanned : 1;
1348
1349         uint32_t write_in_progress : 1;
1350         uint32_t metadata_only : 1;
1351         uint32_t resource_only : 1;
1352
1353         /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE).  */
1354         uint32_t pipable : 1;
1355         uint32_t reserved_flags : 22;
1356         uint32_t reserved[9];
1357 };
1358
1359 /** Information about a unique stream in the WIM file.  (A stream is the same
1360  * thing as a "resource", except in the case of packed resources.)  */
1361 struct wimlib_resource_entry {
1362         /** Uncompressed size of the stream in bytes. */
1363         uint64_t uncompressed_size;
1364
1365         /** Compressed size of the stream in bytes.  This will be the same as @p
1366          * uncompressed_size if the stream is uncompressed.  Or, if @p packed is
1367          * 1, this will be 0.  */
1368         uint64_t compressed_size;
1369
1370         /** Offset, in bytes, of this stream from the start of the WIM file.  Or
1371          * if @p packed is 1, then this is actually the offset at which this
1372          * stream begins in the uncompressed contents of the packed resource.
1373          */
1374         uint64_t offset;
1375
1376         /** SHA1 message digest of the stream's uncompressed contents.  */
1377         uint8_t sha1_hash[20];
1378
1379         /** Which part of WIM this stream is in.  */
1380         uint32_t part_number;
1381
1382         /** Number of times this stream is referenced over all WIM images.  */
1383         uint32_t reference_count;
1384
1385         /** 1 if this stream is compressed.  */
1386         uint32_t is_compressed : 1;
1387
1388         /** 1 if this stream is a metadata resource rather than a file resource.
1389          * */
1390         uint32_t is_metadata : 1;
1391
1392         uint32_t is_free : 1;
1393         uint32_t is_spanned : 1;
1394
1395         /** 1 if this stream was not found in the lookup table of the
1396          * ::WIMStruct.  This normally implies a missing call to
1397          * wimlib_reference_resource_files() or wimlib_reference_resources().
1398          * */
1399         uint32_t is_missing : 1;
1400
1401         /** 1 if this stream is located in a packed resource which may contain
1402          * other streams (all compressed together) as well.  */
1403         uint32_t packed : 1;
1404
1405         uint32_t reserved_flags : 26;
1406
1407         /** If @p packed is 1, then this will specify the offset of the packed
1408          * resource in the WIM.  */
1409         uint64_t raw_resource_offset_in_wim;
1410
1411         /** If @p packed is 1, then this will specify the compressed size of the
1412          * packed resource in the WIM.  */
1413         uint64_t raw_resource_compressed_size;
1414
1415         uint64_t reserved[2];
1416 };
1417
1418 /**
1419  * Information about a stream of a particular file in the WIM.
1420  *
1421  * Normally, only WIM images captured from NTFS filesystems will have multiple
1422  * streams per file.  In practice, this is a rarely used feature of the
1423  * filesystem.
1424  */
1425 struct wimlib_stream_entry {
1426         /** Name of the stream, or NULL if the stream is unnamed. */
1427         const wimlib_tchar *stream_name;
1428         /** Location, size, and other information about the stream's data as
1429          * stored in the WIM file.  */
1430         struct wimlib_resource_entry resource;
1431         uint64_t reserved[4];
1432 };
1433
1434 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
1435  * Roughly, the information about a "file" in the WIM--- but really a directory
1436  * entry ("dentry") because hard links are allowed.  The hard_link_group_id
1437  * field can be used to distinguish actual file inodes.  */
1438 struct wimlib_dir_entry {
1439         /** Name of the file, or NULL if this file is unnamed.  Only the root
1440          * directory of an image will be unnamed.  */
1441         const wimlib_tchar *filename;
1442
1443         /** 8.3 name (or "DOS name", or "short name") of this file; or NULL if
1444          * this file has no such name.  */
1445         const wimlib_tchar *dos_name;
1446
1447         /** Full path to this file within the WIM image.  Path separators will
1448          * be ::WIMLIB_WIM_PATH_SEPARATOR.  */
1449         const wimlib_tchar *full_path;
1450
1451         /** Depth of this directory entry, where 0 is the root, 1 is the root's
1452          * children, ..., etc. */
1453         size_t depth;
1454
1455         /** Pointer to the security descriptor for this file, in Windows
1456          * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
1457          * security descriptor.  */
1458         const char *security_descriptor;
1459
1460         /** Length of the above security descriptor.  */
1461         size_t security_descriptor_size;
1462
1463 #define WIMLIB_FILE_ATTRIBUTE_READONLY            0x00000001
1464 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN              0x00000002
1465 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM              0x00000004
1466 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY           0x00000010
1467 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE             0x00000020
1468 #define WIMLIB_FILE_ATTRIBUTE_DEVICE              0x00000040
1469 #define WIMLIB_FILE_ATTRIBUTE_NORMAL              0x00000080
1470 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY           0x00000100
1471 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
1472 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
1473 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED          0x00000800
1474 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE             0x00001000
1475 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1476 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED           0x00004000
1477 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL             0x00010000
1478         /** File attributes, such as whether the file is a directory or not.
1479          * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
1480          * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
1481          * on other platforms.  */
1482         uint32_t attributes;
1483
1484 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO        0x00000000
1485 #define WIMLIB_REPARSE_TAG_RESERVED_ONE         0x00000001
1486 #define WIMLIB_REPARSE_TAG_MOUNT_POINT          0xA0000003
1487 #define WIMLIB_REPARSE_TAG_HSM                  0xC0000004
1488 #define WIMLIB_REPARSE_TAG_HSM2                 0x80000006
1489 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER      0x80000005
1490 #define WIMLIB_REPARSE_TAG_SIS                  0x80000007
1491 #define WIMLIB_REPARSE_TAG_DFS                  0x8000000A
1492 #define WIMLIB_REPARSE_TAG_DFSR                 0x80000012
1493 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER       0x8000000B
1494 #define WIMLIB_REPARSE_TAG_WOF                  0x80000017
1495 #define WIMLIB_REPARSE_TAG_SYMLINK              0xA000000C
1496         /** If the file is a reparse point (FILE_ATTRIBUTE_REPARSE_POINT set in
1497          * the attributes), this will give the reparse tag.  This tells you
1498          * whether the reparse point is a symbolic link, junction point, or some
1499          * other, more unusual kind of reparse point.  */
1500         uint32_t reparse_tag;
1501
1502         /** Number of links to this file's inode (hard links).
1503          *
1504          * Currently, this will always be 1 for directories.  However, it can be
1505          * greater than 1 for nondirectory files.  */
1506         uint32_t num_links;
1507
1508         /** Number of named data streams this file has.  Normally 0.  */
1509         uint32_t num_named_streams;
1510
1511         /** A unique identifier for this file's inode.  However, as a special
1512          * case, if the inode only has a single link (@p num_links == 1), this
1513          * value may be 0.
1514          *
1515          * Note: if a WIM image is captured from a filesystem, this value is not
1516          * guaranteed to be the same as the original number of the inode on the
1517          * filesystem.  */
1518         uint64_t hard_link_group_id;
1519
1520         /** Time this file was created.  */
1521         struct timespec creation_time;
1522
1523         /** Time this file was last written to.  */
1524         struct timespec last_write_time;
1525
1526         /** Time this file was last accessed.  */
1527         struct timespec last_access_time;
1528
1529         /** The UNIX user ID of this file.  This is a wimlib extension.
1530          *
1531          * This field is only valid if @p unix_mode != 0.  */
1532         uint32_t unix_uid;
1533
1534         /** The UNIX group ID of this file.  This is a wimlib extension.
1535          *
1536          * This field is only valid if @p unix_mode != 0.  */
1537         uint32_t unix_gid;
1538
1539         /** The UNIX mode of this file.  This is a wimlib extension.
1540          *
1541          * If this field is 0, then @p unix_uid, @p unix_gid, @p unix_mode, and
1542          * @p unix_rdev are all unknown (fields are not present in the WIM
1543          * image).  */
1544         uint32_t unix_mode;
1545
1546         /** The UNIX device ID (major and minor number) of this file.  This is a
1547          * wimlib extension.
1548          *
1549          * This field is only valid if @p unix_mode != 0.  */
1550         uint32_t unix_rdev;
1551
1552         uint64_t reserved[14];
1553
1554         /**
1555          * Array of streams that make up this file.
1556          *
1557          * The first entry will always exist and will correspond to the unnamed
1558          * data stream (default file contents), so it will have <c>stream_name
1559          * == NULL</c>.  Alternatively, for reparse point files, the first entry
1560          * will corresponding to the reparse data stream.
1561          *
1562          * Then, following the first entry, there be @p num_named_streams
1563          * additional entries that specify the named data streams, if any, each
1564          * of which will have <c>stream_name != NULL</c>.
1565          */
1566         struct wimlib_stream_entry streams[];
1567 };
1568
1569 /**
1570  * Type of a callback function to wimlib_iterate_dir_tree().  Must return 0 on
1571  * success.
1572  */
1573 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
1574                                                   void *user_ctx);
1575
1576 /**
1577  * Type of a callback function to wimlib_iterate_lookup_table().  Must return 0
1578  * on success.
1579  */
1580 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
1581                                                       void *user_ctx);
1582
1583 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
1584  * just on the specified path. */
1585 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
1586
1587 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
1588  * itself; only its children (in the case of a non-empty directory) */
1589 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN  0x00000002
1590
1591 /** Return ::WIMLIB_ERR_RESOURCE_NOT_FOUND if any resources needed to fill in
1592  * the ::wimlib_resource_entry's for the iteration cannot be found in the lookup
1593  * table of the ::WIMStruct.  The default behavior without this flag is to fill
1594  * in the SHA1 message digest of the ::wimlib_resource_entry and set the @ref
1595  * wimlib_resource_entry::is_missing "is_missing" flag.  */
1596 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED  0x00000004
1597
1598
1599 /** @} */
1600 /** @addtogroup G_modifying_wims
1601  * @{ */
1602
1603 /** UNIX-like systems only: Directly capture an NTFS volume rather than a
1604  * generic directory.  This requires that wimlib was compiled with support for
1605  * libntfs-3g.
1606  *
1607  * This flag cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
1608  * ::WIMLIB_ADD_FLAG_UNIX_DATA.
1609  *
1610  * Do not use this flag on Windows, where wimlib already supports all
1611  * Windows-native filesystems, including NTFS, through the Windows APIs.  */
1612 #define WIMLIB_ADD_FLAG_NTFS                    0x00000001
1613
1614 /** Follow symbolic links when scanning the directory tree.  Currently only
1615  * supported on UNIX-like systems.  */
1616 #define WIMLIB_ADD_FLAG_DEREFERENCE             0x00000002
1617
1618 /** Call the progress function with the message
1619  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file has been
1620  * scanned.  */
1621 #define WIMLIB_ADD_FLAG_VERBOSE                 0x00000004
1622
1623 /** Mark the image being added as the bootable image of the WIM.  This flag is
1624  * valid only for wimlib_add_image() and wimlib_add_image_multisource().
1625  *
1626  * Note that you can also change the bootable image of a WIM using
1627  * wimlib_set_wim_info().
1628  *
1629  * Note: ::WIMLIB_ADD_FLAG_BOOT does something different from, and independent
1630  * from, ::WIMLIB_ADD_FLAG_WIMBOOT.  */
1631 #define WIMLIB_ADD_FLAG_BOOT                    0x00000008
1632
1633 /** UNIX-like systems only: Store the UNIX owner, group, mode, and device ID
1634  * (major and minor number) of each file.  Also allows capturing special files
1635  * such as device nodes and FIFOs.  See the documentation for the
1636  * <b>--unix-data</b> option to <b>wimlib-imagex capture</b> for more
1637  * information.  */
1638 #define WIMLIB_ADD_FLAG_UNIX_DATA               0x00000010
1639
1640 /** Do not capture security descriptors.  Only has an effect in NTFS capture
1641  * mode, or in Windows native builds.  */
1642 #define WIMLIB_ADD_FLAG_NO_ACLS                 0x00000020
1643
1644 /** Fail immediately if the full security descriptor of any file or directory
1645  * cannot be accessed.  Only has an effect in Windows native builds.  The
1646  * default behavior without this flag is to first try omitting the SACL from the
1647  * security descriptor, then to try omitting the security descriptor entirely.
1648  */
1649 #define WIMLIB_ADD_FLAG_STRICT_ACLS             0x00000040
1650
1651 /** Call the progress function with the message
1652  * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
1653  * capture.  This is a subset of the messages provided by
1654  * ::WIMLIB_ADD_FLAG_VERBOSE.  */
1655 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE         0x00000080
1656
1657 /** Reparse-point fixups:  Modify absolute symbolic links (and junctions, in the
1658  * case of Windows) that point inside the directory being captured to instead be
1659  * absolute relative to the directory being captured.
1660  *
1661  * Without this flag, the default is to do reparse-point fixups if
1662  * WIM_HDR_FLAG_RP_FIX is set in the WIM header or if this is the first image
1663  * being added.  WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is
1664  * captured with reparse point fixups enabled and currently cannot be unset. */
1665 #define WIMLIB_ADD_FLAG_RPFIX                   0x00000100
1666
1667 /** Don't do reparse point fixups.  See ::WIMLIB_ADD_FLAG_RPFIX.  */
1668 #define WIMLIB_ADD_FLAG_NORPFIX                 0x00000200
1669
1670 /** Do not automatically exclude unsupported files or directories from capture;
1671  * e.g. encrypted files in NTFS-3g capture mode, or device files and FIFOs on
1672  * UNIX-like systems when not also using ::WIMLIB_ADD_FLAG_UNIX_DATA.  Instead,
1673  * fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file is encountered.  */
1674 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE  0x00000400
1675
1676 /**
1677  * Automatically select a capture configuration appropriate for capturing
1678  * filesystems containing Windows operating systems.  For example,
1679  * "/pagefile.sys" and "System Volume Information" will be excluded.
1680  *
1681  * When this flag is specified, the corresponding @p config parameter (for
1682  * wimlib_add_image()) or member (for wimlib_update_image()) must be @c NULL.
1683  * Otherwise, ::WIMLIB_ERR_INVALID_PARAM will be returned.
1684  *
1685  * Note that the default behavior--- that is, when neither
1686  * ::WIMLIB_ADD_FLAG_WINCONFIG nor ::WIMLIB_ADD_FLAG_WIMBOOT is specified and @p
1687  * config is @c NULL--- is to use no capture configuration, meaning that no
1688  * files are excluded from capture.
1689  */
1690 #define WIMLIB_ADD_FLAG_WINCONFIG               0x00000800
1691
1692 /**
1693  * Capture image as WIMBoot compatible.  In addition, if no capture
1694  * configuration file is explicitly specified use the capture configuration file
1695  * <c>$SOURCE/Windows/System32/WimBootCompress.ini</c> if it exists, where
1696  * <c>$SOURCE</c> is the directory being captured; or, if a capture
1697  * configuration file is explicitly specified, use it and also place it at
1698  * /Windows/System32/WimBootCompress.ini in the WIM image.
1699  *
1700  * Note: this will not by itself change the compression type.  Before writing
1701  * the WIM file, it's recommended to also do:
1702  *
1703  * \code
1704  *      wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1705  *      wimlib_set_output_chunk_size(wim, 4096);
1706  * \endcode
1707  *
1708  * since that makes access to the data faster (at the cost of a worse
1709  * compression ratio compared to the 32768-byte LZX chunks usually used).
1710  *
1711  * Note: ::WIMLIB_ADD_FLAG_WIMBOOT does something different from, and
1712  * independent from, ::WIMLIB_ADD_FLAG_BOOT.
1713  */
1714 #define WIMLIB_ADD_FLAG_WIMBOOT                 0x00001000
1715
1716 /**
1717  * If the add command involves adding a non-directory file to a location at
1718  * which there already exists a nondirectory file in the WIM image, issue
1719  * ::WIMLIB_ERR_INVALID_OVERLAY instead of replacing the file.  This only has an
1720  * effect when updating an existing image with wimlib_update_image().
1721  * This was the default behavior in wimlib v1.6.2 and earlier.
1722  */
1723 #define WIMLIB_ADD_FLAG_NO_REPLACE              0x00002000
1724
1725 /**
1726  * Send ::WIMLIB_PROGRESS_MSG_TEST_FILE_EXCLUSION messages to the progress
1727  * function.
1728  *
1729  * Note: This method for file exclusions is independent from the capture
1730  * configuration file mechanism.
1731  */
1732 #define WIMLIB_ADD_FLAG_TEST_FILE_EXCLUSION 0x00004000
1733
1734 #define WIMLIB_ADD_IMAGE_FLAG_NTFS              WIMLIB_ADD_FLAG_NTFS
1735 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       WIMLIB_ADD_FLAG_DEREFERENCE
1736 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           WIMLIB_ADD_FLAG_VERBOSE
1737 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              WIMLIB_ADD_FLAG_BOOT
1738 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA         WIMLIB_ADD_FLAG_UNIX_DATA
1739 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS           WIMLIB_ADD_FLAG_NO_ACLS
1740 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS       WIMLIB_ADD_FLAG_STRICT_ACLS
1741 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE   WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
1742 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX             WIMLIB_ADD_FLAG_RPFIX
1743 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX           WIMLIB_ADD_FLAG_NORPFIX
1744 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
1745                                                 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
1746 #define WIMLIB_ADD_IMAGE_FLAG_WINCONFIG         WIMLIB_ADD_FLAG_WINCONFIG
1747 #define WIMLIB_ADD_IMAGE_FLAG_WIMBOOT           WIMLIB_ADD_FLAG_WIMBOOT
1748
1749
1750 /** @} */
1751 /** @addtogroup G_modifying_wims
1752  * @{ */
1753
1754 /** Do not issue an error if the path to delete does not exist. */
1755 #define WIMLIB_DELETE_FLAG_FORCE                        0x00000001
1756
1757 /** Delete the file or directory tree recursively; if not specified, an error is
1758  * issued if the path to delete is a directory. */
1759 #define WIMLIB_DELETE_FLAG_RECURSIVE                    0x00000002
1760
1761 /** @} */
1762 /** @addtogroup G_modifying_wims
1763  * @{ */
1764
1765 /**
1766  * If a single image is being exported, mark it bootable in the destination WIM.
1767  * Alternatively, if ::WIMLIB_ALL_IMAGES is specified as the image to export,
1768  * the image in the source WIM (if any) that is marked as bootable is also
1769  * marked as bootable in the destination WIM.
1770  */
1771 #define WIMLIB_EXPORT_FLAG_BOOT                         0x00000001
1772
1773 /** Give the exported image(s) no names.  Avoids problems with image name
1774  * collisions.
1775  */
1776 #define WIMLIB_EXPORT_FLAG_NO_NAMES                     0x00000002
1777
1778 /** Give the exported image(s) no descriptions.  */
1779 #define WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS              0x00000004
1780
1781 /** This advises the library that the program is finished with the source
1782  * WIMStruct and will not attempt to access it after the call to
1783  * wimlib_export_image(), with the exception of the call to wimlib_free().  */
1784 #define WIMLIB_EXPORT_FLAG_GIFT                         0x00000008
1785
1786 /**
1787  * Mark each exported image as WIMBoot-compatible.
1788  *
1789  * Note: by itself, this does change the destination WIM's compression type, nor
1790  * does it add the file @c \\Windows\\System32\\WimBootCompress.ini in the WIM
1791  * image.  Before writing the destination WIM, it's recommended to do something
1792  * like:
1793  *
1794  * \code
1795  *      wimlib_set_output_compression_type(wim, WIMLIB_COMPRESSION_TYPE_XPRESS);
1796  *      wimlib_set_output_chunk_size(wim, 4096);
1797  *      wimlib_add_tree(wim, image, L"myconfig.ini",
1798  *                      L"\\Windows\\System32\\WimBootCompress.ini", 0);
1799  * \endcode
1800  */
1801 #define WIMLIB_EXPORT_FLAG_WIMBOOT                      0x00000010
1802
1803 /** @} */
1804 /** @addtogroup G_extracting_wims
1805  * @{ */
1806
1807 /** Extract the image directly to an NTFS volume rather than a generic directory.
1808  * This mode is only available if wimlib was compiled with libntfs-3g support;
1809  * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned.  In this mode, the
1810  * extraction target will be interpreted as the path to an NTFS volume image (as
1811  * a regular file or block device) rather than a directory.  It will be opened
1812  * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1813  * root directory.  Note: this flag cannot be used when wimlib_extract_image()
1814  * is called with ::WIMLIB_ALL_IMAGES as the @p image, nor can it be used with
1815  * wimlib_extract_paths() when passed multiple paths.  */
1816 #define WIMLIB_EXTRACT_FLAG_NTFS                        0x00000001
1817
1818 /** UNIX-like systems only:  Extract special UNIX data captured with
1819  * ::WIMLIB_ADD_FLAG_UNIX_DATA.  This flag cannot be combined with
1820  * ::WIMLIB_EXTRACT_FLAG_NTFS.  */
1821 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA                   0x00000020
1822
1823 /** Do not extract security descriptors.  This flag cannot be combined with
1824  * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS.  */
1825 #define WIMLIB_EXTRACT_FLAG_NO_ACLS                     0x00000040
1826
1827 /** Fail immediately if the full security descriptor of any file or directory
1828  * cannot be set exactly as specified in the WIM file.  On Windows, the default
1829  * behavior without this flag when wimlib does not have permission to set the
1830  * correct security descriptor is to fall back to setting the security
1831  * descriptor with the SACL omitted, then with the DACL omitted, then with the
1832  * owner omitted, then not at all.  This flag cannot be combined with
1833  * ::WIMLIB_EXTRACT_FLAG_NO_ACLS.  */
1834 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS                 0x00000080
1835
1836 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX.  This forces
1837  * reparse-point fixups on, so absolute symbolic links or junction points will
1838  * be fixed to be absolute relative to the actual extraction root.  Reparse-
1839  * point fixups are done by default for wimlib_extract_image() and
1840  * wimlib_extract_image_from_pipe() if WIM_HDR_FLAG_RP_FIX is set in the WIM
1841  * header.  This flag cannot be combined with ::WIMLIB_EXTRACT_FLAG_NORPFIX.  */
1842 #define WIMLIB_EXTRACT_FLAG_RPFIX                       0x00000100
1843
1844 /** Force reparse-point fixups on extraction off, regardless of the state of the
1845  * WIM_HDR_FLAG_RP_FIX flag in the WIM header.  This flag cannot be combined
1846  * with ::WIMLIB_EXTRACT_FLAG_RPFIX.  */
1847 #define WIMLIB_EXTRACT_FLAG_NORPFIX                     0x00000200
1848
1849 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Extract the
1850  * paths, each of which must name a regular file, to standard output.  */
1851 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                   0x00000400
1852
1853 /** Instead of ignoring files and directories with names that cannot be
1854  * represented on the current platform (note: Windows has more restrictions on
1855  * filenames than POSIX-compliant systems), try to replace characters or append
1856  * junk to the names so that they can be extracted in some form.
1857  *
1858  * Note: this flag is unlikely to have any effect when extracting a WIM image
1859  * that was captured on Windows.
1860  */
1861 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES   0x00000800
1862
1863 /** On Windows, when there exist two or more files with the same case
1864  * insensitive name but different case sensitive names, try to extract them all
1865  * by appending junk to the end of them, rather than arbitrarily extracting only
1866  * one.
1867  *
1868  * Note: this flag is unlikely to have any effect when extracting a WIM image
1869  * that was captured on Windows.
1870  */
1871 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS          0x00001000
1872
1873 /** Do not ignore failure to set timestamps on extracted files.  This flag
1874  * currently only has an effect when extracting to a directory on UNIX-like
1875  * systems.  */
1876 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS           0x00002000
1877
1878 /** Do not ignore failure to set short names on extracted files.  This flag
1879  * currently only has an effect on Windows.  */
1880 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES          0x00004000
1881
1882 /** Do not ignore failure to extract symbolic links and junctions due to
1883  * permissions problems.  This flag currently only has an effect on Windows.  By
1884  * default, such failures are ignored since the default configuration of Windows
1885  * only allows the Administrator to create symbolic links.  */
1886 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS             0x00008000
1887
1888 /** Reserved for future use.  */
1889 #define WIMLIB_EXTRACT_FLAG_RESUME                      0x00010000
1890
1891 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Treat the
1892  * paths to extract as wildcard patterns ("globs") which may contain the
1893  * wildcard characters @c ? and @c *.  The @c ? character matches any
1894  * non-path-separator character, whereas the @c * character matches zero or more
1895  * non-path-separator characters.  Consequently, each glob may match zero or
1896  * more actual paths in the WIM image.
1897  *
1898  * By default, if a glob does not match any files, a warning but not an error
1899  * will be issued.  This is the case even if the glob did not actually contain
1900  * wildcard characters.  Use ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB to get an error
1901  * instead.
1902  * */
1903 #define WIMLIB_EXTRACT_FLAG_GLOB_PATHS                  0x00040000
1904
1905 /** In combination with ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS, causes an error
1906  * (::WIMLIB_ERR_PATH_DOES_NOT_EXIST) rather than a warning to be issued when
1907  * one of the provided globs did not match a file.  */
1908 #define WIMLIB_EXTRACT_FLAG_STRICT_GLOB                 0x00080000
1909
1910 /** Do not extract Windows file attributes such as readonly, hidden, etc.
1911  *
1912  * This flag has an effect on Windows as well as in the NTFS-3g extraction mode.
1913  */
1914 #define WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES               0x00100000
1915
1916 /** For wimlib_extract_paths() and wimlib_extract_pathlist() only:  Do not
1917  * preserve the directory structure of the archive when extracting --- that is,
1918  * place each extracted file or directory tree directly in the target directory.
1919  *
1920  * The target directory will still be created if it does not already exist.  */
1921 #define WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE   0x00200000
1922
1923 /** Windows only: Extract files as "pointers" back to the WIM archive.
1924  *
1925  * The effects of this option are fairly complex.  See the documentation for the
1926  * <b>--wimboot</b> option of <b>wimlib-imagex apply</b> for more information.
1927  */
1928 #define WIMLIB_EXTRACT_FLAG_WIMBOOT                     0x00400000
1929
1930 /** @} */
1931 /** @addtogroup G_mounting_wim_images
1932  * @{ */
1933
1934 /** Mount the WIM image read-write rather than the default of read-only. */
1935 #define WIMLIB_MOUNT_FLAG_READWRITE                     0x00000001
1936
1937 /** Enable FUSE debugging by passing the @c -d option to @c fuse_main().  */
1938 #define WIMLIB_MOUNT_FLAG_DEBUG                         0x00000002
1939
1940 /** Do not allow accessing named data streams in the mounted WIM image.  */
1941 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000004
1942
1943 /** Access named data streams in the mounted WIM image through extended file
1944  * attributes named "user.X", where X is the name of a data stream.  This is the
1945  * default mode.  */
1946 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000008
1947
1948 /** Access named data streams in the mounted WIM image by specifying the file
1949  * name, a colon, then the name of the data stream.  */
1950 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000010
1951
1952 /** Use UNIX metadata if available in the WIM image.  See
1953  * ::WIMLIB_ADD_FLAG_UNIX_DATA.  */
1954 #define WIMLIB_MOUNT_FLAG_UNIX_DATA                     0x00000020
1955
1956 /** Allow other users to see the mounted filesystem.  This passes the @c
1957  * allow_other option to fuse_main().  */
1958 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER                   0x00000040
1959
1960 /** @} */
1961 /** @addtogroup G_creating_and_opening_wims
1962  * @{ */
1963
1964 /** Verify the WIM contents against the WIM's integrity table, if present.  This
1965  * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1966  * checksummed and checked against the SHA1 message digests specified in the
1967  * integrity table.  If there are any mismatches, ::WIMLIB_ERR_INTEGRITY is
1968  * issued.  If the WIM file does not contain an integrity table, this flag has
1969  * no effect.  */
1970 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY                0x00000001
1971
1972 /** Issue an error (::WIMLIB_ERR_IS_SPLIT_WIM) if the WIM is part of a split
1973  * WIM.  Software can provide this flag for convenience if it explicitly does
1974  * not want to support split WIMs.  */
1975 #define WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT                 0x00000002
1976
1977 /** Check if the WIM is writable and issue an error
1978  * (::WIMLIB_ERR_WIM_IS_READONLY) if it is not.  A WIM is considered writable
1979  * only if it is writable at the filesystem level, does not have the
1980  * WIM_HDR_FLAG_READONLY flag set in its header, and is not part of a spanned
1981  * set.  It is not required to provide this flag before attempting to make
1982  * changes to the WIM, but with this flag you get an error sooner rather than
1983  * later.  */
1984 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS                   0x00000004
1985
1986 /** @} */
1987 /** @addtogroup G_mounting_wim_images
1988  * @{ */
1989
1990 /** Provide ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY when committing the WIM image.
1991  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
1992 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY             0x00000001
1993
1994 /** Commit changes to the read-write mounted WIM image.
1995  * If this flag is not specified, changes will be discarded.  */
1996 #define WIMLIB_UNMOUNT_FLAG_COMMIT                      0x00000002
1997
1998 /** Provide ::WIMLIB_WRITE_FLAG_REBUILD when committing the WIM image.
1999  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
2000 #define WIMLIB_UNMOUNT_FLAG_REBUILD                     0x00000004
2001
2002 /** Provide ::WIMLIB_WRITE_FLAG_RECOMPRESS when committing the WIM image.
2003  * Ignored if ::WIMLIB_UNMOUNT_FLAG_COMMIT not also specified.  */
2004 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS                  0x00000008
2005
2006 /**
2007  * In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted WIM
2008  * image, forces all file descriptors to the open WIM image to be closed before
2009  * committing it.
2010  *
2011  * Without ::WIMLIB_UNMOUNT_FLAG_COMMIT or with a read-only mounted WIM image,
2012  * this flag has no effect.
2013  */
2014 #define WIMLIB_UNMOUNT_FLAG_FORCE                       0x00000010
2015
2016 /** In combination with ::WIMLIB_UNMOUNT_FLAG_COMMIT for a read-write mounted
2017  * WIM image, causes the modified image to be committed to the WIM file as a
2018  * new, unnamed image appended to the archive.  The original image in the WIM
2019  * file will be unmodified.  */
2020 #define WIMLIB_UNMOUNT_FLAG_NEW_IMAGE                   0x00000020
2021
2022 /** @} */
2023 /** @addtogroup G_modifying_wims
2024  * @{ */
2025
2026 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
2027  * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages.  */
2028 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS                0x00000001
2029
2030 /** @} */
2031 /** @addtogroup G_writing_and_overwriting_wims
2032  * @{ */
2033
2034 /**
2035  * Include an integrity table in the resulting WIM file.
2036  *
2037  * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2038  * include an integrity table if and only if one was present before.  For
2039  * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2040  * to not include an integrity table.
2041  */
2042 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY               0x00000001
2043
2044 /**
2045  * Do not include an integrity table in the resulting WIM file.  This is the
2046  * default behavior, unless the ::WIMStruct was created by opening a WIM with an
2047  * integrity table.
2048  */
2049 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY            0x00000002
2050
2051 /**
2052  * Write the WIM as "pipable".  After writing a WIM with this flag specified,
2053  * images from it can be applied directly from a pipe using
2054  * wimlib_extract_image_from_pipe().  See the documentation for the
2055  * <b>--pipable</b> option of <b>wimlib-imagex capture</b> for more information.
2056  * Beware: WIMs written with this flag will not be compatible with Microsoft's
2057  * software.
2058  *
2059  * For ::WIMStruct's created with wimlib_open_wim(), the default behavior is to
2060  * write the WIM as pipable if and only if it was pipable before.  For
2061  * ::WIMStruct's created with wimlib_create_new_wim(), the default behavior is
2062  * to write the WIM as non-pipable.
2063  */
2064 #define WIMLIB_WRITE_FLAG_PIPABLE                       0x00000004
2065
2066 /**
2067  * Do not write the WIM as "pipable".  This is the default behavior, unless the
2068  * ::WIMStruct was created by opening a pipable WIM.
2069  */
2070 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE                   0x00000008
2071
2072 /**
2073  * When writing streams to the WIM file, recompress them, even if their data is
2074  * already available in the desired compressed form (for example, in a WIM file
2075  * from which an image has been exported using wimlib_export_image()).
2076  *
2077  * ::WIMLIB_WRITE_FLAG_RECOMPRESS can be used to recompress with a higher
2078  * compression ratio for the same compression type and chunk size.  Simply using
2079  * the default compression settings may suffice for this, especially if the WIM
2080  * file was created using another program/library that may not use as
2081  * sophisticated compression algorithms.  Or,
2082  * wimlib_set_default_compression_level() can be called beforehand to set an
2083  * even higher compression level than the default.
2084  *
2085  * If the WIM contains solid blocks, then ::WIMLIB_WRITE_FLAG_RECOMPRESS can be
2086  * used in combination with ::WIMLIB_WRITE_FLAG_PACK_STREAMS to prevent any
2087  * solid blocks from being re-used.  Otherwise, solid blocks are re-used
2088  * somewhat more liberally than normal compressed blocks.
2089  *
2090  * ::WIMLIB_WRITE_FLAG_RECOMPRESS does <b>not</b> cause recompression of streams
2091  * that would not otherwise be written.  For example, a call to
2092  * wimlib_overwrite() with ::WIMLIB_WRITE_FLAG_RECOMPRESS will not, by itself,
2093  * cause already-existing streams in the WIM file to be recompressed.  To force
2094  * the WIM file to be fully rebuilt and recompressed, combine
2095  * ::WIMLIB_WRITE_FLAG_RECOMPRESS with ::WIMLIB_WRITE_FLAG_REBUILD.
2096  */
2097 #define WIMLIB_WRITE_FLAG_RECOMPRESS                    0x00000010
2098
2099 /**
2100  * Immediately before closing the WIM file, sync its data to disk.
2101  *
2102  * This flag forces the function to wait until the data is safely on disk before
2103  * returning success.  Otherwise, modern operating systems tend to cache data
2104  * for some time (in some cases, 30+ seconds) before actually writing it to
2105  * disk, even after reporting to the application that the writes have succeeded.
2106  *
2107  * wimlib_overwrite() will set this flag automatically if it decides to
2108  * overwrite the WIM file via a temporary file instead of in-place.  This is
2109  * necessary on POSIX systems; it will, for example, avoid problems with delayed
2110  * allocation on ext4.
2111  */
2112 #define WIMLIB_WRITE_FLAG_FSYNC                         0x00000020
2113
2114 /**
2115  * For wimlib_overwrite(), rebuild the entire WIM file, even if it otherwise
2116  * could be updated in-place by appending to it.
2117  *
2118  * When rebuilding the WIM file, stream reference counts will be recomputed, and
2119  * any streams with 0 reference count (e.g. from deleted files or images) will
2120  * not be included in the resulting WIM file.  This can free up space that is
2121  * currently not being used.
2122  *
2123  * This flag can be combined with ::WIMLIB_WRITE_FLAG_RECOMPRESS to force all
2124  * data to be recompressed.  Otherwise, compressed data is re-used if possible.
2125  *
2126  * wimlib_write() ignores this flag.
2127  */
2128 #define WIMLIB_WRITE_FLAG_REBUILD                       0x00000040
2129
2130 /**
2131  * For wimlib_overwrite(), override the default behavior after one or more calls
2132  * to wimlib_delete_image(), which is to rebuild the entire WIM file.  With this
2133  * flag, only minimal changes to correctly remove the image from the WIM file
2134  * will be taken.  In particular, all streams will be retained, even if they are
2135  * no longer referenced.  This may not be what you want, because no space will
2136  * be saved by deleting an image in this way.
2137  *
2138  * wimlib_write() ignores this flag.
2139  */
2140 #define WIMLIB_WRITE_FLAG_SOFT_DELETE                   0x00000080
2141
2142 /**
2143  * For wimlib_overwrite(), allow overwriting the WIM file even if the readonly
2144  * flag (WIM_HDR_FLAG_READONLY) is set in the WIM header.  This can be used
2145  * following a call to wimlib_set_wim_info() with the
2146  * ::WIMLIB_CHANGE_READONLY_FLAG flag to actually set the readonly flag on the
2147  * on-disk WIM file.
2148  *
2149  * wimlib_write() ignores this flag.
2150  */
2151 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG          0x00000100
2152
2153 /**
2154  * Do not include streams already present in other WIMs.  This flag can be used
2155  * to write a "delta" WIM after resources from the WIM on which the delta is to
2156  * be based were referenced with wimlib_reference_resource_files() or
2157  * wimlib_reference_resources().
2158  */
2159 #define WIMLIB_WRITE_FLAG_SKIP_EXTERNAL_WIMS            0x00000200
2160
2161 /**
2162  * Advises the library that for writes of all WIM images, all streams needed for
2163  * the WIM are already present (not in external resource WIMs) and their
2164  * reference counts are correct, so the code does not need to recalculate which
2165  * streams are referenced.  This is for optimization purposes only, since with
2166  * this flag specified, the metadata resources may not need to be decompressed
2167  * and parsed.
2168  *
2169  * wimlib_overwrite() will set this flag automatically.
2170  */
2171 #define WIMLIB_WRITE_FLAG_STREAMS_OK                    0x00000400
2172
2173 /**
2174  * For wimlib_write(), retain the WIM's GUID instead of generating a new one.
2175  *
2176  * wimlib_overwrite() sets this by default, since the WIM remains, logically,
2177  * the same file.
2178  */
2179 #define WIMLIB_WRITE_FLAG_RETAIN_GUID                   0x00000800
2180
2181 /**
2182  * When writing streams in the resulting WIM file, pack multiple streams into a
2183  * single compressed resource instead of compressing them independently.  This
2184  * is also known as creating a "solid archive".  This tends to produce a better
2185  * compression ratio at the cost of much slower random access.
2186  *
2187  * WIM files created with this flag are only compatible with wimlib v1.6.0 or
2188  * later, WIMGAPI Windows 8 or later, and DISM Windows 8.1 or later.  WIM files
2189  * created with this flag use a different version number in their header (3584
2190  * instead of 68864) and are also called "ESD files".
2191  *
2192  * If this flag is passed to wimlib_overwrite(), any new data streams will be
2193  * written in solid mode.  Use both ::WIMLIB_WRITE_FLAG_REBUILD and
2194  * ::WIMLIB_WRITE_FLAG_RECOMPRESS to force the entire WIM file be rebuilt with
2195  * all streams recompressed in solid mode.
2196  *
2197  * Currently, new solid blocks will, by default, be written using LZMS
2198  * compression with 32 MiB (33554432 byte) chunks.  Use
2199  * wimlib_set_output_pack_compression_type() and/or
2200  * wimlib_set_output_pack_chunk_size() to change this.  This is independent of
2201  * the WIM's main compression type and chunk size; you can have a WIM that
2202  * nominally uses LZX compression and 32768 byte chunks but actually contains
2203  * LZMS-compressed solid blocks, for example.  However, if including solid
2204  * blocks, I suggest that you set the WIM's main compression type to LZMS as
2205  * well, either by creating the WIM with
2206  * ::wimlib_create_new_wim(::WIMLIB_COMPRESSION_TYPE_LZMS, ...) or by calling
2207  * ::wimlib_set_output_compression_type(..., ::WIMLIB_COMPRESSION_TYPE_LZMS).
2208  *
2209  * This flag will be set by default when writing or overwriting a WIM file that
2210  * either already contains packed streams, or has had packed streams exported
2211  * into it and the WIM's main compression type is LZMS.
2212  */
2213 #define WIMLIB_WRITE_FLAG_PACK_STREAMS                  0x00001000
2214
2215 /**
2216  * Send ::WIMLIB_PROGRESS_MSG_DONE_WITH_FILE messages while writing the WIM
2217  * file.  This is only needed in the unusual case that the library user needs to
2218  * know exactly when wimlib has read each file for the last time.
2219  */
2220 #define WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES  0x00002000
2221
2222 /** @} */
2223 /** @addtogroup G_general
2224  * @{ */
2225
2226 /** Assume that strings are represented in UTF-8, even if this is not the
2227  * locale's character encoding.  This flag is ignored on Windows, where wimlib
2228  * always uses UTF-16LE.  */
2229 #define WIMLIB_INIT_FLAG_ASSUME_UTF8                    0x00000001
2230
2231 /** Windows-only: do not attempt to acquire additional privileges (currently
2232  * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
2233  * SeTakeOwnershipPrivilege) when initializing the library.  This is intended
2234  * for the case where the calling program manages these privileges itself.
2235  * Note: no error is issued if privileges cannot be acquired, although related
2236  * errors may be reported later, depending on if the operations performed
2237  * actually require additional privileges or not.  */
2238 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES        0x00000002
2239
2240 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2241  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2242  * to read all possible data and metadata for a capture operation could not be
2243  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES.
2244  */
2245 #define WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES      0x00000004
2246
2247 /** Windows only:  If ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES not specified,
2248  * return ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES if privileges that may be needed
2249  * to restore all possible data and metadata for an apply operation could not be
2250  * acquired.  Can be combined with ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES.
2251  */
2252 #define WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES        0x00000008
2253
2254 /** Default to interpreting WIM paths case sensitively (default on UNIX-like
2255  * systems).  */
2256 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_SENSITIVE         0x00000010
2257
2258 /** Default to interpreting WIM paths case insensitively (default on Windows).
2259  * This does not apply to mounted images.  */
2260 #define WIMLIB_INIT_FLAG_DEFAULT_CASE_INSENSITIVE       0x00000020
2261
2262 /** @} */
2263 /** @addtogroup G_nonstandalone_wims
2264  * @{ */
2265
2266 /** For wimlib_reference_resource_files(), enable shell-style filename globbing.
2267  * Ignored by wimlib_reference_resources().  */
2268 #define WIMLIB_REF_FLAG_GLOB_ENABLE             0x00000001
2269
2270 /** For wimlib_reference_resource_files(), issue an error
2271  * (::WIMLIB_ERR_GLOB_HAD_NO_MATCHES) if a glob did not match any files.  The
2272  * default behavior without this flag is to issue no error at that point, but
2273  * then attempt to open the glob as a literal path, which of course will fail
2274  * anyway if no file exists at that path.  No effect if
2275  * ::WIMLIB_REF_FLAG_GLOB_ENABLE is not also specified.  Ignored by
2276  * wimlib_reference_resources().  */
2277 #define WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH     0x00000002
2278
2279 /** @} */
2280 /** @addtogroup G_modifying_wims
2281  * @{ */
2282
2283 /** The specific type of update to perform. */
2284 enum wimlib_update_op {
2285         /** Add a new file or directory tree to the WIM image in a
2286          * certain location. */
2287         WIMLIB_UPDATE_OP_ADD = 0,
2288
2289         /** Delete a file or directory tree from the WIM image. */
2290         WIMLIB_UPDATE_OP_DELETE,
2291
2292         /** Rename a file or directory tree in the WIM image. */
2293         WIMLIB_UPDATE_OP_RENAME,
2294 };
2295
2296 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
2297 struct wimlib_add_command {
2298         /** Filesystem path to the file or directory tree to add.  */
2299         wimlib_tchar *fs_source_path;
2300
2301         /** Destination path in the WIM image.  Use ::WIMLIB_WIM_ROOT_PATH to
2302          * specify the root directory of the WIM image.  */
2303         wimlib_tchar *wim_target_path;
2304
2305         /** Path to capture configuration file to use, or @c NULL for default.
2306          */
2307         wimlib_tchar *config_file;
2308
2309         /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
2310         int add_flags;
2311 };
2312
2313 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
2314 struct wimlib_delete_command {
2315
2316         /** Path, specified from the root of the WIM image, for the file or
2317          * directory tree within the WIM image to be deleted.  */
2318         wimlib_tchar *wim_path;
2319
2320         /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags.  */
2321         int delete_flags;
2322 };
2323
2324 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
2325 struct wimlib_rename_command {
2326
2327         /** Path, specified from the root of the WIM image, for the source file
2328          * or directory tree within the WIM image.  */
2329         wimlib_tchar *wim_source_path;
2330
2331         /** Path, specified from the root of the WIM image, for the destination
2332          * file or directory tree within the WIM image.  */
2333         wimlib_tchar *wim_target_path;
2334
2335         /** Reserved; set to 0.  */
2336         int rename_flags;
2337 };
2338
2339 /** Specification of an update to perform on a WIM image. */
2340 struct wimlib_update_command {
2341
2342         enum wimlib_update_op op;
2343
2344         union {
2345                 struct wimlib_add_command add;
2346                 struct wimlib_delete_command delete_; /* Underscore is for C++
2347                                                          compatibility.  */
2348                 struct wimlib_rename_command rename;
2349         };
2350 };
2351
2352 /** @} */
2353 /** @addtogroup G_general
2354  * @{ */
2355
2356 /**
2357  * Possible values of the error code returned by many functions in wimlib.
2358  *
2359  * See the documentation for each wimlib function to see specifically what error
2360  * codes can be returned by a given function, and what they mean.
2361  */
2362 enum wimlib_error_code {
2363         WIMLIB_ERR_SUCCESS                            = 0,
2364         WIMLIB_ERR_ALREADY_LOCKED                     = 1,
2365         WIMLIB_ERR_DECOMPRESSION                      = 2,
2366         WIMLIB_ERR_FUSE                               = 6,
2367         WIMLIB_ERR_GLOB_HAD_NO_MATCHES                = 8,
2368         WIMLIB_ERR_ICONV_NOT_AVAILABLE                = 9,
2369         WIMLIB_ERR_IMAGE_COUNT                        = 10,
2370         WIMLIB_ERR_IMAGE_NAME_COLLISION               = 11,
2371         WIMLIB_ERR_INSUFFICIENT_PRIVILEGES            = 12,
2372         WIMLIB_ERR_INTEGRITY                          = 13,
2373         WIMLIB_ERR_INVALID_CAPTURE_CONFIG             = 14,
2374         WIMLIB_ERR_INVALID_CHUNK_SIZE                 = 15,
2375         WIMLIB_ERR_INVALID_COMPRESSION_TYPE           = 16,
2376         WIMLIB_ERR_INVALID_HEADER                     = 17,
2377         WIMLIB_ERR_INVALID_IMAGE                      = 18,
2378         WIMLIB_ERR_INVALID_INTEGRITY_TABLE            = 19,
2379         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY         = 20,
2380         WIMLIB_ERR_INVALID_METADATA_RESOURCE          = 21,
2381         WIMLIB_ERR_INVALID_MULTIBYTE_STRING           = 22,
2382         WIMLIB_ERR_INVALID_OVERLAY                    = 23,
2383         WIMLIB_ERR_INVALID_PARAM                      = 24,
2384         WIMLIB_ERR_INVALID_PART_NUMBER                = 25,
2385         WIMLIB_ERR_INVALID_PIPABLE_WIM                = 26,
2386         WIMLIB_ERR_INVALID_REPARSE_DATA               = 27,
2387         WIMLIB_ERR_INVALID_RESOURCE_HASH              = 28,
2388         WIMLIB_ERR_INVALID_UTF16_STRING               = 30,
2389         WIMLIB_ERR_INVALID_UTF8_STRING                = 31,
2390         WIMLIB_ERR_IS_DIRECTORY                       = 32,
2391         WIMLIB_ERR_IS_SPLIT_WIM                       = 33,
2392         WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,
2393         WIMLIB_ERR_LINK                               = 35,
2394         WIMLIB_ERR_METADATA_NOT_FOUND                 = 36,
2395         WIMLIB_ERR_MKDIR                              = 37,
2396         WIMLIB_ERR_MQUEUE                             = 38,
2397         WIMLIB_ERR_NOMEM                              = 39,
2398         WIMLIB_ERR_NOTDIR                             = 40,
2399         WIMLIB_ERR_NOTEMPTY                           = 41,
2400         WIMLIB_ERR_NOT_A_REGULAR_FILE                 = 42,
2401         WIMLIB_ERR_NOT_A_WIM_FILE                     = 43,
2402         WIMLIB_ERR_NOT_PIPABLE                        = 44,
2403         WIMLIB_ERR_NO_FILENAME                        = 45,
2404         WIMLIB_ERR_NTFS_3G                            = 46,
2405         WIMLIB_ERR_OPEN                               = 47,
2406         WIMLIB_ERR_OPENDIR                            = 48,
2407         WIMLIB_ERR_PATH_DOES_NOT_EXIST                = 49,
2408         WIMLIB_ERR_READ                               = 50,
2409         WIMLIB_ERR_READLINK                           = 51,
2410         WIMLIB_ERR_RENAME                             = 52,
2411         WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED         = 54,
2412         WIMLIB_ERR_RESOURCE_NOT_FOUND                 = 55,
2413         WIMLIB_ERR_RESOURCE_ORDER                     = 56,
2414         WIMLIB_ERR_SET_ATTRIBUTES                     = 57,
2415         WIMLIB_ERR_SET_REPARSE_DATA                   = 58,
2416         WIMLIB_ERR_SET_SECURITY                       = 59,
2417         WIMLIB_ERR_SET_SHORT_NAME                     = 60,
2418         WIMLIB_ERR_SET_TIMESTAMPS                     = 61,
2419         WIMLIB_ERR_SPLIT_INVALID                      = 62,
2420         WIMLIB_ERR_STAT                               = 63,
2421         WIMLIB_ERR_UNEXPECTED_END_OF_FILE             = 65,
2422         WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE   = 66,
2423         WIMLIB_ERR_UNKNOWN_VERSION                    = 67,
2424         WIMLIB_ERR_UNSUPPORTED                        = 68,
2425         WIMLIB_ERR_UNSUPPORTED_FILE                   = 69,
2426         WIMLIB_ERR_WIM_IS_READONLY                    = 71,
2427         WIMLIB_ERR_WRITE                              = 72,
2428         WIMLIB_ERR_XML                                = 73,
2429         WIMLIB_ERR_WIM_IS_ENCRYPTED                   = 74,
2430         WIMLIB_ERR_WIMBOOT                            = 75,
2431         WIMLIB_ERR_ABORTED_BY_PROGRESS                = 76,
2432         WIMLIB_ERR_UNKNOWN_PROGRESS_STATUS            = 77,
2433         WIMLIB_ERR_MKNOD                              = 78,
2434         WIMLIB_ERR_MOUNTED_IMAGE_IS_BUSY              = 79,
2435         WIMLIB_ERR_NOT_A_MOUNTPOINT                   = 80,
2436         WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT           = 81,
2437 };
2438
2439
2440 /** Used to indicate no WIM image or an invalid WIM image. */
2441 #define WIMLIB_NO_IMAGE         0
2442
2443 /** Used to specify all images in the WIM. */
2444 #define WIMLIB_ALL_IMAGES       (-1)
2445
2446 /** @}  */
2447
2448 /**
2449  * @ingroup G_modifying_wims
2450  *
2451  * Appends an empty image to a WIM file.  This empty image will initially
2452  * contain no files or directories, although if written without further
2453  * modifications, a root directory will be created automatically for it.  After
2454  * calling this function, you can use wimlib_update_image() to add files to the
2455  * new WIM image.  This gives you slightly more control over making the new
2456  * image compared to calling wimlib_add_image() or
2457  * wimlib_add_image_multisource() directly.
2458  *
2459  * @param wim
2460  *      Pointer to the ::WIMStruct for the WIM file to which the image is to be
2461  *      added.
2462  * @param name
2463  *      Name to give the new image.  If @c NULL or empty, the new image is given
2464  *      no name.  If nonempty, it must specify a name that does not already
2465  *      exist in @p wim.
2466  * @param new_idx_ret
2467  *      If non-<code>NULL</code>, the index of the newly added image is returned
2468  *      in this location.
2469  *
2470  * @return 0 on success; nonzero on failure.  The possible error codes are:
2471  *
2472  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2473  *      There is already an image in @p wim named @p name.
2474  * @retval ::WIMLIB_ERR_NOMEM
2475  *      Failed to allocate the memory needed to add the new image.
2476  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2477  *      The WIM file is considered read-only because of any of the reasons
2478  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2479  *      flag.
2480  */
2481 extern int
2482 wimlib_add_empty_image(WIMStruct *wim,
2483                        const wimlib_tchar *name,
2484                        int *new_idx_ret);
2485
2486 /**
2487  * @ingroup G_modifying_wims
2488  *
2489  * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
2490  *
2491  * The directory tree or NTFS volume is scanned immediately to load the dentry
2492  * tree into memory, and file attributes and symbolic links are read.  However,
2493  * actual file data is not read until wimlib_write() or wimlib_overwrite() is
2494  * called.
2495  *
2496  * See the manual page for the @b wimlib-imagex program for more information
2497  * about the "normal" capture mode versus the NTFS capture mode (entered by
2498  * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
2499  *
2500  * Note that @b no changes are committed to the underlying WIM file (if
2501  * any) until wimlib_write() or wimlib_overwrite() is called.
2502  *
2503  * @param wim
2504  *      Pointer to the ::WIMStruct to which to add the image.
2505  * @param source
2506  *      A path to a directory or unmounted NTFS volume that will be captured as
2507  *      a WIM image.
2508  * @param name
2509  *      Name to give the new image.  If @c NULL or empty, the new image is given
2510  *      no name.  If nonempty, it must specify a name that does not already
2511  *      exist in @p wim.
2512  * @param config_file
2513  *      Path to capture configuration file, or @c NULL.  This file may specify,
2514  *      among other things, which files to exclude from capture.  See the man
2515  *      page for <b>wimlib-imagex capture</b> (<b>--config</b> option) for
2516  *      details of the file format.  If @c NULL, the default capture
2517  *      configuration shall be used.  Ordinarily, the default capture
2518  *      configuration will result in no files being excluded from capture purely
2519  *      based on name; however, the ::WIMLIB_ADD_FLAG_WINCONFIG and
2520  *      ::WIMLIB_ADD_FLAG_WIMBOOT flags modify the default.
2521  * @param add_flags
2522  *      Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
2523  *
2524  * @return 0 on success; nonzero on error.  On error, changes to @p wim are
2525  * discarded so that it appears to be in the same state as when this function
2526  * was called.
2527  *
2528  * This function is implemented by calling wimlib_add_empty_image(), then
2529  * calling wimlib_update_image() with a single "add" command, so any error code
2530  * returned by wimlib_add_empty_image() may be returned, as well as any error
2531  * codes returned by wimlib_update_image() other than ones documented as only
2532  * being returned specifically by an update involving delete or rename commands.
2533  *
2534  * If a progress function is registered with @p wim, it will receive the
2535  * messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and ::WIMLIB_PROGRESS_MSG_SCAN_END.
2536  * In addition, if ::WIMLIB_ADD_FLAG_VERBOSE is specified in @p add_flags, it
2537  * will receive ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
2538  */
2539 extern int
2540 wimlib_add_image(WIMStruct *wim,
2541                  const wimlib_tchar *source,
2542                  const wimlib_tchar *name,
2543                  const wimlib_tchar *config_file,
2544                  int add_flags);
2545
2546 /**
2547  * @ingroup G_modifying_wims
2548  *
2549  * This function is equivalent to wimlib_add_image() except it allows for
2550  * multiple sources to be combined into a single WIM image.  This is done by
2551  * specifying the @p sources and @p num_sources parameters instead of the @p
2552  * source parameter of wimlib_add_image().  The rest of the parameters are the
2553  * same as wimlib_add_image().  See the documentation for <b>wimlib-imagex
2554  * capture</b> for full details on how this mode works.
2555  *
2556  * In addition to the error codes that wimlib_add_image() can return,
2557  * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
2558  * when trying to overlay a non-directory on a directory or when otherwise
2559  * trying to overlay multiple conflicting files to the same location in the WIM
2560  * image.  It will also return ::WIMLIB_ERR_INVALID_PARAM if
2561  * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
2562  * was not exactly one capture source with the target being the root directory.
2563  * (In this respect, there is no advantage to using
2564  * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
2565  * NTFS mode.) */
2566 extern int
2567 wimlib_add_image_multisource(WIMStruct *wim,
2568                              const struct wimlib_capture_source *sources,
2569                              size_t num_sources,
2570                              const wimlib_tchar *name,
2571                              const wimlib_tchar *config_file,
2572                              int add_flags);
2573
2574 /**
2575  * @ingroup G_modifying_wims
2576  *
2577  * Add the file or directory tree at @p fs_source_path on the filesystem to the
2578  * location @p wim_target_path within the specified @p image of the @p wim.
2579  *
2580  * This just builds an appropriate ::wimlib_add_command and passes it to
2581  * wimlib_update_image().
2582  */
2583 extern int
2584 wimlib_add_tree(WIMStruct *wim, int image,
2585                 const wimlib_tchar *fs_source_path,
2586                 const wimlib_tchar *wim_target_path, int add_flags);
2587
2588 /**
2589  * @ingroup G_creating_and_opening_wims
2590  *
2591  * Creates a ::WIMStruct for a new WIM file.
2592  *
2593  * This only creates an in-memory structure for a WIM that initially contains no
2594  * images.  No on-disk file is created until wimlib_write() is called.
2595  *
2596  * @param ctype
2597  *      The type of compression to be used in the new WIM file, as one of the
2598  *      ::wimlib_compression_type constants.
2599  *      <br/>
2600  *      This choice is not necessarily final; if desired, it can still be
2601  *      changed at any time before the WIM is written to disk, using
2602  *      wimlib_set_output_compression_type().  In addition, if you wish to use a
2603  *      non-default chunk size, you will need to call
2604  *      wimlib_set_output_chunk_size().
2605  * @param wim_ret
2606  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
2607  *      written to the memory location pointed to by this parameter.  The
2608  *      ::WIMStruct must be freed using using wimlib_free() when finished with
2609  *      it.
2610  * @return 0 on success; nonzero on error.
2611  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2612  *      @p ctype was not a supported compression type.
2613  * @retval ::WIMLIB_ERR_NOMEM
2614  *      Failed to allocate needed memory.
2615  */
2616 extern int
2617 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
2618
2619 /**
2620  * @ingroup G_modifying_wims
2621  *
2622  * Deletes an image, or all images, from a WIM file.
2623  *
2624  * Note: no changes are committed to the underlying WIM file (if any) until
2625  * wimlib_write() or wimlib_overwrite() is called.
2626  *
2627  * @param wim
2628  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
2629  *      being deleted.
2630  * @param image
2631  *      The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
2632  *      images.
2633  *
2634  * @return 0 on success; nonzero on failure.  On failure, @p wim is guaranteed
2635  * to be left unmodified only if @p image specified a single image.  If instead
2636  * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
2637  * possible for some but not all of the images to have been deleted when a
2638  * failure status is returned.
2639  *
2640  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2641  *      @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
2642  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2643  *      The WIM file is considered read-only because of any of the reasons
2644  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2645  *      flag.
2646  *
2647  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2648  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2649  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2650  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2651  * different reasons) to read the metadata resource for an image that needed to
2652  * be deleted.
2653  */
2654 extern int
2655 wimlib_delete_image(WIMStruct *wim, int image);
2656
2657 /**
2658  * @ingroup G_modifying_wims
2659  *
2660  * Delete the @p path from the specified @p image of the @p wim.
2661  *
2662  * This just builds an appropriate ::wimlib_delete_command and passes it to
2663  * wimlib_update_image().
2664  */
2665 extern int
2666 wimlib_delete_path(WIMStruct *wim, int image,
2667                    const wimlib_tchar *path, int delete_flags);
2668
2669 /**
2670  * @ingroup G_modifying_wims
2671  *
2672  * Exports an image, or all the images, from a WIM file, into another WIM file.
2673  *
2674  * The destination image is made to share the same dentry tree and security data
2675  * structure as the source image.  This places some restrictions on additional
2676  * functions that may be called.  For example, you may not call wimlib_free() on
2677  * @p src_wim before calling wimlib_write() or wimlib_overwrite() on @p dest_wim
2678  * because @p dest_wim will have references back to @p src_wim.
2679  *
2680  * If this function fails, all changes to @p dest_wim are rolled back.
2681  *
2682  * Please note that no changes are committed to the underlying WIM file of @p
2683  * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
2684  *
2685  * @param src_wim
2686  *      The WIM from which to export the images, specified as a pointer to the
2687  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2688  *      split WIM.  In the case of a WIM file that is not standalone, this
2689  *      ::WIMStruct must have had any needed external resources previously
2690  *      referenced using wimlib_reference_resources() or
2691  *      wimlib_reference_resource_files().
2692  * @param src_image
2693  *      The image to export from @p src_wim, as either a 1-based image index to
2694  *      export a single image, or ::WIMLIB_ALL_IMAGES to export all images.
2695  * @param dest_wim
2696  *      Pointer to the ::WIMStruct for a WIM that will receive the images being
2697  *      exported.
2698  * @param dest_name
2699  *      For single-image exports, the name to give the exported image in @p
2700  *      dest_wim.  If left @c NULL, the name from @p src_wim is used.  For
2701  *      ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c NULL; in
2702  *      that case, the names are all taken from @p src_wim.  This parameter is
2703  *      overridden by ::WIMLIB_EXPORT_FLAG_NO_NAMES.
2704  * @param dest_description
2705  *      For single-image exports, the description to give the exported image in
2706  *      the new WIM file.  If left @c NULL, the description from @p src_wim is
2707  *      used.  For ::WIMLIB_ALL_IMAGES exports, this parameter must be left @c
2708  *      NULL; in that case, the description are all taken from @p src_wim.  This
2709  *      parameter is overridden by ::WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS.
2710  * @param export_flags
2711  *      Bitwise OR of flags prefixed with WIMLIB_EXPORT_FLAG.
2712  *
2713  * @return 0 on success; nonzero on error.
2714  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2715  *      One or more of the names being given to an exported image was already in
2716  *      use in the destination WIM.
2717  * @retval ::WIMLIB_ERR_INVALID_IMAGE
2718  *      @p src_image does not exist in @p src_wim and was not
2719  *      ::WIMLIB_ALL_IMAGES.
2720  * @retval ::WIMLIB_ERR_INVALID_PARAM
2721  *      @p src_wim and/or @p dest_wim were @c NULL; or @p src_image was
2722  *      ::WIMLIB_ALL_IMAGES but @p dest_name and/or @p dest_description were not
2723  *      @c NULL.
2724  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2725  *      Either @p src_wim or @p dest_wim did not contain metadata resources; for
2726  *      example, one of them was a non-first part of a split WIM.
2727  * @retval ::WIMLIB_ERR_NOMEM
2728  *      Failed to allocate needed memory.
2729  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2730  *      A resource that needed to be exported could not be found in either the
2731  *      source or destination WIMs.  This error can occur if, for example, @p
2732  *      src_wim is part of a split WIM but needed resources from the other split
2733  *      WIM parts were not referenced with wimlib_reference_resources() or
2734  *      wimlib_reference_resource_files() before the call to
2735  *      wimlib_export_image().
2736  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2737  *      @p dest_wim is considered read-only because of any of the reasons
2738  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2739  *      flag.
2740  *
2741  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2742  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
2743  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
2744  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
2745  * different reasons) to read the metadata resource for an image in @p src_wim
2746  * that needed to be exported.
2747  */
2748 extern int
2749 wimlib_export_image(WIMStruct *src_wim, int src_image,
2750                     WIMStruct *dest_wim,
2751                     const wimlib_tchar *dest_name,
2752                     const wimlib_tchar *dest_description,
2753                     int export_flags);
2754
2755 /**
2756  * @ingroup G_extracting_wims
2757  *
2758  * Extracts an image, or all images, from a WIM to a directory or NTFS volume
2759  * image.
2760  *
2761  * The exact behavior of how wimlib extracts files from a WIM image is
2762  * controllable by the @p extract_flags parameter, but there also are
2763  * differences depending on the platform (UNIX-like vs Windows).  See the manual
2764  * page for <b>wimlib-imagex apply</b> for more information, including about the
2765  * NTFS-3g extraction mode.
2766  *
2767  * @param wim
2768  *      The WIM from which to extract the image(s), specified as a pointer to
2769  *      the ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1
2770  *      of a split WIM.  In the case of a WIM file that is not standalone, this
2771  *      ::WIMStruct must have had any needed external resources previously
2772  *      referenced using wimlib_reference_resources() or
2773  *      wimlib_reference_resource_files().
2774  * @param image
2775  *      The image to extract, specified as either the 1-based index of a single
2776  *      image to extract, or ::WIMLIB_ALL_IMAGES to specify that all images are
2777  *      to be extracted.  However, ::WIMLIB_ALL_IMAGES cannot be used if
2778  *      ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
2779  * @param target
2780  *      Directory to extract the WIM image(s) to; or, with
2781  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to
2782  *      the unmounted NTFS volume to which to extract the image.
2783  * @param extract_flags
2784  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
2785  *
2786  * @return 0 on success; nonzero on error.
2787  * @retval ::WIMLIB_ERR_DECOMPRESSION
2788  *      Failed to decompress data contained in the WIM.
2789  * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2790  *      The metadata for one of the images to extract was invalid.
2791  * @retval ::WIMLIB_ERR_INVALID_PARAM
2792  *      The extraction flags were invalid; more details may be found in the
2793  *      documentation for the specific extraction flags that were specified.  Or
2794  *      @p target was @c NULL or an empty string, or @p wim was @c NULL.
2795  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2796  *      The SHA1 message digest of an extracted stream did not match the SHA1
2797  *      message digest given in the WIM.  In other words, the WIM file is
2798  *      corrupted, so the data cannot be extracted in its original form.
2799  * @retval ::WIMLIB_ERR_LINK
2800  *      Failed to create a symbolic link or a hard link.
2801  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
2802  *      The metadata resource for one of the images to extract was not found.
2803  *      This can happen if @p wim represents a non-first part of a split WIM.
2804  * @retval ::WIMLIB_ERR_MKDIR
2805  *      Failed create a directory.
2806  * @retval ::WIMLIB_ERR_NOMEM
2807  *      Failed to allocate needed memory.
2808  * @retval ::WIMLIB_ERR_OPEN
2809  *      Could not create a file, or failed to open an already-extracted file.
2810  * @retval ::WIMLIB_ERR_READ
2811  *      Failed to read data from the WIM.
2812  * @retval ::WIMLIB_ERR_READLINK
2813  *      Failed to determine the target of a symbolic link in the WIM.
2814  * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2815  *      Failed to fix the target of an absolute symbolic link (e.g. if the
2816  *      target would have exceeded the maximum allowed length).  (Only if
2817  *      reparse data was supported by the extraction mode and
2818  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p
2819  *      extract_flags.)
2820  * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2821  *      One of the files or directories that needed to be extracted referenced a
2822  *      stream not present in the WIM's lookup table (or in any of the lookup
2823  *      tables of the split WIM parts).  This can happen if the WIM is not
2824  *      standalone and the necessary resource WIMs, or split WIM parts, were not
2825  *      referenced with wimlib_reference_resource_files().
2826  * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
2827  *      Failed to set attributes on a file.
2828  * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
2829  *      Failed to set reparse data on a file (only if reparse data was supported
2830  *      by the extraction mode).
2831  * @retval ::WIMLIB_ERR_SET_SECURITY
2832  *      Failed to set security descriptor on a file.
2833  * @retval ::WIMLIB_ERR_SET_SHORT_NAME
2834  *      Failed to set the short name of a file.
2835  * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
2836  *      Failed to set timestamps on a file.
2837  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2838  *      Unexpected end-of-file occurred when reading data from the WIM.
2839  * @retval ::WIMLIB_ERR_UNSUPPORTED
2840  *      A requested extraction flag, or the data or metadata that must be
2841  *      extracted to support it, is unsupported in the build and configuration
2842  *      of wimlib, or on the current platform or extraction mode or target
2843  *      volume.  Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
2844  *      ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
2845  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
2846  *      ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS, and
2847  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS.  For example, if
2848  *      ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
2849  *      extract_flags, ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM
2850  *      image contains one or more files with short names, but extracting short
2851  *      names is not supported --- on Windows, this occurs if the target volume
2852  *      does not support short names, while on non-Windows, this occurs if
2853  *      ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
2854  * @retval ::WIMLIB_ERR_WIMBOOT
2855  *      ::WIMLIB_EXTRACT_FLAG_WIMBOOT was specified in @p extract_flags, but
2856  *      there was a problem creating WIMBoot pointer files.
2857  * @retval ::WIMLIB_ERR_WRITE
2858  *      Failed to write data to a file being extracted.
2859  *
2860  * If a progress function is registered with @p wim, then as each image is
2861  * extracted it will receive ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN, then
2862  * zero or more ::WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE messages, then zero
2863  * or more ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages, then zero or more
2864  * ::WIMLIB_PROGRESS_MSG_EXTRACT_METADATA messages, then
2865  * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END.
2866  */
2867 extern int
2868 wimlib_extract_image(WIMStruct *wim, int image,
2869                      const wimlib_tchar *target, int extract_flags);
2870
2871 /**
2872  * @ingroup G_extracting_wims
2873  *
2874  * Extract one image from a pipe on which a pipable WIM is being sent.
2875  *
2876  * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE, and @ref
2877  * subsec_pipable_wims, for more information about pipable WIMs.
2878  *
2879  * This function operates in a special way to read the WIM fully sequentially.
2880  * As a result, there is no ::WIMStruct is made visible to library users, and
2881  * you cannot call wimlib_open_wim() on the pipe.  (You can, however, use
2882  * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
2883  * seekable file, not a pipe.)
2884  *
2885  * @param pipe_fd
2886  *      File descriptor, which may be a pipe, opened for reading and positioned
2887  *      at the start of the pipable WIM.
2888  * @param image_num_or_name
2889  *      String that specifies the 1-based index or name of the image to extract.
2890  *      It is translated to an image index using the same rules that
2891  *      wimlib_resolve_image() uses.  However, unlike wimlib_extract_image(),
2892  *      only a single image (not all images) can be specified.  Alternatively,
2893  *      specify @p NULL here to use the first image in the WIM if it contains
2894  *      exactly one image but otherwise return ::WIMLIB_ERR_INVALID_IMAGE.
2895  * @param target
2896  *      Same as the corresponding parameter to wimlib_extract_image().
2897  * @param extract_flags
2898  *      Same as the corresponding parameter to wimlib_extract_image().
2899  *
2900  * @return 0 on success; nonzero on error.  The possible error codes include
2901  * those returned by wimlib_extract_image() and wimlib_open_wim() as well as the
2902  * following:
2903  *
2904  * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
2905  *      Data read from the pipable WIM was invalid.
2906  * @retval ::WIMLIB_ERR_NOT_PIPABLE
2907  *      The WIM being piped over @p pipe_fd is a normal WIM, not a pipable WIM.
2908  */
2909 extern int
2910 wimlib_extract_image_from_pipe(int pipe_fd,
2911                                const wimlib_tchar *image_num_or_name,
2912                                const wimlib_tchar *target, int extract_flags);
2913
2914 /*
2915  * @ingroup G_extracting_wims
2916  *
2917  * Same as wimlib_extract_image_from_pipe(), but allows specifying a progress
2918  * function.  The progress function will be used while extracting the WIM image
2919  * and will receive the normal extraction progress messages, such as
2920  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, in addition to
2921  * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN.
2922  */
2923 extern int
2924 wimlib_extract_image_from_pipe_with_progress(int pipe_fd,
2925                                              const wimlib_tchar *image_num_or_name,
2926                                              const wimlib_tchar *target,
2927                                              int extract_flags,
2928                                              wimlib_progress_func_t progfunc,
2929                                              void *progctx);
2930
2931 /**
2932  * @ingroup G_extracting_wims
2933  *
2934  * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
2935  * image are specified in the ASCII, UTF-8, or UTF-16LE text file named by @p
2936  * path_list_file which itself contains the list of paths to use, one per line.
2937  * Leading and trailing whitespace is ignored.  Empty lines and lines beginning
2938  * with the ';' or '#' characters are ignored.  No quotes are needed, as paths
2939  * are otherwise delimited by the newline character.  However, quotes will be
2940  * stripped if present.
2941  *
2942  * The error codes are the same as those returned by wimlib_extract_paths(),
2943  * except that wimlib_extract_pathlist() returns an appropriate error code if it
2944  * cannot read the path list file (e.g. ::WIMLIB_ERR_OPEN, ::WIMLIB_ERR_STAT,
2945  * ::WIMLIB_ERR_READ).
2946  */
2947 extern int
2948 wimlib_extract_pathlist(WIMStruct *wim, int image,
2949                         const wimlib_tchar *target,
2950                         const wimlib_tchar *path_list_file,
2951                         int extract_flags);
2952
2953 /**
2954  * @ingroup G_extracting_wims
2955  *
2956  * Extract zero or more paths (files or directory trees) from the specified WIM
2957  * image.
2958  *
2959  * By default, each path will be extracted to a corresponding subdirectory of
2960  * the target based on its location in the WIM image.  For example, if one of
2961  * the paths to extract is "/Windows/explorer.exe" and the target is "outdir",
2962  * the file will be extracted to "outdir/Windows/explorer.exe".  This behavior
2963  * can be changed by providing the flag
2964  * ::WIMLIB_EXTRACT_FLAG_NO_PRESERVE_DIR_STRUCTURE, which will cause each file
2965  * or directory tree to be placed directly in the target directory --- so the
2966  * same example would extract "/Windows/explorer.exe" to "outdir/explorer.exe".
2967  *
2968  * Symbolic links will not be dereferenced when paths in the WIM image are
2969  * interpreted.
2970  *
2971  * @param wim
2972  *      WIM from which to extract the paths, specified as a pointer to the
2973  *      ::WIMStruct for a standalone WIM file, a delta WIM file, or part 1 of a
2974  *      split WIM.  In the case of a WIM file that is not standalone, this
2975  *      ::WIMStruct must have had any needed external resources previously
2976  *      referenced using wimlib_reference_resources() or
2977  *      wimlib_reference_resource_files().
2978  * @param image
2979  *      1-based index of the WIM image from which to extract the paths.
2980  * @param paths
2981  *      Array of paths to extract.  Each element must be the absolute path to a
2982  *      file or directory within the WIM image.  Separators may be either
2983  *      forwards or backwards slashes, and leading path separators are optional.
2984  *      The paths will be interpreted either case-sensitively (UNIX default) or
2985  *      case-insensitively (Windows default); however, the behavior can be
2986  *      configured explicitly at library initialization time by passing an
2987  *      appropriate flag to wimlib_global_init().
2988  *      <br/>
2989  *      By default, the characters @c * and @c ? are interpreted literally.
2990  *      This can be changed by specifying ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS in @p
2991  *      extract_flags.
2992  *      <br/>
2993  *      By default, if any paths to extract do not exist, the error code
2994  *      ::WIMLIB_ERR_PATH_DOES_NOT_EXIST is returned.  This behavior changes if
2995  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS is specified in @p extract_flags.
2996  * @param num_paths
2997  *      Number of paths specified in @p paths.
2998  * @param target
2999  *      Directory to which to extract the paths; or with
3000  *      ::WIMLIB_EXTRACT_FLAG_NTFS specified in @p extract_flags, the path to an
3001  *      unmounted NTFS volume to which to extract the paths.  Unlike the @p
3002  *      paths being extracted, the @p target must be native path.  On UNIX-like
3003  *      systems it may not contain backslashes, for example.
3004  * @param extract_flags
3005  *      Bitwise OR of flags prefixed with WIMLIB_EXTRACT_FLAG.
3006  *
3007  * @return 0 on success; nonzero on error.  Most of the error codes are the same
3008  * as those returned by wimlib_extract_image().  Below, some of the error codes
3009  * returned in situations specific to path-mode extraction are documented:
3010  *
3011  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3012  *      One of the paths to extract did not exist in the WIM image.  This error
3013  *      code can only be returned if ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS was not
3014  *      specified in @p extract_flags, or if both
3015  *      ::WIMLIB_EXTRACT_FLAG_GLOB_PATHS and ::WIMLIB_EXTRACT_FLAG_STRICT_GLOB
3016  *      were specified in @p extract_flags.
3017  * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
3018  *      ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified in @p extract_flags, but
3019  *      one of the paths to extract did not name a regular file.
3020  *
3021  * If a progress function is registered with @p wim, it will receive
3022  * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS.  Note that because the extraction code
3023  * is stream-based and not file-based, there is no way to get information about
3024  * which path is currently being extracted, but based on byte count you can
3025  * still calculate an approximate percentage complete for the extraction overall
3026  * which may be all you really need anyway.
3027  */
3028 extern int
3029 wimlib_extract_paths(WIMStruct *wim,
3030                      int image,
3031                      const wimlib_tchar *target,
3032                      const wimlib_tchar * const *paths,
3033                      size_t num_paths,
3034                      int extract_flags);
3035
3036 /**
3037  * @ingroup G_wim_information
3038  *
3039  * Extracts the XML data of a WIM file to a file stream.  Every WIM file
3040  * includes a string of XML that describes the images contained in the WIM.
3041  *
3042  * See wimlib_get_xml_data() to read the XML data into memory instead.
3043  *
3044  * @param wim
3045  *      Pointer to the ::WIMStruct to query.  This need not represent a
3046  *      standalone WIM (e.g. it could represent part of a split WIM).
3047  * @param fp
3048  *      @c stdout, or a FILE* opened for writing, to extract the data to.
3049  *
3050  * @return 0 on success; nonzero on error.
3051  * @retval ::WIMLIB_ERR_INVALID_PARAM
3052  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
3053  * @retval ::WIMLIB_ERR_NOMEM
3054  *      Failed to allocate needed memory.
3055  * @retval ::WIMLIB_ERR_READ
3056  *      Error reading the XML data from the WIM file.
3057  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3058  *      Error reading the XML data from the WIM file.
3059  * @retval ::WIMLIB_ERR_WRITE
3060  *      Failed to completely write the XML data to @p fp.
3061  */
3062 extern int
3063 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
3064
3065 /**
3066  * @ingroup G_general
3067  *
3068  * Frees all memory allocated for a WIMStruct and closes all files associated
3069  * with it.
3070  *
3071  * @param wim
3072  *      Pointer to the ::WIMStruct to free.
3073  *
3074  * @return This function has no return value.
3075  */
3076 extern void
3077 wimlib_free(WIMStruct *wim);
3078
3079 /**
3080  * @ingroup G_general
3081  *
3082  * Converts a ::wimlib_compression_type value into a string.
3083  *
3084  * @param ctype
3085  *      The ::wimlib_compression_type value to convert.
3086  *
3087  * @return
3088  *      A statically allocated string naming the compression algorithm,
3089  *      such as "None", "LZX", "XPRESS", or "Invalid".
3090  */
3091 extern const wimlib_tchar *
3092 wimlib_get_compression_type_string(int ctype);
3093
3094 /**
3095  * @ingroup G_general
3096  *
3097  * Converts an error code into a string describing it.
3098  *
3099  * @param code
3100  *      The error code returned by one of wimlib's functions.
3101  *
3102  * @return
3103  *      Pointer to a statically allocated string describing the error code.  If
3104  *      the error code is for some reason not recognized by the library, the
3105  *      string will be "Unknown error".
3106  */
3107 extern const wimlib_tchar *
3108 wimlib_get_error_string(enum wimlib_error_code code);
3109
3110 /**
3111  * @ingroup G_wim_information
3112  *
3113  * Returns the description of the specified image.
3114  *
3115  * @param wim
3116  *      Pointer to the ::WIMStruct to query.  This need not represent a
3117  *      standalone WIM (e.g. it could represent part of a split WIM).
3118  * @param image
3119  *      The number of the image, numbered starting at 1.
3120  *
3121  * @return
3122  *      The description of the image, or @c NULL if there is no such image, or
3123  *      @c NULL if the specified image has no description.  The description
3124  *      string is in library-internal memory and may not be modified or freed;
3125  *      in addition, the string will become invalid if the description of the
3126  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
3127  */
3128 extern const wimlib_tchar *
3129 wimlib_get_image_description(const WIMStruct *wim, int image);
3130
3131 /**
3132  * @ingroup G_wim_information
3133  *
3134  * Returns the name of the specified image.
3135  *
3136  * @param wim
3137  *      Pointer to the ::WIMStruct to query.  This need not represent a
3138  *      standalone WIM (e.g. it could represent part of a split WIM).
3139  * @param image
3140  *      The number of the image, numbered starting at 1.
3141  *
3142  * @return
3143  *      The name of the image, or @c NULL if there is no such image, or an empty
3144  *      string if the image is unnamed.  The name string is in
3145  *      library-internal memory and may not be modified or freed; in addition,
3146  *      the string will become invalid if the name of the image is changed, the
3147  *      image is deleted, or the ::WIMStruct is destroyed.
3148  */
3149 extern const wimlib_tchar *
3150 wimlib_get_image_name(const WIMStruct *wim, int image);
3151
3152 /**
3153  * @ingroup G_general
3154  *
3155  * Returns the version of wimlib as a 32-bit number whose top 12 bits contain
3156  * the major version, the next 10 bits contain the minor version, and the low 10
3157  * bits contain the patch version.
3158  *
3159  * In other words, the returned value is equal to <code>((WIMLIB_MAJOR_VERSION
3160  * << 22) | (WIMLIB_MINOR_VERSION << 10) | WIMLIB_PATCH_VERSION)</code> for the
3161  * corresponding header file.
3162  */
3163 extern uint32_t
3164 wimlib_get_version(void);
3165
3166 /**
3167  * @ingroup G_wim_information
3168  *
3169  * Get basic information about a WIM file.
3170  *
3171  * @param wim
3172  *      Pointer to the ::WIMStruct to query.  This need not represent a
3173  *      standalone WIM (e.g. it could represent part of a split WIM).
3174  * @param info
3175  *      A ::wimlib_wim_info structure that will be filled in with information
3176  *      about the WIM file.
3177  * @return
3178  *      0
3179  */
3180 extern int
3181 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
3182
3183 /**
3184  * @ingroup G_wim_information
3185  *
3186  * Read the XML data of a WIM file into an in-memory buffer.  Every WIM file
3187  * includes a string of XML that describes the images contained in the WIM.
3188  *
3189  * See wimlib_extract_xml_data() to extract the XML data to a file stream
3190  * instead.
3191  *
3192  * @param wim
3193  *      Pointer to the ::WIMStruct to query.  This need not represent a
3194  *      standalone WIM (e.g. it could represent part of a split WIM).
3195  * @param buf_ret
3196  *      On success, a pointer to an allocated buffer containing the raw UTF16-LE
3197  *      XML data is written to this location.
3198  * @param bufsize_ret
3199  *      The size of the XML data in bytes is written to this location.
3200  *
3201  * @return 0 on success; nonzero on error.
3202  * @retval ::WIMLIB_ERR_INVALID_PARAM
3203  *      @p wim is not a ::WIMStruct that was created by wimlib_open_wim(), or
3204  *      @p buf_ret or @p bufsize_ret was @c NULL.
3205  * @retval ::WIMLIB_ERR_NOMEM
3206  * @retval ::WIMLIB_ERR_READ
3207  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3208  *      Failed to read the XML data from the WIM.
3209  */
3210 extern int
3211 wimlib_get_xml_data(WIMStruct *wim, void **buf_ret, size_t *bufsize_ret);
3212
3213 /**
3214  * @ingroup G_general
3215  *
3216  * Initialization function for wimlib.  Call before using any other wimlib
3217  * function except wimlib_set_print_errors().  If not done manually, this
3218  * function will be called automatically with @p init_flags set to
3219  * ::WIMLIB_INIT_FLAG_ASSUME_UTF8.  This function does nothing if called again
3220  * after it has already successfully run.
3221  *
3222  * @param init_flags
3223  *      Bitwise OR of flags prefixed with WIMLIB_INIT_FLAG.
3224  *
3225  * @return 0 on success; nonzero on failure.  Currently, only the following
3226  * error code is defined:
3227  *
3228  * @retval ::WIMLIB_ERR_INSUFFICIENT_PRIVILEGES
3229  *      ::WIMLIB_INIT_FLAG_STRICT_APPLY_PRIVILEGES and/or
3230  *      ::WIMLIB_INIT_FLAG_STRICT_CAPTURE_PRIVILEGES were specified in @p
3231  *      init_flags, but the corresponding privileges could not be acquired.
3232  */
3233 extern int
3234 wimlib_global_init(int init_flags);
3235
3236 /**
3237  * @ingroup G_general
3238  *
3239  * Cleanup function for wimlib.  You are not required to call this function, but
3240  * it will release any global resources allocated by the library.
3241  */
3242 extern void
3243 wimlib_global_cleanup(void);
3244
3245 /**
3246  * @ingroup G_wim_information
3247  *
3248  * Determines if an image name is already used by some image in the WIM.
3249  *
3250  * @param wim
3251  *      Pointer to the ::WIMStruct to query.  This need not represent a
3252  *      standalone WIM (e.g. it could represent part of a split WIM).
3253  * @param name
3254  *      The name to check.
3255  *
3256  * @return
3257  *      @c true if there is already an image in @p wim named @p name; @c false
3258  *      if there is no image named @p name in @p wim.  If @p name is @c NULL or
3259  *      the empty string, @c false is returned.
3260  */
3261 extern bool
3262 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
3263
3264 /**
3265  * @ingroup G_wim_information
3266  *
3267  * Iterate through a file or directory tree in the WIM image.  By specifying
3268  * appropriate flags and a callback function, you can get the attributes of a
3269  * file in the WIM, get a directory listing, or even get a listing of the entire
3270  * WIM image.
3271  *
3272  * @param wim
3273  *      The WIM containing the image(s) over which to iterate, specified as a
3274  *      pointer to the ::WIMStruct for a standalone WIM file, a delta WIM file,
3275  *      or part 1 of a split WIM.  In the case of a WIM file that is not
3276  *      standalone, this ::WIMStruct should have had any needed external
3277  *      resources previously referenced using wimlib_reference_resources() or
3278  *      wimlib_reference_resource_files().  If not, see
3279  *      ::WIMLIB_ITERATE_DIR_TREE_FLAG_RESOURCES_NEEDED for information about
3280  *      the behavior when resources are missing.
3281  *
3282  * @param image
3283  *      The 1-based number of the image in @p wim that contains the files or
3284  *      directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
3285  *      iteration on all images in the WIM.
3286  *
3287  * @param path
3288  *      Path in the WIM image at which to do the iteration.
3289  *
3290  * @param flags
3291  *      Bitwise OR of flags prefixed with WIMLIB_ITERATE_DIR_TREE_FLAG.
3292  *
3293  * @param cb
3294  *      A callback function that will receive each directory entry.
3295  *
3296  * @param user_ctx
3297  *      An extra parameter that will always be passed to the callback function
3298  *      @p cb.
3299  *
3300  * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
3301  * first nonzero value that was returned from @p cb.  However, additional error
3302  * codes may be returned, including the following:
3303  *
3304  * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
3305  *      @p path did not exist in the WIM image.
3306  * @retval ::WIMLIB_ERR_NOMEM
3307  *      Failed to allocate memory needed to create a ::wimlib_dir_entry.
3308  *
3309  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3310  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3311  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3312  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3313  * different reasons) to read the metadata resource for an image over which
3314  * iteration needed to be done.
3315  */
3316 extern int
3317 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
3318                         int flags,
3319                         wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
3320
3321 /**
3322  * @ingroup G_wim_information
3323  *
3324  * Iterate through the lookup table of a WIM file.  This can be used to directly
3325  * get a listing of the unique resources contained in a WIM file over all
3326  * images.  Both file resources and metadata resources are included.  However,
3327  * only resources actually included in the file represented by @a wim, plus
3328  * explicitly referenced external resources (via wimlib_reference_resources() or
3329  * wimlib_reference_resource_files()) are included in the iteration.  For
3330  * example, if @p wim represents just one part of a split WIM, then only
3331  * resources in that part will be included, unless other resources were
3332  * explicitly referenced.
3333  *
3334  * @param wim
3335  *      Pointer to the ::WIMStruct to query.  This need not represent a
3336  *      standalone WIM (e.g. it could represent part of a split WIM).
3337  *
3338  * @param flags
3339  *      Reserved; set to 0.
3340  *
3341  * @param cb
3342  *      A callback function that will receive each resource.
3343  *
3344  * @param user_ctx
3345  *      An extra parameter that will always be passed to the callback function
3346  *      @p cb.
3347  *
3348  * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
3349  * that was returned from @p cb.
3350  */
3351 extern int
3352 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
3353                             wimlib_iterate_lookup_table_callback_t cb,
3354                             void *user_ctx);
3355
3356 /**
3357  * @ingroup G_nonstandalone_wims
3358  *
3359  * Joins a split WIM into a stand-alone one-part WIM.
3360  *
3361  * @param swms
3362  *      An array of strings that gives the filenames of all parts of the split
3363  *      WIM.  No specific order is required, but all parts must be included with
3364  *      no duplicates.
3365  * @param num_swms
3366  *      Number of filenames in @p swms.
3367  * @param swm_open_flags
3368  *      Open flags for the split WIM parts (e.g.
3369  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY).
3370  * @param wim_write_flags
3371  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
3372  *      be used to write the joined WIM.
3373  * @param output_path
3374  *      The path to write the joined WIM file to.
3375  *
3376  * @return 0 on success; nonzero on error.  This function may return most error
3377  * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
3378  * as the following error code:
3379  *
3380  * @retval ::WIMLIB_ERR_SPLIT_INVALID
3381  *      The split WIMs do not form a valid WIM because they do not include all
3382  *      the parts of the original WIM, there are duplicate parts, or not all the
3383  *      parts have the same GUID and compression type.
3384  *
3385  * Note: wimlib is generalized enough that this function is not actually needed
3386  * to join a split WIM; instead, you could open the first part of the split WIM,
3387  * then reference the other parts with wimlib_reference_resource_files(), then
3388  * write the joined WIM using wimlib_write().  However, wimlib_join() provides
3389  * an easy-to-use wrapper around this that has some advantages (e.g.  extra
3390  * sanity checks).
3391  */
3392 extern int
3393 wimlib_join(const wimlib_tchar * const *swms,
3394             unsigned num_swms,
3395             const wimlib_tchar *output_path,
3396             int swm_open_flags,
3397             int wim_write_flags);
3398
3399 /**
3400  * @ingroup G_nonstandalone_wims
3401  *
3402  * Same as wimlib_join(), but allows specifying a progress function.  The
3403  * progress function will receive the write progress messages, such as
3404  * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS, while writing the joined WIM.  In
3405  * addition, if ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p
3406  * swm_open_flags, the progress function will receive a series of
3407  * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY messages when each of the split WIM
3408  * parts is opened.
3409  */
3410 extern int
3411 wimlib_join_with_progress(const wimlib_tchar * const *swms,
3412                           unsigned num_swms,
3413                           const wimlib_tchar *output_path,
3414                           int swm_open_flags,
3415                           int wim_write_flags,
3416                           wimlib_progress_func_t progfunc,
3417                           void *progctx);
3418
3419
3420 /**
3421  * @ingroup G_mounting_wim_images
3422  *
3423  * Mounts an image from a WIM file on a directory read-only or read-write.
3424  *
3425  * @param wim
3426  *      Pointer to the ::WIMStruct containing the image to be mounted.
3427  * @param image
3428  *      The 1-based index of the image to mount.
3429  * @param dir
3430  *      The path to an existing empty directory on which to mount the WIM image.
3431  * @param mount_flags
3432  *      Bitwise OR of flags prefixed with WIMLIB_MOUNT_FLAG.  Use
3433  *      ::WIMLIB_MOUNT_FLAG_READWRITE to request a read-write mount instead of a
3434  *      read-only mount.
3435  * @param staging_dir
3436  *      If non-NULL, the name of a directory in which a temporary directory for
3437  *      storing modified or added files will be created.  Ignored if
3438  *      ::WIMLIB_MOUNT_FLAG_READWRITE is not specified in @p mount_flags.  If
3439  *      left @c NULL, the staging directory is created in the same directory as
3440  *      the WIM file that @p wim was originally read from.  The staging
3441  *      directory is automatically deleted when the image is unmounted.
3442  *
3443  * @return 0 on success; nonzero on error.  The possible error codes include:
3444  *
3445  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3446  *      An image from the WIM file is already mounted read-write, or another
3447  *      process is currently appending data to the WIM file.
3448  * @retval ::WIMLIB_ERR_FUSE
3449  *      A non-zero status code was returned by @c fuse_main().
3450  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3451  *      @p image does not specify an existing, single image in @p wim.
3452  * @retval ::WIMLIB_ERR_INVALID_PARAM
3453  *      @p wim was @c NULL; or @p dir was NULL or an empty string; or an
3454  *      unrecognized flag was specified in @p mount_flags; or the WIM image has
3455  *      already been modified in memory (e.g. by wimlib_update_image()).
3456  * @retval ::WIMLIB_ERR_MKDIR
3457  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3458  *      staging directory could not be created.
3459  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3460  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
3461  *      WIM file is considered read-only because of any of the reasons mentioned
3462  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3463  * @retval ::WIMLIB_ERR_UNSUPPORTED
3464  *      Mounting is not supported in this build of the library.
3465  *
3466  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3467  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3468  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3469  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3470  * different reasons) to read the metadata resource for the image to mount.
3471  *
3472  * The ability to mount WIM image is implemented using FUSE (Filesystem in
3473  * UserSpacE).  Depending on how FUSE is set up on your system, this function
3474  * may work as normal users in addition to the root user.
3475  *
3476  * Mounting WIM images is not supported if wimlib was configured
3477  * <code>--without-fuse</code>.  This includes Windows builds of wimlib;
3478  * ::WIMLIB_ERR_UNSUPPORTED will be returned in such cases.
3479  *
3480  * Calling this function daemonizes the process, unless
3481  * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early error occurs.
3482  *
3483  * It is safe to mount multiple images from the same underlying WIM file
3484  * read-only at the same time, but only if different ::WIMStruct's are used.  It
3485  * is @b not safe to mount multiple images from the same WIM file read-write at
3486  * the same time.
3487  *
3488  * To unmount the image, call wimlib_unmount_image().  This may be done in a
3489  * different process.
3490  */
3491 extern int
3492 wimlib_mount_image(WIMStruct *wim,
3493                    int image,
3494                    const wimlib_tchar *dir,
3495                    int mount_flags,
3496                    const wimlib_tchar *staging_dir);
3497
3498 /**
3499  * @ingroup G_creating_and_opening_wims
3500  *
3501  * Opens a WIM file and creates a ::WIMStruct for it.
3502  *
3503  * @param wim_file
3504  *      The path to the WIM file to open.
3505  *
3506  * @param open_flags
3507  *      Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
3508  *
3509  * @param wim_ret
3510  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
3511  *      is written to the memory location pointed to by this parameter.  The
3512  *      ::WIMStruct must be freed using using wimlib_free() when finished with
3513  *      it.
3514  *
3515  * @return 0 on success; nonzero on error.
3516  * @retval ::WIMLIB_ERR_IMAGE_COUNT
3517  *      The number of metadata resources found in the WIM did not match the
3518  *      image count specified in the WIM header, or the number of &lt;IMAGE&gt;
3519  *      elements in the XML data of the WIM did not match the image count
3520  *      specified in the WIM header.
3521  * @retval ::WIMLIB_ERR_INTEGRITY
3522  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3523  *      the WIM contained an integrity table, but the SHA1 message digest for a
3524  *      chunk of the WIM did not match the corresponding value in the integrity
3525  *      table.
3526  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
3527  *      The library did not recognize the compression chunk size of the WIM as
3528  *      valid for its compression type.
3529  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
3530  *      The library did not recognize the compression type of the WIM.
3531  * @retval ::WIMLIB_ERR_INVALID_HEADER
3532  *      The header of the WIM was otherwise invalid.
3533  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
3534  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and
3535  *      the WIM contained an integrity table, but the integrity table was
3536  *      invalid.
3537  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
3538  *      The lookup table of the WIM was invalid.
3539  * @retval ::WIMLIB_ERR_INVALID_PARAM
3540  *      @p wim_ret was @c NULL; or, @p wim_file was not a nonempty string.
3541  * @retval ::WIMLIB_ERR_IS_SPLIT_WIM
3542  *      The WIM was a split WIM and ::WIMLIB_OPEN_FLAG_ERROR_IF_SPLIT was
3543  *      specified in @p open_flags.
3544  * @retval ::WIMLIB_ERR_NOMEM
3545  *      Failed to allocated needed memory.
3546  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
3547  *      The file did not begin with the magic characters that identify a WIM
3548  *      file.
3549  * @retval ::WIMLIB_ERR_OPEN
3550  *      Failed to open the WIM file for reading.  Some possible reasons: the WIM
3551  *      file does not exist, or the calling process does not have permission to
3552  *      open it.
3553  * @retval ::WIMLIB_ERR_READ
3554  *      Failed to read data from the WIM file.
3555  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
3556  *      Unexpected end-of-file while reading data from the WIM file.
3557  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
3558  *      The WIM version number was not recognized. (May be a pre-Vista WIM.)
3559  * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
3560  *      The WIM cannot be opened because it contains encrypted segments.  (It
3561  *      may be a Windows 8 "ESD" file.)
3562  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3563  *      ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
3564  *      considered read-only because of any of the reasons mentioned in the
3565  *      documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3566  * @retval ::WIMLIB_ERR_XML
3567  *      The XML data of the WIM was invalid.
3568  */
3569 extern int
3570 wimlib_open_wim(const wimlib_tchar *wim_file,
3571                 int open_flags,
3572                 WIMStruct **wim_ret);
3573
3574 /**
3575  * @ingroup G_creating_and_opening_wims
3576  *
3577  * Same as wimlib_open_wim(), but allows specifying a progress function and
3578  * progress context.  If successful, the progress function will be registered in
3579  * the newly open ::WIMStruct, as if by an automatic call to
3580  * wimlib_register_progress_function().  In addition, if
3581  * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is specified in @p open_flags, the
3582  * progress function will receive ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY
3583  * messages while checking the WIM file's integrity.
3584  */
3585 extern int
3586 wimlib_open_wim_with_progress(const wimlib_tchar *wim_file,
3587                               int open_flags,
3588                               WIMStruct **wim_ret,
3589                               wimlib_progress_func_t progfunc,
3590                               void *progctx);
3591
3592 /**
3593  * @ingroup G_writing_and_overwriting_wims
3594  *
3595  * Overwrites the file that the WIM was originally read from, with changes made.
3596  * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
3597  * rather than wimlib_create_new_wim().
3598  *
3599  * There are two ways that a WIM may be overwritten.  The first is to do a full
3600  * rebuild.  In this mode, the new WIM is written to a temporary file and then
3601  * renamed to the original file after it is has been completely written.  The
3602  * temporary file is made in the same directory as the original WIM file.  A
3603  * full rebuild may take a while, but it will save space by producing a WIM with
3604  * no "holes".
3605  *
3606  * The second way to overwrite a WIM is by appending to the end of it and
3607  * overwriting the header.  This can be much faster than a full rebuild, but the
3608  * disadvantage is that some space will be wasted.  Writing a WIM in this mode
3609  * begins with writing any new file resources *after* everything in the old WIM,
3610  * even though this will leave a hole where the old lookup table, XML data, and
3611  * integrity were.  This is done so that the WIM remains valid even if the
3612  * operation is aborted mid-write.  The WIM header is only overwritten at the
3613  * very last moment, and up until that point the WIM will be seen as the old
3614  * version.
3615  *
3616  * By default, wimlib_overwrite() does the append-style overwrite described
3617  * above, unless resources in the WIM are arranged in an unusual way or if
3618  * images have been deleted from the WIM.  Use the flag
3619  * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
3620  * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
3621  * images have been deleted from the WIM.
3622  *
3623  * If this function completes successfully, no more functions should be called
3624  * on @p wim other than wimlib_free().  If you need to continue using the WIM,
3625  * you must use wimlib_open_wim() to read it anew.
3626  *
3627  * @param wim
3628  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
3629  *      been in-memory changes made to it, which are then reflected in the
3630  *      output file.
3631  * @param write_flags
3632  *      Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
3633  * @param num_threads
3634  *      Number of threads to use for compression, or 0 for the default. (See
3635  *      wimlib_write().)
3636  *
3637  * @return 0 on success; nonzero on error.  This function may return most error
3638  * codes returned by wimlib_write() as well as the following error codes:
3639  *
3640  * @retval ::WIMLIB_ERR_ALREADY_LOCKED
3641  *      The WIM was going to be modified in-place (with no temporary file), but
3642  *      an exclusive advisory lock on the on-disk WIM file could not be acquired
3643  *      because another thread or process has mounted an image from the WIM
3644  *      read-write or is currently modifying the WIM in-place.
3645  * @retval ::WIMLIB_ERR_NO_FILENAME
3646  *      @p wim corresponds to a ::WIMStruct created with wimlib_create_new_wim()
3647  *      rather than a WIM read with wimlib_open_wim().
3648  * @retval ::WIMLIB_ERR_RENAME
3649  *      The temporary file that the WIM was written to could not be renamed to
3650  *      the original filename of @p wim.
3651  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3652  *      The WIM file is considered read-only because of any of the reasons
3653  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3654  *      flag.
3655  *
3656  * If a progress function is registered with @p wim, it will receive the
3657  * messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
3658  * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN, and
3659  * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END.
3660  */
3661 extern int
3662 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads);
3663
3664 /**
3665  * @ingroup G_wim_information
3666  *
3667  * Prints information about one image, or all images, contained in a WIM.
3668  *
3669  * @param wim
3670  *      Pointer to the ::WIMStruct to query.  This need not represent a
3671  *      standalone WIM (e.g. it could represent part of a split WIM).
3672  * @param image
3673  *      The image about which to print information.  Can be the number of an
3674  *      image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
3675  *      WIM.
3676  *
3677  * @return This function has no return value.  No error checking is done when
3678  * printing the information.  If @p image is invalid, an error message is
3679  * printed.
3680  */
3681 extern void
3682 wimlib_print_available_images(const WIMStruct *wim, int image);
3683
3684 /**
3685  * @ingroup G_wim_information
3686  *
3687  * Deprecated in favor of wimlib_get_wim_info(), which provides the information
3688  * in a way that can be accessed programatically.
3689  */
3690 extern void
3691 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
3692
3693 /**
3694  * @ingroup G_nonstandalone_wims
3695  *
3696  * Reference resources from other WIM files or split WIM parts.  This function
3697  * can be used on WIMs that are not standalone, such as split or "delta" WIMs,
3698  * to load needed resources (that is, "streams" keyed by SHA1 message digest)
3699  * from other files, before calling a function such as wimlib_extract_image()
3700  * that requires the resources to be present.
3701  *
3702  * @param wim
3703  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
3704  *      necessarily "standalone".  In the case of split WIMs, this should be the
3705  *      first part, since only the first part contains the metadata resources.
3706  *      In the case of delta WIMs, this should be the delta WIM rather than the
3707  *      WIM on which it is based.
3708  * @param resource_wimfiles_or_globs
3709  *      Array of paths to WIM files and/or split WIM parts to reference.
3710  *      Alternatively, when ::WIMLIB_REF_FLAG_GLOB_ENABLE is specified in @p
3711  *      ref_flags, these are treated as globs rather than literal paths.  That
3712  *      is, using this function you can specify zero or more globs, each of
3713  *      which expands to one or more literal paths.
3714  * @param count
3715  *      Number of entries in @p resource_wimfiles_or_globs.
3716  * @param ref_flags
3717  *      Bitwise OR of ::WIMLIB_REF_FLAG_GLOB_ENABLE and/or
3718  *      ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH.
3719  * @param open_flags
3720  *      Additional open flags, such as ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY, to
3721  *      pass to internal calls to wimlib_open_wim() on the reference files.
3722  *
3723  * @return 0 on success; nonzero on error.
3724  *
3725  * @retval ::WIMLIB_ERR_GLOB_HAD_NO_MATCHES
3726  *      One of the specified globs did not match any paths (only with both
3727  *      ::WIMLIB_REF_FLAG_GLOB_ENABLE and ::WIMLIB_REF_FLAG_GLOB_ERR_ON_NOMATCH
3728  *      specified in @p ref_flags).
3729  * @retval ::WIMLIB_ERR_NOMEM
3730  *      Failed to allocate memory.
3731  * @retval ::WIMLIB_ERR_READ
3732  *      I/O or permissions error while processing a file glob.
3733  *
3734  * This function can additionally return most values that can be returned by
3735  * wimlib_open_wim().
3736  */
3737 extern int
3738 wimlib_reference_resource_files(WIMStruct *wim,
3739                                 const wimlib_tchar * const *resource_wimfiles_or_globs,
3740                                 unsigned count,
3741                                 int ref_flags,
3742                                 int open_flags);
3743
3744 /**
3745  * @ingroup G_nonstandalone_wims
3746  *
3747  * Similar to wimlib_reference_resource_files(), but operates at a lower level
3748  * where the caller must open the ::WIMStruct for each referenced file itself.
3749  *
3750  * @param wim
3751  *      The ::WIMStruct for a WIM that contains metadata resources, but is not
3752  *      necessarily "standalone".  In the case of split WIMs, this should be the
3753  *      first part, since only the first part contains the metadata resources.
3754  * @param resource_wims
3755  *      Array of pointers to the ::WIMStruct's for additional resource WIMs or
3756  *      split WIM parts to reference.
3757  * @param num_resource_wims
3758  *      Number of entries in @p resource_wims.
3759  * @param ref_flags
3760  *      Currently ignored (set to 0).
3761  *
3762  * @return 0 on success; nonzero on error.  On success, the ::WIMStruct's of the
3763  * @p resource_wims are referenced internally by @p wim and must not be freed
3764  * with wimlib_free() or overwritten with wimlib_overwrite() until @p wim has
3765  * been freed with wimlib_free(), or immediately before freeing @p wim with
3766  * wimlib_free().
3767  *
3768  * @retval ::WIMLIB_ERR_INVALID_PARAM
3769  *      @p wim was @c NULL, or @p num_resource_wims was nonzero but @p
3770  *      resource_wims was @c NULL, or an entry in @p resource_wims was @p NULL.
3771  * @retval ::WIMLIB_ERR_NOMEM
3772  *      Failed to allocate memory.
3773  */
3774 extern int
3775 wimlib_reference_resources(WIMStruct *wim, WIMStruct **resource_wims,
3776                            unsigned num_resource_wims, int ref_flags);
3777
3778 /**
3779  * @ingroup G_modifying_wims
3780  *
3781  * Declares that a newly added image is mostly the same as a prior image, but
3782  * captured at a later point in time, possibly with some modifications in the
3783  * intervening time.  This is designed to be used in incremental backups of the
3784  * same filesystem or directory tree.
3785  *
3786  * This function compares the metadata of the directory tree of the newly added
3787  * image against that of the old image.  Any files that are present in both the
3788  * newly added image and the old image and have timestamps that indicate they
3789  * haven't been modified are deemed not to have been modified and have their
3790  * SHA1 message digest copied from the old image.  Because of this and because
3791  * WIM uses single-instance streams, such files need not be read from the
3792  * filesystem when the WIM is being written or overwritten.  Note that these
3793  * unchanged files will still be "archived" and will be logically present in the
3794  * new image; the optimization is that they don't need to actually be read from
3795  * the filesystem because the WIM already contains them.
3796  *
3797  * This function is provided to optimize incremental backups.  The resulting WIM
3798  * file will still be the same regardless of whether this function is called.
3799  * (This is, however, assuming that timestamps have not been manipulated or
3800  * unmaintained as to trick this function into thinking a file has not been
3801  * modified when really it has.  To partly guard against such cases, other
3802  * metadata such as file sizes will be checked as well.)
3803  *
3804  * This function must be called after adding the new image (e.g. with
3805  * wimlib_add_image()), but before writing the updated WIM file (e.g. with
3806  * wimlib_overwrite()).
3807  *
3808  * @param wim
3809  *      Pointer to the ::WIMStruct for a WIM.
3810  * @param new_image
3811  *      1-based index in the WIM of the newly added image.  This image can have
3812  *      been added with wimlib_add_image() or wimlib_add_image_multisource(), or
3813  *      wimlib_add_empty_image() followed by wimlib_update_image().
3814  * @param template_wim
3815  *      The ::WIMStruct for the WIM containing the template image.  This can be
3816  *      the same as @p wim, or it can be a different ::WIMStruct.
3817  * @param template_image
3818  *      1-based index in the WIM of a template image that reflects a prior state
3819  *      of the directory tree being captured.
3820  * @param flags
3821  *      Reserved; must be 0.
3822  *
3823  * @return 0 on success; nonzero on error.
3824  *
3825  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3826  *      @p new_image and/or @p template_image were not a valid image indices in
3827  *      the WIM.
3828  * @retval ::WIMLIB_ERR_METADATA_NOT_FOUND
3829  *      The specified ::WIMStruct did not actually contain the metadata resource
3830  *      for the new or template image; for example, it was a non-first part of a
3831  *      split WIM.
3832  * @retval ::WIMLIB_ERR_NOMEM
3833  *      Failed to allocate needed memory.
3834  * @retval ::WIMLIB_ERR_INVALID_PARAM
3835  *      @p new_image was equal to @p template_image, or @p new_image specified
3836  *      an image that had not been modified since opening the WIM.
3837  *
3838  * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
3839  * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_METADATA_NOT_FOUND,
3840  * ::WIMLIB_ERR_NOMEM, ::WIMLIB_ERR_READ, or
3841  * ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which indicate failure (for
3842  * different reasons) to read the metadata resource for the template image.
3843  */
3844 extern int
3845 wimlib_reference_template_image(WIMStruct *wim, int new_image,
3846                                 WIMStruct *template_wim, int template_image,
3847                                 int flags);
3848
3849 /**
3850  * @ingroup G_general
3851  *
3852  * Registers a progress function with a ::WIMStruct.
3853  *
3854  * @param wim
3855  *      The ::WIMStruct for which to register the progress function.
3856  * @param progfunc
3857  *      Pointer to the progress function to register.  If the WIM already has a
3858  *      progress function registered, it will be replaced with this one.  If @p
3859  *      NULL, the current progress function (if any) will be unregistered.
3860  * @param progctx
3861  *      The value which will be passed as the third argument to calls to @p
3862  *      progfunc.
3863  */
3864 extern void
3865 wimlib_register_progress_function(WIMStruct *wim,
3866                                   wimlib_progress_func_t progfunc,
3867                                   void *progctx);
3868
3869 /**
3870  * @ingroup G_modifying_wims
3871  *
3872  * Rename the @p source_path to the @p dest_path in the specified @p image of
3873  * the @p wim.
3874  *
3875  * This just builds an appropriate ::wimlib_rename_command and passes it to
3876  * wimlib_update_image().
3877  */
3878 extern int
3879 wimlib_rename_path(WIMStruct *wim, int image,
3880                    const wimlib_tchar *source_path, const wimlib_tchar *dest_path);
3881
3882 /**
3883  * @ingroup G_wim_information
3884  *
3885  * Translates a string specifying the name or number of an image in the WIM into
3886  * the number of the image.  The images are numbered starting at 1.
3887  *
3888  * @param wim
3889  *      Pointer to the ::WIMStruct for a WIM.
3890  * @param image_name_or_num
3891  *      A string specifying the name or number of an image in the WIM.  If it
3892  *      parses to a positive integer, this integer is taken to specify the
3893  *      number of the image, indexed starting at 1.  Otherwise, it is taken to
3894  *      be the name of an image, as given in the XML data for the WIM file.  It
3895  *      also may be the keyword "all" or the string "*", both of which will
3896  *      resolve to ::WIMLIB_ALL_IMAGES.
3897  *      <br/> <br/>
3898  *      There is no way to search for an image actually named "all", "*", or an
3899  *      integer number, or an image that has no name.  However, you can use
3900  *      wimlib_get_image_name() to get the name of any image.
3901  *
3902  * @return
3903  *      If the string resolved to a single existing image, the number of that
3904  *      image, indexed starting at 1, is returned.  If the keyword "all" or "*"
3905  *      was specified, ::WIMLIB_ALL_IMAGES is returned.  Otherwise,
3906  *      ::WIMLIB_NO_IMAGE is returned.  If @p image_name_or_num was @c NULL or
3907  *      the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
3908  *      images in @p wim has no name.
3909  */
3910 extern int
3911 wimlib_resolve_image(WIMStruct *wim,
3912                      const wimlib_tchar *image_name_or_num);
3913
3914 /**
3915  * @ingroup G_general
3916  *
3917  * Sets the file to which the library will print error and warning messages.
3918  *
3919  * This version of the function takes a C library <c>FILE *</c> opened for
3920  * writing (or appending).  Use wimlib_set_error_file_by_name() to specify the
3921  * file by name instead.
3922  *
3923  * This also enables error messages, as if by a call to
3924  * wimlib_set_print_errors(true).
3925  *
3926  * @return 0 on success; nonzero on error.
3927  * @retval ::WIMLIB_ERR_UNSUPPORTED
3928  *      wimlib was compiled using the <c>--without-error-messages</c> option.
3929  */
3930 extern int
3931 wimlib_set_error_file(FILE *fp);
3932
3933 /**
3934  * @ingroup G_general
3935  *
3936  * Sets the path to the file to which the library will print error and warning
3937  * messages.  The library will open this file for appending.
3938  *
3939  * This also enables error messages, as if by a call to
3940  * wimlib_set_print_errors(true).
3941  *
3942  * @return 0 on success; nonzero on error.
3943  * @retval ::WIMLIB_ERR_OPEN
3944  *      The file named by @p path could not be opened for appending.
3945  * @retval ::WIMLIB_ERR_UNSUPPORTED
3946  *      wimlib was compiled using the <c>--without-error-messages</c> option.
3947  */
3948 extern int
3949 wimlib_set_error_file_by_name(const wimlib_tchar *path);
3950
3951 /**
3952  * @ingroup G_modifying_wims
3953  *
3954  * Changes the description of an image in the WIM.
3955  *
3956  * @param wim
3957  *      Pointer to the ::WIMStruct for a WIM.
3958  * @param image
3959  *      The number of the image for which to change the description.
3960  * @param description
3961  *      The new description to give the image.  It may be @c NULL, which
3962  *      indicates that the image is to be given no description.
3963  *
3964  * @return 0 on success; nonzero on error.
3965  * @retval ::WIMLIB_ERR_INVALID_IMAGE
3966  *      @p image does not specify a single existing image in @p wim.
3967  * @retval ::WIMLIB_ERR_NOMEM
3968  *      Failed to allocate the memory needed to duplicate the @p description
3969  *      string.
3970  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3971  *      @p wim is considered read-only because of any of the reasons mentioned
3972  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
3973  */
3974 extern int
3975 wimlib_set_image_descripton(WIMStruct *wim, int image,
3976                             const wimlib_tchar *description);
3977
3978 /**
3979  * @ingroup G_writing_and_overwriting_wims
3980  *
3981  * Set the compression chunk size of a WIM to use in subsequent calls to
3982  * wimlib_write() or wimlib_overwrite().
3983  *
3984  * A larger compression chunk size will likely result in a better compression
3985  * ratio, but the speed of random access to the WIM will be reduced.
3986  * Furthermore, the effect of a larger compression chunk size is limited by the
3987  * size of each stream ("file") being compressed.
3988  *
3989  * @param wim
3990  *      ::WIMStruct for a WIM.
3991  * @param chunk_size
3992  *      The chunk size (in bytes) to set.  The valid chunk sizes are dependent
3993  *      on the compression format.  See the documentation for each
3994  *      ::wimlib_compression_type constant for more information.  As a special
3995  *      case, if @p chunk_size is specified as 0, the chunk size is set to the
3996  *      default for the currently selected output compression type.
3997  *
3998  * @return 0 on success; nonzero on error.
3999  *
4000  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
4001  *      @p chunk_size is not a supported chunk size for the currently selected
4002  *      output compression type.
4003  */
4004 extern int
4005 wimlib_set_output_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4006
4007 /**
4008  * @ingroup G_writing_and_overwriting_wims
4009  *
4010  * Similar to wimlib_set_output_chunk_size(), but set the chunk size for writing
4011  * packed streams (solid blocks).
4012  */
4013 extern int
4014 wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
4015
4016 /**
4017  * @ingroup G_writing_and_overwriting_wims
4018  *
4019  * Set the compression type of a WIM to use in subsequent calls to
4020  * wimlib_write() or wimlib_overwrite().
4021  *
4022  * @param wim
4023  *      ::WIMStruct for a WIM.
4024  * @param ctype
4025  *      The compression type to set (one of ::wimlib_compression_type).  If this
4026  *      compression type is incompatible with the current output chunk size
4027  *      (either the default or as set with wimlib_set_output_chunk_size()), the
4028  *      output chunk size is reset to the default for that compression type.
4029  *
4030  * @return 0 on success; nonzero on error.
4031  *
4032  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
4033  *      @p ctype did not specify a valid compression type.
4034  */
4035 extern int
4036 wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
4037
4038 /**
4039  * @ingroup G_writing_and_overwriting_wims
4040  *
4041  * Similar to wimlib_set_output_compression_type(), but set the compression type
4042  * for writing packed streams (solid blocks).
4043  */
4044 extern int
4045 wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
4046
4047 /**
4048  * @ingroup G_modifying_wims
4049  *
4050  * Set basic information about a WIM.
4051  *
4052  * @param wim
4053  *      Pointer to the ::WIMStruct for a WIM.
4054  * @param info
4055  *      A struct ::wimlib_wim_info that contains the information to set.  Only
4056  *      the information explicitly specified in the @p which flags need be
4057  *      valid.
4058  * @param which
4059  *      Flags that specify which information to set.  This is a bitwise OR of
4060  *      ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
4061  *      ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
4062  *
4063  * @return 0 on success; nonzero on failure.
4064  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4065  *      The WIM file is considered read-only because of any of the reasons
4066  *      mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
4067  *      flag.  However, as a special case, if you are using
4068  *      ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
4069  *      function will not fail due to the readonly flag being previously set.
4070  * @retval ::WIMLIB_ERR_IMAGE_COUNT
4071  *      ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
4072  *      ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
4073  *      index in the WIM.
4074  */
4075 extern int
4076 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
4077                     int which);
4078
4079 /**
4080  * @ingroup G_modifying_wims
4081  *
4082  * Changes what is written in the \<FLAGS\> element in the WIM XML data
4083  * (something like "Core" or "Ultimate")
4084  *
4085  * @param wim
4086  *      Pointer to the ::WIMStruct for a WIM.
4087  * @param image
4088  *      The number of the image for which to change the description.
4089  * @param flags
4090  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
4091  *      indicates that the image is to be given no \<FLAGS\> element.
4092  *
4093  * @return 0 on success; nonzero on error.
4094  * @retval ::WIMLIB_ERR_INVALID_IMAGE
4095  *      @p image does not specify a single existing image in @p wim.
4096  * @retval ::WIMLIB_ERR_NOMEM
4097  *      Failed to allocate the memory needed to duplicate the @p flags string.
4098  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
4099  *      @p wim is considered read-only because of any of the reasons mentioned
4100  *      in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
4101  */
4102 extern int
4103 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
4104
4105 /**
4106  * @ingroup G_modifying_wims
4107  *