4 * External header for wimlib.
6 * This file contains extensive comments for generating documentation with
7 * Doxygen. The built HTML documentation can be viewed at
8 * http://wimlib.sourceforge.net.
12 * Copyright (C) 2012, 2013 Eric Biggers
14 * This file is part of wimlib, a library for working with WIM files.
16 * wimlib is free software; you can redistribute it and/or modify it under the
17 * terms of the GNU General Public License as published by the Free
18 * Software Foundation; either version 3 of the License, or (at your option)
21 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23 * A PARTICULAR PURPOSE. See the GNU General Public License for more
26 * You should have received a copy of the GNU General Public License
27 * along with wimlib; if not, see http://www.gnu.org/licenses/.
32 * \section intro Introduction
34 * This is the documentation for the library interface of wimlib 1.5.0, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the README file.
40 * \section starting Getting Started
42 * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43 * install with <code>configure && make && sudo make install</code>; however,
44 * please see the README for more information about installing it. To use
45 * wimlib in a program after installing it, include @c wimlib.h and link your
46 * program with @c -lwim.
48 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
49 * may represent either a stand-alone WIM or one part of a split WIM.
51 * All functions in wimlib's public API are prefixed with @c wimlib. Most
52 * return 0 on success and a positive error code on failure. Use
53 * wimlib_get_error_string() to get a string that describes an error code.
54 * wimlib also can print error messages itself when an error happens, and these
55 * may be more informative than the error code; to enable this, call
56 * wimlib_set_print_errors(). Please note that this is for convenience only,
57 * and some errors can occur without a message being printed.
59 * First before calling any other functions, you should call
60 * wimlib_global_init() to initialize the library.
62 * To open an existing WIM, use wimlib_open_wim().
64 * To create a new WIM that initially contains no images, use
65 * wimlib_create_new_wim().
67 * To add an image to a WIM file from a directory tree on your filesystem, call
68 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
69 * wimlib_open_wim() or from wimlib_create_new_wim(). On UNIX,
70 * wimlib_add_image() can also capture a WIM image directly from a block device
71 * containing a NTFS filesystem.
73 * To extract an image from a WIM file, call wimlib_extract_image(). This can
74 * be done either to a directory, or, on UNIX, directly to a block device
75 * containing a NTFS filesystem.
77 * To extract individual files or directories from a WIM image, rather than a
78 * full image, call wimlib_extract_files().
80 * To programatically make changes to a WIM image without mounting it, call
81 * wimlib_update_image().
83 * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84 * Mounting is done using wimlib_mount_image() and unmounting is done using
85 * wimlib_unmount_image(). Mounting can be done without root privileges because
86 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
87 * compiled with the <code>--without-fuse</code> flag, these functions will be
88 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
90 * After creating or modifying a WIM file, you can write it to a file using
91 * wimlib_write(). Alternatively, if the WIM was originally read from a file
92 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93 * wimlib_overwrite() to overwrite the original file. Still alternatively, you
94 * can write a WIM directly to a file descriptor by calling wimlib_write_to_fd()
97 * wimlib supports a special "pipable" WIM format (which unfortunately is @b not
98 * compatible with Microsoft's software). To create a pipable WIM, call
99 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
100 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
101 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
102 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
105 * Please note: merely by calling wimlib_add_image() or many of the other
106 * functions in this library that operate on ::WIMStruct's, you are @b not
107 * modifying the WIM file on disk. Changes are not saved until you explicitly
108 * call wimlib_write() or wimlib_overwrite().
110 * After you are done with the WIM file, use wimlib_free() to free all memory
111 * associated with a ::WIMStruct and close all files associated with it.
113 * When you are completely done with using wimlib in your program, you should
114 * call wimlib_global_cleanup().
116 * A number of functions take a pointer to a progress function of type
117 * ::wimlib_progress_func_t. This function will be called periodically during
118 * the WIM operation(s) to report on the progress of the operation (for example,
119 * how many bytes have been written so far).
121 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
122 * the following exceptions:
123 * - You must call wimlib_global_init() in one thread before calling any other
125 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
126 * race conditions with one-time allocations of memory.
127 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
128 * concurrently in the same process, will daemonize the entire process when it
129 * does so for the first time. This includes changing the working directory
130 * to the root directory.
132 * \section encodings Locales and character encodings
134 * To support Windows as well as UNIX, wimlib's API typically takes and returns
135 * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
137 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
138 * and the encoding is UTF-16LE.
140 * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
141 * encoding is the locale-dependent multibyte encoding. I recommend you set
142 * your locale to a UTF-8 capable locale to avoid any issues. Also, by default,
143 * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
144 * wimlib_global_init() after having set your desired locale.
146 * \section Limitations
148 * This section documents some technical limitations of wimlib not already
149 * documented in the man page for @b wimlib-imagex.
151 * - The old WIM format from Vista pre-releases is not supported.
152 * - Compressed resource chunk sizes other than 32768 are not supported. This
153 * doesn't seem to be a real problem because the chunk size always seems to be
155 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
156 * functionality other than that already present in @b ImageX, that allows you
157 * to make certain Windows-specific modifications to a Windows PE image, such
158 * as adding a driver or Windows component. Such a tool possibly could be
159 * implemented on top of wimlib.
168 #include <inttypes.h>
171 /** Major version of the library (for example, the 1 in 1.2.5). */
172 #define WIMLIB_MAJOR_VERSION 1
174 /** Minor version of the library (for example, the 2 in 1.2.5). */
175 #define WIMLIB_MINOR_VERSION 5
177 /** Patch version of the library (for example, the 5 in 1.2.5). */
178 #define WIMLIB_PATCH_VERSION 0
181 * Opaque structure that represents a WIM file. This is an in-memory structure
182 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
183 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
184 * continuing to exist so that data can be read from it as needed.
186 * Most functions in this library will work the same way regardless of whether a
187 * given ::WIMStruct was obtained through wimlib_open_wim() or
188 * wimlib_create_new_wim(). Exceptions are documented.
190 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
191 * file from a ::WIMStruct.
193 #ifndef WIMLIB_WIMSTRUCT_DECLARED
194 typedef struct WIMStruct WIMStruct;
195 #define WIMLIB_WIMSTRUCT_DECLARED
199 typedef wchar_t wimlib_tchar;
201 /** See \ref encodings */
202 typedef char wimlib_tchar;
206 /** Path separator for WIM paths passed back to progress callbacks. */
207 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
208 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
210 /** Path separator for WIM paths passed back to progress callbacks. */
211 # define WIMLIB_WIM_PATH_SEPARATOR '/'
212 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
216 # define _wimlib_deprecated __attribute__((deprecated))
218 # define _wimlib_deprecated
222 * Specifies the compression type of a WIM file.
224 enum wimlib_compression_type {
225 /** An invalid compression type. */
226 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
228 /** The WIM does not include any compressed resources. */
229 WIMLIB_COMPRESSION_TYPE_NONE = 0,
231 /** Compressed resources in the WIM use LZX compression. */
232 WIMLIB_COMPRESSION_TYPE_LZX = 1,
234 /** Compressed resources in the WIM use XPRESS compression. */
235 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
238 /** Possible values of the first parameter to the user-supplied
239 * ::wimlib_progress_func_t progress function */
240 enum wimlib_progress_msg {
242 /** A WIM image is about to be extracted. @a info will point to
243 * ::wimlib_progress_info.extract. */
244 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
246 /** A file or directory tree within a WIM image (not the full image) is
247 * about to be extracted. @a info will point to
248 * ::wimlib_progress_info.extract. */
249 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
251 /** The directory structure of the WIM image is about to be extracted.
252 * @a info will point to ::wimlib_progress_info.extract. */
253 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
255 /** The directory structure of the WIM image has been successfully
256 * extracted. @a info will point to ::wimlib_progress_info.extract. */
257 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
259 /** The WIM image's files resources are currently being extracted. @a
260 * info will point to ::wimlib_progress_info.extract. */
261 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
264 WIMLIB_PROGRESS_MSG_EXTRACT_RESERVED,
266 /** All the WIM files and directories have been extracted, and
267 * timestamps are about to be applied. @a info will point to
268 * ::wimlib_progress_info.extract. */
269 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
271 /** A WIM image has been successfully extracted. @a info will point to
272 * ::wimlib_progress_info.extract. */
273 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
275 /** A file or directory tree within a WIM image (not the full image) has
276 * been successfully extracted. @a info will point to
277 * ::wimlib_progress_info.extract. */
278 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
280 /** The directory or NTFS volume is about to be scanned to build a tree
281 * of WIM dentries in-memory. @a info will point to
282 * ::wimlib_progress_info.scan. */
283 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
285 /** A directory or file is being scanned. @a info will point to
286 * ::wimlib_progress_info.scan, and its @a cur_path member will be
287 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
288 * is passed to wimlib_add_image(). */
289 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
291 /** The directory or NTFS volume has been successfully scanned, and a
292 * tree of WIM dentries has been built in-memory. @a info will point to
293 * ::wimlib_progress_info.scan. */
294 WIMLIB_PROGRESS_MSG_SCAN_END,
297 * File resources are currently being written to the WIM.
298 * @a info will point to ::wimlib_progress_info.write_streams. */
299 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
302 * The metadata resource for each image is about to be written to the
303 * WIM. @a info will not be valid. */
304 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
307 * The metadata resource for each image has successfully been writen to
308 * the WIM. @a info will not be valid. */
309 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
312 * The temporary file has successfully been renamed to the original WIM
313 * file. Only happens when wimlib_overwrite() is called and the
314 * overwrite is not done in-place.
315 * @a info will point to ::wimlib_progress_info.rename. */
316 WIMLIB_PROGRESS_MSG_RENAME,
318 /** The contents of the WIM are being checked against the integrity
319 * table. Only happens when wimlib_open_wim() is called with the
320 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
321 * ::wimlib_progress_info.integrity. */
322 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
324 /** An integrity table is being calculated for the WIM being written.
325 * Only happens when wimlib_write() or wimlib_overwrite() is called with
326 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
327 * ::wimlib_progress_info.integrity. */
328 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
330 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
331 * but in wimlib v1.5.0 this was removed to simplify the code and now
332 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
333 WIMLIB_PROGRESS_MSG_RESERVED,
335 /** A wimlib_split() operation is in progress, and a new split part is
336 * about to be started. @a info will point to
337 * ::wimlib_progress_info.split. */
338 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
340 /** A wimlib_split() operation is in progress, and a split part has been
341 * finished. @a info will point to ::wimlib_progress_info.split. */
342 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
345 * A WIM update command is just about to be executed; @a info will point
346 * to ::wimlib_progress_info.update.
348 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
351 * A WIM update command has just been executed; @a info will point to
352 * ::wimlib_progress_info.update.
354 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
358 /** A pointer to this union is passed to the user-supplied
359 * ::wimlib_progress_func_t progress function. One (or none) of the structures
360 * contained in this union will be applicable for the operation
361 * (::wimlib_progress_msg) indicated in the first argument to the progress
363 union wimlib_progress_info {
365 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
366 * document them if they aren't given a name... */
368 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
369 struct wimlib_progress_info_write_streams {
370 /** Number of bytes that are going to be written for all the
371 * streams combined. This is the amount in uncompressed data.
372 * (The actual number of bytes will be less if the data is being
373 * written compressed.) */
374 uint64_t total_bytes;
376 /** Number of streams that are going to be written. */
377 uint64_t total_streams;
379 /** Number of uncompressed bytes that have been written so far.
380 * Will be 0 initially, and equal to @a total_bytes at the end.
382 uint64_t completed_bytes;
384 /** Number of streams that have been written. Will be 0
385 * initially, and equal to @a total_streams at the end. */
386 uint64_t completed_streams;
388 /** Number of threads that are being used to compress resources
389 * (if applicable). */
390 unsigned num_threads;
392 /** The compression type being used to write the streams; either
393 * ::WIMLIB_COMPRESSION_TYPE_NONE,
394 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
395 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
396 int compression_type;
398 /** Number of split WIM parts from which streams are being
399 * written (may be 0 if irrelevant). */
400 unsigned total_parts;
402 /** Number of split WIM parts from which streams have been
403 * written (may be 0 if irrelevant). */
404 unsigned completed_parts;
407 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
408 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
409 struct wimlib_progress_info_scan {
410 /** Directory or NTFS volume that is being scanned. */
411 const wimlib_tchar *source;
413 /** Path to the file or directory that is about to be scanned,
414 * relative to the root of the image capture or the NTFS volume.
416 const wimlib_tchar *cur_path;
418 /** True iff @a cur_path is being excluded from the image
419 * capture due to the capture configuration file. */
422 /** Target path in the WIM. Only valid on messages
423 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
424 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
425 const wimlib_tchar *wim_target_path;
428 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
429 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
430 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
431 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
432 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
433 struct wimlib_progress_info_extract {
434 /** Number of the image being extracted (1-based). */
437 /** Flags passed to to wimlib_extract_image() */
440 /** Full path to the WIM file being extracted. */
441 const wimlib_tchar *wimfile_name;
443 /** Name of the image being extracted. */
444 const wimlib_tchar *image_name;
446 /** Directory or NTFS volume to which the image is being
448 const wimlib_tchar *target;
451 const wimlib_tchar *cur_path;
453 /** Number of bytes of uncompressed data that will be extracted.
454 * Takes into account hard links (they are not counted for each
456 uint64_t total_bytes;
458 /** Number of bytes that have been written so far. Will be 0
459 * initially, and equal to @a total_bytes at the end. */
460 uint64_t completed_bytes;
462 /** Number of streams that will be extracted. This may more or
463 * less than the number of "files" to be extracted due to
464 * special cases (hard links, symbolic links, and alternate data
466 uint64_t num_streams;
468 /** Path to the root dentry within the WIM for the tree that is
469 * being extracted. Will be the empty string when extracting a
471 const wimlib_tchar *extract_root_wim_source_path;
474 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
475 struct wimlib_progress_info_rename {
476 /** Name of the temporary file that the WIM was written to. */
477 const wimlib_tchar *from;
479 /** Name of the original WIM file to which the temporary file is
481 const wimlib_tchar *to;
484 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
485 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
486 struct wimlib_progress_info_update {
487 /** Pointer to the update command that will be executed or has
488 * just been executed. */
489 const struct wimlib_update_command *command;
491 /** Number of update commands that have been completed so far.
493 size_t completed_commands;
495 /** Number of update commands that are being executed as part of
496 * this call to wimlib_update_image(). */
497 size_t total_commands;
500 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
501 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
502 struct wimlib_progress_info_integrity {
503 /** Number of bytes from the end of the WIM header to the end of
504 * the lookup table (the area that is covered by the SHA1
505 * integrity checks.) */
506 uint64_t total_bytes;
508 /** Number of bytes that have been SHA1-summed so far. Will be
509 * 0 initially, and equal @a total_bytes at the end. */
510 uint64_t completed_bytes;
512 /** Number of chunks that the checksummed region is divided
514 uint32_t total_chunks;
516 /** Number of chunks that have been SHA1-summed so far. Will
517 * be 0 initially, and equal to @a total_chunks at the end. */
518 uint32_t completed_chunks;
520 /** Size of the chunks used for the integrity calculation. */
523 /** Filename of the WIM (only valid if the message is
524 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
525 const wimlib_tchar *filename;
528 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
529 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
530 struct wimlib_progress_info_split {
531 /** Total size of the original WIM's file and metadata resources
533 uint64_t total_bytes;
535 /** Number of bytes of file and metadata resources that have
536 * been copied out of the original WIM so far. Will be 0
537 * initially, and equal to @a total_bytes at the end. */
538 uint64_t completed_bytes;
540 /** Number of the split WIM part that is about to be started
541 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
542 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
543 unsigned cur_part_number;
545 /** Total number of split WIM parts that are being written. */
546 unsigned total_parts;
548 /** Name of the split WIM part that is about to be started
549 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
550 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
551 const wimlib_tchar *part_name;
555 /** A user-supplied function that will be called periodically during certain WIM
556 * operations. The first argument will be the type of operation that is being
557 * performed or is about to be started or has been completed. The second
558 * argument will be a pointer to one of a number of structures depending on the
559 * first argument. It may be @c NULL for some message types.
561 * The return value of the progress function is currently ignored, but it may do
562 * something in the future. (Set it to 0 for now.)
564 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
565 const union wimlib_progress_info *info);
567 /** An array of these structures is passed to wimlib_add_image_multisource() to
568 * specify the sources from which to create a WIM image. */
569 struct wimlib_capture_source {
570 /** Absolute or relative path to a file or directory on the external
571 * filesystem to be included in the WIM image. */
572 wimlib_tchar *fs_source_path;
574 /** Destination path in the WIM image. Leading and trailing slashes are
575 * ignored. The empty string or @c NULL means the root directory of the
577 wimlib_tchar *wim_target_path;
579 /** Reserved; set to 0. */
583 /** Structure that specifies a list of path patterns. */
584 struct wimlib_pattern_list {
585 /** Array of patterns. The patterns may be modified by library code,
586 * but the @a pats pointer itself will not. See the man page for
587 * <b>wimlib-imagex capture</b> for more information about allowed
591 /** Number of patterns in the @a pats array. */
594 /** Ignored; may be used by the calling code. */
595 size_t num_allocated_pats;
598 /** A structure that contains lists of wildcards that match paths to treat
599 * specially when capturing a WIM image. */
600 struct wimlib_capture_config {
601 /** Paths matching any pattern this list are excluded from being
602 * captured, except if the same path appears in @a
603 * exclusion_exception_pats. */
604 struct wimlib_pattern_list exclusion_pats;
606 /** Paths matching any pattern in this list are never excluded from
608 struct wimlib_pattern_list exclusion_exception_pats;
610 /** Reserved for future capture configuration options. */
611 struct wimlib_pattern_list reserved1;
613 /** Reserved for future capture configuration options. */
614 struct wimlib_pattern_list reserved2;
616 /** Library internal use only. */
617 wimlib_tchar *_prefix;
619 /** Library internal use only. */
620 size_t _prefix_num_tchars;
623 /** Set or unset the WIM header flag that marks it read-only
624 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
625 * ::wimlib_wim_info.is_marked_readonly member of the @a info parameter. This
626 * is distinct from basic file permissions; this flag can be set on a WIM file
627 * that is physically writable. If this flag is set, all further operations to
628 * modify the WIM will fail, except calling wimlib_overwrite() with
629 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
630 * allows you to set this flag persistently on the underlying WIM file.
632 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
634 /** Set the GUID (globally unique identifier) of the WIM file to the value
635 * specified in ::wimlib_wim_info.guid of the @a info parameter. */
636 #define WIMLIB_CHANGE_GUID 0x00000002
638 /** Change the bootable image of the WIM to the value specified in
639 * ::wimlib_wim_info.boot_index of the @a info parameter. */
640 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
642 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
643 * in ::wimlib_wim_info.has_rpfix of the @a info parameter. This flag generally
644 * indicates whether an image in the WIM has been captured with reparse-point
645 * fixups enabled. wimlib also treats this flag as specifying whether to do
646 * reparse-point fixups by default when capturing or applying WIM images. */
647 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
649 #define WIMLIB_GUID_LEN 16
651 /** General information about a WIM file. */
652 struct wimlib_wim_info {
654 /** Globally unique identifier for the WIM file. Note: all parts of a
655 * split WIM should have an identical value in this field. */
656 uint8_t guid[WIMLIB_GUID_LEN];
658 /** Number of images in the WIM. */
659 uint32_t image_count;
661 /** 1-based index of the bootable image in the WIM, or 0 if no image is
665 /** Version of the WIM file. */
666 uint32_t wim_version;
668 /** Chunk size used for compression. */
671 /** 1-based index of this part within a split WIM, or 1 if the WIM is
673 uint16_t part_number;
675 /** Total number of parts in the split WIM, or 1 if the WIM is
677 uint16_t total_parts;
679 /** One of the ::wimlib_compression_type values that specifies the
680 * method used to compress resources in the WIM. */
681 int32_t compression_type;
683 /** Size of the WIM file in bytes, excluding the XML data and integrity
685 uint64_t total_bytes;
687 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
688 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
689 * this will always be 0, even if the ::WIMStruct was written to
690 * somewhere by calling wimlib_write() with the
691 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
692 uint32_t has_integrity_table : 1;
694 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
695 * wimlib_create_new_wim(). */
696 uint32_t opened_from_file : 1;
698 /** 1 if the WIM is considered readonly for any reason. */
699 uint32_t is_readonly : 1;
701 /** 1 if reparse-point fixups are supposedly enabled for one or more
702 * images in the WIM. */
703 uint32_t has_rpfix : 1;
705 /** 1 if the WIM is marked as read-only. */
706 uint32_t is_marked_readonly : 1;
708 /** 1 if the WIM is part of a spanned set. */
709 uint32_t spanned : 1;
711 uint32_t write_in_progress : 1;
712 uint32_t metadata_only : 1;
713 uint32_t resource_only : 1;
715 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
716 uint32_t pipable : 1;
717 uint32_t reserved_flags : 22;
718 uint32_t reserved[9];
721 /** Information about a unique resource in the WIM file.
723 struct wimlib_resource_entry {
724 /** Uncompressed size of the resource in bytes. */
725 uint64_t uncompressed_size;
727 /** Compressed size of the resource in bytes. This will be the same as
728 * @a uncompressed_size if the resource is uncompressed. */
729 uint64_t compressed_size;
731 /** Offset, in bytes, of this resource from the start of the WIM file.
735 /** SHA1 message digest of the resource's uncompressed contents. */
736 uint8_t sha1_hash[20];
738 /** Which part number of the split WIM this resource is in. This should
739 * be the same as the part number provided by wimlib_get_wim_info(). */
740 uint32_t part_number;
742 /** Number of times this resource is referenced over all WIM images. */
743 uint32_t reference_count;
745 /** 1 if this resource is compressed. */
746 uint32_t is_compressed : 1;
748 /** 1 if this resource is a metadata resource rather than a file
750 uint32_t is_metadata : 1;
752 uint32_t is_free : 1;
753 uint32_t is_spanned : 1;
754 uint32_t reserved_flags : 28;
755 uint64_t reserved[4];
758 /** A stream of a file in the WIM. */
759 struct wimlib_stream_entry {
760 /** Name of the stream, or NULL if the stream is unnamed. */
761 const wimlib_tchar *stream_name;
762 /** Location, size, etc. of the stream within the WIM file. */
763 struct wimlib_resource_entry resource;
764 uint64_t reserved[4];
767 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
768 * Roughly, the information about a "file" in the WIM--- but really a directory
769 * entry ("dentry") because hard links are allowed. The hard_link_group_id
770 * field can be used to distinguish actual file inodes. */
771 struct wimlib_dir_entry {
772 /** Name of the file, or NULL if this file is unnamed (only possible for
773 * the root directory) */
774 const wimlib_tchar *filename;
776 /** 8.3 DOS name of this file, or NULL if this file has no such name.
778 const wimlib_tchar *dos_name;
780 /** Full path to this file within the WIM image. */
781 const wimlib_tchar *full_path;
783 /** Depth of this directory entry, where 0 is the root, 1 is the root's
784 * children, ..., etc. */
787 /** Pointer to the security descriptor for this file, in Windows
788 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
789 * security descriptor. */
790 const char *security_descriptor;
792 /** Length of the above security descriptor. */
793 size_t security_descriptor_size;
795 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
796 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
797 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
798 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
799 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
800 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
801 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
802 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
803 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
804 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
805 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
806 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
807 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
808 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
809 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
810 /** File attributes, such as whether the file is a directory or not.
811 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
812 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
813 * on other platforms. */
816 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
817 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
818 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
819 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
820 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
821 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
822 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
823 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
824 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
825 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
826 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
827 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
828 * attributes), this will give the reparse tag. This tells you whether
829 * the reparse point is a symbolic link, junction point, or some other,
830 * more unusual kind of reparse point. */
831 uint32_t reparse_tag;
833 /* Number of (hard) links to this file. */
836 /** Number of named data streams that this file has. Normally 0. */
837 uint32_t num_named_streams;
839 /** Roughly, the inode number of this file. However, it may be 0 if
840 * @a num_links == 1. */
841 uint64_t hard_link_group_id;
843 /** Time this file was created. */
844 struct timespec creation_time;
846 /** Time this file was last written to. */
847 struct timespec last_write_time;
849 /** Time this file was last accessed. */
850 struct timespec last_access_time;
851 uint64_t reserved[16];
853 /** Array of streams that make up this file. The first entry will
854 * always exist and will correspond to the unnamed data stream (default
855 * file contents), so it will have @a stream_name == @c NULL. There
856 * will then be @a num_named_streams additional entries that specify the
857 * named data streams, if any, each of which will have @a stream_name !=
859 struct wimlib_stream_entry streams[];
863 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
866 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
870 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
873 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
876 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
877 * just on the specified path. */
878 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
880 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
881 * itself; only its children (in the case of a non-empty directory) */
882 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
886 /*****************************
888 *****************************/
890 /** Directly capture a NTFS volume rather than a generic directory. This flag
891 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
892 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
893 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
895 /** Follow symlinks; archive and dump the files they point to. Cannot be used
896 * with ::WIMLIB_ADD_FLAG_NTFS. */
897 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
899 /** Call the progress function with the message
900 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
902 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
904 /** Mark the image being added as the bootable image of the WIM. */
905 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
907 /** Store the UNIX owner, group, and mode. This is done by adding a special
908 * alternate data stream to each regular file, symbolic link, and directory to
909 * contain this information. Please note that this flag is for convenience
910 * only; Microsoft's @a imagex.exe will not understand this special information.
911 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
912 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
914 /** Do not capture security descriptors. Only has an effect in NTFS capture
915 * mode, or in Win32 native builds. */
916 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
918 /** Fail immediately if the full security descriptor of any file or directory
919 * cannot be accessed. Only has an effect in Win32 native builds. The default
920 * behavior without this flag is to first try omitting the SACL from the
921 * security descriptor, then to try omitting the security descriptor entirely.
923 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
925 /** Call the progress function with the message
926 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
927 * capture. This is a subset of the messages provided by
928 * ::WIMLIB_ADD_FLAG_VERBOSE. */
929 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
931 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
932 * in the case of Windows) that point inside the directory being captured to
933 * instead be absolute relative to the directory being captured, rather than the
934 * current root; also exclude absolute symbolic links that point outside the
935 * directory tree being captured.
937 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
938 * the WIM header or if this is the first image being added.
939 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
940 * reparse point fixups enabled and currently cannot be unset. */
941 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
943 /** Don't do reparse point fixups. The default behavior is described in the
944 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
945 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
947 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
948 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
949 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
950 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
951 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
952 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
953 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
954 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
955 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
956 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
958 /******************************
959 * WIMLIB_DELETE_FLAG_*
960 ******************************/
962 /** Do not issue an error if the path to delete does not exist. */
963 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
965 /** Delete the file or directory tree recursively; if not specified, an error is
966 * issued if the path to delete is a directory. */
967 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
969 /******************************
970 * WIMLIB_EXPORT_FLAG_*
971 ******************************/
973 /** See documentation for wimlib_export_image(). */
974 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
976 /******************************
977 * WIMLIB_EXTRACT_FLAG_*
978 ******************************/
980 /** Extract the image directly to a NTFS volume rather than a generic directory.
982 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
984 /** When identical files are extracted from the WIM, always hard link them
985 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
986 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
988 /** When identical files are extracted from the WIM, always symlink them
989 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
990 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
992 /** This flag no longer does anything but is reserved for future use. */
993 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
995 /** Read the WIM file sequentially while extracting the image. */
996 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
998 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
999 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
1000 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1002 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
1003 * or in Win32 native builds. */
1004 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1006 /** Fail immediately if the full security descriptor of any file or directory
1007 * cannot be set exactly as specified in the WIM file. The default behavior
1008 * without this flag is to fall back to setting the security descriptor with the
1009 * SACL omitted, then only the default inherited security descriptor, if we do
1010 * not have permission to set the desired one. */
1011 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1013 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
1014 * fixups on, so absolute symbolic links or junction points will be fixed to be
1015 * absolute relative to the actual extraction root. Done by default if
1016 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
1017 * specified when extracting a full image. */
1018 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1020 /** Force reparse-point fixups on extraction off, regardless of the state of the
1021 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1022 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1024 /** Extract files to standard output rather than to the filesystem. */
1025 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1027 /** Instead of ignoring files and directories with names that cannot be
1028 * represented on the current platform (note: Windows has more restrictions on
1029 * filenames than UNIX), try to replace characters or append junk to the names
1030 * so that they can be extracted in some form. */
1031 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1033 /** On Windows, when there exist two or more files with the same case
1034 * insensitive name but different case sensitive names, try to extract them all
1035 * by appending junk to the end of them, rather than arbitrarily extracting only
1037 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1039 /** Do not ignore failure to set timestamps on extracted files. */
1040 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1042 /** Do not ignore failure to set short names on extracted files. */
1043 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1045 /** Do not ignore failure to extract symbolic links (and junction points, on
1046 * Windows) due to permissions problems. By default, such failures are ignored
1047 * since the default configuration of Windows only allows the Administrator to
1048 * create symbolic links. */
1049 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1052 /******************************
1053 * WIMLIB_MOUNT_FLAG_*
1054 ******************************/
1056 /** Mount the WIM image read-write rather than the default of read-only. */
1057 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1059 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1060 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1062 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1063 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1065 /** Access alternate data streams in the mounted WIM image through extended file
1066 * attributes. This is the default mode. */
1067 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1069 /** Access alternate data streams in the mounted WIM image by specifying the
1070 * file name, a colon, then the alternate file stream name. */
1071 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1073 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1074 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1075 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1077 /** Allow other users to see the mounted filesystem. (this passes the @c
1078 * allow_other option to FUSE mount) */
1079 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1081 /******************************
1082 * WIMLIB_OPEN_FLAG_*
1083 ******************************/
1085 /** Verify the WIM contents against the WIM's integrity table, if present. This
1086 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1087 * checksummed and checked against the SHA1 message digests specified in the
1088 * integrity table. WIMLIB_ERR_INTEGRITY is returned if there are any
1090 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1092 /** Do not issue an error if the WIM is part of a split WIM. */
1093 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
1095 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1096 * is not. A WIM is considered writable only if it is writable at the
1097 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1098 * header, and is not part of a spanned set. It is not required to provide this
1099 * flag to make changes to the WIM, but with this flag you get the error sooner
1100 * rather than later. */
1101 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1103 /******************************
1104 * WIMLIB_UNMOUNT_FLAG_*
1105 ******************************/
1107 /** Include an integrity table in the WIM after it's been unmounted. Ignored
1108 * for read-only mounts. */
1109 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1111 /** Unless this flag is given, changes to a read-write mounted WIM are
1112 * discarded. Ignored for read-only mounts. */
1113 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1115 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
1116 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1118 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1119 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1121 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
1122 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1124 /******************************
1125 * WIMLIB_UPDATE_FLAG_*
1126 ******************************/
1128 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1129 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1130 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1132 /******************************
1133 * WIMLIB_WRITE_FLAG_*
1134 ******************************/
1136 /** Include an integrity table in the WIM.
1138 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1139 * an integrity table if and only if one was present before. For WIMs created
1140 * with wimlib_create_new_wim(), the default behavior is to not include an
1141 * integrity table. */
1142 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1144 /** Do not include an integrity table in the new WIM file. This is the default
1145 * behavior, unless the WIM already included an integrity table. */
1146 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1148 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1149 * images from it can be applied directly from a pipe using
1150 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1151 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1152 * with this flag will not be compatible with Microsoft's software.
1154 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1155 * WIM as pipable if and only if it was pipable before. For WIMs created with
1156 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1158 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1160 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1161 * WIM was pipable already. */
1162 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1164 /** Recompress all resources, even if they could otherwise be copied from a
1165 * different WIM with the same compression type (in the case of
1166 * wimlib_export_image() being called previously). This flag is also valid in
1167 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1168 * in the joined WIM file will be recompressed. */
1169 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1171 /** Call fsync() just before the WIM file is closed. */
1172 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1174 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1175 * data to it if possible. */
1176 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1178 /** wimlib_overwrite() only: Specifying this flag overrides the default
1179 * behavior of wimlib_overwrite() after one or more calls to
1180 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1181 * only minimal changes to correctly remove the image from the WIM will be
1182 * taken. In particular, all streams will be left alone, even if they are no
1183 * longer referenced. This is probably not what you want, because almost no
1184 * space will be saved by deleting an image in this way. */
1185 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1187 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1188 * flag is set in the WIM header. This can be used in combination with
1189 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1190 * set the readonly flag on the on-disk WIM file. */
1191 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1193 /******************************
1194 * WIMLIB_INIT_FLAG_*
1195 ******************************/
1197 /** Assume that strings are represented in UTF-8, even if this is not the
1198 * locale's character encoding. Not used on Windows. */
1199 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1201 /** Windows-only: do not attempt to acquire additional privileges (currently
1202 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1203 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1204 * for the case where the calling program manages these privileges itself.
1205 * Note: no error is issued if privileges cannot be acquired, although related
1206 * errors may be reported later, depending on if the operations performed
1207 * actually require additional privileges or not. */
1208 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1210 /** Specification of an update to perform on a WIM image. */
1211 struct wimlib_update_command {
1213 /** The specific type of update to perform. */
1214 enum wimlib_update_op {
1215 /** Add a new file or directory tree to the WIM image in a
1216 * certain location. */
1217 WIMLIB_UPDATE_OP_ADD = 0,
1219 /** Delete a file or directory tree from the WIM image. */
1220 WIMLIB_UPDATE_OP_DELETE,
1222 /** Rename a file or directory tree in the WIM image. */
1223 WIMLIB_UPDATE_OP_RENAME,
1226 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1227 struct wimlib_add_command {
1228 /** Filesystem path to the file or directory tree to
1230 wimlib_tchar *fs_source_path;
1231 /** Path, specified from the root of the WIM image, at
1232 * which to add the file or directory tree within the
1234 wimlib_tchar *wim_target_path;
1236 /** Configuration for excluded files. @c NULL means
1237 * exclude no files. */
1238 struct wimlib_capture_config *config;
1240 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1243 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1244 struct wimlib_delete_command {
1245 /** Path, specified from the root of the WIM image, for
1246 * the file or directory tree within the WIM image to be
1248 wimlib_tchar *wim_path;
1249 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1252 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1253 struct wimlib_rename_command {
1254 /** Path, specified from the root of the WIM image, for
1255 * the source file or directory tree within the WIM
1257 wimlib_tchar *wim_source_path;
1258 /** Path, specified from the root of the WIM image, for
1259 * the destination file or directory tree within the WIM
1261 wimlib_tchar *wim_target_path;
1262 /** Reserved; set to 0. */
1268 /** Specification of a file or directory tree to extract from a WIM image. */
1269 struct wimlib_extract_command {
1270 /** Path to file or directory tree within the WIM image to extract. It
1271 * must be provided as an absolute path from the root of the WIM image.
1272 * The path separators may be either forward slashes or backslashes. */
1273 wimlib_tchar *wim_source_path;
1275 /** Filesystem path to extract the file or directory tree to. */
1276 wimlib_tchar *fs_dest_path;
1278 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1283 * Possible values of the error code returned by many functions in wimlib.
1285 * See the documentation for each wimlib function to see specifically what error
1286 * codes can be returned by a given function, and what they mean.
1288 enum wimlib_error_code {
1289 WIMLIB_ERR_SUCCESS = 0,
1290 WIMLIB_ERR_ALREADY_LOCKED,
1291 WIMLIB_ERR_DECOMPRESSION,
1292 WIMLIB_ERR_DELETE_STAGING_DIR,
1293 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1296 WIMLIB_ERR_FUSERMOUNT,
1297 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1298 WIMLIB_ERR_IMAGE_COUNT,
1299 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1300 WIMLIB_ERR_INTEGRITY,
1301 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1302 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1303 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1304 WIMLIB_ERR_INVALID_HEADER,
1305 WIMLIB_ERR_INVALID_IMAGE,
1306 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1307 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1308 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1309 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1310 WIMLIB_ERR_INVALID_OVERLAY,
1311 WIMLIB_ERR_INVALID_PARAM,
1312 WIMLIB_ERR_INVALID_PART_NUMBER,
1313 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1314 WIMLIB_ERR_INVALID_REPARSE_DATA,
1315 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1316 WIMLIB_ERR_INVALID_SECURITY_DATA,
1317 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1318 WIMLIB_ERR_INVALID_UTF16_STRING,
1319 WIMLIB_ERR_INVALID_UTF8_STRING,
1320 WIMLIB_ERR_IS_DIRECTORY,
1321 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1327 WIMLIB_ERR_NOTEMPTY,
1328 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1329 WIMLIB_ERR_NOT_A_WIM_FILE,
1330 WIMLIB_ERR_NOT_PIPABLE,
1331 WIMLIB_ERR_NO_FILENAME,
1335 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1337 WIMLIB_ERR_READLINK,
1340 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1341 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1342 WIMLIB_ERR_RESOURCE_ORDER,
1343 WIMLIB_ERR_SET_ATTRIBUTES,
1344 WIMLIB_ERR_SET_SECURITY,
1345 WIMLIB_ERR_SET_TIMESTAMPS,
1346 WIMLIB_ERR_SPECIAL_FILE,
1347 WIMLIB_ERR_SPLIT_INVALID,
1348 WIMLIB_ERR_SPLIT_UNSUPPORTED,
1351 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1352 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1353 WIMLIB_ERR_UNKNOWN_VERSION,
1354 WIMLIB_ERR_UNSUPPORTED,
1355 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1356 WIMLIB_ERR_WIM_IS_READONLY,
1362 /** Used to indicate no WIM image or an invalid WIM image. */
1363 #define WIMLIB_NO_IMAGE 0
1365 /** Used to specify all images in the WIM. */
1366 #define WIMLIB_ALL_IMAGES (-1)
1369 * Appends an empty image to a WIM file. This empty image will initially
1370 * contain no files or directories, although if written without further
1371 * modifications, a root directory will be created automatically for it. After
1372 * calling this function, you can use wimlib_update_image() to add files to the
1373 * new WIM image. This gives you slightly more control over making the new
1374 * image compared to calling wimlib_add_image() or
1375 * wimlib_add_image_multisource() directly.
1378 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1381 * Name to give the new image. If @c NULL or empty, the new image is given
1382 * no name. If nonempty, it must specify a name that does not already
1384 * @param new_idx_ret
1385 * If non-<code>NULL</code>, the index of the newly added image is returned
1388 * @return 0 on success; nonzero on failure. The possible error codes are:
1390 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1391 * There is already an image in @a wim named @a name.
1392 * @retval ::WIMLIB_ERR_NOMEM
1393 * Failed to allocate the memory needed to add the new image.
1394 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1395 * The WIM file is considered read-only because of any of the reasons
1396 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1400 wimlib_add_empty_image(WIMStruct *wim,
1401 const wimlib_tchar *name,
1405 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1407 * The directory tree or NTFS volume is scanned immediately to load the dentry
1408 * tree into memory, and file attributes and symbolic links are read. However,
1409 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1412 * See the manual page for the @b wimlib-imagex program for more information
1413 * about the "normal" capture mode versus the NTFS capture mode (entered by
1414 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1416 * Note that @b no changes are committed to the underlying WIM file (if
1417 * any) until wimlib_write() or wimlib_overwrite() is called.
1420 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1423 * A path to a directory or unmounted NTFS volume that will be captured as
1426 * Name to give the new image. If @c NULL or empty, the new image is given
1427 * no name. If nonempty, it must specify a name that does not already
1430 * Capture configuration that specifies files, directories, or path globs
1431 * to exclude from being captured. If @c NULL, a dummy configuration where
1432 * no paths are treated specially is used.
1434 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1435 * @param progress_func
1436 * If non-NULL, a function that will be called periodically with the
1437 * progress of the current operation.
1439 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1440 * discarded so that it appears to be in the same state as when this function
1443 * This function is implemented by calling wimlib_add_empty_image(), then
1444 * calling wimlib_update_image() with a single "add" command, so any error code
1445 * returned by wimlib_add_empty_image() may be returned, as well as any error
1446 * codes returned by wimlib_update_image() other than ones documented as only
1447 * being returned specifically by an update involving delete or rename commands.
1450 wimlib_add_image(WIMStruct *wim,
1451 const wimlib_tchar *source,
1452 const wimlib_tchar *name,
1453 const struct wimlib_capture_config *config,
1455 wimlib_progress_func_t progress_func);
1457 /** This function is equivalent to wimlib_add_image() except it allows for
1458 * multiple sources to be combined into a single WIM image. This is done by
1459 * specifying the @a sources and @a num_sources parameters instead of the @a
1460 * source parameter of wimlib_add_image(). The rest of the parameters are the
1461 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1462 * capture</b> for full details on how this mode works.
1464 * In addition to the error codes that wimlib_add_image() can return,
1465 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1466 * when trying to overlay a non-directory on a directory or when otherwise
1467 * trying to overlay multiple conflicting files to the same location in the WIM
1468 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1469 * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1470 * was not exactly one capture source with the target being the root directory.
1471 * (In this respect, there is no advantage to using
1472 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1475 wimlib_add_image_multisource(WIMStruct *wim,
1476 const struct wimlib_capture_source *sources,
1478 const wimlib_tchar *name,
1479 const struct wimlib_capture_config *config,
1481 wimlib_progress_func_t progress_func);
1484 * Creates a ::WIMStruct for a new WIM file.
1486 * This only creates an in-memory structure for a WIM that initially contains no
1487 * images. No on-disk file is created until wimlib_write() is called.
1490 * The type of compression to be used in the new WIM file. Must be
1491 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1492 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1494 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1495 * written to the memory location pointed to by this paramater. The
1496 * ::WIMStruct must be freed using using wimlib_free() when finished with
1498 * @return 0 on success; nonzero on error.
1499 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1500 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1501 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1502 * @retval ::WIMLIB_ERR_NOMEM
1503 * Failed to allocate needed memory.
1506 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1509 * Deletes an image, or all images, from a WIM file.
1511 * All streams referenced by the image(s) being deleted are removed from the
1512 * lookup table of the WIM if they are not referenced by any other images in the
1515 * Please note that @b no changes are committed to the underlying WIM file (if
1516 * any) until wimlib_write() or wimlib_overwrite() is called.
1519 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1522 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1524 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1525 * to be left unmodified only if @a image specified a single image. If instead
1526 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1527 * possible for some but not all of the images to have been deleted when a
1528 * failure status is returned.
1530 * @retval ::WIMLIB_ERR_DECOMPRESSION
1531 * Could not decompress the metadata resource for @a image.
1532 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1533 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1534 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1535 * The metadata resource for @a image in the WIM is invalid.
1536 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1537 * The security data for @a image in the WIM is invalid.
1538 * @retval ::WIMLIB_ERR_NOMEM
1539 * Failed to allocate needed memory.
1540 * @retval ::WIMLIB_ERR_READ
1541 * Could not read the metadata resource for @a image from the WIM.
1542 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1543 * The WIM file is considered read-only because of any of the reasons
1544 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1548 wimlib_delete_image(WIMStruct *wim, int image);
1551 * Exports an image, or all the images, from a WIM file, into another WIM file.
1553 * The destination image is made to share the same dentry tree and security data
1554 * structure as the source image. This places some restrictions on additional
1555 * functions that may be called. wimlib_mount_image() may not be called on
1556 * either the source image or the destination image without an intervening call
1557 * to a function that un-shares the images, such as wimlib_free() on @a
1558 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1559 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1560 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1561 * have references back to @a src_wim.
1563 * If this function fails, all changes to @a dest_wim are rolled back.
1565 * No changes shall be made to @a src_wim by this function.
1567 * Please note that no changes are committed to the underlying WIM file of @a
1568 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1571 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1572 * WIM that contains the image(s) being exported.
1574 * The image to export from @a src_wim. Can be the number of an image, or
1575 * ::WIMLIB_ALL_IMAGES to export all images.
1577 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1580 * The name to give the exported image in the new WIM file. If left @c
1581 * NULL, the name from @a src_wim is used. This parameter must be left @c
1582 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1583 * than one image; in that case, the names are all taken from the @a
1584 * src_wim. (This is allowed even if one or more images being exported has
1586 * @param dest_description
1587 * The description to give the exported image in the new WIM file. If left
1588 * @c NULL, the description from the @a src_wim is used. This parameter must
1589 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1590 * more than one image; in that case, the descriptions are all taken from
1591 * @a src_wim. (This is allowed even if one or more images being exported
1592 * has no description.)
1593 * @param export_flags
1594 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1595 * bootable, or 0 if which image is marked as bootable in the destination
1596 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1597 * there are multiple images in @a src_wim, specifying
1598 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1599 * currently marked as bootable in @a src_wim; if that is the case, then
1600 * that image is marked as bootable in the destination WIM.
1601 * @param additional_swms
1602 * Array of pointers to the ::WIMStruct for each additional part in the
1603 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1604 * need to be in any particular order, but they must include all parts of
1605 * the split WIM other than the first part, which must be provided in the
1607 * @param num_additional_swms
1608 * Number of additional WIM parts provided in the @a additional_swms array.
1609 * This number should be one less than the total number of parts in the
1610 * split WIM. Set to 0 if the WIM is a standalone WIM.
1611 * @param progress_func
1612 * If non-NULL, a function that will be called periodically with the
1613 * progress of the current operation.
1615 * @return 0 on success; nonzero on error.
1616 * @retval ::WIMLIB_ERR_DECOMPRESSION
1617 * Could not decompress the metadata resource for @a src_image
1619 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1620 * One or more of the names being given to an exported image was already in
1621 * use in the destination WIM.
1622 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1623 * @a src_image does not exist in @a src_wim.
1624 * @retval ::WIMLIB_ERR_INVALID_PARAM
1625 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1626 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1627 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1628 * dest_description were non-<code>NULL</code>, @a src_image was
1629 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1630 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1631 * The metadata resource for @a src_image in @a src_wim is invalid.
1632 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1633 * The security data for @a src_image in @a src_wim is invalid.
1634 * @retval ::WIMLIB_ERR_NOMEM
1635 * Failed to allocate needed memory.
1636 * @retval ::WIMLIB_ERR_READ
1637 * Could not read the metadata resource for @a src_image from @a src_wim.
1638 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1639 * The source WIM is a split WIM, but the parts specified do not form a
1640 * complete split WIM because they do not include all the parts of the
1641 * original WIM, there are duplicate parts, or not all the parts have the
1642 * same GUID and compression type.
1643 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1644 * @a dest_wim is considered read-only because of any of the reasons
1645 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1649 wimlib_export_image(WIMStruct *src_wim, int src_image,
1650 WIMStruct *dest_wim,
1651 const wimlib_tchar *dest_name,
1652 const wimlib_tchar *dest_description,
1654 WIMStruct **additional_swms,
1655 unsigned num_additional_swms,
1656 wimlib_progress_func_t progress_func);
1659 * Extract zero or more files or directory trees from a WIM image.
1661 * This generalizes the single-image extraction functionality of
1662 * wimlib_extract_image() to allow extracting only the specified subsets of the
1666 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1670 * The 1-based number of the image in @a wim from which the files or
1671 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1674 * An array of ::wimlib_extract_command structures that specifies the
1675 * extractions to perform.
1678 * Number of commands in the @a cmds array.
1680 * @param default_extract_flags
1681 * Default extraction flags; the behavior shall be as if these flags had
1682 * been specified in the ::wimlib_extract_command.extract_flags member in
1683 * each extraction command, in combination with any flags already present.
1685 * @param additional_swms
1686 * Array of pointers to the ::WIMStruct for each additional part in the
1687 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1688 * need to be in any particular order, but they must include all parts of
1689 * the split WIM other than the first part, which must be provided in the
1692 * @param num_additional_swms
1693 * Number of additional WIM parts provided in the @a additional_swms array.
1694 * This number should be one less than the total number of parts in the
1695 * split WIM. Set to 0 if the WIM is a standalone WIM.
1697 * @param progress_func
1698 * If non-NULL, a function that will be called periodically with the
1699 * progress of the current operation.
1701 * @return 0 on success; nonzero on error. The possible error codes include
1702 * those documented as returned by wimlib_extract_image() as well as the
1703 * following additional error codes:
1705 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1706 * The ::wimlib_extract_command.wim_source_path member in one of the
1707 * extract commands did not exist in the WIM.
1708 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1709 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1710 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1711 * regular file or directory.
1712 * @retval ::WIMLIB_ERR_INVALID_PARAM
1713 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1714 * specified for some commands but not all; or
1715 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1716 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1717 * for a command in which ::wimlib_extract_command.wim_source_path did not
1718 * specify the root directory of the WIM image.
1721 wimlib_extract_files(WIMStruct *wim,
1723 const struct wimlib_extract_command *cmds,
1725 int default_extract_flags,
1726 WIMStruct **additional_swms,
1727 unsigned num_additional_swms,
1728 wimlib_progress_func_t progress_func);
1731 * Extracts an image, or all images, from a standalone or split WIM file to a
1732 * directory or a NTFS volume.
1734 * Please see the manual page for the @c wimlib-imagex program for more
1735 * information about the "normal" extraction mode versus the NTFS extraction
1736 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1738 * Extraction is done with one thread.
1740 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1741 * returned if any resulting SHA1 message digests do not match the values
1742 * provided in the WIM file. Therefore, if this function is successful, you can
1743 * be fairly sure that any compressed data in the WIM was uncompressed
1747 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1750 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1751 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1752 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1754 * Directory to extract the WIM image(s) to (created if it does not already
1755 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1756 * path to the unmounted NTFS volume to extract the image to.
1757 * @param extract_flags
1758 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1760 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1761 * a NTFS volume to extract the image to. The volume will be opened using
1762 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1763 * Otherwise, @a target is interpreted as a directory to extract the
1766 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1767 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1768 * specified. These flags cause extracted files that are identical to be
1769 * hardlinked or symlinked together, depending on the flag. These flags
1770 * override the hard link groups that are specified in the WIM file itself.
1771 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1772 * hardlinked or symlinked across images if a file is found to occur in
1773 * more than one image.
1775 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1776 * name of each file or directory as it is extracted.
1778 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1779 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1780 * each image is considered separately with regards to the sequential
1781 * order. It is also possible for alternate data streams to break the
1782 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1784 * @param additional_swms
1785 * Array of pointers to the ::WIMStruct for each additional part in the
1786 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1787 * need to be in any particular order, but they must include all parts of
1788 * the split WIM other than the first part, which must be provided in the
1790 * @param num_additional_swms
1791 * Number of additional WIM parts provided in the @a additional_swms array.
1792 * This number should be one less than the total number of parts in the
1793 * split WIM. Set to 0 if the WIM is a standalone WIM.
1795 * @param progress_func
1796 * If non-NULL, a function that will be called periodically with the
1797 * progress of the current operation.
1799 * @return 0 on success; nonzero on error.
1800 * @retval ::WIMLIB_ERR_DECOMPRESSION
1801 * Could not decompress a resource (file or metadata) for @a image in @a
1803 * @retval ::WIMLIB_ERR_INVALID_PARAM
1804 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1805 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1806 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1807 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1808 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1809 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1810 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1811 * specified in @a extract_flag.
1812 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1813 * The SHA1 message digest of an extracted stream did not match the SHA1
1814 * message digest given in the WIM file.
1815 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1816 * A resource (file or metadata) for @a image in @a wim is invalid.
1817 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1818 * The security data for @a image in @a wim is invalid.
1819 * @retval ::WIMLIB_ERR_LINK
1820 * Failed to create a symbolic link or a hard link (only if
1821 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1822 * @retval ::WIMLIB_ERR_MKDIR
1823 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1824 * not specified in @a extract_flags).
1825 * @retval ::WIMLIB_ERR_NOMEM
1826 * Failed to allocate needed memory.
1827 * @retval ::WIMLIB_ERR_NTFS_3G
1828 * An error was returned from a libntfs-3g function while the WIM image was
1829 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1830 * was specified in @a extract_flags).
1831 * @retval ::WIMLIB_ERR_OPEN
1832 * Could not open one of the files being extracted for writing (only if
1833 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1834 * @retval ::WIMLIB_ERR_READ
1835 * A unexpected end-of-file or read error occurred when trying to read data
1836 * from the WIM file associated with @a wim.
1837 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1838 * One of the dentries in the image referenced a stream not present in the
1839 * WIM's lookup table (or in any of the lookup tables of the split WIM
1841 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
1842 * Failed to set attributes on a file.
1843 * @retval ::WIMLIB_ERR_SET_SECURITY
1844 * Failed to set security descriptor on a file
1845 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS) specified in @p
1847 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
1848 * Failed to set timestamps on a file (only if
1849 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS) specified in @p extract_flags.
1850 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1851 * The WIM is a split WIM, but the parts specified do not form a complete
1852 * split WIM because they do not include all the parts of the original WIM,
1853 * there are duplicate parts, or not all the parts have the same GUID and
1855 * @retval ::WIMLIB_ERR_UNSUPPORTED
1856 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1857 * was configured with the @c --without-ntfs-3g flag.
1858 * @retval ::WIMLIB_ERR_WRITE
1859 * Failed to write a file being extracted (only if
1860 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1863 wimlib_extract_image(WIMStruct *wim, int image,
1864 const wimlib_tchar *target,
1866 WIMStruct **additional_swms,
1867 unsigned num_additional_swms,
1868 wimlib_progress_func_t progress_func);
1871 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
1872 * pipable WIM is being sent.
1874 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
1875 * about pipable WIMs.
1877 * This function operates in a special way to read the WIM fully sequentially.
1878 * As a result, there is no ::WIMStruct is made visible to library users, and
1879 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
1880 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
1881 * seekable file, not a pipe.)
1884 * File descriptor, which may be a pipe, opened for reading and positioned
1885 * at the start of the pipable WIM.
1886 * @param image_num_or_name
1887 * String that specifies the 1-based index or name of the image to extract.
1888 * It is translated to an image index using the same rules that
1889 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
1890 * only a single image (not all images) can be specified. Alternatively,
1891 * specify @p NULL here to use the first image in the WIM if it contains
1892 * exactly one image but otherwise return @p WIMLIB_ERR_INVALID_IMAGE.
1894 * Same as the corresponding parameter to wimlib_extract_image().
1895 * @param extract_flags
1896 * Same as the corresponding parameter to wimlib_extract_image(), except
1897 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
1898 * always implied, since data is always read from @p pipe_fd sequentially
1899 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
1900 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
1901 * @param progress_func
1902 * Same as the corresponding parameter to wimlib_extract_image().
1904 * @return 0 on success; nonzero on error. The possible error codes include
1905 * those returned by wimlib_extract_image() as well as the following:
1907 * @retval ::WIMLIB_ERR_NOT_PIPABLE
1908 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
1911 wimlib_extract_image_from_pipe(int pipe_fd,
1912 const wimlib_tchar *image_num_or_name,
1913 const wimlib_tchar *target, int extract_flags,
1914 wimlib_progress_func_t progress_func);
1917 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1918 * includes a string of XML that describes the images contained in the WIM.
1919 * This function works on standalone WIMs as well as split WIM parts.
1922 * Pointer to the ::WIMStruct for a WIM file.
1924 * @c stdout, or a FILE* opened for writing, to extract the data to.
1926 * @return 0 on success; nonzero on error.
1927 * @retval ::WIMLIB_ERR_INVALID_PARAM
1928 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1929 * @retval ::WIMLIB_ERR_NOMEM
1930 * Failed to allocate needed memory.
1931 * @retval ::WIMLIB_ERR_READ
1932 * Failed to read the XML data from the WIM.
1933 * @retval ::WIMLIB_ERR_WRITE
1934 * Failed to completely write the XML data to @a fp.
1937 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1940 * Frees all memory allocated for a WIMStruct and closes all files associated
1944 * Pointer to the ::WIMStruct for a WIM file.
1946 * @return This function has no return value.
1949 wimlib_free(WIMStruct *wim);
1952 * Deprecated in favor of wimlib_get_wim_info().
1955 wimlib_get_boot_idx(const WIMStruct *wim) _wimlib_deprecated;
1958 * Deprecated in favor of wimlib_get_wim_info().
1961 wimlib_get_compression_type(const WIMStruct *wim) _wimlib_deprecated;
1964 * Converts a ::wimlib_compression_type value into a string.
1967 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1968 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1971 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1974 extern const wimlib_tchar *
1975 wimlib_get_compression_type_string(int ctype);
1978 * Converts an error code into a string describing it.
1981 * The error code returned by one of wimlib's functions.
1984 * Pointer to a statically allocated string describing the error code,
1985 * or @c NULL if the error code is not valid.
1987 extern const wimlib_tchar *
1988 wimlib_get_error_string(enum wimlib_error_code code);
1991 * Returns the description of the specified image.
1994 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1995 * standalone WIM or a split WIM part.
1997 * The number of the image, numbered starting at 1.
2000 * The description of the image, or @c NULL if there is no such image, or
2001 * @c NULL if the specified image has no description. The description
2002 * string is in library-internal memory and may not be modified or freed;
2003 * in addition, the string will become invalid if the description of the
2004 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2006 extern const wimlib_tchar *
2007 wimlib_get_image_description(const WIMStruct *wim, int image);
2010 * Returns the name of the specified image.
2013 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2014 * standalone WIM or a split WIM part.
2016 * The number of the image, numbered starting at 1.
2019 * The name of the image, or @c NULL if there is no such image. The name
2020 * string is in library-internal memory and may not be modified or freed;
2021 * in addition, the string will become invalid if the name of the image is
2022 * changed, the image is deleted, or the ::WIMStruct is destroyed.
2024 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
2025 * the WIM to be unnamed, in which case an empty string will be returned
2026 * when the corresponding name is requested.
2028 extern const wimlib_tchar *
2029 wimlib_get_image_name(const WIMStruct *wim, int image);
2033 * Deprecated in favor of wimlib_get_wim_info().
2036 wimlib_get_num_images(const WIMStruct *wim) _wimlib_deprecated;
2039 * Deprecated in favor of wimlib_get_wim_info().
2042 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret) _wimlib_deprecated;
2045 * Get basic information about a WIM file.
2048 * Pointer to the ::WIMStruct for a WIM file. It may be for either a
2049 * standalone WIM or part of a split WIM.
2051 * A ::wimlib_wim_info structure that will be filled in with information
2052 * about the WIM file.
2057 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2060 * Initialization function for wimlib. Call before using any other wimlib
2061 * function except wimlib_set_print_errors(). (However, currently this is not
2062 * strictly necessary and it will be called automatically if not done manually,
2063 * but you should not rely on this behavior.)
2066 * Bitwise OR of ::WIMLIB_INIT_FLAG_ASSUME_UTF8 and/or
2067 * ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES.
2069 * @return 0; other error codes may be returned in future releases.
2072 wimlib_global_init(int init_flags);
2075 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
2076 * You are not required to call this function, but it will release any global
2077 * resources allocated by the library.
2080 wimlib_global_cleanup(void);
2083 * Deprecated in favor of wimlib_get_wim_info().
2086 wimlib_has_integrity_table(const WIMStruct *wim) _wimlib_deprecated;
2089 * Determines if an image name is already used by some image in the WIM.
2092 * Pointer to the ::WIMStruct for a WIM file.
2094 * The name to check.
2097 * @c true if there is already an image in @a wim named @a name; @c false
2098 * if there is no image named @a name in @a wim. If @a name is @c NULL or
2099 * the empty string, @c false is returned.
2102 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2105 * Iterate through a file or directory tree in the WIM image. By specifying
2106 * appropriate flags and a callback function, you can get the attributes of a
2107 * file in the WIM, get a directory listing, or even get a listing of the entire
2111 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
2115 * The 1-based number of the image in @a wim that contains the files or
2116 * directories to iterate over.
2119 * Path in the WIM image at which to do the iteration.
2122 * Bitwise OR of ::WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE and/or
2123 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN.
2126 * A callback function that will receive each directory entry.
2129 * An extra parameter that will always be passed to the callback function
2132 * @return Normally, returns 0 if all calls to @a cb returned 0; otherwise the
2133 * first nonzero value that was returned from @a cb. However, additional error
2134 * codes may be returned, including the following:
2136 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2137 * @a path did not exist in the WIM image.
2138 * @retval ::WIMLIB_ERR_NOMEM
2139 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2142 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2144 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2147 * Iterate through the lookup table of a WIM file. This can be used to directly
2148 * get a listing of the unique resources contained in a WIM file. Both file
2149 * resources and metadata resources are included.
2152 * Pointer to the ::WIMStruct of a standalone WIM file or a split WIM part.
2153 * Note: metadata resources will only be included if the WIM is standalone
2154 * or the first part of the split WIM.
2157 * Reserved; set to 0.
2160 * A callback function that will receive each resource.
2163 * An extra parameter that will always be passed to the callback function
2166 * @return 0 if all calls to @a cb returned 0; otherwise the first nonzero value
2167 * that was returned from @a cb.
2170 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2171 wimlib_iterate_lookup_table_callback_t cb,
2175 * Joins a split WIM into a stand-alone one-part WIM.
2178 * An array of strings that gives the filenames of all parts of the split
2179 * WIM. No specific order is required, but all parts must be included with
2182 * Number of filenames in @a swms.
2183 * @param swm_open_flags
2184 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
2185 * part should be verified, if integrity tables are present. Otherwise,
2187 * @param wim_write_flags
2188 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
2189 * @param output_path
2190 * The path to write the one-part WIM to.
2191 * @param progress_func
2192 * If non-NULL, a function that will be called periodically with the
2193 * progress of the current operation.
2195 * @return 0 on success; nonzero on error. This function may return any value
2196 * returned by wimlib_open_wim() and wimlib_write() except
2197 * ::WIMLIB_ERR_WIM_IS_READONLY, as well as the following error code:
2199 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2200 * The split WIMs do not form a valid WIM because they do not include all
2201 * the parts of the original WIM, there are duplicate parts, or not all the
2202 * parts have the same GUID and compression type.
2204 * Note: the WIM's uncompressed and compressed resources are not checksummed
2205 * when they are copied from the split WIM parts to the joined WIM, nor are
2206 * compressed resources re-compressed.
2208 * Note: wimlib_export_image() can provide similar functionality to
2209 * wimlib_join(), since it is possible to export all images from a split WIM.
2212 wimlib_join(const wimlib_tchar * const *swms,
2214 const wimlib_tchar *output_path,
2216 int wim_write_flags,
2217 wimlib_progress_func_t progress_func);
2220 * Compress a chunk of a WIM resource using LZX compression.
2222 * This function is exported for convenience only and need not be used.
2225 * Uncompressed data of the chunk.
2227 * Size of the uncompressed chunk, in bytes.
2229 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
2232 * The size of the compressed data written to @a out in bytes, or 0 if the
2233 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
2235 * As a special requirement, the compression code is optimized for the WIM
2236 * format and therefore requires (@a chunk_size <= 32768).
2239 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
2242 * Decompresses a block of LZX-compressed data as used in the WIM file format.
2244 * Note that this will NOT work unmodified for LZX as used in the cabinet
2245 * format, which is not the same as in the WIM format!
2247 * This function is exported for convenience only and need not be used.
2249 * @param compressed_data
2250 * Pointer to the compressed data.
2252 * @param compressed_len
2253 * Length of the compressed data, in bytes.
2255 * @param uncompressed_data
2256 * Pointer to the buffer into which to write the uncompressed data.
2258 * @param uncompressed_len
2259 * Length of the uncompressed data. It must be 32768 bytes or less.
2262 * 0 on success; non-zero on failure.
2265 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2266 void *uncompressed_data, unsigned uncompressed_len);
2270 * Mounts an image in a WIM file on a directory read-only or read-write.
2272 * This is not supported on Windows.
2274 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
2275 * process will be daemonized.
2277 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
2278 * modifications to the WIM are staged in a temporary directory.
2280 * It is safe to mount multiple images from the same WIM file read-only at the
2281 * same time, but only if different ::WIMStruct's are used. It is @b not safe
2282 * to mount multiple images from the same WIM file read-write at the same time.
2284 * wimlib_mount_image() cannot be used on an image that was exported with
2285 * wimlib_export_image() while the dentry trees for both images are still in
2286 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2287 * that has just been added with wimlib_add_image(), unless the WIM has been
2288 * written and read into a new ::WIMStruct.
2291 * Pointer to the ::WIMStruct containing the image to be mounted.
2293 * The number of the image to mount, indexed starting from it. It must be
2294 * an existing, single image.
2296 * The path to an existing empty directory to mount the image on.
2297 * @param mount_flags
2298 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2300 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
2301 * rather than the default of read-only.
2303 * WIMs may contain named (alternate) data streams, which are a somewhat
2304 * obscure NTFS feature. They can be read and written on a mounted WIM
2305 * through one of several interfaces. The interface to use if specified by
2306 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
2307 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
2308 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
2309 * the XATTR interface.
2310 * @param additional_swms
2311 * Array of pointers to the ::WIMStruct for each additional part in the
2312 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
2313 * need to be in any particular order, but they must include all parts of
2314 * the split WIM other than the first part, which must be provided in the
2316 * @param num_additional_swms
2317 * Number of additional WIM parts provided in the @a additional_swms array.
2318 * This number should be one less than the total number of parts in the
2319 * split WIM. Set to 0 if the WIM is a standalone WIM.
2320 * @param staging_dir
2321 * If non-NULL, the name of a directory in which the staging directory will
2322 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2323 * in @a mount_flags. If left @c NULL, the staging directory is created in
2324 * the same directory as the WIM file that @a wim was originally read from.
2326 * @return 0 on success; nonzero on error.
2328 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2329 * A read-write mount was requested, but an an exclusive advisory lock on
2330 * the on-disk WIM file could not be acquired because another thread or
2331 * process has mounted an image from the WIM read-write or is currently
2332 * modifying the WIM in-place.
2333 * @retval ::WIMLIB_ERR_DECOMPRESSION
2334 * Could not decompress the metadata resource for @a image in @a wim.
2335 * @retval ::WIMLIB_ERR_FUSE
2336 * A non-zero status was returned by @c fuse_main().
2337 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2338 * @a image does not specify an existing, single image in @a wim.
2339 * @retval ::WIMLIB_ERR_INVALID_PARAM
2340 * @a image is shared among multiple ::WIMStruct's as a result of a call to
2341 * wimlib_export_image(), or @a image has been added with
2342 * wimlib_add_image().
2343 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2344 * The metadata resource for @a image in @a wim is invalid.
2345 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2346 * The security data for @a image in @a wim is invalid.
2347 * @retval ::WIMLIB_ERR_MKDIR
2348 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
2349 * staging directory could not be created.
2350 * @retval ::WIMLIB_ERR_NOMEM
2351 * Failed to allocate needed memory.
2352 * @retval ::WIMLIB_ERR_NOTDIR
2353 * Could not determine the current working directory.
2354 * @retval ::WIMLIB_ERR_READ
2355 * An unexpected end-of-file or read error occurred when trying to read
2356 * data from the WIM file associated with @a wim.
2357 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2358 * One of the dentries in the image referenced a stream not present in the
2359 * WIM's lookup table (or in any of the lookup tables of the split WIM
2361 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2362 * The WIM is a split WIM, but the parts specified do not form a complete
2363 * split WIM because they do not include all the parts of the original WIM,
2364 * there are duplicate parts, or not all the parts have the same GUID and
2366 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2367 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but @a
2368 * wim is considered read-only because of any of the reasons mentioned in
2369 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2370 * @retval ::WIMLIB_ERR_UNSUPPORTED
2371 * Mounting is not supported, either because the platform is Windows, or
2372 * because the platform is UNIX and wimlib was compiled with @c
2376 wimlib_mount_image(WIMStruct *wim,
2378 const wimlib_tchar *dir,
2380 WIMStruct **additional_swms,
2381 unsigned num_additional_swms,
2382 const wimlib_tchar *staging_dir);
2385 * Opens a WIM file and creates a ::WIMStruct for it.
2388 * The path to the WIM file to open.
2390 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
2391 * ::WIMLIB_OPEN_FLAG_SPLIT_OK and/or ::WIMLIB_OPEN_FLAG_WRITE_ACCESS.
2393 * @param progress_func
2394 * If non-NULL, a function that will be called periodically with the
2395 * progress of the current operation.
2398 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2399 * is written to the memory location pointed to by this parameter. The
2400 * ::WIMStruct must be freed using using wimlib_free() when finished with
2403 * @return 0 on success; nonzero on error.
2404 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
2405 * The lookup table of @a wim_file is compressed. Support for this can be
2406 * added to wimlib if needed, but it appears to be the case that the lookup
2407 * table is never compressed.
2408 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2409 * The WIM is not the non-first part of a split WIM, and the number of
2410 * metadata resources found in the WIM did not match the image count given
2411 * in the WIM header, or the number of <IMAGE> elements in the XML
2412 * data for the WIM did not match the image count given in the WIM header.
2413 * @retval ::WIMLIB_ERR_INTEGRITY
2414 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2415 * wim_file contains an integrity table, but the SHA1 message digest for a
2416 * chunk of the WIM does not match the corresponding message digest given
2417 * in the integrity table.
2418 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2419 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
2420 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2421 * The header of @a wim_file says that resources in the WIM are compressed,
2422 * but the header flag indicating LZX or XPRESS compression is not set.
2423 * @retval ::WIMLIB_ERR_INVALID_HEADER
2424 * The length field of the WIM header is not 208.
2425 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2426 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2427 * wim_file contains an integrity table, but the integrity table is
2429 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2430 * The lookup table for the WIM contained duplicate entries that are not
2431 * for metadata resources, or it contained an entry with a SHA1 message
2432 * digest of all 0's.
2433 * @retval ::WIMLIB_ERR_INVALID_PARAM
2434 * @p wim_ret was @c NULL.
2435 * @retval ::WIMLIB_ERR_NOMEM
2436 * Failed to allocated needed memory.
2437 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2438 * @a wim_file does not begin with the expected magic characters.
2439 * @retval ::WIMLIB_ERR_OPEN
2440 * Failed to open the file @a wim_file for reading.
2441 * @retval ::WIMLIB_ERR_READ
2442 * An unexpected end-of-file or read error occurred when trying to read
2443 * data from @a wim_file.
2444 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2445 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2446 * specified in @a open_flags.
2447 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2448 * A number other than 0x10d00 is written in the version field of the WIM
2449 * header of @a wim_file. (Probably a pre-Vista WIM).
2450 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2451 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2452 * considered read-only because of any of the reasons mentioned in the
2453 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2454 * @retval ::WIMLIB_ERR_XML
2455 * The XML data for @a wim_file is invalid.
2458 wimlib_open_wim(const wimlib_tchar *wim_file,
2460 WIMStruct **wim_ret,
2461 wimlib_progress_func_t progress_func);
2464 * Overwrites the file that the WIM was originally read from, with changes made.
2465 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2466 * rather than wimlib_create_new_wim().
2468 * There are two ways that a WIM may be overwritten. The first is to do a full
2469 * rebuild. In this mode, the new WIM is written to a temporary file and then
2470 * renamed to the original file after it is has been completely written. The
2471 * temporary file is made in the same directory as the original WIM file. A
2472 * full rebuild may take a while, but can be used even if images have been
2473 * modified or deleted, will produce a WIM with no holes, and has little chance
2474 * of unintentional data loss because the temporary WIM is fsync()ed before
2475 * being renamed to the original WIM.
2477 * The second way to overwrite a WIM is by appending to the end of it and
2478 * overwriting the header. This can be much faster than a full rebuild, but the
2479 * disadvantage is that some space will be wasted. Writing a WIM in this mode
2480 * begins with writing any new file resources *after* everything in the old WIM,
2481 * even though this will leave a hole where the old lookup table, XML data, and
2482 * integrity were. This is done so that the WIM remains valid even if the
2483 * operation is aborted mid-write. The WIM header is only overwritten at the
2484 * very last moment, and up until that point the WIM will be seen as the old
2487 * By default, wimlib_overwrite() does the append-style overwrite described
2488 * above, unless resources in the WIM are arranged in an unusual way or if
2489 * images have been deleted from the WIM. Use the flag
2490 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2491 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2492 * images have been deleted from the WIM.
2494 * In the temporary-file overwrite mode, no changes are made to the WIM on
2495 * failure, and the temporary file is deleted if possible. Abnormal termination
2496 * of the program will result in the temporary file being orphaned. In the
2497 * direct append mode, the WIM is truncated to the original length on failure;
2498 * and while abnormal termination of the program will result in extra data
2499 * appended to the original WIM, it should still be a valid WIM.
2501 * If this function completes successfully, no more functions should be called
2502 * on @a wim other than wimlib_free(). You must use wimlib_open_wim() to read
2503 * the WIM file anew.
2506 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2507 * been in-memory changes made to it, which are then reflected in the
2509 * @param write_flags
2510 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2511 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2512 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2513 * @param num_threads
2514 * Number of threads to use for compression (see wimlib_write()).
2515 * @param progress_func
2516 * If non-NULL, a function that will be called periodically with the
2517 * progress of the current operation.
2519 * @return 0 on success; nonzero on error. This function may return any value
2520 * returned by wimlib_write() as well as the following error codes:
2521 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2522 * The WIM was going to be modified in-place (with no temporary file), but
2523 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2524 * because another thread or process has mounted an image from the WIM
2525 * read-write or is currently modifying the WIM in-place.
2526 * @retval ::WIMLIB_ERR_NO_FILENAME
2527 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2528 * than a WIM read with wimlib_open_wim().
2529 * @retval ::WIMLIB_ERR_RENAME
2530 * The temporary file that the WIM was written to could not be renamed to
2531 * the original filename of @a wim.
2532 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2533 * The WIM file is considered read-only because of any of the reasons
2534 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2538 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2539 wimlib_progress_func_t progress_func);
2542 * Prints information about one image, or all images, contained in a WIM.
2545 * Pointer to the ::WIMStruct for a WIM file.
2547 * The image about which to print information. Can be the number of an
2548 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2551 * @return This function has no return value. No error checking is done when
2552 * printing the information. If @a image is invalid, an error message is
2556 wimlib_print_available_images(const WIMStruct *wim, int image);
2559 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2560 * information in a way that can be accessed programatically.
2563 wimlib_print_files(WIMStruct *wim, int image) _wimlib_deprecated;
2566 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2567 * in a way that can be accessed programatically.
2570 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
2573 * Deprecated in favor of wimlib_iterate_lookup_table(), which provides the
2574 * information in a way that can be accessed programatically.
2577 wimlib_print_lookup_table(WIMStruct *wim) _wimlib_deprecated;
2580 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2581 * information in a way that can be accessed programatically.
2584 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
2587 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2588 * in a way that can be accessed programatically.
2591 wimlib_print_wim_information(const WIMStruct *wim) _wimlib_deprecated;
2594 * Translates a string specifying the name or number of an image in the WIM into
2595 * the number of the image. The images are numbered starting at 1.
2598 * Pointer to the ::WIMStruct for a WIM file.
2599 * @param image_name_or_num
2600 * A string specifying the name or number of an image in the WIM. If it
2601 * parses to a positive integer, this integer is taken to specify the
2602 * number of the image, indexed starting at 1. Otherwise, it is taken to
2603 * be the name of an image, as given in the XML data for the WIM file. It
2604 * also may be the keyword "all" or the string "*", both of which will
2605 * resolve to ::WIMLIB_ALL_IMAGES.
2607 * There is no way to search for an image actually named "all", "*", or an
2608 * integer number, or an image that has no name. However, you can use
2609 * wimlib_get_image_name() to get the name of any image.
2612 * If the string resolved to a single existing image, the number of that
2613 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2614 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2615 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2616 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2617 * images in @a wim has no name.
2620 wimlib_resolve_image(WIMStruct *wim,
2621 const wimlib_tchar *image_name_or_num);
2624 * Deprecated in favor of wimlib_set_wim_info().
2627 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx) _wimlib_deprecated;
2630 * Changes the description of an image in the WIM.
2633 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2634 * standalone WIM or part of a split WIM; however, you should set the same
2635 * description on all parts of a split WIM.
2637 * The number of the image for which to change the description.
2638 * @param description
2639 * The new description to give the image. It may be @c NULL, which
2640 * indicates that the image is to be given no description.
2642 * @return 0 on success; nonzero on error.
2643 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2644 * @a image does not specify a single existing image in @a wim.
2645 * @retval ::WIMLIB_ERR_NOMEM
2646 * Failed to allocate the memory needed to duplicate the @a description
2648 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2649 * @a wim is considered read-only because of any of the reasons mentioned
2650 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2653 wimlib_set_image_descripton(WIMStruct *wim, int image,
2654 const wimlib_tchar *description);
2657 * Set basic information about a WIM.
2660 * A WIMStruct for a standalone WIM file.
2662 * A struct ::wimlib_wim_info that contains the information to set. Only
2663 * the information explicitly specified in the @a which flags need be
2666 * Flags that specify which information to set. This is a bitwise OR of
2667 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
2668 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
2670 * @return 0 on success; nonzero on failure.
2671 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2672 * The WIM file is considered read-only because of any of the reasons
2673 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2674 * flag. However, as a special case, if you are using
2675 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
2676 * function will not fail due to the readonly flag being previously set.
2677 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2678 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
2679 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
2683 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
2687 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2688 * (something like "Core" or "Ultimate")
2691 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2692 * standalone WIM or part of a split WIM; however, you should set the same
2693 * \<FLAGS\> element on all parts of a split WIM.
2695 * The number of the image for which to change the description.
2697 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2698 * indicates that the image is to be given no \<FLAGS\> element.
2700 * @return 0 on success; nonzero on error.
2701 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2702 * @a image does not specify a single existing image in @a wim.
2703 * @retval ::WIMLIB_ERR_NOMEM
2704 * Failed to allocate the memory needed to duplicate the @a flags string.
2705 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2706 * @a wim is considered read-only because of any of the reasons mentioned
2707 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2710 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
2713 * Changes the name of an image in the WIM.
2716 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2717 * standalone WIM or part of a split WIM; however, you should set the same
2718 * name on all parts of a split WIM.
2720 * The number of the image for which to change the name.
2722 * New name to give the new image. If @c NULL or empty, the new image is
2723 * given no name. If nonempty, it must specify a name that does not
2724 * already exist in @a wim.
2726 * @return 0 on success; nonzero on error.
2727 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2728 * There is already an image named @a name in @a wim.
2729 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2730 * @a image does not specify a single existing image in @a wim.
2731 * @retval ::WIMLIB_ERR_NOMEM
2732 * Failed to allocate the memory needed to duplicate the @a name string.
2733 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2734 * @a wim is considered read-only because of any of the reasons mentioned
2735 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2737 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2738 const wimlib_tchar *name);
2741 * Set the functions that wimlib uses to allocate and free memory.
2743 * These settings are global and not per-WIM.
2745 * The default is to use the default @c malloc() and @c free() from the C
2748 * Please note that some external functions, such as those in @c libntfs-3g, may
2749 * use the standard memory allocation functions.
2751 * @param malloc_func
2752 * A function equivalent to @c malloc() that wimlib will use to allocate
2753 * memory. If @c NULL, the allocator function is set back to the default
2754 * @c malloc() from the C library.
2756 * A function equivalent to @c free() that wimlib will use to free memory.
2757 * If @c NULL, the free function is set back to the default @c free() from
2759 * @param realloc_func
2760 * A function equivalent to @c realloc() that wimlib will use to reallocate
2761 * memory. If @c NULL, the free function is set back to the default @c
2762 * realloc() from the C library.
2763 * @return 0 on success; nonzero on error.
2764 * @retval ::WIMLIB_ERR_UNSUPPORTED
2765 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2766 * so custom memory allocators are unsupported.
2769 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2770 void (*free_func)(void *),
2771 void *(*realloc_func)(void *, size_t));
2774 * Sets whether wimlib is to print error messages to @c stderr when a function
2775 * fails. These error messages may provide information that cannot be
2776 * determined only from the error code that is returned. Not every error will
2777 * result in an error message being printed.
2779 * This setting is global and not per-WIM.
2781 * By default, error messages are not printed.
2783 * This can be called before wimlib_global_init().
2785 * @param show_messages
2786 * @c true if error messages are to be printed; @c false if error messages
2787 * are not to be printed.
2789 * @return 0 on success; nonzero on error.
2790 * @retval ::WIMLIB_ERR_UNSUPPORTED
2791 * @a show_messages was @c true, but wimlib was compiled with the @c
2792 * --without-error-messages option. Therefore, error messages cannot be
2796 wimlib_set_print_errors(bool show_messages);
2799 * Splits a WIM into multiple parts.
2802 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2805 * Name of the SWM file to create. This will be the name of the first
2806 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2807 * appended before the suffix.
2809 * The maximum size per part, in bytes. It is not guaranteed that this
2810 * will really be the maximum size per part, because some file resources in
2811 * the WIM may be larger than this size, and the WIM file format provides
2812 * no way to split up file resources among multiple WIMs.
2813 * @param write_flags
2814 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2815 * included in the split WIM parts.
2816 * @param progress_func
2817 * If non-NULL, a function that will be called periodically with the
2818 * progress of the current operation.
2820 * @return 0 on success; nonzero on error. This function may return any value
2821 * returned by wimlib_write() as well as the following error codes:
2823 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2824 * @a wim is not part 1 of a stand-alone WIM.
2825 * @retval ::WIMLIB_ERR_INVALID_PARAM
2826 * @a swm_name was @c NULL, or @a part_size was 0.
2828 * Note: the WIM's uncompressed and compressed resources are not checksummed
2829 * when they are copied from the joined WIM to the split WIM parts, nor are
2830 * compressed resources re-compressed.
2833 wimlib_split(WIMStruct *wim,
2834 const wimlib_tchar *swm_name,
2837 wimlib_progress_func_t progress_func);
2840 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2842 * The image to unmount is specified by the path to the mountpoint, not the
2843 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2844 * touched and also may have been allocated in a different process.
2846 * To unmount the image, the thread calling this function communicates with the
2847 * thread that is managing the mounted WIM image. This function blocks until it
2848 * is known whether the unmount succeeded or failed. In the case of a
2849 * read-write mounted WIM, the unmount is not considered to have succeeded until
2850 * all changes have been saved to the underlying WIM file.
2853 * The directory that the WIM image was mounted on.
2854 * @param unmount_flags
2855 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2856 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2857 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2859 * @param progress_func
2860 * If non-NULL, a function that will be called periodically with the
2861 * progress of the current operation.
2863 * @return 0 on success; nonzero on error.
2865 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2866 * The filesystem daemon was unable to remove the staging directory and the
2867 * temporary files that it contains.
2868 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2869 * The filesystem daemon appears to have terminated before sending an exit
2871 * @retval ::WIMLIB_ERR_FORK
2872 * Could not @c fork() the process.
2873 * @retval ::WIMLIB_ERR_FUSERMOUNT
2874 * The @b fusermount program could not be executed or exited with a failure
2876 * @retval ::WIMLIB_ERR_MQUEUE
2877 * Could not open a POSIX message queue to communicate with the filesystem
2878 * daemon servicing the mounted filesystem, could not send a message
2879 * through the queue, or could not receive a message through the queue.
2880 * @retval ::WIMLIB_ERR_NOMEM
2881 * Failed to allocate needed memory.
2882 * @retval ::WIMLIB_ERR_OPEN
2883 * The filesystem daemon could not open a temporary file for writing the
2885 * @retval ::WIMLIB_ERR_READ
2886 * A read error occurred when the filesystem daemon tried to a file from
2887 * the staging directory
2888 * @retval ::WIMLIB_ERR_RENAME
2889 * The filesystem daemon failed to rename the newly written WIM file to the
2890 * original WIM file.
2891 * @retval ::WIMLIB_ERR_UNSUPPORTED
2892 * Mounting is not supported, either because the platform is Windows, or
2893 * because the platform is UNIX and wimlib was compiled with @c
2895 * @retval ::WIMLIB_ERR_WRITE
2896 * A write error occurred when the filesystem daemon was writing to the new
2897 * WIM file, or the filesystem daemon was unable to flush changes that had
2898 * been made to files in the staging directory.
2901 wimlib_unmount_image(const wimlib_tchar *dir,
2903 wimlib_progress_func_t progress_func);
2906 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2909 * Pointer to the ::WIMStruct for the WIM file to update.
2911 * The 1-based index of the image in the WIM to update. It cannot be
2912 * ::WIMLIB_ALL_IMAGES.
2914 * An array of ::wimlib_update_command's that specify the update operations
2917 * Number of commands in @a cmds.
2918 * @param update_flags
2919 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2920 * @param progress_func
2921 * If non-NULL, a function that will be called periodically with the
2922 * progress of the current operation.
2924 * @return 0 on success; nonzero on error. On failure, some but not all of the
2925 * update commands may have been executed. No individual update command will
2926 * have been partially executed. Possible error codes include:
2928 * @retval ::WIMLIB_ERR_DECOMPRESSION
2929 * Failed to decompress the metadata resource from @a image in @a wim.
2930 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2931 * The capture configuration structure specified for an add command was
2933 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2934 * @a image did not specify a single, existing image in @a wim.
2935 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2936 * Attempted to perform an add command that conflicted with previously
2937 * existing files in the WIM when an overlay was attempted.
2938 * @retval ::WIMLIB_ERR_INVALID_PARAM
2939 * An unknown operation type was specified in the update commands; or,
2940 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2941 * in the @a add_flags, but the same image had previously already been
2942 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2943 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2944 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2945 * specified in the @a add_flags for an add command in which @a
2946 * wim_target_path was not the root directory of the WIM image.
2947 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2948 * (Windows only): While executing an add command, tried to capture a
2949 * reparse point with invalid data.
2950 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2951 * The metadata resource for @a image in @a wim is invalid.
2952 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2953 * The security data for image @a image in @a wim is invalid.
2954 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2955 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2956 * for a WIM path that corresponded to a directory; or, a rename command
2957 * attempted to rename a directory to a non-directory.
2958 * @retval ::WIMLIB_ERR_NOMEM
2959 * Failed to allocate needed memory.
2960 * @retval ::WIMLIB_ERR_NOTDIR
2961 * A rename command attempted to rename a directory to a non-directory; or,
2962 * an add command was executed that attempted to set the root of the WIM
2963 * image as a non-directory; or, a path component used as a directory in a
2964 * rename command was not, in fact, a directory.
2965 * @retval ::WIMLIB_ERR_NOTEMPTY
2966 * A rename command attempted to rename a directory to a non-empty
2968 * @retval ::WIMLIB_ERR_NTFS_3G
2969 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2970 * error occurred while reading data from the NTFS volume using libntfs-3g.
2971 * @retval ::WIMLIB_ERR_OPEN
2972 * Failed to open a file to be captured while executing an add command.
2973 * @retval ::WIMLIB_ERR_OPENDIR
2974 * Failed to open a directory to be captured while executing an add command.
2975 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2976 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2977 * WIM path that did not exist; or, a rename command attempted to rename a
2978 * file that does not exist.
2979 * @retval ::WIMLIB_ERR_READ
2980 * Failed to read the metadata resource for @a image in @a wim; or, while
2981 * executing an add command, failed to read data from a file or directory
2983 * @retval ::WIMLIB_ERR_READLINK
2984 * While executing an add command, failed to read the target of a symbolic
2985 * link or junction point.
2986 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2987 * (Windows only) Failed to perform a reparse point fixup because of
2988 * problems with the data of a reparse point.
2989 * @retval ::WIMLIB_ERR_SPECIAL_FILE
2990 * While executing an add command, attempted to capture a file that was not
2991 * a supported file type, such as a regular file, directory, symbolic link,
2992 * or (on Windows) a reparse point.
2993 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2994 * @a wim is part of a split WIM. Updating a split WIM is unsupported.
2995 * @retval ::WIMLIB_ERR_STAT
2996 * While executing an add command, failed to get attributes for a file or
2998 * @retval ::WIMLIB_ERR_UNSUPPORTED
2999 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
3000 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
3001 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
3002 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
3003 * add_flags for an update command.
3004 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
3005 * The WIM file is considered read-only because of any of the reasons
3006 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
3010 wimlib_update_image(WIMStruct *wim,
3012 const struct wimlib_update_command *cmds,
3015 wimlib_progress_func_t progress_func);
3018 * Writes a standalone WIM to a file.
3020 * This brings in resources from any external locations, such as directory trees
3021 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3022 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3025 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3026 * changes made to it, which are then reflected in the output file.
3028 * The path to the file to write the WIM to.
3030 * The 1-based index of the image inside the WIM to write. Use
3031 * ::WIMLIB_ALL_IMAGES to include all images.
3032 * @param write_flags
3033 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3034 * @param num_threads
3035 * Number of threads to use for compressing data. If 0, the number of
3036 * threads is taken to be the number of online processors. Note: if no
3037 * data compression needs to be done, no additional threads will be created
3038 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3039 * exporting an image from a compressed WIM to another WIM of the same
3040 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
3042 * @param progress_func
3043 * If non-NULL, a function that will be called periodically with the
3044 * progress of the current operation. The possible messages are
3045 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3046 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3047 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3049 * @return 0 on success; nonzero on error.
3050 * @retval ::WIMLIB_ERR_DECOMPRESSION
3051 * Failed to decompress a metadata or file resource in @a wim.
3052 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3053 * @a image does not specify a single existing image in @a wim, and is not
3054 * ::WIMLIB_ALL_IMAGES.
3055 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3056 * A file that had previously been scanned for inclusion in the WIM by
3057 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3058 * message digest check.
3059 * @retval ::WIMLIB_ERR_INVALID_PARAM
3060 * @p path was @c NULL.
3061 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
3062 * The metadata resource for @a image in @a wim is invalid.
3063 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
3064 * The security data for @a image in @a wim is invalid.
3065 * @retval ::WIMLIB_ERR_NOMEM
3066 * Failed to allocate needed memory.
3067 * @retval ::WIMLIB_ERR_OPEN
3068 * Failed to open @a path for writing, or some file resources in @a wim
3069 * refer to files in the outside filesystem, and one of these files could
3070 * not be opened for reading.
3071 * @retval ::WIMLIB_ERR_READ
3072 * An error occurred when trying to read data from the WIM file associated
3073 * with @a wim, or some file resources in @a wim refer to files in the
3074 * outside filesystem, and a read error occurred when reading one of these
3076 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
3077 * @a wim is part of a split WIM, not a standalone WIM.
3078 * @retval ::WIMLIB_ERR_WRITE
3079 * An error occurred when trying to write data to the new WIM file.
3082 wimlib_write(WIMStruct *wim,
3083 const wimlib_tchar *path,
3086 unsigned num_threads,
3087 wimlib_progress_func_t progress_func);
3090 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3091 * file descriptor, which need not be seekable if the write is done in a special
3092 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3093 * write_flags. This can, for example, allow capturing a WIM image and
3094 * streaming it over the network. See the documentation for
3095 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3097 * The file descriptor @p fd will not be closed when the write is complete; the
3098 * calling code is responsible for this.
3100 * Return values are mostly the same as wimlib_write(), but also:
3102 * @retval ::WIMLIB_ERR_INVALID_PARAM
3103 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3104 * specified in @p write_flags.
3107 wimlib_write_to_fd(WIMStruct *wim,
3111 unsigned num_threads,
3112 wimlib_progress_func_t progress_func);
3115 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
3116 * the data using "XPRESS" compression.
3119 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3122 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
3123 * the data is compressed using "XPRESS" compression.
3126 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3127 void *uncompressed_data, unsigned uncompressed_len);
3129 #endif /* _WIMLIB_H */