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