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