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 or manual pages.
40 * \section starting Getting Started
42 * wimlib uses the GNU autotools, so, on UNIX-like 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-like systems,
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-like systems, directly to a block
75 * device 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-like systems supporting FUSE (such as Linux), wimlib supports
84 * mounting WIM files either read-only or read-write. Mounting is done using
85 * wimlib_mount_image() and unmounting is done using wimlib_unmount_image().
86 * Mounting can be done without root privileges because it is implemented using
87 * FUSE (Filesystem in Userspace). If wimlib is compiled with the
88 * <code>--without-fuse</code> flag, these functions will be available but will
89 * fail with ::WIMLIB_ERR_UNSUPPORTED.
91 * After creating or modifying a WIM file, you can write it to a file using
92 * wimlib_write(). Alternatively, if the WIM was originally read from a file
93 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
94 * wimlib_overwrite() to overwrite the original file. Still alternatively, you
95 * can write a WIM directly to a file descriptor by calling wimlib_write_to_fd()
98 * wimlib supports a special "pipable" WIM format (which unfortunately is @b not
99 * compatible with Microsoft's software). To create a pipable WIM, call
100 * wimlib_write(), wimlib_write_to_fd(), or wimlib_overwrite() with
101 * ::WIMLIB_WRITE_FLAG_PIPABLE specified. Pipable WIMs are pipable in both
102 * directions, so wimlib_write_to_fd() can be used to write a pipable WIM to a
103 * pipe, and wimlib_extract_image_from_pipe() can be used to apply an image from
104 * a pipable WIM. wimlib can also transparently open and operate on pipable WIM
105 * s using a seekable file descriptor using the regular function calls (e.g.
106 * wimlib_open_wim(), wimlib_extract_image()).
108 * Please note: merely by calling wimlib_add_image() or many of the other
109 * functions in this library that operate on ::WIMStruct's, you are @b not
110 * modifying the WIM file on disk. Changes are not saved until you explicitly
111 * call wimlib_write() or wimlib_overwrite().
113 * After you are done with the WIM file, use wimlib_free() to free all memory
114 * associated with a ::WIMStruct and close all files associated with it.
116 * When you are completely done with using wimlib in your program, you should
117 * call wimlib_global_cleanup().
119 * A number of functions take a pointer to a progress function of type
120 * ::wimlib_progress_func_t. This function will be called periodically during
121 * the WIM operation(s) to report on the progress of the operation (for example,
122 * how many bytes have been written so far).
124 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
125 * the following exceptions:
126 * - You must call wimlib_global_init() in one thread before calling any other
128 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
129 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
130 * concurrently in the same process, will daemonize the entire process when it
131 * does so for the first time. This includes changing the working directory
132 * to the root directory.
134 * \section encodings Locales and character encodings
136 * To support Windows as well as UNIX-like systems, wimlib's API typically takes
137 * and returns strings of ::wimlib_tchar, which are in a platform-dependent
140 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
141 * and the encoding is UTF-16LE.
143 * On UNIX-like systems, each ::wimlib_tchar is 1 byte and is simply a "char",
144 * and the encoding is the locale-dependent multibyte encoding. I recommend you
145 * set your locale to a UTF-8 capable locale to avoid any issues. Also, by
146 * default, wimlib on UNIX will assume the locale is UTF-8 capable unless you
147 * call wimlib_global_init() after having set your desired locale.
149 * \section Limitations
151 * This section documents some technical limitations of wimlib not already
152 * documented in the man page for @b wimlib-imagex.
154 * - The old WIM format from Vista pre-releases is not supported.
155 * - Compressed resource chunk sizes other than 32768 are not supported. This
156 * doesn't seem to be a real problem because the chunk size always seems to be
158 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
159 * functionality other than that already present in @b ImageX, that allows you
160 * to make certain Windows-specific modifications to a Windows PE image, such
161 * as adding a driver or Windows component. Such a tool possibly could be
162 * implemented on top of wimlib.
171 #include <inttypes.h>
174 /** Major version of the library (for example, the 1 in 1.2.5). */
175 #define WIMLIB_MAJOR_VERSION 1
177 /** Minor version of the library (for example, the 2 in 1.2.5). */
178 #define WIMLIB_MINOR_VERSION 5
180 /** Patch version of the library (for example, the 5 in 1.2.5). */
181 #define WIMLIB_PATCH_VERSION 0
184 * Opaque structure that represents a WIM file. This is an in-memory structure
185 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
186 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
187 * continuing to exist so that data can be read from it as needed.
189 * Most functions in this library will work the same way regardless of whether a
190 * given ::WIMStruct was obtained through wimlib_open_wim() or
191 * wimlib_create_new_wim(). Exceptions are documented.
193 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
194 * file from a ::WIMStruct.
196 #ifndef WIMLIB_WIMSTRUCT_DECLARED
197 typedef struct WIMStruct WIMStruct;
198 #define WIMLIB_WIMSTRUCT_DECLARED
202 typedef wchar_t wimlib_tchar;
204 /** See \ref encodings */
205 typedef char wimlib_tchar;
209 /** Path separator for WIM paths passed back to progress callbacks. */
210 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
211 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
213 /** Path separator for WIM paths passed back to progress callbacks. */
214 # define WIMLIB_WIM_PATH_SEPARATOR '/'
215 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
219 # define _wimlib_deprecated __attribute__((deprecated))
221 # define _wimlib_deprecated
224 #define WIMLIB_GUID_LEN 16
227 * Specifies the compression type of a WIM file.
229 enum wimlib_compression_type {
230 /** An invalid compression type. */
231 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
233 /** The WIM does not include any compressed resources. */
234 WIMLIB_COMPRESSION_TYPE_NONE = 0,
236 /** Compressed resources in the WIM use LZX compression. */
237 WIMLIB_COMPRESSION_TYPE_LZX = 1,
239 /** Compressed resources in the WIM use XPRESS compression. */
240 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
243 /** Possible values of the first parameter to the user-supplied
244 * ::wimlib_progress_func_t progress function */
245 enum wimlib_progress_msg {
247 /** A WIM image is about to be extracted. @p info will point to
248 * ::wimlib_progress_info.extract. */
249 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
251 /** A file or directory tree within a WIM image (not the full image) is
252 * about to be extracted. @p info will point to
253 * ::wimlib_progress_info.extract. */
254 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
256 /** The directory structure of the WIM image is about to be extracted.
257 * @p info will point to ::wimlib_progress_info.extract. */
258 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
260 /** The directory structure of the WIM image has been successfully
261 * extracted. @p info will point to ::wimlib_progress_info.extract. */
262 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
264 /** The WIM image's files resources are currently being extracted. @p
265 * info will point to ::wimlib_progress_info.extract. */
266 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
268 /** Starting to read a new part of a split pipable WIM over the pipe.
269 * @p info will point to ::wimlib_progress_info.extract. */
270 WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN,
272 /** All the WIM files and directories have been extracted, and
273 * timestamps are about to be applied. @p info will point to
274 * ::wimlib_progress_info.extract. */
275 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
277 /** A WIM image has been successfully extracted. @p info will point to
278 * ::wimlib_progress_info.extract. */
279 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
281 /** A file or directory tree within a WIM image (not the full image) has
282 * been successfully extracted. @p info will point to
283 * ::wimlib_progress_info.extract. */
284 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
286 /** The directory or NTFS volume is about to be scanned to build a tree
287 * of WIM dentries in-memory. @p info will point to
288 * ::wimlib_progress_info.scan. */
289 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
291 /** A directory or file is being scanned. @p info will point to
292 * ::wimlib_progress_info.scan, and its @p cur_path member will be
293 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
294 * is passed to wimlib_add_image(). */
295 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
297 /** The directory or NTFS volume has been successfully scanned, and a
298 * tree of WIM dentries has been built in-memory. @p info will point to
299 * ::wimlib_progress_info.scan. */
300 WIMLIB_PROGRESS_MSG_SCAN_END,
303 * File resources are currently being written to the WIM.
304 * @p info will point to ::wimlib_progress_info.write_streams. */
305 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
308 * The metadata resource for each image is about to be written to the
309 * WIM. @p info will not be valid. */
310 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
313 * The metadata resource for each image has successfully been writen to
314 * the WIM. @p info will not be valid. */
315 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
318 * The temporary file has successfully been renamed to the original WIM
319 * file. Only happens when wimlib_overwrite() is called and the
320 * overwrite is not done in-place.
321 * @p info will point to ::wimlib_progress_info.rename. */
322 WIMLIB_PROGRESS_MSG_RENAME,
324 /** The contents of the WIM are being checked against the integrity
325 * table. Only happens when wimlib_open_wim() is called with the
326 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @p info will point to
327 * ::wimlib_progress_info.integrity. */
328 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
330 /** An integrity table is being calculated for the WIM being written.
331 * Only happens when wimlib_write() or wimlib_overwrite() is called with
332 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @p info will point to
333 * ::wimlib_progress_info.integrity. */
334 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
336 /** Reserved. (Previously used for WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
337 * but in wimlib v1.5.0 this was removed to simplify the code and now
338 * you'll get ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS messages instead.) */
339 WIMLIB_PROGRESS_MSG_RESERVED,
341 /** A wimlib_split() operation is in progress, and a new split part is
342 * about to be started. @p info will point to
343 * ::wimlib_progress_info.split. */
344 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
346 /** A wimlib_split() operation is in progress, and a split part has been
347 * finished. @p info will point to ::wimlib_progress_info.split. */
348 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
351 * A WIM update command is just about to be executed; @p info will point
352 * to ::wimlib_progress_info.update.
354 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
357 * A WIM update command has just been executed; @p info will point to
358 * ::wimlib_progress_info.update.
360 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
364 /** A pointer to this union is passed to the user-supplied
365 * ::wimlib_progress_func_t progress function. One (or none) of the structures
366 * contained in this union will be applicable for the operation
367 * (::wimlib_progress_msg) indicated in the first argument to the progress
369 union wimlib_progress_info {
371 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
372 * document them if they aren't given a name... */
374 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
375 struct wimlib_progress_info_write_streams {
376 /** Number of bytes that are going to be written for all the
377 * streams combined. This is the amount in uncompressed data.
378 * (The actual number of bytes will be less if the data is being
379 * written compressed.) */
380 uint64_t total_bytes;
382 /** Number of streams that are going to be written. */
383 uint64_t total_streams;
385 /** Number of uncompressed bytes that have been written so far.
386 * Will be 0 initially, and equal to @p total_bytes at the end.
388 uint64_t completed_bytes;
390 /** Number of streams that have been written. Will be 0
391 * initially, and equal to @p total_streams at the end. */
392 uint64_t completed_streams;
394 /** Number of threads that are being used to compress resources
395 * (if applicable). */
396 unsigned num_threads;
398 /** The compression type being used to write the streams; either
399 * ::WIMLIB_COMPRESSION_TYPE_NONE,
400 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
401 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
402 int compression_type;
404 /** Number of split WIM parts from which streams are being
405 * written (may be 0 if irrelevant). */
406 unsigned total_parts;
408 /** Number of split WIM parts from which streams have been
409 * written (may be 0 if irrelevant). */
410 unsigned completed_parts;
413 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
414 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
415 struct wimlib_progress_info_scan {
416 /** Directory or NTFS volume that is being scanned. */
417 const wimlib_tchar *source;
419 /** Path to the file or directory that is about to be scanned,
420 * relative to the root of the image capture or the NTFS volume.
422 const wimlib_tchar *cur_path;
425 /** File or directory looks okay and will be captured. */
426 WIMLIB_SCAN_DENTRY_OK = 0,
428 /** File or directory is being excluded from capture due
429 * to the capture configuration file. */
430 WIMLIB_SCAN_DENTRY_EXCLUDED,
432 /** File or directory is being excluded from capture due
433 * to being unsupported (e.g. an encrypted or device
435 WIMLIB_SCAN_DENTRY_UNSUPPORTED,
438 /** Target path in the WIM. Only valid on messages
439 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
440 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
441 const wimlib_tchar *wim_target_path;
444 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
445 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
446 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
447 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
448 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
449 struct wimlib_progress_info_extract {
450 /** Number of the image being extracted (1-based). */
453 /** Flags passed to to wimlib_extract_image() */
456 /** Full path to the WIM file being extracted. */
457 const wimlib_tchar *wimfile_name;
459 /** Name of the image being extracted. */
460 const wimlib_tchar *image_name;
462 /** Directory or NTFS volume to which the image is being
464 const wimlib_tchar *target;
467 const wimlib_tchar *cur_path;
469 /** Number of bytes of uncompressed data that will be extracted.
470 * Takes into account hard links (they are not counted for each
472 uint64_t total_bytes;
474 /** Number of bytes that have been written so far. Will be 0
475 * initially, and equal to @p total_bytes at the end. */
476 uint64_t completed_bytes;
478 /** Number of streams that will be extracted. This may more or
479 * less than the number of "files" to be extracted due to
480 * special cases (hard links, symbolic links, and alternate data
482 uint64_t num_streams;
484 /** Path to the root dentry within the WIM for the tree that is
485 * being extracted. Will be the empty string when extracting a
487 const wimlib_tchar *extract_root_wim_source_path;
489 /** Currently only used for
490 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
492 unsigned part_number;
494 /** Currently only used for
495 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
496 unsigned total_parts;
498 /** Currently only used for
499 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN. */
500 uint8_t guid[WIMLIB_GUID_LEN];
503 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
504 struct wimlib_progress_info_rename {
505 /** Name of the temporary file that the WIM was written to. */
506 const wimlib_tchar *from;
508 /** Name of the original WIM file to which the temporary file is
510 const wimlib_tchar *to;
513 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
514 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
515 struct wimlib_progress_info_update {
516 /** Pointer to the update command that will be executed or has
517 * just been executed. */
518 const struct wimlib_update_command *command;
520 /** Number of update commands that have been completed so far.
522 size_t completed_commands;
524 /** Number of update commands that are being executed as part of
525 * this call to wimlib_update_image(). */
526 size_t total_commands;
529 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
530 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
531 struct wimlib_progress_info_integrity {
532 /** Number of bytes from the end of the WIM header to the end of
533 * the lookup table (the area that is covered by the SHA1
534 * integrity checks.) */
535 uint64_t total_bytes;
537 /** Number of bytes that have been SHA1-summed so far. Will be
538 * 0 initially, and equal @p total_bytes at the end. */
539 uint64_t completed_bytes;
541 /** Number of chunks that the checksummed region is divided
543 uint32_t total_chunks;
545 /** Number of chunks that have been SHA1-summed so far. Will
546 * be 0 initially, and equal to @p total_chunks at the end. */
547 uint32_t completed_chunks;
549 /** Size of the chunks used for the integrity calculation. */
552 /** Filename of the WIM (only valid if the message is
553 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
554 const wimlib_tchar *filename;
557 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
558 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
559 struct wimlib_progress_info_split {
560 /** Total size of the original WIM's file and metadata resources
562 uint64_t total_bytes;
564 /** Number of bytes of file and metadata resources that have
565 * been copied out of the original WIM so far. Will be 0
566 * initially, and equal to @p total_bytes at the end. */
567 uint64_t completed_bytes;
569 /** Number of the split WIM part that is about to be started
570 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
571 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
572 unsigned cur_part_number;
574 /** Total number of split WIM parts that are being written. */
575 unsigned total_parts;
577 /** Name of the split WIM part that is about to be started
578 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
579 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
580 const wimlib_tchar *part_name;
584 /** A user-supplied function that will be called periodically during certain WIM
585 * operations. The first argument will be the type of operation that is being
586 * performed or is about to be started or has been completed. The second
587 * argument will be a pointer to one of a number of structures depending on the
588 * first argument. It may be @c NULL for some message types.
590 * The return value of the progress function is currently ignored, but it may do
591 * something in the future. (Set it to 0 for now.)
593 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
594 const union wimlib_progress_info *info);
596 /** An array of these structures is passed to wimlib_add_image_multisource() to
597 * specify the sources from which to create a WIM image. */
598 struct wimlib_capture_source {
599 /** Absolute or relative path to a file or directory on the external
600 * filesystem to be included in the WIM image. */
601 wimlib_tchar *fs_source_path;
603 /** Destination path in the WIM image. Leading and trailing slashes are
604 * ignored. The empty string or @c NULL means the root directory of the
606 wimlib_tchar *wim_target_path;
608 /** Reserved; set to 0. */
612 /** Structure that specifies a list of path patterns. */
613 struct wimlib_pattern_list {
614 /** Array of patterns. The patterns may be modified by library code,
615 * but the @p pats pointer itself will not. See the man page for
616 * <b>wimlib-imagex capture</b> for more information about allowed
620 /** Number of patterns in the @p pats array. */
623 /** Ignored; may be used by the calling code. */
624 size_t num_allocated_pats;
627 /** A structure that contains lists of wildcards that match paths to treat
628 * specially when capturing a WIM image. */
629 struct wimlib_capture_config {
630 /** Paths matching any pattern this list are excluded from being
631 * captured, except if the same path appears in @p
632 * exclusion_exception_pats. */
633 struct wimlib_pattern_list exclusion_pats;
635 /** Paths matching any pattern in this list are never excluded from
637 struct wimlib_pattern_list exclusion_exception_pats;
639 /** Reserved for future capture configuration options. */
640 struct wimlib_pattern_list reserved1;
642 /** Reserved for future capture configuration options. */
643 struct wimlib_pattern_list reserved2;
645 /** Library internal use only. */
646 wimlib_tchar *_prefix;
648 /** Library internal use only. */
649 size_t _prefix_num_tchars;
652 /** Set or unset the WIM header flag that marks it read-only
653 * (WIM_HDR_FLAG_READONLY in Microsoft's documentation), based on the
654 * ::wimlib_wim_info.is_marked_readonly member of the @p info parameter. This
655 * is distinct from basic file permissions; this flag can be set on a WIM file
656 * that is physically writable. If this flag is set, all further operations to
657 * modify the WIM will fail, except calling wimlib_overwrite() with
658 * ::WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG specified, which is a loophole that
659 * allows you to set this flag persistently on the underlying WIM file.
661 #define WIMLIB_CHANGE_READONLY_FLAG 0x00000001
663 /** Set the GUID (globally unique identifier) of the WIM file to the value
664 * specified in ::wimlib_wim_info.guid of the @p info parameter. */
665 #define WIMLIB_CHANGE_GUID 0x00000002
667 /** Change the bootable image of the WIM to the value specified in
668 * ::wimlib_wim_info.boot_index of the @p info parameter. */
669 #define WIMLIB_CHANGE_BOOT_INDEX 0x00000004
671 /** Change the WIM_HDR_FLAG_RP_FIX flag of the WIM file to the value specified
672 * in ::wimlib_wim_info.has_rpfix of the @p info parameter. This flag generally
673 * indicates whether an image in the WIM has been captured with reparse-point
674 * fixups enabled. wimlib also treats this flag as specifying whether to do
675 * reparse-point fixups by default when capturing or applying WIM images. */
676 #define WIMLIB_CHANGE_RPFIX_FLAG 0x00000008
678 /** General information about a WIM file. */
679 struct wimlib_wim_info {
681 /** Globally unique identifier for the WIM file. Note: all parts of a
682 * split WIM should have an identical value in this field. */
683 uint8_t guid[WIMLIB_GUID_LEN];
685 /** Number of images in the WIM. */
686 uint32_t image_count;
688 /** 1-based index of the bootable image in the WIM, or 0 if no image is
692 /** Version of the WIM file. */
693 uint32_t wim_version;
695 /** Chunk size used for compression. */
698 /** 1-based index of this part within a split WIM, or 1 if the WIM is
700 uint16_t part_number;
702 /** Total number of parts in the split WIM, or 1 if the WIM is
704 uint16_t total_parts;
706 /** One of the ::wimlib_compression_type values that specifies the
707 * method used to compress resources in the WIM. */
708 int32_t compression_type;
710 /** Size of the WIM file in bytes, excluding the XML data and integrity
712 uint64_t total_bytes;
714 /** 1 if the WIM has an integrity table. Note: if the ::WIMStruct was
715 * created via wimlib_create_new_wim() rather than wimlib_open_wim(),
716 * this will always be 0, even if the ::WIMStruct was written to
717 * somewhere by calling wimlib_write() with the
718 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag specified. */
719 uint32_t has_integrity_table : 1;
721 /** 1 if the ::WIMStruct was created via wimlib_open_wim() rather than
722 * wimlib_create_new_wim(). */
723 uint32_t opened_from_file : 1;
725 /** 1 if the WIM is considered readonly for any reason. */
726 uint32_t is_readonly : 1;
728 /** 1 if reparse-point fixups are supposedly enabled for one or more
729 * images in the WIM. */
730 uint32_t has_rpfix : 1;
732 /** 1 if the WIM is marked as read-only. */
733 uint32_t is_marked_readonly : 1;
735 /** 1 if the WIM is part of a spanned set. */
736 uint32_t spanned : 1;
738 uint32_t write_in_progress : 1;
739 uint32_t metadata_only : 1;
740 uint32_t resource_only : 1;
742 /** 1 if the WIM is pipable (see ::WIMLIB_WRITE_FLAG_PIPABLE). */
743 uint32_t pipable : 1;
744 uint32_t reserved_flags : 22;
745 uint32_t reserved[9];
748 /** Information about a unique resource in the WIM file.
750 struct wimlib_resource_entry {
751 /** Uncompressed size of the resource in bytes. */
752 uint64_t uncompressed_size;
754 /** Compressed size of the resource in bytes. This will be the same as
755 * @p uncompressed_size if the resource is uncompressed. */
756 uint64_t compressed_size;
758 /** Offset, in bytes, of this resource from the start of the WIM file.
762 /** SHA1 message digest of the resource's uncompressed contents. */
763 uint8_t sha1_hash[20];
765 /** Which part number of the split WIM this resource is in. This should
766 * be the same as the part number provided by wimlib_get_wim_info(). */
767 uint32_t part_number;
769 /** Number of times this resource is referenced over all WIM images. */
770 uint32_t reference_count;
772 /** 1 if this resource is compressed. */
773 uint32_t is_compressed : 1;
775 /** 1 if this resource is a metadata resource rather than a file
777 uint32_t is_metadata : 1;
779 uint32_t is_free : 1;
780 uint32_t is_spanned : 1;
781 uint32_t reserved_flags : 28;
782 uint64_t reserved[4];
785 /** A stream of a file in the WIM. */
786 struct wimlib_stream_entry {
787 /** Name of the stream, or NULL if the stream is unnamed. */
788 const wimlib_tchar *stream_name;
789 /** Location, size, etc. of the stream within the WIM file. */
790 struct wimlib_resource_entry resource;
791 uint64_t reserved[4];
794 /** Structure passed to the wimlib_iterate_dir_tree() callback function.
795 * Roughly, the information about a "file" in the WIM--- but really a directory
796 * entry ("dentry") because hard links are allowed. The hard_link_group_id
797 * field can be used to distinguish actual file inodes. */
798 struct wimlib_dir_entry {
799 /** Name of the file, or NULL if this file is unnamed (only possible for
800 * the root directory) */
801 const wimlib_tchar *filename;
803 /** 8.3 DOS name of this file, or NULL if this file has no such name.
805 const wimlib_tchar *dos_name;
807 /** Full path to this file within the WIM image. */
808 const wimlib_tchar *full_path;
810 /** Depth of this directory entry, where 0 is the root, 1 is the root's
811 * children, ..., etc. */
814 /** Pointer to the security descriptor for this file, in Windows
815 * SECURITY_DESCRIPTOR_RELATIVE format, or NULL if this file has no
816 * security descriptor. */
817 const char *security_descriptor;
819 /** Length of the above security descriptor. */
820 size_t security_descriptor_size;
822 #define WIMLIB_FILE_ATTRIBUTE_READONLY 0x00000001
823 #define WIMLIB_FILE_ATTRIBUTE_HIDDEN 0x00000002
824 #define WIMLIB_FILE_ATTRIBUTE_SYSTEM 0x00000004
825 #define WIMLIB_FILE_ATTRIBUTE_DIRECTORY 0x00000010
826 #define WIMLIB_FILE_ATTRIBUTE_ARCHIVE 0x00000020
827 #define WIMLIB_FILE_ATTRIBUTE_DEVICE 0x00000040
828 #define WIMLIB_FILE_ATTRIBUTE_NORMAL 0x00000080
829 #define WIMLIB_FILE_ATTRIBUTE_TEMPORARY 0x00000100
830 #define WIMLIB_FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
831 #define WIMLIB_FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
832 #define WIMLIB_FILE_ATTRIBUTE_COMPRESSED 0x00000800
833 #define WIMLIB_FILE_ATTRIBUTE_OFFLINE 0x00001000
834 #define WIMLIB_FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
835 #define WIMLIB_FILE_ATTRIBUTE_ENCRYPTED 0x00004000
836 #define WIMLIB_FILE_ATTRIBUTE_VIRTUAL 0x00010000
837 /** File attributes, such as whether the file is a directory or not.
838 * These are the "standard" Windows FILE_ATTRIBUTE_* values, although in
839 * wimlib.h they are defined as WIMLIB_FILE_ATTRIBUTE_* for convenience
840 * on other platforms. */
843 #define WIMLIB_REPARSE_TAG_RESERVED_ZERO 0x00000000
844 #define WIMLIB_REPARSE_TAG_RESERVED_ONE 0x00000001
845 #define WIMLIB_REPARSE_TAG_MOUNT_POINT 0xA0000003
846 #define WIMLIB_REPARSE_TAG_HSM 0xC0000004
847 #define WIMLIB_REPARSE_TAG_HSM2 0x80000006
848 #define WIMLIB_REPARSE_TAG_DRIVER_EXTENDER 0x80000005
849 #define WIMLIB_REPARSE_TAG_SIS 0x80000007
850 #define WIMLIB_REPARSE_TAG_DFS 0x8000000A
851 #define WIMLIB_REPARSE_TAG_DFSR 0x80000012
852 #define WIMLIB_REPARSE_TAG_FILTER_MANAGER 0x8000000B
853 #define WIMLIB_REPARSE_TAG_SYMLINK 0xA000000C
854 /** If the file is a reparse point (FILE_ATTRIBUTE_DIRECTORY set in the
855 * attributes), this will give the reparse tag. This tells you whether
856 * the reparse point is a symbolic link, junction point, or some other,
857 * more unusual kind of reparse point. */
858 uint32_t reparse_tag;
860 /* Number of (hard) links to this file. */
863 /** Number of named data streams that this file has. Normally 0. */
864 uint32_t num_named_streams;
866 /** Roughly, the inode number of this file. However, it may be 0 if
867 * @p num_links == 1. */
868 uint64_t hard_link_group_id;
870 /** Time this file was created. */
871 struct timespec creation_time;
873 /** Time this file was last written to. */
874 struct timespec last_write_time;
876 /** Time this file was last accessed. */
877 struct timespec last_access_time;
878 uint64_t reserved[16];
880 /** Array of streams that make up this file. The first entry will
881 * always exist and will correspond to the unnamed data stream (default
882 * file contents), so it will have @p stream_name == @c NULL. There
883 * will then be @p num_named_streams additional entries that specify the
884 * named data streams, if any, each of which will have @p stream_name !=
886 struct wimlib_stream_entry streams[];
890 * Type of a callback function to wimlib_iterate_dir_tree(). Must return 0 on
893 typedef int (*wimlib_iterate_dir_tree_callback_t)(const struct wimlib_dir_entry *dentry,
897 * Type of a callback function to wimlib_iterate_lookup_table(). Must return 0
900 typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resource_entry *resource,
903 /** For wimlib_iterate_dir_tree(): Iterate recursively on children rather than
904 * just on the specified path. */
905 #define WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE 0x00000001
907 /** For wimlib_iterate_dir_tree(): Don't iterate on the file or directory
908 * itself; only its children (in the case of a non-empty directory) */
909 #define WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN 0x00000002
913 /*****************************
915 *****************************/
917 /** Directly capture a NTFS volume rather than a generic directory. This flag
918 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
919 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
920 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
922 /** Follow symlinks; archive and dump the files they point to. Cannot be used
923 * with ::WIMLIB_ADD_FLAG_NTFS. */
924 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
926 /** Call the progress function with the message
927 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
928 * be scanned, or when a directory or file is being excluded from capture. */
929 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
931 /** Mark the image being added as the bootable image of the WIM. */
932 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
934 /** Store the UNIX owner, group, and mode. This is done by adding a special
935 * alternate data stream to each regular file, symbolic link, and directory to
936 * contain this information. Please note that this flag is for convenience
937 * only; Microsoft's @a imagex.exe will not understand this special information.
938 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
939 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
941 /** Do not capture security descriptors. Only has an effect in NTFS capture
942 * mode, or in Win32 native builds. */
943 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
945 /** Fail immediately if the full security descriptor of any file or directory
946 * cannot be accessed. Only has an effect in Win32 native builds. The default
947 * behavior without this flag is to first try omitting the SACL from the
948 * security descriptor, then to try omitting the security descriptor entirely.
950 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
952 /** Call the progress function with the message
953 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
954 * capture. This is a subset of the messages provided by
955 * ::WIMLIB_ADD_FLAG_VERBOSE. */
956 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
958 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
959 * in the case of Windows) that point inside the directory being captured to
960 * instead be absolute relative to the directory being captured, rather than the
961 * current root; also exclude absolute symbolic links that point outside the
962 * directory tree being captured.
964 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
965 * the WIM header or if this is the first image being added.
966 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
967 * reparse point fixups enabled and currently cannot be unset. */
968 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
970 /** Don't do reparse point fixups. The default behavior is described in the
971 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
972 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
974 /** Do not exclude unsupported files or directories from capture; e.g. encrypted
975 * directories in NTFS-3g capture mode, or device files and FIFOs on UNIX-like
976 * systems. Instead, fail with ::WIMLIB_ERR_UNSUPPORTED_FILE when such a file
978 #define WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE 0x00000400
981 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
982 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
983 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
984 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
985 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
986 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
987 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
988 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
989 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
990 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
991 #define WIMLIB_ADD_IMAGE_FLAG_NO_UNSUPPORTED_EXCLUDE \
992 WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE
994 /******************************
995 * WIMLIB_DELETE_FLAG_*
996 ******************************/
998 /** Do not issue an error if the path to delete does not exist. */
999 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
1001 /** Delete the file or directory tree recursively; if not specified, an error is
1002 * issued if the path to delete is a directory. */
1003 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
1005 /******************************
1006 * WIMLIB_EXPORT_FLAG_*
1007 ******************************/
1009 /** See documentation for wimlib_export_image(). */
1010 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
1012 /******************************
1013 * WIMLIB_EXTRACT_FLAG_*
1014 ******************************/
1016 /** Extract the image directly to a NTFS volume rather than a generic directory.
1017 * This mode is only available if wimlib was compiled with libntfs-3g support;
1018 * if not, ::WIMLIB_ERR_UNSUPPORTED will be returned. In this mode, the
1019 * extraction target will be interpreted as the path to a NTFS volume image (as
1020 * a regular file or block device) rather than a directory. It will be opened
1021 * using libntfs-3g, and the image will be extracted to the NTFS filesystem's
1022 * root directory. Note: this flag cannot be used when wimlib_extract_image()
1023 * is called with ::WIMLIB_ALL_IMAGES as the @p image. */
1024 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
1026 /** When identical files are extracted from the WIM, always hard link them
1028 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
1030 /** When identical files are extracted from the WIM, always symlink them
1032 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
1034 /** This flag no longer does anything but is reserved for future use. */
1035 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
1037 /** Read the WIM file sequentially while extracting the image. */
1038 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
1040 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
1041 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
1042 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
1044 /** Do not extract security descriptors. */
1045 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
1047 /** Fail immediately if the full security descriptor of any file or directory
1048 * cannot be set exactly as specified in the WIM file. On Windows, the default
1049 * behavior without this flag is to fall back to setting the security descriptor
1050 * with the SACL omitted, then only the default inherited security descriptor,
1051 * if we do not have permission to set the desired one. */
1052 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
1054 /** This is the extraction equivalent to ::WIMLIB_ADD_FLAG_RPFIX. This forces
1055 * reparse-point fixups on, so absolute symbolic links or junction points will
1056 * be fixed to be absolute relative to the actual extraction root. Reparse
1057 * point fixups are done by default if WIM_HDR_FLAG_RP_FIX is set in the WIM
1058 * header. This flag may only be specified when extracting a full image (not a
1059 * file or directory tree within one). */
1060 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
1062 /** Force reparse-point fixups on extraction off, regardless of the state of the
1063 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
1064 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
1066 /** Extract the specified file to standard output. This is only valid in an
1067 * extraction command that specifies the extraction of a regular file in the WIM
1069 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
1071 /** Instead of ignoring files and directories with names that cannot be
1072 * represented on the current platform (note: Windows has more restrictions on
1073 * filenames than POSIX-compliant systems), try to replace characters or append
1074 * junk to the names so that they can be extracted in some form. */
1075 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
1077 /** On Windows, when there exist two or more files with the same case
1078 * insensitive name but different case sensitive names, try to extract them all
1079 * by appending junk to the end of them, rather than arbitrarily extracting only
1081 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
1083 /** Do not ignore failure to set timestamps on extracted files. */
1084 #define WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS 0x00002000
1086 /** Do not ignore failure to set short names on extracted files. */
1087 #define WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES 0x00004000
1089 /** Do not ignore failure to extract symbolic links (and junction points, on
1090 * Windows) due to permissions problems. By default, such failures are ignored
1091 * since the default configuration of Windows only allows the Administrator to
1092 * create symbolic links. */
1093 #define WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS 0x00008000
1096 #define WIMLIB_EXTRACT_FLAG_RESUME 0x00010000
1099 /******************************
1100 * WIMLIB_MOUNT_FLAG_*
1101 ******************************/
1103 /** Mount the WIM image read-write rather than the default of read-only. */
1104 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
1106 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
1107 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
1109 /** Do not allow accessing alternate data streams in the mounted WIM image. */
1110 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
1112 /** Access alternate data streams in the mounted WIM image through extended file
1113 * attributes. This is the default mode. */
1114 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
1116 /** Access alternate data streams in the mounted WIM image by specifying the
1117 * file name, a colon, then the alternate file stream name. */
1118 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
1120 /** Use UNIX file owners, groups, and modes if available in the WIM (see
1121 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
1122 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
1124 /** Allow other users to see the mounted filesystem. (this passes the @c
1125 * allow_other option to FUSE mount) */
1126 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
1128 /******************************
1129 * WIMLIB_OPEN_FLAG_*
1130 ******************************/
1132 /** Verify the WIM contents against the WIM's integrity table, if present. This
1133 * causes the raw data of the WIM file, divided into 10 MB chunks, to be
1134 * checksummed and checked against the SHA1 message digests specified in the
1135 * integrity table. ::WIMLIB_ERR_INTEGRITY is returned if there are any
1137 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
1139 /** Do not issue an error if the WIM is part of a split WIM. */
1140 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
1142 /** Check if the WIM is writable and return ::WIMLIB_ERR_WIM_IS_READONLY if it
1143 * is not. A WIM is considered writable only if it is writable at the
1144 * filesystem level, does not have the WIM_HDR_FLAG_READONLY flag set in its
1145 * header, and is not part of a spanned set. It is not required to provide this
1146 * flag to make changes to the WIM, but with this flag you get the error sooner
1147 * rather than later. */
1148 #define WIMLIB_OPEN_FLAG_WRITE_ACCESS 0x00000004
1150 /******************************
1151 * WIMLIB_UNMOUNT_FLAG_*
1152 ******************************/
1154 /** Include an integrity table in the WIM after it's been unmounted. Ignored
1155 * for read-only mounts. */
1156 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
1158 /** Unless this flag is given, changes to a read-write mounted WIM are
1159 * discarded. Ignored for read-only mounts. */
1160 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
1162 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
1163 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
1165 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
1166 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
1168 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
1169 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
1171 /******************************
1172 * WIMLIB_UPDATE_FLAG_*
1173 ******************************/
1175 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
1176 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
1177 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
1179 /******************************
1180 * WIMLIB_WRITE_FLAG_*
1181 ******************************/
1183 /** Include an integrity table in the WIM.
1185 * For WIMs created with wimlib_open_wim(), the default behavior is to include
1186 * an integrity table if and only if one was present before. For WIMs created
1187 * with wimlib_create_new_wim(), the default behavior is to not include an
1188 * integrity table. */
1189 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
1191 /** Do not include an integrity table in the new WIM file. This is the default
1192 * behavior, unless the WIM already included an integrity table. */
1193 #define WIMLIB_WRITE_FLAG_NO_CHECK_INTEGRITY 0x00000002
1195 /** Write the WIM as "pipable". After writing a WIM with this flag specified,
1196 * images from it can be applied directly from a pipe using
1197 * wimlib_extract_image_from_pipe(). See the documentation for the --pipable
1198 * flag of `wimlib-imagex capture' for more information. Beware: WIMs written
1199 * with this flag will not be compatible with Microsoft's software.
1201 * For WIMs created with wimlib_open_wim(), the default behavior is to write the
1202 * WIM as pipable if and only if it was pipable before. For WIMs created with
1203 * wimlib_create_new_wim(), the default behavior is to write the WIM as
1205 #define WIMLIB_WRITE_FLAG_PIPABLE 0x00000004
1207 /** Do not write the WIM as "pipable". This is the default behavior, unless the
1208 * WIM was pipable already. */
1209 #define WIMLIB_WRITE_FLAG_NOT_PIPABLE 0x00000008
1211 /** Recompress all resources, even if they could otherwise be copied from a
1212 * different WIM with the same compression type (in the case of
1213 * wimlib_export_image() being called previously). This flag is also valid in
1214 * the @p wim_write_flags of wimlib_join(), in which case all resources included
1215 * in the joined WIM file will be recompressed. */
1216 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000010
1218 /** Call fsync() just before the WIM file is closed. */
1219 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000020
1221 /** wimlib_overwrite() only: Re-build the entire WIM file rather than appending
1222 * data to it if possible. */
1223 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000040
1225 /** wimlib_overwrite() only: Specifying this flag overrides the default
1226 * behavior of wimlib_overwrite() after one or more calls to
1227 * wimlib_delete_image(), which is to rebuild the entire WIM. With this flag,
1228 * only minimal changes to correctly remove the image from the WIM will be
1229 * taken. In particular, all streams will be left alone, even if they are no
1230 * longer referenced. This is probably not what you want, because almost no
1231 * space will be saved by deleting an image in this way. */
1232 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000080
1234 /** wimlib_overwrite() only: Allow overwriting the WIM even if the readonly
1235 * flag is set in the WIM header. This can be used in combination with
1236 * wimlib_set_wim_info() with the ::WIMLIB_CHANGE_READONLY_FLAG flag to actually
1237 * set the readonly flag on the on-disk WIM file. */
1238 #define WIMLIB_WRITE_FLAG_IGNORE_READONLY_FLAG 0x00000100
1240 /******************************
1241 * WIMLIB_INIT_FLAG_*
1242 ******************************/
1244 /** Assume that strings are represented in UTF-8, even if this is not the
1245 * locale's character encoding. Not used on Windows. */
1246 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
1248 /** Windows-only: do not attempt to acquire additional privileges (currently
1249 * SeBackupPrivilege, SeRestorePrivilege, SeSecurityPrivilege, and
1250 * SeTakeOwnershipPrivilege) when initializing the library. This is intended
1251 * for the case where the calling program manages these privileges itself.
1252 * Note: no error is issued if privileges cannot be acquired, although related
1253 * errors may be reported later, depending on if the operations performed
1254 * actually require additional privileges or not. */
1255 #define WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES 0x00000002
1257 /** Specification of an update to perform on a WIM image. */
1258 struct wimlib_update_command {
1260 /** The specific type of update to perform. */
1261 enum wimlib_update_op {
1262 /** Add a new file or directory tree to the WIM image in a
1263 * certain location. */
1264 WIMLIB_UPDATE_OP_ADD = 0,
1266 /** Delete a file or directory tree from the WIM image. */
1267 WIMLIB_UPDATE_OP_DELETE,
1269 /** Rename a file or directory tree in the WIM image. */
1270 WIMLIB_UPDATE_OP_RENAME,
1273 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
1274 struct wimlib_add_command {
1275 /** Filesystem path to the file or directory tree to
1277 wimlib_tchar *fs_source_path;
1278 /** Path, specified from the root of the WIM image, at
1279 * which to add the file or directory tree within the
1281 wimlib_tchar *wim_target_path;
1283 /** Configuration for excluded files. @c NULL means
1284 * exclude no files. */
1285 struct wimlib_capture_config *config;
1287 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
1290 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
1291 struct wimlib_delete_command {
1292 /** Path, specified from the root of the WIM image, for
1293 * the file or directory tree within the WIM image to be
1295 wimlib_tchar *wim_path;
1296 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
1299 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
1300 struct wimlib_rename_command {
1301 /** Path, specified from the root of the WIM image, for
1302 * the source file or directory tree within the WIM
1304 wimlib_tchar *wim_source_path;
1305 /** Path, specified from the root of the WIM image, for
1306 * the destination file or directory tree within the WIM
1308 wimlib_tchar *wim_target_path;
1309 /** Reserved; set to 0. */
1315 /** Specification of a file or directory tree to extract from a WIM image. */
1316 struct wimlib_extract_command {
1317 /** Path to file or directory tree within the WIM image to extract. It
1318 * must be provided as an absolute path from the root of the WIM image.
1319 * The path separators may be either forward slashes or backslashes. */
1320 wimlib_tchar *wim_source_path;
1322 /** Filesystem path to extract the file or directory tree to. */
1323 wimlib_tchar *fs_dest_path;
1325 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
1330 * Possible values of the error code returned by many functions in wimlib.
1332 * See the documentation for each wimlib function to see specifically what error
1333 * codes can be returned by a given function, and what they mean.
1335 enum wimlib_error_code {
1336 WIMLIB_ERR_SUCCESS = 0,
1337 WIMLIB_ERR_ALREADY_LOCKED,
1338 WIMLIB_ERR_DECOMPRESSION,
1339 WIMLIB_ERR_DELETE_STAGING_DIR,
1340 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
1343 WIMLIB_ERR_FUSERMOUNT,
1344 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
1345 WIMLIB_ERR_IMAGE_COUNT,
1346 WIMLIB_ERR_IMAGE_NAME_COLLISION,
1347 WIMLIB_ERR_INTEGRITY,
1348 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1349 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1350 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1351 WIMLIB_ERR_INVALID_HEADER,
1352 WIMLIB_ERR_INVALID_IMAGE,
1353 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1354 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1355 WIMLIB_ERR_INVALID_METADATA_RESOURCE,
1356 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1357 WIMLIB_ERR_INVALID_OVERLAY,
1358 WIMLIB_ERR_INVALID_PARAM,
1359 WIMLIB_ERR_INVALID_PART_NUMBER,
1360 WIMLIB_ERR_INVALID_PIPABLE_WIM,
1361 WIMLIB_ERR_INVALID_REPARSE_DATA,
1362 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1363 WIMLIB_ERR_INVALID_SECURITY_DATA,
1364 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1365 WIMLIB_ERR_INVALID_UTF16_STRING,
1366 WIMLIB_ERR_INVALID_UTF8_STRING,
1367 WIMLIB_ERR_IS_DIRECTORY,
1368 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1374 WIMLIB_ERR_NOTEMPTY,
1375 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1376 WIMLIB_ERR_NOT_A_WIM_FILE,
1377 WIMLIB_ERR_NOT_PIPABLE,
1378 WIMLIB_ERR_NO_FILENAME,
1382 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1384 WIMLIB_ERR_READLINK,
1387 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1388 WIMLIB_ERR_RESOURCE_NOT_FOUND,
1389 WIMLIB_ERR_RESOURCE_ORDER,
1390 WIMLIB_ERR_SET_ATTRIBUTES,
1391 WIMLIB_ERR_SET_REPARSE_DATA,
1392 WIMLIB_ERR_SET_SECURITY,
1393 WIMLIB_ERR_SET_SHORT_NAME,
1394 WIMLIB_ERR_SET_TIMESTAMPS,
1395 WIMLIB_ERR_SPLIT_INVALID,
1396 WIMLIB_ERR_SPLIT_UNSUPPORTED,
1399 WIMLIB_ERR_UNEXPECTED_END_OF_FILE,
1400 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1401 WIMLIB_ERR_UNKNOWN_VERSION,
1402 WIMLIB_ERR_UNSUPPORTED,
1403 WIMLIB_ERR_UNSUPPORTED_FILE,
1404 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1405 WIMLIB_ERR_WIM_IS_READONLY,
1411 /** Used to indicate no WIM image or an invalid WIM image. */
1412 #define WIMLIB_NO_IMAGE 0
1414 /** Used to specify all images in the WIM. */
1415 #define WIMLIB_ALL_IMAGES (-1)
1418 * Appends an empty image to a WIM file. This empty image will initially
1419 * contain no files or directories, although if written without further
1420 * modifications, a root directory will be created automatically for it. After
1421 * calling this function, you can use wimlib_update_image() to add files to the
1422 * new WIM image. This gives you slightly more control over making the new
1423 * image compared to calling wimlib_add_image() or
1424 * wimlib_add_image_multisource() directly.
1427 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1430 * Name to give the new image. If @c NULL or empty, the new image is given
1431 * no name. If nonempty, it must specify a name that does not already
1433 * @param new_idx_ret
1434 * If non-<code>NULL</code>, the index of the newly added image is returned
1437 * @return 0 on success; nonzero on failure. The possible error codes are:
1439 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1440 * There is already an image in @p wim named @p name.
1441 * @retval ::WIMLIB_ERR_NOMEM
1442 * Failed to allocate the memory needed to add the new image.
1443 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1444 * The WIM file is considered read-only because of any of the reasons
1445 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1449 wimlib_add_empty_image(WIMStruct *wim,
1450 const wimlib_tchar *name,
1454 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1456 * The directory tree or NTFS volume is scanned immediately to load the dentry
1457 * tree into memory, and file attributes and symbolic links are read. However,
1458 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1461 * See the manual page for the @b wimlib-imagex program for more information
1462 * about the "normal" capture mode versus the NTFS capture mode (entered by
1463 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1465 * Note that @b no changes are committed to the underlying WIM file (if
1466 * any) until wimlib_write() or wimlib_overwrite() is called.
1469 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1472 * A path to a directory or unmounted NTFS volume that will be captured as
1475 * Name to give the new image. If @c NULL or empty, the new image is given
1476 * no name. If nonempty, it must specify a name that does not already
1479 * Capture configuration that specifies files, directories, or path globs
1480 * to exclude from being captured. If @c NULL, a dummy configuration where
1481 * no paths are treated specially is used.
1483 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1484 * @param progress_func
1485 * If non-NULL, a function that will be called periodically with the
1486 * progress of the current operation. The progress messages that will be
1487 * received are ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
1488 * ::WIMLIB_PROGRESS_MSG_SCAN_END, and, if ::WIMLIB_ADD_FLAG_VERBOSE was
1489 * included in @p add_flags, also ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY.
1491 * @return 0 on success; nonzero on error. On error, changes to @p wim are
1492 * discarded so that it appears to be in the same state as when this function
1495 * This function is implemented by calling wimlib_add_empty_image(), then
1496 * calling wimlib_update_image() with a single "add" command, so any error code
1497 * returned by wimlib_add_empty_image() may be returned, as well as any error
1498 * codes returned by wimlib_update_image() other than ones documented as only
1499 * being returned specifically by an update involving delete or rename commands.
1502 wimlib_add_image(WIMStruct *wim,
1503 const wimlib_tchar *source,
1504 const wimlib_tchar *name,
1505 const struct wimlib_capture_config *config,
1507 wimlib_progress_func_t progress_func);
1509 /** This function is equivalent to wimlib_add_image() except it allows for
1510 * multiple sources to be combined into a single WIM image. This is done by
1511 * specifying the @p sources and @p num_sources parameters instead of the @p
1512 * source parameter of wimlib_add_image(). The rest of the parameters are the
1513 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1514 * capture</b> for full details on how this mode works.
1516 * In addition to the error codes that wimlib_add_image() can return,
1517 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1518 * when trying to overlay a non-directory on a directory or when otherwise
1519 * trying to overlay multiple conflicting files to the same location in the WIM
1520 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1521 * ::WIMLIB_ADD_FLAG_NTFS was specified in @p add_flags but there
1522 * was not exactly one capture source with the target being the root directory.
1523 * (In this respect, there is no advantage to using
1524 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1527 wimlib_add_image_multisource(WIMStruct *wim,
1528 const struct wimlib_capture_source *sources,
1530 const wimlib_tchar *name,
1531 const struct wimlib_capture_config *config,
1533 wimlib_progress_func_t progress_func);
1536 * Creates a ::WIMStruct for a new WIM file.
1538 * This only creates an in-memory structure for a WIM that initially contains no
1539 * images. No on-disk file is created until wimlib_write() is called.
1542 * The type of compression to be used in the new WIM file. Must be
1543 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1544 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1546 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1547 * written to the memory location pointed to by this paramater. The
1548 * ::WIMStruct must be freed using using wimlib_free() when finished with
1550 * @return 0 on success; nonzero on error.
1551 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1552 * @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1553 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1554 * @retval ::WIMLIB_ERR_NOMEM
1555 * Failed to allocate needed memory.
1558 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1561 * Deletes an image, or all images, from a WIM file.
1563 * All streams referenced by the image(s) being deleted are removed from the
1564 * lookup table of the WIM if they are not referenced by any other images in the
1567 * Please note that @b no changes are committed to the underlying WIM file (if
1568 * any) until wimlib_write() or wimlib_overwrite() is called.
1571 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1574 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1576 * @return 0 on success; nonzero on failure. On failure, @p wim is guaranteed
1577 * to be left unmodified only if @p image specified a single image. If instead
1578 * @p image was ::WIMLIB_ALL_IMAGES and @p wim contained more than one image, it's
1579 * possible for some but not all of the images to have been deleted when a
1580 * failure status is returned.
1582 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1583 * @p image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1584 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1585 * The WIM file is considered read-only because of any of the reasons
1586 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1589 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1590 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
1591 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
1592 * indicate failure (for different reasons) to read the metadata resource for an
1593 * image that needed to be deleted.
1596 wimlib_delete_image(WIMStruct *wim, int image);
1599 * Exports an image, or all the images, from a WIM file, into another WIM file.
1601 * The destination image is made to share the same dentry tree and security data
1602 * structure as the source image. This places some restrictions on additional
1603 * functions that may be called. wimlib_mount_image() may not be called on
1604 * either the source image or the destination image without an intervening call
1605 * to a function that un-shares the images, such as wimlib_free() on @p
1606 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1607 * Furthermore, you may not call wimlib_free() on @p src_wim before calling
1608 * wimlib_write() or wimlib_overwrite() on @p dest_wim because @p dest_wim will
1609 * have references back to @p src_wim.
1611 * If this function fails, all changes to @p dest_wim are rolled back.
1613 * Please note that no changes are committed to the underlying WIM file of @p
1614 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1617 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1618 * WIM that contains the image(s) being exported.
1620 * The image to export from @p src_wim. Can be the number of an image, or
1621 * ::WIMLIB_ALL_IMAGES to export all images.
1623 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1626 * The name to give the exported image in the new WIM file. If left @c
1627 * NULL, the name from @p src_wim is used. This parameter must be left @c
1628 * NULL if @p src_image is ::WIMLIB_ALL_IMAGES and @p src_wim contains more
1629 * than one image; in that case, the names are all taken from the @p
1630 * src_wim. (This is allowed even if one or more images being exported has
1632 * @param dest_description
1633 * The description to give the exported image in the new WIM file. If left
1634 * @c NULL, the description from the @p src_wim is used. This parameter must
1635 * be left @c NULL if @p src_image is ::WIMLIB_ALL_IMAGES and @p src_wim contains
1636 * more than one image; in that case, the descriptions are all taken from
1637 * @p src_wim. (This is allowed even if one or more images being exported
1638 * has no description.)
1639 * @param export_flags
1640 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1641 * bootable, or 0 if which image is marked as bootable in the destination
1642 * WIM is to be left unchanged. If @p src_image is ::WIMLIB_ALL_IMAGES and
1643 * there are multiple images in @p src_wim, specifying
1644 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1645 * currently marked as bootable in @p src_wim; if that is the case, then
1646 * that image is marked as bootable in the destination WIM.
1647 * @param additional_swms
1648 * Array of pointers to the ::WIMStruct for each additional part in the
1649 * split WIM. Ignored if @p num_additional_swms is 0. The pointers do not
1650 * need to be in any particular order, but they must include all parts of
1651 * the split WIM other than the first part, which must be provided in the
1653 * @param num_additional_swms
1654 * Number of additional WIM parts provided in the @p additional_swms array.
1655 * This number should be one less than the total number of parts in the
1656 * split WIM. Set to 0 if the WIM is a standalone WIM.
1657 * @param progress_func
1658 * If non-NULL, a function that will be called periodically with the
1659 * progress of the current operation.
1661 * @return 0 on success; nonzero on error.
1662 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1663 * One or more of the names being given to an exported image was already in
1664 * use in the destination WIM.
1665 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1666 * @p src_image does not exist in @p src_wim.
1667 * @retval ::WIMLIB_ERR_INVALID_PARAM
1668 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @p flags, @p src_image was
1669 * ::WIMLIB_ALL_IMAGES, @p src_wim contains multiple images, and no images in
1670 * @p src_wim are marked as bootable; or @p dest_name and/or @p
1671 * dest_description were non-<code>NULL</code>, @p src_image was
1672 * ::WIMLIB_ALL_IMAGES, and @p src_wim contains multiple images.
1673 * @retval ::WIMLIB_ERR_NOMEM
1674 * Failed to allocate needed memory.
1675 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1676 * The source WIM is a split WIM, but the parts specified do not form a
1677 * complete split WIM because they do not include all the parts of the
1678 * split WIM, there are duplicate parts, or not all the parts are in fact
1679 * from the same split WIM.
1680 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
1681 * @p dest_wim is considered read-only because of any of the reasons
1682 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
1685 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
1686 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
1687 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
1688 * indicate failure (for different reasons) to read the metadata resource for an
1689 * image in @p src_wim that needed to be exported.
1692 wimlib_export_image(WIMStruct *src_wim, int src_image,
1693 WIMStruct *dest_wim,
1694 const wimlib_tchar *dest_name,
1695 const wimlib_tchar *dest_description,
1697 WIMStruct **additional_swms,
1698 unsigned num_additional_swms,
1699 wimlib_progress_func_t progress_func);
1702 * Extract zero or more files or directory trees from a WIM image.
1704 * This generalizes the single-image extraction functionality of
1705 * wimlib_extract_image() to allow extracting only the specified subsets of the
1709 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1713 * The 1-based number of the image in @p wim from which the files or
1714 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1717 * An array of ::wimlib_extract_command structures that specifies the
1718 * extractions to perform.
1721 * Number of commands in the @p cmds array.
1723 * @param default_extract_flags
1724 * Default extraction flags; the behavior shall be as if these flags had
1725 * been specified in the ::wimlib_extract_command.extract_flags member in
1726 * each extraction command, in combination with any flags already present.
1728 * @param additional_swms
1729 * Array of pointers to the ::WIMStruct for each additional part in the
1730 * split WIM. Ignored if @p num_additional_swms is 0. The pointers do not
1731 * need to be in any particular order, but they must include all parts of
1732 * the split WIM other than the first part, which must be provided in the
1735 * @param num_additional_swms
1736 * Number of additional WIM parts provided in the @p additional_swms array.
1737 * This number should be one less than the total number of parts in the
1738 * split WIM. Set to 0 if the WIM is a standalone WIM.
1740 * @param progress_func
1741 * If non-NULL, a function that will be called periodically with the
1742 * progress of the current operation.
1744 * @return 0 on success; nonzero on error. The possible error codes include
1745 * most of those documented as returned by wimlib_extract_image() as well as the
1746 * following additional error codes:
1748 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1749 * @p image was ::WIMLIB_ALL_IMAGES (or was not otherwise a valid image in
1751 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1752 * The ::wimlib_extract_command.wim_source_path member in one of the
1753 * extract commands did not exist in the WIM.
1754 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1755 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1756 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1757 * regular file or directory.
1758 * @retval ::WIMLIB_ERR_INVALID_PARAM
1759 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1760 * specified for some commands but not all; or
1761 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1762 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1763 * for a command in which ::wimlib_extract_command.wim_source_path did not
1764 * specify the root directory of the WIM image.
1767 wimlib_extract_files(WIMStruct *wim,
1769 const struct wimlib_extract_command *cmds,
1771 int default_extract_flags,
1772 WIMStruct **additional_swms,
1773 unsigned num_additional_swms,
1774 wimlib_progress_func_t progress_func);
1777 * Extracts an image, or all images, from a standalone or split WIM file to a
1778 * directory or directly to a NTFS volume image.
1780 * The exact behavior of how wimlib extracts files from a WIM image is
1781 * controllable by the @p extract_flags parameter, but there also are
1782 * differences depending on the platform (UNIX-like vs Windows). See the manual
1783 * page for <b>wimlib-imagex apply</b> for more information, including about the
1784 * special "NTFS volume extraction mode" entered by providing
1785 * ::WIMLIB_EXTRACT_FLAG_NTFS.
1787 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1788 * returned if any resulting SHA1 message digests do not match the values
1789 * provided in the WIM file. Therefore, if this function is successful, you can
1790 * be fairly sure that any compressed data in the WIM was uncompressed
1794 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1797 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1798 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1799 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @p extract_flags.
1801 * Directory to extract the WIM image(s) to (created if it does not already
1802 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @p extract_flags, the
1803 * path to the unmounted NTFS volume to extract the image to.
1804 * @param extract_flags
1805 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1806 * @param additional_swms
1807 * Array of pointers to the ::WIMStruct for each additional part in the
1808 * split WIM. Ignored if @p num_additional_swms is 0. The pointers do not
1809 * need to be in any particular order, but they must include all parts of
1810 * the split WIM other than the first part, which must be provided in the
1812 * @param num_additional_swms
1813 * Number of additional WIM parts provided in the @p additional_swms array.
1814 * This number should be one less than the total number of parts in the
1815 * split WIM. Set to 0 if the WIM is a standalone WIM.
1817 * @param progress_func
1818 * If non-NULL, a function that will be called periodically with the
1819 * progress of the current operation.
1821 * @return 0 on success; nonzero on error.
1822 * @retval ::WIMLIB_ERR_DECOMPRESSION
1823 * Failed to decompress a resource to be extracted, or failed to decompress
1824 * a needed metadata resource.
1825 * @retval ::WIMLIB_ERR_INVALID_PARAM
1826 * Both ::WIMLIB_EXTRACT_FLAG_HARDLINK and ::WIMLIB_EXTRACT_FLAG_SYMLINK
1827 * were specified in @p extract_flags; or both
1828 * ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS and ::WIMLIB_EXTRACT_FLAG_NO_ACLS were
1829 * specified in @p extract_flags; or both ::WIMLIB_EXTRACT_FLAG_RPFIX and
1830 * ::WIMLIB_EXTRACT_FLAG_NORPFIX were specified in @p extract_flags; or
1831 * ::WIMLIB_EXTRACT_FLAG_RESUME was specified in @p extract_flags; or if
1832 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @p extract_flags and
1833 * @p image was ::WIMLIB_ALL_IMAGES.
1834 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
1835 * The metadata resource for an image being extracted was invalid.
1836 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1837 * The SHA1 message digest of an extracted stream did not match the SHA1
1838 * message digest given in the WIM file.
1839 * @retval ::WIMLIB_ERR_LINK
1840 * Failed to create a symbolic link or a hard link.
1841 * @retval ::WIMLIB_ERR_MKDIR
1842 * Failed create a directory.
1843 * @retval ::WIMLIB_ERR_NOMEM
1844 * Failed to allocate needed memory.
1845 * @retval ::WIMLIB_ERR_OPEN
1846 * Could not create a file, or failed to open an already-extracted file.
1847 * @retval ::WIMLIB_ERR_READ
1848 * Failed to read data from the WIM file associated with @p wim.
1849 * @retval ::WIMLIB_ERR_READLINK
1850 * Failed to determine the target of a symbolic link in the WIM.
1851 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
1852 * Failed to fix the target of an absolute symbolic link (e.g. if the
1853 * target would have exceeded the maximum allowed length). (Only if
1854 * reparse data was supported by the extraction mode and
1855 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS was specified in @p extract_flags.)
1856 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
1857 * One of the files or directories that needed to be extracted referenced a
1858 * stream not present in the WIM's lookup table (or in any of the lookup
1859 * tables of the split WIM parts).
1860 * @retval ::WIMLIB_ERR_SET_ATTRIBUTES
1861 * Failed to set attributes on a file.
1862 * @retval ::WIMLIB_ERR_SET_REPARSE_DATA
1863 * Failed to set reparse data on a file (only if reparse data was supported
1864 * by the extraction mode).
1865 * @retval ::WIMLIB_ERR_SET_SECURITY
1866 * Failed to set security descriptor on a file
1867 * (only if ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS was specified in @p
1869 * @retval ::WIMLIB_ERR_SET_SHORT_NAME
1870 * Failed to set the short name of a file (only if
1871 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES was specified in @p extract_flags).
1872 * @retval ::WIMLIB_ERR_SET_TIMESTAMPS
1873 * Failed to set timestamps on a file (only if
1874 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS was specified in @p extract_flags).
1875 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1876 * The WIM is a split WIM, but the parts specified do not form a complete
1877 * split WIM because they do not include all the parts of the original WIM,
1878 * there are duplicate parts, or not all the parts have the same GUID and
1880 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
1881 * Unexpected end-of-file occurred when reading data from the WIM file
1882 * associated with @p wim.
1883 * @retval ::WIMLIB_ERR_UNSUPPORTED
1884 * A requested extraction flag, or the data or metadata that must be
1885 * extracted to support it, is unsupported in the build and configuration
1886 * of wimlib, or on the current platform or extraction mode or target
1887 * volume. Flags affected by this include ::WIMLIB_EXTRACT_FLAG_NTFS,
1888 * ::WIMLIB_EXTRACT_FLAG_UNIX_DATA, ::WIMLIB_EXTRACT_FLAG_STRICT_ACLS,
1889 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES,
1890 * ::WIMLIB_EXTRACT_FLAG_STRICT_TIMESTAMPS,
1891 * ::WIMLIB_EXTRACT_FLAG_STRICT_SYMLINKS, ::WIMLIB_EXTRACT_FLAG_SYMLINK,
1892 * and ::WIMLIB_EXTRACT_FLAG_HARDLINK. For example, if
1893 * ::WIMLIB_EXTRACT_FLAG_STRICT_SHORT_NAMES is specified in @p
1895 * ::WIMLIB_ERR_UNSUPPORTED will be returned if the WIM image contains one
1896 * or more files with short names, but extracting short names is not
1897 * supported --- on Windows, this occurs if the target volume does not
1898 * support short names, while on non-Windows, this occurs if
1899 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @p extract_flags.
1900 * @retval ::WIMLIB_ERR_WRITE
1901 * Failed to write data to a file being extracted.
1904 wimlib_extract_image(WIMStruct *wim, int image,
1905 const wimlib_tchar *target,
1907 WIMStruct **additional_swms,
1908 unsigned num_additional_swms,
1909 wimlib_progress_func_t progress_func);
1912 * Since wimlib v1.5.0: Extract one or more images from a pipe on which a
1913 * pipable WIM is being sent.
1915 * See the documentation for ::WIMLIB_WRITE_FLAG_PIPABLE for more information
1916 * about pipable WIMs.
1918 * This function operates in a special way to read the WIM fully sequentially.
1919 * As a result, there is no ::WIMStruct is made visible to library users, and
1920 * you cannot call wimlib_open_wim() on the pipe. (You can, however, use
1921 * wimlib_open_wim() to transparently open a pipable WIM if it's available as a
1922 * seekable file, not a pipe.)
1925 * File descriptor, which may be a pipe, opened for reading and positioned
1926 * at the start of the pipable WIM.
1927 * @param image_num_or_name
1928 * String that specifies the 1-based index or name of the image to extract.
1929 * It is translated to an image index using the same rules that
1930 * wimlib_resolve_image() uses. However, unlike wimlib_extract_image(),
1931 * only a single image (not all images) can be specified. Alternatively,
1932 * specify @p NULL here to use the first image in the WIM if it contains
1933 * exactly one image but otherwise return @p WIMLIB_ERR_INVALID_IMAGE.
1935 * Same as the corresponding parameter to wimlib_extract_image().
1936 * @param extract_flags
1937 * Same as the corresponding parameter to wimlib_extract_image(), except
1938 * for the following exceptions: ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is
1939 * always implied, since data is always read from @p pipe_fd sequentially
1940 * in this mode; also, ::WIMLIB_EXTRACT_FLAG_TO_STDOUT is invalid and will
1941 * result in ::WIMLIB_ERR_INVALID_PARAM being returned.
1942 * @param progress_func
1943 * Same as the corresponding parameter to wimlib_extract_image(), except
1944 * ::WIMLIB_PROGRESS_MSG_EXTRACT_SPWM_PART_BEGIN messages will also be
1947 * @return 0 on success; nonzero on error. The possible error codes include
1948 * those returned by wimlib_extract_image() as well as the following:
1950 * @retval ::WIMLIB_ERR_INVALID_PIPABLE_WIM
1951 * Data read from the pipable WIM was invalid.
1952 * @retval ::WIMLIB_ERR_NOT_PIPABLE
1953 * The WIM being piped in a @p pipe_fd is a normal WIM, not a pipable WIM.
1956 wimlib_extract_image_from_pipe(int pipe_fd,
1957 const wimlib_tchar *image_num_or_name,
1958 const wimlib_tchar *target, int extract_flags,
1959 wimlib_progress_func_t progress_func);
1962 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1963 * includes a string of XML that describes the images contained in the WIM.
1964 * This function works on standalone WIMs as well as split WIM parts.
1967 * Pointer to the ::WIMStruct for a WIM file.
1969 * @c stdout, or a FILE* opened for writing, to extract the data to.
1971 * @return 0 on success; nonzero on error.
1972 * @retval ::WIMLIB_ERR_INVALID_PARAM
1973 * @p wim is not a ::WIMStruct that was created by wimlib_open_wim().
1974 * @retval ::WIMLIB_ERR_NOMEM
1975 * @retval ::WIMLIB_ERR_READ
1976 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
1977 * Failed to read the XML data from the WIM.
1978 * @retval ::WIMLIB_ERR_WRITE
1979 * Failed to completely write the XML data to @p fp.
1982 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1985 * Frees all memory allocated for a WIMStruct and closes all files associated
1989 * Pointer to the ::WIMStruct for a WIM file.
1991 * @return This function has no return value.
1994 wimlib_free(WIMStruct *wim);
1997 * Converts a ::wimlib_compression_type value into a string.
2000 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
2001 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
2004 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
2007 extern const wimlib_tchar *
2008 wimlib_get_compression_type_string(int ctype);
2011 * Converts an error code into a string describing it.
2014 * The error code returned by one of wimlib's functions.
2017 * Pointer to a statically allocated string describing the error code,
2018 * or @c NULL if the error code is not valid.
2020 extern const wimlib_tchar *
2021 wimlib_get_error_string(enum wimlib_error_code code);
2024 * Returns the description of the specified image.
2027 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2028 * standalone WIM or a split WIM part.
2030 * The number of the image, numbered starting at 1.
2033 * The description of the image, or @c NULL if there is no such image, or
2034 * @c NULL if the specified image has no description. The description
2035 * string is in library-internal memory and may not be modified or freed;
2036 * in addition, the string will become invalid if the description of the
2037 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
2039 extern const wimlib_tchar *
2040 wimlib_get_image_description(const WIMStruct *wim, int image);
2043 * Returns the name of the specified image.
2046 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2047 * standalone WIM or a split WIM part.
2049 * The number of the image, numbered starting at 1.
2052 * The name of the image, or @c NULL if there is no such image, or an empty
2053 * string if the image is unnamed. The name string is in
2054 * library-internal memory and may not be modified or freed; in addition,
2055 * the string will become invalid if the name of the image is changed, the
2056 * image is deleted, or the ::WIMStruct is destroyed.
2058 extern const wimlib_tchar *
2059 wimlib_get_image_name(const WIMStruct *wim, int image);
2063 * Get basic information about a WIM file.
2066 * Pointer to the ::WIMStruct for a WIM file. It may be for either a
2067 * standalone WIM or part of a split WIM.
2069 * A ::wimlib_wim_info structure that will be filled in with information
2070 * about the WIM file.
2075 wimlib_get_wim_info(WIMStruct *wim, struct wimlib_wim_info *info);
2078 * Initialization function for wimlib. Call before using any other wimlib
2079 * function except wimlib_set_print_errors(). (However, currently this is not
2080 * strictly necessary and it will be called automatically if not done manually,
2081 * but you should not rely on this behavior.)
2084 * Bitwise OR of ::WIMLIB_INIT_FLAG_ASSUME_UTF8 and/or
2085 * ::WIMLIB_INIT_FLAG_DONT_ACQUIRE_PRIVILEGES.
2087 * @return 0; other error codes may be returned in future releases.
2090 wimlib_global_init(int init_flags);
2093 * Cleanup function for wimlib. You are not required to call this function, but
2094 * it will release any global resources allocated by the library.
2097 wimlib_global_cleanup(void);
2100 * Determines if an image name is already used by some image in the WIM.
2103 * Pointer to the ::WIMStruct for a WIM file.
2105 * The name to check.
2108 * @c true if there is already an image in @p wim named @p name; @c false
2109 * if there is no image named @p name in @p wim. If @p name is @c NULL or
2110 * the empty string, @c false is returned.
2113 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
2116 * Iterate through a file or directory tree in the WIM image. By specifying
2117 * appropriate flags and a callback function, you can get the attributes of a
2118 * file in the WIM, get a directory listing, or even get a listing of the entire
2122 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
2126 * The 1-based number of the image in @p wim that contains the files or
2127 * directories to iterate over, or ::WIMLIB_ALL_IMAGES to repeat the same
2128 * iteration on all images in the WIM.
2131 * Path in the WIM image at which to do the iteration.
2134 * Bitwise OR of ::WIMLIB_ITERATE_DIR_TREE_FLAG_RECURSIVE and/or
2135 * ::WIMLIB_ITERATE_DIR_TREE_FLAG_CHILDREN.
2138 * A callback function that will receive each directory entry.
2141 * An extra parameter that will always be passed to the callback function
2144 * @return Normally, returns 0 if all calls to @p cb returned 0; otherwise the
2145 * first nonzero value that was returned from @p cb. However, additional error
2146 * codes may be returned, including the following:
2148 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2149 * @p path did not exist in the WIM image.
2150 * @retval ::WIMLIB_ERR_NOMEM
2151 * Failed to allocate memory needed to create a ::wimlib_dir_entry.
2153 * This function can additionally return ::WIMLIB_ERR_DECOMPRESSION,
2154 * ::WIMLIB_ERR_INVALID_METADATA_RESOURCE, ::WIMLIB_ERR_NOMEM,
2155 * ::WIMLIB_ERR_READ, or ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE, all of which
2156 * indicate failure (for different reasons) to read the metadata resource for an
2157 * image over which iteration needed to be done.
2160 wimlib_iterate_dir_tree(WIMStruct *wim, int image, const wimlib_tchar *path,
2162 wimlib_iterate_dir_tree_callback_t cb, void *user_ctx);
2165 * Iterate through the lookup table of a WIM file. This can be used to directly
2166 * get a listing of the unique resources contained in a WIM file. Both file
2167 * resources and metadata resources are included.
2170 * Pointer to the ::WIMStruct of a standalone WIM file or a split WIM part.
2171 * Note: metadata resources will only be included if the WIM is standalone
2172 * or the first part of the split WIM.
2175 * Reserved; set to 0.
2178 * A callback function that will receive each resource.
2181 * An extra parameter that will always be passed to the callback function
2184 * @return 0 if all calls to @p cb returned 0; otherwise the first nonzero value
2185 * that was returned from @p cb.
2188 wimlib_iterate_lookup_table(WIMStruct *wim, int flags,
2189 wimlib_iterate_lookup_table_callback_t cb,
2193 * Joins a split WIM into a stand-alone one-part WIM.
2196 * An array of strings that gives the filenames of all parts of the split
2197 * WIM. No specific order is required, but all parts must be included with
2200 * Number of filenames in @p swms.
2201 * @param swm_open_flags
2202 * Open flags for the split WIM parts (e.g.
2203 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY). Note: WIMLIB_OPEN_FLAG_SPLIT_OK is
2204 * automatically added to the value specified here.
2205 * @param wim_write_flags
2206 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG, which will
2207 * be used to write the joined WIM.
2208 * @param output_path
2209 * The path to write the joined WIM file to.
2210 * @param progress_func
2211 * If non-NULL, a function that will be called periodically with the
2212 * progress of the current operation.
2214 * @return 0 on success; nonzero on error. This function may return most error
2215 * codes that can be returned by wimlib_open_wim() and wimlib_write(), as well
2216 * as the following error code:
2218 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2219 * The split WIMs do not form a valid WIM because they do not include all
2220 * the parts of the original WIM, there are duplicate parts, or not all the
2221 * parts have the same GUID and compression type.
2223 * Note: wimlib_export_image() can provide similar functionality to
2224 * wimlib_join(), since it is possible to export all images from a split WIM.
2225 * Actually, wimlib_join() currently calls wimlib_export_image internally.
2228 wimlib_join(const wimlib_tchar * const *swms,
2230 const wimlib_tchar *output_path,
2232 int wim_write_flags,
2233 wimlib_progress_func_t progress_func);
2236 * Compress a chunk of a WIM resource using LZX compression.
2238 * This function is exported for convenience only and should only be used by
2239 * library clients looking to make use of wimlib's compression code for another
2243 * Uncompressed data of the chunk.
2245 * Size of the uncompressed chunk, in bytes.
2247 * Pointer to output buffer of size at least (@p chunk_size - 1) bytes.
2250 * The size of the compressed data written to @p out in bytes, or 0 if the
2251 * data could not be compressed to (@p chunk_size - 1) bytes or fewer.
2253 * As a special requirement, the compression code is optimized for the WIM
2254 * format and therefore requires (@p chunk_size <= 32768).
2257 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
2260 * Decompresses a block of LZX-compressed data as used in the WIM file format.
2262 * Note that this will NOT work unmodified for LZX as used in the cabinet
2263 * format, which is not the same as in the WIM format!
2265 * This function is exported for convenience only and should only be used by
2266 * library clients looking to make use of wimlib's compression code for another
2269 * @param compressed_data
2270 * Pointer to the compressed data.
2272 * @param compressed_len
2273 * Length of the compressed data, in bytes.
2275 * @param uncompressed_data
2276 * Pointer to the buffer into which to write the uncompressed data.
2278 * @param uncompressed_len
2279 * Length of the uncompressed data. It must be 32768 bytes or less.
2282 * 0 on success; non-zero on failure.
2285 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
2286 void *uncompressed_data, unsigned uncompressed_len);
2290 * Mounts an image in a WIM file on a directory read-only or read-write.
2292 * As this is implemented using FUSE (Filesystme in UserSpacE), this is not
2293 * supported if wimlib was configured with @c --without-fuse. This includes
2294 * Windows builds of wimlib; ::WIMLIB_ERR_UNSUPPORTED will be returned in such
2297 * Calling this function daemonizes the process, unless
2298 * ::WIMLIB_MOUNT_FLAG_DEBUG was specified or an early occur occurs. If the
2299 * mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified), modifications
2300 * to the WIM are staged in a temporary directory.
2302 * It is safe to mount multiple images from the same underlying WIM file
2303 * read-only at the same time, but only if different ::WIMStruct's are used. It
2304 * is @b not safe to mount multiple images from the same WIM file read-write at
2307 * wimlib_mount_image() cannot be used on an image that was exported with
2308 * wimlib_export_image() while the dentry trees for both images are still in
2309 * memory. In addition, wimlib_mount_image() may not be used to mount an image
2310 * that already has modifications pending (e.g. an image added with
2311 * wimlib_add_image()).
2314 * Pointer to the ::WIMStruct containing the image to be mounted.
2316 * The number of the image to mount, indexed starting from it. It must be
2317 * an existing, single image.
2319 * The path to an existing empty directory to mount the image on.
2320 * @param mount_flags
2321 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
2322 * @param additional_swms
2323 * Array of pointers to the ::WIMStruct for each additional part in the
2324 * split WIM. Ignored if @p num_additional_swms is 0. The pointers do not
2325 * need to be in any particular order, but they must include all parts of
2326 * the split WIM other than the first part, which must be provided in the
2328 * @param num_additional_swms
2329 * Number of additional WIM parts provided in the @p additional_swms array.
2330 * This number should be one less than the total number of parts in the
2331 * split WIM. Set to 0 if the WIM is a standalone WIM.
2332 * @param staging_dir
2333 * If non-NULL, the name of a directory in which the staging directory will
2334 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
2335 * in @p mount_flags. If left @c NULL, the staging directory is created in
2336 * the same directory as the WIM file that @p wim was originally read from.
2338 * @return 0 on success; nonzero on error.
2340 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2341 * A read-write mount was requested, but an an exclusive advisory lock on
2342 * the on-disk WIM file could not be acquired because another thread or
2343 * process has mounted an image from the WIM read-write or is currently
2344 * modifying the WIM in-place.
2345 * @retval ::WIMLIB_ERR_DECOMPRESSION
2346 * Could not decompress the metadata resource for @p image in @p wim.
2347 * @retval ::WIMLIB_ERR_FUSE
2348 * A non-zero status was returned by @c fuse_main().
2349 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2350 * @p image does not specify an existing, single image in @p wim.
2351 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
2352 * The metadata resource for @p image is invalid.
2353 * @retval ::WIMLIB_ERR_INVALID_PARAM
2354 * @p image is shared among multiple ::WIMStruct's as a result of a call to
2355 * wimlib_export_image(), or @p image has been added with
2356 * wimlib_add_image().
2357 * @retval ::WIMLIB_ERR_MKDIR
2358 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but the
2359 * staging directory could not be created.
2360 * @retval ::WIMLIB_ERR_NOMEM
2361 * Failed to allocate needed memory.
2362 * @retval ::WIMLIB_ERR_NOTDIR
2363 * Could not determine the current working directory.
2364 * @retval ::WIMLIB_ERR_READ
2365 * Failed to read data from the WIM file associated with @p wim.
2366 * @retval ::WIMLIB_ERR_RESOURCE_NOT_FOUND
2367 * One of the dentries in the image referenced a stream not present in the
2368 * WIM's lookup table (or in any of the lookup tables of the split WIM
2370 * @retval ::WIMLIB_ERR_SPLIT_INVALID
2371 * The WIM is a split WIM, but the parts specified do not form a complete
2372 * split WIM because they do not include all the parts of the original WIM,
2373 * there are duplicate parts, or not all the parts have the same GUID and
2375 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2376 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @p mount_flags, but @p
2377 * wim is considered read-only because of any of the reasons mentioned in
2378 * the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2379 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2380 * Unexpected end-of-file occurred while reading data from the WIM file
2381 * associated with @p wim.
2382 * @retval ::WIMLIB_ERR_UNSUPPORTED
2383 * Mounting is not supported, either because the platform is Windows, or
2384 * because the platform is UNIX-like and wimlib was compiled with @c
2388 wimlib_mount_image(WIMStruct *wim,
2390 const wimlib_tchar *dir,
2392 WIMStruct **additional_swms,
2393 unsigned num_additional_swms,
2394 const wimlib_tchar *staging_dir);
2397 * Opens a WIM file and creates a ::WIMStruct for it.
2400 * The path to the WIM file to open.
2403 * Bitwise OR of flags prefixed with WIMLIB_OPEN_FLAG.
2405 * @param progress_func
2406 * If non-NULL, a function that will be called periodically with the
2407 * progress of the current operation. Currently, the only messages sent
2408 * will be ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY, and only if
2409 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags.
2412 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
2413 * is written to the memory location pointed to by this parameter. The
2414 * ::WIMStruct can be freed using using wimlib_free() when finished with
2417 * @return 0 on success; nonzero on error.
2418 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2419 * The WIM is not the non-first part of a split WIM, and the number of
2420 * metadata resources found in the WIM did not match the image count given
2421 * in the WIM header, or the number of <IMAGE> elements in the XML
2422 * data for the WIM did not match the image count given in the WIM header.
2423 * @retval ::WIMLIB_ERR_INTEGRITY
2424 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2425 * wim_file contains an integrity table, but the SHA1 message digest for a
2426 * chunk of the WIM does not match the corresponding message digest given
2427 * in the integrity table.
2428 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2429 * Resources in @p wim_file are compressed, but the chunk size is not 32768.
2430 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2431 * The header of @p wim_file says that resources in the WIM are compressed,
2432 * but the header flag indicating LZX or XPRESS compression is not set.
2433 * @retval ::WIMLIB_ERR_INVALID_HEADER
2434 * The header of @p wim_file was otherwise invalid.
2435 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2436 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @p open_flags and @p
2437 * wim_file contains an integrity table, but the integrity table is
2439 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2440 * The lookup table for the WIM contained duplicate entries that are not
2441 * for metadata resources, or it contained an entry with a SHA1 message
2442 * digest of all 0's.
2443 * @retval ::WIMLIB_ERR_INVALID_PARAM
2444 * @p wim_ret was @c NULL.
2445 * @retval ::WIMLIB_ERR_NOMEM
2446 * Failed to allocated needed memory.
2447 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2448 * @p wim_file does not begin with the expected magic characters.
2449 * @retval ::WIMLIB_ERR_OPEN
2450 * Failed to open the file @p wim_file for reading.
2451 * @retval ::WIMLIB_ERR_READ
2452 * Failed to read data from @p wim_file.
2453 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2454 * @p wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2455 * specified in @p open_flags.
2456 * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
2457 * Unexpected end-of-file while reading data from @p wim_file.
2458 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2459 * A number other than 0x10d00 is written in the version field of the WIM
2460 * header of @p wim_file. (May be a pre-Vista WIM.)
2461 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2462 * ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
2463 * considered read-only because of any of the reasons mentioned in the
2464 * documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2465 * @retval ::WIMLIB_ERR_XML
2466 * The XML data for @p wim_file is invalid.
2469 wimlib_open_wim(const wimlib_tchar *wim_file,
2471 WIMStruct **wim_ret,
2472 wimlib_progress_func_t progress_func);
2475 * Overwrites the file that the WIM was originally read from, with changes made.
2476 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2477 * rather than wimlib_create_new_wim().
2479 * There are two ways that a WIM may be overwritten. The first is to do a full
2480 * rebuild. In this mode, the new WIM is written to a temporary file and then
2481 * renamed to the original file after it is has been completely written. The
2482 * temporary file is made in the same directory as the original WIM file. A
2483 * full rebuild may take a while, but can be used even if images have been
2484 * modified or deleted, will produce a WIM with no holes, and has little chance
2485 * of unintentional data loss because the temporary WIM is fsync()ed before
2486 * being renamed to the original WIM.
2488 * The second way to overwrite a WIM is by appending to the end of it and
2489 * overwriting the header. This can be much faster than a full rebuild, but the
2490 * disadvantage is that some space will be wasted. Writing a WIM in this mode
2491 * begins with writing any new file resources *after* everything in the old WIM,
2492 * even though this will leave a hole where the old lookup table, XML data, and
2493 * integrity were. This is done so that the WIM remains valid even if the
2494 * operation is aborted mid-write. The WIM header is only overwritten at the
2495 * very last moment, and up until that point the WIM will be seen as the old
2498 * By default, wimlib_overwrite() does the append-style overwrite described
2499 * above, unless resources in the WIM are arranged in an unusual way or if
2500 * images have been deleted from the WIM. Use the flag
2501 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2502 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2503 * images have been deleted from the WIM.
2505 * In the temporary-file overwrite mode, no changes are made to the WIM on
2506 * failure, and the temporary file is deleted if possible. Abnormal termination
2507 * of the program will result in the temporary file being orphaned. In the
2508 * direct append mode, the WIM is truncated to the original length on failure;
2509 * and while abnormal termination of the program will result in extra data
2510 * appended to the original WIM, it should still be a valid WIM.
2512 * If this function completes successfully, no more functions should be called
2513 * on @p wim other than wimlib_free(). You must use wimlib_open_wim() to read
2514 * the WIM file anew.
2517 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2518 * been in-memory changes made to it, which are then reflected in the
2520 * @param write_flags
2521 * Bitwise OR of relevant flags prefixed with WIMLIB_WRITE_FLAG.
2522 * @param num_threads
2523 * Number of threads to use for compression (see wimlib_write()).
2524 * @param progress_func
2525 * If non-NULL, a function that will be called periodically with the
2526 * progress of the current operation.
2528 * @return 0 on success; nonzero on error. This function may return any value
2529 * returned by wimlib_write() as well as the following error codes:
2530 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2531 * The WIM was going to be modified in-place (with no temporary file), but
2532 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2533 * because another thread or process has mounted an image from the WIM
2534 * read-write or is currently modifying the WIM in-place.
2535 * @retval ::WIMLIB_ERR_NO_FILENAME
2536 * @p wim corresponds to a WIM created with wimlib_create_new_wim() rather
2537 * than a WIM read with wimlib_open_wim().
2538 * @retval ::WIMLIB_ERR_RENAME
2539 * The temporary file that the WIM was written to could not be renamed to
2540 * the original filename of @p wim.
2541 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2542 * The WIM file is considered read-only because of any of the reasons
2543 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2547 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2548 wimlib_progress_func_t progress_func);
2551 * Prints information about one image, or all images, contained in a WIM.
2554 * Pointer to the ::WIMStruct for a WIM file.
2556 * The image about which to print information. Can be the number of an
2557 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2560 * @return This function has no return value. No error checking is done when
2561 * printing the information. If @p image is invalid, an error message is
2565 wimlib_print_available_images(const WIMStruct *wim, int image);
2568 * Deprecated in favor of wimlib_get_wim_info(), which provides the information
2569 * in a way that can be accessed programatically.
2572 wimlib_print_header(const WIMStruct *wim) _wimlib_deprecated;
2575 * Deprecated in favor of wimlib_iterate_dir_tree(), which provides the
2576 * information in a way that can be accessed programatically.
2579 wimlib_print_metadata(WIMStruct *wim, int image) _wimlib_deprecated;
2582 * Translates a string specifying the name or number of an image in the WIM into
2583 * the number of the image. The images are numbered starting at 1.
2586 * Pointer to the ::WIMStruct for a WIM file.
2587 * @param image_name_or_num
2588 * A string specifying the name or number of an image in the WIM. If it
2589 * parses to a positive integer, this integer is taken to specify the
2590 * number of the image, indexed starting at 1. Otherwise, it is taken to
2591 * be the name of an image, as given in the XML data for the WIM file. It
2592 * also may be the keyword "all" or the string "*", both of which will
2593 * resolve to ::WIMLIB_ALL_IMAGES.
2595 * There is no way to search for an image actually named "all", "*", or an
2596 * integer number, or an image that has no name. However, you can use
2597 * wimlib_get_image_name() to get the name of any image.
2600 * If the string resolved to a single existing image, the number of that
2601 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2602 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2603 * ::WIMLIB_NO_IMAGE is returned. If @p image_name_or_num was @c NULL or
2604 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2605 * images in @p wim has no name.
2608 wimlib_resolve_image(WIMStruct *wim,
2609 const wimlib_tchar *image_name_or_num);
2612 * Changes the description of an image in the WIM.
2615 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2616 * standalone WIM or part of a split WIM; however, you should set the same
2617 * description on all parts of a split WIM.
2619 * The number of the image for which to change the description.
2620 * @param description
2621 * The new description to give the image. It may be @c NULL, which
2622 * indicates that the image is to be given no description.
2624 * @return 0 on success; nonzero on error.
2625 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2626 * @p image does not specify a single existing image in @p wim.
2627 * @retval ::WIMLIB_ERR_NOMEM
2628 * Failed to allocate the memory needed to duplicate the @p description
2630 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2631 * @p wim is considered read-only because of any of the reasons mentioned
2632 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2635 wimlib_set_image_descripton(WIMStruct *wim, int image,
2636 const wimlib_tchar *description);
2639 * Set basic information about a WIM.
2642 * A WIMStruct for a standalone WIM file.
2644 * A struct ::wimlib_wim_info that contains the information to set. Only
2645 * the information explicitly specified in the @p which flags need be
2648 * Flags that specify which information to set. This is a bitwise OR of
2649 * ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,
2650 * ::WIMLIB_CHANGE_BOOT_INDEX, and/or ::WIMLIB_CHANGE_RPFIX_FLAG.
2652 * @return 0 on success; nonzero on failure.
2653 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2654 * The WIM file is considered read-only because of any of the reasons
2655 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2656 * flag. However, as a special case, if you are using
2657 * ::WIMLIB_CHANGE_READONLY_FLAG to unset the readonly flag, then this
2658 * function will not fail due to the readonly flag being previously set.
2659 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2660 * ::WIMLIB_CHANGE_BOOT_INDEX was specified, but
2661 * ::wimlib_wim_info.boot_index did not specify 0 or a valid 1-based image
2665 wimlib_set_wim_info(WIMStruct *wim, const struct wimlib_wim_info *info,
2669 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2670 * (something like "Core" or "Ultimate")
2673 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2674 * standalone WIM or part of a split WIM; however, you should set the same
2675 * \<FLAGS\> element on all parts of a split WIM.
2677 * The number of the image for which to change the description.
2679 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2680 * indicates that the image is to be given no \<FLAGS\> element.
2682 * @return 0 on success; nonzero on error.
2683 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2684 * @p image does not specify a single existing image in @p wim.
2685 * @retval ::WIMLIB_ERR_NOMEM
2686 * Failed to allocate the memory needed to duplicate the @p flags string.
2687 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2688 * @p wim is considered read-only because of any of the reasons mentioned
2689 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2692 wimlib_set_image_flags(WIMStruct *wim, int image, const wimlib_tchar *flags);
2695 * Changes the name of an image in the WIM.
2698 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2699 * standalone WIM or part of a split WIM; however, you should set the same
2700 * name on all parts of a split WIM.
2702 * The number of the image for which to change the name.
2704 * New name to give the new image. If @c NULL or empty, the new image is
2705 * given no name. If nonempty, it must specify a name that does not
2706 * already exist in @p wim.
2708 * @return 0 on success; nonzero on error.
2709 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2710 * There is already an image named @p name in @p wim.
2711 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2712 * @p image does not specify a single existing image in @p wim.
2713 * @retval ::WIMLIB_ERR_NOMEM
2714 * Failed to allocate the memory needed to duplicate the @p name string.
2715 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2716 * @p wim is considered read-only because of any of the reasons mentioned
2717 * in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS flag.
2719 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2720 const wimlib_tchar *name);
2723 * Set the functions that wimlib uses to allocate and free memory.
2725 * These settings are global and not per-WIM.
2727 * The default is to use the default @c malloc() and @c free() from the C
2730 * Please note that some external functions, such as those in @c libntfs-3g, may
2731 * use the standard memory allocation functions.
2733 * @param malloc_func
2734 * A function equivalent to @c malloc() that wimlib will use to allocate
2735 * memory. If @c NULL, the allocator function is set back to the default
2736 * @c malloc() from the C library.
2738 * A function equivalent to @c free() that wimlib will use to free memory.
2739 * If @c NULL, the free function is set back to the default @c free() from
2741 * @param realloc_func
2742 * A function equivalent to @c realloc() that wimlib will use to reallocate
2743 * memory. If @c NULL, the free function is set back to the default @c
2744 * realloc() from the C library.
2745 * @return 0 on success; nonzero on error.
2746 * @retval ::WIMLIB_ERR_UNSUPPORTED
2747 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2748 * so custom memory allocators are unsupported.
2751 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2752 void (*free_func)(void *),
2753 void *(*realloc_func)(void *, size_t));
2756 * Sets whether wimlib is to print error messages to @c stderr when a function
2757 * fails. These error messages may provide information that cannot be
2758 * determined only from the error code that is returned. Not every error will
2759 * result in an error message being printed.
2761 * This setting is global and not per-WIM.
2763 * By default, error messages are not printed.
2765 * This can be called before wimlib_global_init().
2767 * @param show_messages
2768 * @c true if error messages are to be printed; @c false if error messages
2769 * are not to be printed.
2771 * @return 0 on success; nonzero on error.
2772 * @retval ::WIMLIB_ERR_UNSUPPORTED
2773 * @p show_messages was @c true, but wimlib was compiled with the @c
2774 * --without-error-messages option. Therefore, error messages cannot be
2778 wimlib_set_print_errors(bool show_messages);
2781 * Splits a WIM into multiple parts.
2784 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2787 * Name of the SWM file to create. This will be the name of the first
2788 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2789 * appended before the suffix.
2791 * The maximum size per part, in bytes. Unfortunately, it is not
2792 * guaranteed that this will really be the maximum size per part, because
2793 * some file resources in the WIM may be larger than this size, and the WIM
2794 * file format provides no way to split up file resources among multiple
2796 * @param write_flags
2797 * Bitwise OR of relevant flags prefixed with @c WIMLIB_WRITE_FLAG. These
2798 * flags will be used to write each split WIM part. Specify 0 here to get
2799 * the default behavior.
2800 * @param progress_func
2801 * If non-NULL, a function that will be called periodically with the
2802 * progress of the current operation
2803 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
2804 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART).
2806 * @return 0 on success; nonzero on error. This function may return most error
2807 * codes that can be returned by wimlib_write() as well as the following error
2810 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2811 * @p wim was not part 1 of a stand-alone WIM.
2812 * @retval ::WIMLIB_ERR_INVALID_PARAM
2813 * @p swm_name was not a nonempty string, or @p part_size was 0.
2815 * Note: the WIM's uncompressed and compressed resources are not checksummed
2816 * when they are copied from the joined WIM to the split WIM parts, nor are
2817 * compressed resources re-compressed (unless explicitly requested with
2818 * ::WIMLIB_WRITE_FLAG_RECOMPRESS).
2821 wimlib_split(WIMStruct *wim,
2822 const wimlib_tchar *swm_name,
2825 wimlib_progress_func_t progress_func);
2828 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2830 * The image to unmount is specified by the path to the mountpoint, not the
2831 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2832 * touched and also may have been allocated in a different process.
2834 * To unmount the image, the thread calling this function communicates with the
2835 * thread that is managing the mounted WIM image. This function blocks until it
2836 * is known whether the unmount succeeded or failed. In the case of a
2837 * read-write mounted WIM, the unmount is not considered to have succeeded until
2838 * all changes have been saved to the underlying WIM file.
2841 * The directory that the WIM image was mounted on.
2842 * @param unmount_flags
2843 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2844 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2845 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2847 * @param progress_func
2848 * If non-NULL, a function that will be called periodically with the
2849 * progress of the current operation. Currently, only
2850 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS will be sent.
2852 * @return 0 on success; nonzero on error.
2854 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2855 * The filesystem daemon was unable to remove the staging directory and the
2856 * temporary files that it contains.
2857 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2858 * The filesystem daemon appears to have terminated before sending an exit
2860 * @retval ::WIMLIB_ERR_FORK
2861 * Could not @c fork() the process.
2862 * @retval ::WIMLIB_ERR_FUSERMOUNT
2863 * The @b fusermount program could not be executed or exited with a failure
2865 * @retval ::WIMLIB_ERR_MQUEUE
2866 * Could not open a POSIX message queue to communicate with the filesystem
2867 * daemon servicing the mounted filesystem, could not send a message
2868 * through the queue, or could not receive a message through the queue.
2869 * @retval ::WIMLIB_ERR_NOMEM
2870 * Failed to allocate needed memory.
2871 * @retval ::WIMLIB_ERR_OPEN
2872 * The filesystem daemon could not open a temporary file for writing the
2874 * @retval ::WIMLIB_ERR_READ
2875 * A read error occurred when the filesystem daemon tried to a file from
2876 * the staging directory
2877 * @retval ::WIMLIB_ERR_RENAME
2878 * The filesystem daemon failed to rename the newly written WIM file to the
2879 * original WIM file.
2880 * @retval ::WIMLIB_ERR_UNSUPPORTED
2881 * Mounting is not supported, either because the platform is Windows, or
2882 * because the platform is UNIX-like and wimlib was compiled with @c
2884 * @retval ::WIMLIB_ERR_WRITE
2885 * A write error occurred when the filesystem daemon was writing to the new
2886 * WIM file, or the filesystem daemon was unable to flush changes that had
2887 * been made to files in the staging directory.
2890 wimlib_unmount_image(const wimlib_tchar *dir,
2892 wimlib_progress_func_t progress_func);
2895 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2898 * Pointer to the ::WIMStruct for the WIM file to update.
2900 * The 1-based index of the image in the WIM to update. It cannot be
2901 * ::WIMLIB_ALL_IMAGES.
2903 * An array of ::wimlib_update_command's that specify the update operations
2906 * Number of commands in @p cmds.
2907 * @param update_flags
2908 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2909 * @param progress_func
2910 * If non-NULL, a function that will be called periodically with the
2911 * progress of the current operation.
2913 * @return 0 on success; nonzero on error. On failure, some but not all of the
2914 * update commands may have been executed. No individual update command will
2915 * have been partially executed. Possible error codes include:
2917 * @retval ::WIMLIB_ERR_DECOMPRESSION
2918 * Failed to decompress the metadata resource from @p image in @p wim.
2919 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2920 * The capture configuration structure specified for an add command was
2922 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2923 * @p image did not specify a single, existing image in @p wim.
2924 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2925 * Attempted to perform an add command that conflicted with previously
2926 * existing files in the WIM when an overlay was attempted.
2927 * @retval ::WIMLIB_ERR_INVALID_PARAM
2928 * An unknown operation type was specified in the update commands; or,
2929 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2930 * in the @p add_flags, but the same image had previously already been
2931 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2932 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @p add_flags for one add
2933 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2934 * specified in the @p add_flags for an add command in which @p
2935 * wim_target_path was not the root directory of the WIM image.
2936 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2937 * (Windows only): While executing an add command, tried to capture a
2938 * reparse point with invalid data.
2939 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2940 * The metadata resource for @p image in @p wim is invalid.
2941 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2942 * The security data for image @p image in @p wim is invalid.
2943 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2944 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2945 * for a WIM path that corresponded to a directory; or, a rename command
2946 * attempted to rename a directory to a non-directory.
2947 * @retval ::WIMLIB_ERR_NOMEM
2948 * Failed to allocate needed memory.
2949 * @retval ::WIMLIB_ERR_NOTDIR
2950 * A rename command attempted to rename a directory to a non-directory; or,
2951 * an add command was executed that attempted to set the root of the WIM
2952 * image as a non-directory; or, a path component used as a directory in a
2953 * rename command was not, in fact, a directory.
2954 * @retval ::WIMLIB_ERR_NOTEMPTY
2955 * A rename command attempted to rename a directory to a non-empty
2957 * @retval ::WIMLIB_ERR_NTFS_3G
2958 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2959 * error occurred while reading data from the NTFS volume using libntfs-3g.
2960 * @retval ::WIMLIB_ERR_OPEN
2961 * Failed to open a file to be captured while executing an add command.
2962 * @retval ::WIMLIB_ERR_OPENDIR
2963 * Failed to open a directory to be captured while executing an add command.
2964 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2965 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2966 * WIM path that did not exist; or, a rename command attempted to rename a
2967 * file that does not exist.
2968 * @retval ::WIMLIB_ERR_READ
2969 * Failed to read the metadata resource for @p image in @p wim; or, while
2970 * executing an add command, failed to read data from a file or directory
2972 * @retval ::WIMLIB_ERR_READLINK
2973 * While executing an add command, failed to read the target of a symbolic
2974 * link or junction point.
2975 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2976 * (Windows only) Failed to perform a reparse point fixup because of
2977 * problems with the data of a reparse point.
2978 * @retval ::WIMLIB_ERR_UNSUPPORTED_FILE
2979 * While executing an add command, attempted to capture a file that was not
2980 * a supported file type (e.g. a device file). Only if
2981 * ::WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE specified in @p the add_flags
2982 * for an update command.
2983 * @retval ::WIMLIB_ERR_STAT
2984 * While executing an add command, failed to get attributes for a file or
2986 * @retval ::WIMLIB_ERR_UNSUPPORTED
2987 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @p add_flags for an update
2988 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
2989 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2990 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @p
2991 * add_flags for an update command.
2992 * @retval ::WIMLIB_ERR_WIM_IS_READONLY
2993 * The WIM file is considered read-only because of any of the reasons
2994 * mentioned in the documentation for the ::WIMLIB_OPEN_FLAG_WRITE_ACCESS
2998 wimlib_update_image(WIMStruct *wim,
3000 const struct wimlib_update_command *cmds,
3003 wimlib_progress_func_t progress_func);
3006 * Writes a standalone WIM to a file.
3008 * This brings in resources from any external locations, such as directory trees
3009 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
3010 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
3013 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
3014 * changes made to it, which are then reflected in the output file.
3016 * The path to the file to write the WIM to.
3018 * The 1-based index of the image inside the WIM to write. Use
3019 * ::WIMLIB_ALL_IMAGES to include all images.
3020 * @param write_flags
3021 * Bitwise OR of any of the flags prefixed with @c WIMLIB_WRITE_FLAG.
3022 * @param num_threads
3023 * Number of threads to use for compressing data. If 0, the number of
3024 * threads is taken to be the number of online processors. Note: if no
3025 * data compression needs to be done, no additional threads will be created
3026 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
3027 * exporting an image from a compressed WIM to another WIM of the same
3028 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @p
3030 * @param progress_func
3031 * If non-NULL, a function that will be called periodically with the
3032 * progress of the current operation. The possible messages are
3033 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
3034 * ::WIMLIB_PROGRESS_MSG_WRITE_METADATA_END, and
3035 * ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS.
3037 * @return 0 on success; nonzero on error.
3039 * @retval ::WIMLIB_ERR_DECOMPRESSION
3040 * Failed to decompress a metadata or file resource in @p wim.
3041 * @retval ::WIMLIB_ERR_INVALID_IMAGE
3042 * @p image does not specify a single existing image in @p wim, and is not
3043 * ::WIMLIB_ALL_IMAGES.
3044 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
3045 * A file that had previously been scanned for inclusion in the WIM by
3046 * wimlib_add_image() was concurrently modified, so it failed the SHA1
3047 * message digest check.
3048 * @retval ::WIMLIB_ERR_INVALID_PARAM
3049 * @p path was @c NULL.
3050 * @retval ::WIMLIB_ERR_INVALID_METADATA_RESOURCE
3051 * The metadata resource for @p image in @p wim is invalid.
3052 * @retval ::WIMLIB_ERR_NOMEM
3053 * Failed to allocate needed memory.
3054 * @retval ::WIMLIB_ERR_OPEN
3055 * Failed to open @p path for writing, or some file resources in @p wim
3056 * refer to files in the outside filesystem, and one of these files could
3057 * not be opened for reading.
3058 * @retval ::WIMLIB_ERR_READ
3059 * An error occurred when trying to read data from the WIM file associated
3060 * with @p wim, or some file resources in @p wim refer to files in the
3061 * outside filesystem, and a read error occurred when reading one of these
3063 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
3064 * @p wim is part of a split WIM, not a standalone WIM.
3065 * @retval ::WIMLIB_ERR_WRITE
3066 * An error occurred when trying to write data to the new WIM file.
3069 wimlib_write(WIMStruct *wim,
3070 const wimlib_tchar *path,
3073 unsigned num_threads,
3074 wimlib_progress_func_t progress_func);
3077 * Since wimlib v1.5.0: Same as wimlib_write(), but write the WIM directly to a
3078 * file descriptor, which need not be seekable if the write is done in a special
3079 * pipable WIM format by providing ::WIMLIB_WRITE_FLAG_PIPABLE in @p
3080 * write_flags. This can, for example, allow capturing a WIM image and
3081 * streaming it over the network. See the documentation for
3082 * ::WIMLIB_WRITE_FLAG_PIPABLE for more information about pipable WIMs.
3084 * The file descriptor @p fd will @b not be closed when the write is complete;
3085 * the calling code is responsible for this.
3087 * Returns 0 on success; nonzero on failure. The possible error codes include
3088 * those that can be returned by wimlib_write() as well as the following:
3090 * @retval ::WIMLIB_ERR_INVALID_PARAM
3091 * @p fd was not seekable, but ::WIMLIB_WRITE_FLAG_PIPABLE was not
3092 * specified in @p write_flags.
3095 wimlib_write_to_fd(WIMStruct *wim,
3099 unsigned num_threads,
3100 wimlib_progress_func_t progress_func);
3103 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
3104 * the data using "XPRESS" compression.
3107 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
3110 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
3111 * the data is compressed using "XPRESS" compression.
3114 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
3115 void *uncompressed_data, unsigned uncompressed_len);
3117 #endif /* _WIMLIB_H */