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