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