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