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.4.1, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the README file.
40 * \section starting Getting Started
42 * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43 * install with <code>configure && make && sudo make install</code>; however,
44 * please see the README for more information about installing it. To use
45 * wimlib in a program after installing it, include @c wimlib.h and link your
46 * program with @c -lwim.
48 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
49 * may represent either a stand-alone WIM or one part of a split WIM.
51 * All functions in wimlib's public API are prefixed with @c wimlib. Most
52 * return 0 on success and a positive error code on failure. Use
53 * wimlib_get_error_string() to get a string that describes an error code.
54 * wimlib also can print error messages itself when an error happens, and these
55 * may be more informative than the error code; to enable this, call
56 * wimlib_set_print_errors(). Please note that this is for convenience only,
57 * and some errors can occur without a message being printed.
59 * First before calling any other functions, you should call
60 * wimlib_global_init() to initialize the library.
62 * To open an existing WIM, use wimlib_open_wim().
64 * To create a new WIM that initially contains no images, use
65 * wimlib_create_new_wim().
67 * To add an image to a WIM file from a directory tree on your filesystem, call
68 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
69 * wimlib_open_wim() or from wimlib_create_new_wim(). On UNIX,
70 * wimlib_add_image() can also capture a WIM image directly from a block device
71 * containing a NTFS filesystem.
73 * To extract an image from a WIM file, call wimlib_extract_image(). This can
74 * be done either to a directory, or, on UNIX, directly to a block device
75 * containing a NTFS filesystem.
77 * To extract individual files or directories from a WIM image, rather than a
78 * full image, call wimlib_extract_files().
80 * To programatically make changes to a WIM image without mounting it, call
81 * wimlib_update_image().
83 * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84 * Mounting is done using wimlib_mount_image() and unmounting is done using
85 * wimlib_unmount_image(). Mounting can be done without root privileges because
86 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
87 * compiled with the <code>--without-fuse</code> flag, these functions will be
88 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
90 * After creating or modifying a WIM file, you can write it to a file using
91 * wimlib_write(). Alternatively, if the WIM was originally read from a file
92 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93 * wimlib_overwrite() to overwrite the original file.
95 * Please note: merely by calling wimlib_add_image() or many of the other
96 * functions in this library that operate on ::WIMStruct's, you are @b not
97 * modifying the WIM file on disk. Changes are not saved until you explicitly
98 * call wimlib_write() or wimlib_overwrite().
100 * After you are done with the WIM file, use wimlib_free() to free all memory
101 * associated with a ::WIMStruct and close all files associated with it.
103 * When you are completely done with using wimlib in your program, you should
104 * call wimlib_global_cleanup().
106 * A number of functions take a pointer to a progress function of type
107 * ::wimlib_progress_func_t. This function will be called periodically during
108 * the WIM operation(s) to report on the progress of the operation (for example,
109 * how many bytes have been written so far).
111 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112 * the following exceptions:
113 * - You must call wimlib_global_init() in one thread before calling any other
115 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
116 * race conditions with one-time allocations of memory.
117 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
118 * concurrently in the same process, will daemonize the entire process when it
119 * does so for the first time. This includes changing the working directory
120 * to the root directory.
122 * \section encodings Locales and character encodings
124 * To support Windows as well as UNIX, wimlib's API typically takes and returns
125 * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
127 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
128 * and the encoding is UTF-16LE.
130 * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
131 * encoding is the locale-dependent multibyte encoding. I recommend you set
132 * your locale to a UTF-8 capable locale to avoid any issues. Also, by default,
133 * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
134 * wimlib_global_init() after having set your desired locale.
136 * \section Limitations
138 * This section documents some technical limitations of wimlib not already
139 * documented in the man page for @b wimlib-imagex.
141 * - The old WIM format from Vista pre-releases is not supported.
142 * - Compressed resource chunk sizes other than 32768 are not supported. This
143 * doesn't seem to be a real problem because the chunk size always seems to be
145 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
146 * functionality other than that already present in @b ImageX, that allows you
147 * to make certain Windows-specific modifications to a Windows PE image, such
148 * as adding a driver or Windows component. Such a tool possibly could be
149 * implemented on top of wimlib.
158 #include <inttypes.h>
160 /** Major version of the library (for example, the 1 in 1.2.5). */
161 #define WIMLIB_MAJOR_VERSION 1
163 /** Minor version of the library (for example, the 2 in 1.2.5). */
164 #define WIMLIB_MINOR_VERSION 4
166 /** Patch version of the library (for example, the 5 in 1.2.5). */
167 #define WIMLIB_PATCH_VERSION 1
170 * Opaque structure that represents a WIM file. This is an in-memory structure
171 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
172 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
173 * continuing to exist so that data can be read from it as needed.
175 * Most functions in this library will work the same way regardless of whether a
176 * given ::WIMStruct was obtained through wimlib_open_wim() or
177 * wimlib_create_new_wim(). Exceptions are documented.
179 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
180 * file from a ::WIMStruct.
182 #ifndef WIMLIB_WIMSTRUCT_DECLARED
183 typedef struct WIMStruct WIMStruct;
184 #define WIMLIB_WIMSTRUCT_DECLARED
188 typedef wchar_t wimlib_tchar;
190 /** See \ref encodings */
191 typedef char wimlib_tchar;
195 /** Path separator for WIM paths passed back to progress callbacks. */
196 # define WIMLIB_WIM_PATH_SEPARATOR '\\'
197 # define WIMLIB_WIM_PATH_SEPARATOR_STRING L"\\"
199 /** Path separator for WIM paths passed back to progress callbacks. */
200 # define WIMLIB_WIM_PATH_SEPARATOR '/'
201 # define WIMLIB_WIM_PATH_SEPARATOR_STRING "/"
204 * Specifies the compression type of a WIM file.
206 enum wimlib_compression_type {
207 /** An invalid compression type. */
208 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
210 /** The WIM does not include any compressed resources. */
211 WIMLIB_COMPRESSION_TYPE_NONE = 0,
213 /** Compressed resources in the WIM use LZX compression. */
214 WIMLIB_COMPRESSION_TYPE_LZX = 1,
216 /** Compressed resources in the WIM use XPRESS compression. */
217 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
220 /** Possible values of the first parameter to the user-supplied
221 * ::wimlib_progress_func_t progress function */
222 enum wimlib_progress_msg {
224 /** A WIM image is about to be extracted. @a info will point to
225 * ::wimlib_progress_info.extract. */
226 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN = 0,
228 /** A file or directory tree within a WIM image (not the full image) is
229 * about to be extracted. @a info will point to
230 * ::wimlib_progress_info.extract. */
231 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
233 /** The directory structure of the WIM image is about to be extracted.
234 * @a info will point to ::wimlib_progress_info.extract. */
235 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
237 /** The directory structure of the WIM image has been successfully
238 * extracted. @a info will point to ::wimlib_progress_info.extract. */
239 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
241 /** The WIM image's files resources are currently being extracted. @a
242 * info will point to ::wimlib_progress_info.extract. */
243 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
245 /** A file or directory is being extracted. @a info will point to
246 * ::wimlib_progress_info.extract, and the @a cur_path member will be
248 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
250 /** All the WIM files and directories have been extracted, and
251 * timestamps are about to be applied. @a info will point to
252 * ::wimlib_progress_info.extract. */
253 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
255 /** A WIM image has been successfully extracted. @a info will point to
256 * ::wimlib_progress_info.extract. */
257 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
259 /** A file or directory tree within a WIM image (not the full image) has
260 * been successfully extracted. @a info will point to
261 * ::wimlib_progress_info.extract. */
262 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
264 /** The directory or NTFS volume is about to be scanned to build a tree
265 * of WIM dentries in-memory. @a info will point to
266 * ::wimlib_progress_info.scan. */
267 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
269 /** A directory or file is being scanned. @a info will point to
270 * ::wimlib_progress_info.scan, and its @a cur_path member will be
271 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
272 * is passed to wimlib_add_image(). */
273 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
275 /** The directory or NTFS volume has been successfully scanned, and a
276 * tree of WIM dentries has been built in-memory. @a info will point to
277 * ::wimlib_progress_info.scan. */
278 WIMLIB_PROGRESS_MSG_SCAN_END,
281 * File resources are currently being written to the WIM.
282 * @a info will point to ::wimlib_progress_info.write_streams. */
283 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
286 * The metadata resource for each image is about to be written to the
287 * WIM. @a info will not be valid. */
288 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
291 * The metadata resource for each image has successfully been writen to
292 * the WIM. @a info will not be valid. */
293 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
296 * The temporary file has successfully been renamed to the original WIM
297 * file. Only happens when wimlib_overwrite() is called and the
298 * overwrite is not done in-place.
299 * @a info will point to ::wimlib_progress_info.rename. */
300 WIMLIB_PROGRESS_MSG_RENAME,
302 /** The contents of the WIM are being checked against the integrity
303 * table. Only happens when wimlib_open_wim() is called with the
304 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
305 * ::wimlib_progress_info.integrity. */
306 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
308 /** An integrity table is being calculated for the WIM being written.
309 * Only happens when wimlib_write() or wimlib_overwrite() is called with
310 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
311 * ::wimlib_progress_info.integrity. */
312 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
314 /** A wimlib_join() operation is in progress. @a info will point to
315 * ::wimlib_progress_info.join. */
316 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
318 /** A wimlib_split() operation is in progress, and a new split part is
319 * about to be started. @a info will point to
320 * ::wimlib_progress_info.split. */
321 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
323 /** A wimlib_split() operation is in progress, and a split part has been
324 * finished. @a info will point to ::wimlib_progress_info.split. */
325 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
328 * A WIM update command is just about to be executed; @a info will point
329 * to ::wimlib_progress_info.update.
331 WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND,
334 * A WIM update command has just been executed; @a info will point to
335 * ::wimlib_progress_info.update.
337 WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND,
341 /** A pointer to this union is passed to the user-supplied
342 * ::wimlib_progress_func_t progress function. One (or none) of the structures
343 * contained in this union will be applicable for the operation
344 * (::wimlib_progress_msg) indicated in the first argument to the progress
346 union wimlib_progress_info {
348 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
349 * document them if they aren't given a name... */
351 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
352 struct wimlib_progress_info_write_streams {
353 /** Number of bytes that are going to be written for all the
354 * streams combined. This is the amount in uncompressed data.
355 * (The actual number of bytes will be less if the data is being
356 * written compressed.) */
357 uint64_t total_bytes;
358 /** Number of streams that are going to be written. */
359 uint64_t total_streams;
361 /** Number of uncompressed bytes that have been written so far.
362 * Will be 0 initially, and equal to @a total_bytes at the end.
364 uint64_t completed_bytes;
366 /** Number of streams that have been written. Will be 0
367 * initially, and equal to @a total_streams at the end. */
368 uint64_t completed_streams;
370 /** Number of threads that are being used to compress resources
371 * (if applicable). */
372 unsigned num_threads;
374 /** The compression type being used to write the streams; either
375 * ::WIMLIB_COMPRESSION_TYPE_NONE,
376 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
377 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
378 int compression_type;
380 /** Library internal use only. */
384 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
385 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
386 struct wimlib_progress_info_scan {
387 /** Directory or NTFS volume that is being scanned. */
388 const wimlib_tchar *source;
390 /** Path to the file or directory that is about to be scanned,
391 * relative to the root of the image capture or the NTFS volume.
393 const wimlib_tchar *cur_path;
395 /** True iff @a cur_path is being excluded from the image
396 * capture due to the capture configuration file. */
399 /** Target path in the WIM. Only valid on messages
400 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
401 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
402 const wimlib_tchar *wim_target_path;
405 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
406 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
407 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
408 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
409 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
410 struct wimlib_progress_info_extract {
411 /** Number of the image being extracted (1-based). */
414 /** Flags passed to to wimlib_extract_image() */
417 /** Full path to the WIM file being extracted. */
418 const wimlib_tchar *wimfile_name;
420 /** Name of the image being extracted. */
421 const wimlib_tchar *image_name;
423 /** Directory or NTFS volume to which the image is being
425 const wimlib_tchar *target;
427 /** Current dentry being extracted. (Valid only if message is
428 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
429 const wimlib_tchar *cur_path;
431 /** Number of bytes of uncompressed data that will be extracted.
432 * Takes into account hard links (they are not counted for each
435 uint64_t total_bytes;
437 /** Number of bytes that have been written so far. Will be 0
438 * initially, and equal to @a total_bytes at the end. */
439 uint64_t completed_bytes;
441 /** Number of streams that will be extracted. This may more or
442 * less than the number of "files" to be extracted due to
443 * special cases (hard links, symbolic links, and alternate data
445 uint64_t num_streams;
447 /** Path to the root dentry within the WIM for the tree that is
448 * being extracted. Will be the empty string when extracting a
450 const wimlib_tchar *extract_root_wim_source_path;
453 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
454 struct wimlib_progress_info_rename {
455 /** Name of the temporary file that the WIM was written to. */
456 const wimlib_tchar *from;
458 /** Name of the original WIM file to which the temporary file is
460 const wimlib_tchar *to;
463 /** Valid on messages ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
464 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND. */
465 struct wimlib_progress_info_update {
466 /** Pointer to the update command that will be executed or has
467 * just been executed. */
468 const struct wimlib_update_command *command;
470 /** Number of update commands that have been completed so far.
472 size_t completed_commands;
474 /** Number of update commands that are being executed as part of
475 * this call to wimlib_update_image(). */
476 size_t total_commands;
479 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
480 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
481 struct wimlib_progress_info_integrity {
482 /** Number of bytes from the end of the WIM header to the end of
483 * the lookup table (the area that is covered by the SHA1
484 * integrity checks.) */
485 uint64_t total_bytes;
487 /** Number of bytes that have been SHA1-summed so far. Will be
488 * 0 initially, and equal @a total_bytes at the end. */
489 uint64_t completed_bytes;
491 /** Number of chunks that the checksummed region is divided
493 uint32_t total_chunks;
495 /** Number of chunks that have been SHA1-summed so far. Will
496 * be 0 initially, and equal to @a total_chunks at the end. */
497 uint32_t completed_chunks;
499 /** Size of the chunks used for the integrity calculation. */
502 /** Filename of the WIM (only valid if the message is
503 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
504 const wimlib_tchar *filename;
507 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
508 struct wimlib_progress_info_join {
509 /** Total number of bytes of compressed data contained in all
510 * the split WIM part's file and metadata resources. */
511 uint64_t total_bytes;
513 /** Number of bytes that have been copied to the joined WIM so
514 * far. Will be 0 initially, and equal to @a total_bytes at the
516 uint64_t completed_bytes;
518 /** Number of split WIM parts that have had all their file and
519 * metadata resources copied over to the joined WIM so far. */
520 unsigned completed_parts;
522 /** Number of split WIM parts. */
523 unsigned total_parts;
526 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
527 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
528 struct wimlib_progress_info_split {
529 /** Total size of the original WIM's file and metadata resources
531 uint64_t total_bytes;
533 /** Number of bytes of file and metadata resources that have
534 * been copied out of the original WIM so far. Will be 0
535 * initially, and equal to @a total_bytes at the end. */
536 uint64_t completed_bytes;
538 /** Number of the split WIM part that is about to be started
539 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
540 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
541 unsigned cur_part_number;
543 /** Name of the split WIM part that is about to be started
544 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
545 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
546 const wimlib_tchar *part_name;
550 /** A user-supplied function that will be called periodically during certain WIM
551 * operations. The first argument will be the type of operation that is being
552 * performed or is about to be started or has been completed. The second
553 * argument will be a pointer to one of a number of structures depending on the
554 * first argument. It may be @c NULL for some message types.
556 * The return value of the progress function is currently ignored, but it may do
557 * something in the future. (Set it to 0 for now.)
559 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
560 const union wimlib_progress_info *info);
562 /** An array of these structures is passed to wimlib_add_image_multisource() to
563 * specify the sources from which to create a WIM image. */
564 struct wimlib_capture_source {
565 /** Absolute or relative path to a file or directory on the external
566 * filesystem to be included in the WIM image. */
567 wimlib_tchar *fs_source_path;
569 /** Destination path in the WIM image. Leading and trailing slashes are
570 * ignored. The empty string or @c NULL means the root directory of the
572 wimlib_tchar *wim_target_path;
574 /** Reserved; set to 0. */
578 /** Structure that specifies a list of path patterns. */
579 struct wimlib_pattern_list {
580 /** Array of patterns. The patterns may be modified by library code,
581 * but the @a pats pointer itself will not. See the man page for
582 * <b>wimlib-imagex capture</b> for more information about allowed
586 /** Number of patterns in the @a pats array. */
589 /** Ignored; may be used by the calling code. */
590 size_t num_allocated_pats;
593 /** A structure that contains lists of wildcards that match paths to treat
594 * specially when capturing a WIM image. */
595 struct wimlib_capture_config {
596 /** Paths matching any pattern this list are excluded from being
597 * captured, except if the same path appears in @a
598 * exclusion_exception_pats. */
599 struct wimlib_pattern_list exclusion_pats;
601 /** Paths matching any pattern in this list are never excluded from
603 struct wimlib_pattern_list exclusion_exception_pats;
605 /** Reserved for future capture configuration options. */
606 struct wimlib_pattern_list reserved1;
608 /** Reserved for future capture configuration options. */
609 struct wimlib_pattern_list reserved2;
611 /** Library internal use only. */
612 const wimlib_tchar *_prefix;
614 /** Library internal use only. */
615 size_t _prefix_num_tchars;
619 /*****************************
621 *****************************/
623 /** Directly capture a NTFS volume rather than a generic directory. This flag
624 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
625 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
626 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
628 /** Follow symlinks; archive and dump the files they point to. Cannot be used
629 * with ::WIMLIB_ADD_FLAG_NTFS. */
630 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
632 /** Call the progress function with the message
633 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
635 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
637 /** Mark the image being added as the bootable image of the WIM. */
638 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
640 /** Store the UNIX owner, group, and mode. This is done by adding a special
641 * alternate data stream to each regular file, symbolic link, and directory to
642 * contain this information. Please note that this flag is for convenience
643 * only; Microsoft's @a imagex.exe will not understand this special information.
644 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
645 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
647 /** Do not capture security descriptors. Only has an effect in NTFS capture
648 * mode, or in Win32 native builds. */
649 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
651 /** Fail immediately if the full security descriptor of any file or directory
652 * cannot be accessed. Only has an effect in Win32 native builds. The default
653 * behavior without this flag is to first try omitting the SACL from the
654 * security descriptor, then to try omitting the security descriptor entirely.
656 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
658 /** Call the progress function with the message
659 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
660 * capture. This is a subset of the messages provided by
661 * ::WIMLIB_ADD_FLAG_VERBOSE. */
662 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
664 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
665 * in the case of Windows) that point inside the directory being captured to
666 * instead be absolute relative to the directory being captured, rather than the
667 * current root; also exclude absolute symbolic links that point outside the
668 * directory tree being captured.
670 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
671 * the WIM header or if this is the first image being added.
672 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
673 * reparse point fixups enabled and currently cannot be unset. */
674 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
676 /** Don't do reparse point fixups. The default behavior is described in the
677 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
678 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
680 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
681 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
682 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
683 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
684 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
685 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
686 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
687 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
688 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
689 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
691 /******************************
692 * WIMLIB_DELETE_FLAG_*
693 ******************************/
695 /** Do not issue an error if the path to delete does not exist. */
696 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
698 /** Delete the file or directory tree recursively; if not specified, an error is
699 * issued if the path to delete is a directory. */
700 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
702 /******************************
703 * WIMLIB_EXPORT_FLAG_*
704 ******************************/
706 /** See documentation for wimlib_export_image(). */
707 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
709 /******************************
710 * WIMLIB_EXTRACT_FLAG_*
711 ******************************/
713 /** Extract the image directly to a NTFS volume rather than a generic directory.
715 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
717 /** When identical files are extracted from the WIM, always hard link them
718 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
719 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
721 /** When identical files are extracted from the WIM, always symlink them
722 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
723 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
725 /** Call the progress function with the argument
726 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
727 * extracted. Note: these calls will be interspersed with calls for the message
728 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
729 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
731 /** Read the WIM file sequentially while extracting the image. */
732 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
734 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
735 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
736 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
738 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
739 * or in Win32 native builds. */
740 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
742 /** Fail immediately if the full security descriptor of any file or directory
743 * cannot be set exactly as specified in the WIM file. The default behavior
744 * without this flag is to fall back to setting the security descriptor with the
745 * SACL omitted, then only the default inherited security descriptor, if we do
746 * not have permission to set the desired one. */
747 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
749 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
750 * fixups on, so absolute symbolic links or junction points will be fixed to be
751 * absolute relative to the actual extraction root. Done by default if
752 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
753 * specified when extracting a full image. */
754 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
756 /** Force reparse-point fixups on extraction off, regardless of the state of the
757 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
758 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
760 /** Extract files to standard output rather than to the filesystem. */
761 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
763 /** Instead of ignoring files and directories with names that cannot be
764 * represented on the current platform (note: Windows has more restrictions on
765 * filenames than UNIX), try to replace characters or append junk to the names
766 * so that they can be extracted in some form. */
767 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
769 /** On Windows, when there exist two or more files with the same case
770 * insensitive name but different case sensitive names, try to extract them all
771 * by appending junk to the end of them, rather than arbitrarily extracting only
773 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
775 /******************************
776 * WIMLIB_MOUNT_FLAG_*
777 ******************************/
779 /** Mount the WIM image read-write rather than the default of read-only. */
780 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
782 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
783 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
785 /** Do not allow accessing alternate data streams in the mounted WIM image. */
786 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
788 /** Access alternate data streams in the mounted WIM image through extended file
789 * attributes. This is the default mode. */
790 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
792 /** Access alternate data streams in the mounted WIM image by specifying the
793 * file name, a colon, then the alternate file stream name. */
794 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
796 /** Use UNIX file owners, groups, and modes if available in the WIM (see
797 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
798 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
800 /** Allow other users to see the mounted filesystem. (this passes the @c
801 * allow_other option to FUSE mount) */
802 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
804 /******************************
806 ******************************/
808 /** Verify the WIM contents against the WIM's integrity table, if present. */
809 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
811 /** Do not issue an error if the WIM is part of a split WIM. */
812 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
814 /******************************
815 * WIMLIB_UNMOUNT_FLAG_*
816 ******************************/
818 /** Include an integrity table in the WIM after it's been unmounted. Ignored
819 * for read-only mounts. */
820 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
822 /** Unless this flag is given, changes to a read-write mounted WIM are
823 * discarded. Ignored for read-only mounts. */
824 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
826 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
827 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
829 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
830 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
832 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
833 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
835 /******************************
836 * WIMLIB_UPDATE_FLAG_*
837 ******************************/
839 /** Send ::WIMLIB_PROGRESS_MSG_UPDATE_BEGIN_COMMAND and
840 * ::WIMLIB_PROGRESS_MSG_UPDATE_END_COMMAND messages. */
841 #define WIMLIB_UPDATE_FLAG_SEND_PROGRESS 0x00000001
843 /******************************
844 * WIMLIB_WRITE_FLAG_*
845 ******************************/
847 /** Include an integrity table in the new WIM file. */
848 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
850 /** Re-build the entire WIM file rather than appending data to it, if possible.
851 * (Applies to wimlib_overwrite(), not wimlib_write()). */
852 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
854 /** Recompress all resources, even if they could otherwise be copied from a
855 * different WIM with the same compression type (in the case of
856 * wimlib_export_image() being called previously). */
857 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
859 /** Call fsync() when the WIM file is closed */
860 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
862 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
863 * after one or more calls to wimlib_delete_image(), which is to rebuild the
866 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
867 * correctly remove the image from the WIM will be taken. In particular, all
868 * streams will be left alone, even if they are no longer referenced. This is
869 * probably not what you want, because almost no space will be spaced by
870 * deleting an image in this way. */
871 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
873 /******************************
875 ******************************/
877 /** Assume that strings are represented in UTF-8, even if this is not the
878 * locale's character encoding. */
879 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
881 /** Specification of an update to perform on a WIM image. */
882 struct wimlib_update_command {
884 /** The specific type of update to perform. */
885 enum wimlib_update_op {
886 /** Add a new file or directory tree to the WIM image in a
887 * certain location. */
888 WIMLIB_UPDATE_OP_ADD = 0,
890 /** Delete a file or directory tree from the WIM image. */
891 WIMLIB_UPDATE_OP_DELETE,
893 /** Rename a file or directory tree in the WIM image. */
894 WIMLIB_UPDATE_OP_RENAME,
897 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
898 struct wimlib_add_command {
899 /** Filesystem path to the file or directory tree to
901 wimlib_tchar *fs_source_path;
902 /** Path, specified from the root of the WIM image, at
903 * which to add the file or directory tree within the
905 wimlib_tchar *wim_target_path;
907 /** Configuration for excluded files. @c NULL means
908 * exclude no files. */
909 struct wimlib_capture_config *config;
911 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
914 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
915 struct wimlib_delete_command {
916 /** Path, specified from the root of the WIM image, for
917 * the file or directory tree within the WIM image to be
919 wimlib_tchar *wim_path;
920 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
923 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
924 struct wimlib_rename_command {
925 /** Path, specified from the root of the WIM image, for
926 * the source file or directory tree within the WIM
928 wimlib_tchar *wim_source_path;
929 /** Path, specified from the root of the WIM image, for
930 * the destination file or directory tree within the WIM
932 wimlib_tchar *wim_target_path;
933 /** Reserved; set to 0. */
939 /** Specification of a file or directory tree to extract from a WIM image. */
940 struct wimlib_extract_command {
941 /** Path to file or directory tree within the WIM image to extract. It
942 * must be provided as an absolute path from the root of the WIM image.
943 * The path separators may be either forward slashes or backslashes. */
944 wimlib_tchar *wim_source_path;
946 /** Filesystem path to extract the file or directory tree to. */
947 wimlib_tchar *fs_dest_path;
949 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
954 * Possible values of the error code returned by many functions in wimlib.
956 * See the documentation for each wimlib function to see specifically what error
957 * codes can be returned by a given function, and what they mean.
959 enum wimlib_error_code {
960 WIMLIB_ERR_SUCCESS = 0,
961 WIMLIB_ERR_ALREADY_LOCKED,
962 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
963 WIMLIB_ERR_DECOMPRESSION,
964 WIMLIB_ERR_DELETE_STAGING_DIR,
965 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
968 WIMLIB_ERR_FUSERMOUNT,
969 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
970 WIMLIB_ERR_IMAGE_COUNT,
971 WIMLIB_ERR_IMAGE_NAME_COLLISION,
972 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
973 WIMLIB_ERR_INTEGRITY,
974 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
975 WIMLIB_ERR_INVALID_CHUNK_SIZE,
976 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
977 WIMLIB_ERR_INVALID_DENTRY,
978 WIMLIB_ERR_INVALID_HEADER_SIZE,
979 WIMLIB_ERR_INVALID_IMAGE,
980 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
981 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
982 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
983 WIMLIB_ERR_INVALID_OVERLAY,
984 WIMLIB_ERR_INVALID_PARAM,
985 WIMLIB_ERR_INVALID_PART_NUMBER,
986 WIMLIB_ERR_INVALID_REPARSE_DATA,
987 WIMLIB_ERR_INVALID_RESOURCE_HASH,
988 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
989 WIMLIB_ERR_INVALID_SECURITY_DATA,
990 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
991 WIMLIB_ERR_INVALID_UTF16_STRING,
992 WIMLIB_ERR_INVALID_UTF8_STRING,
993 WIMLIB_ERR_IS_DIRECTORY,
994 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1000 WIMLIB_ERR_NOTEMPTY,
1001 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1002 WIMLIB_ERR_NOT_A_WIM_FILE,
1003 WIMLIB_ERR_NO_FILENAME,
1007 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1009 WIMLIB_ERR_READLINK,
1012 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1013 WIMLIB_ERR_RESOURCE_ORDER,
1014 WIMLIB_ERR_SPECIAL_FILE,
1015 WIMLIB_ERR_SPLIT_INVALID,
1016 WIMLIB_ERR_SPLIT_UNSUPPORTED,
1019 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1020 WIMLIB_ERR_UNKNOWN_VERSION,
1021 WIMLIB_ERR_UNSUPPORTED,
1022 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1025 WIMLIB_ERR_WIM_IS_MARKED_READONLY,
1029 /** Used to indicate no WIM image or an invalid WIM image. */
1030 #define WIMLIB_NO_IMAGE 0
1032 /** Used to specify all images in the WIM. */
1033 #define WIMLIB_ALL_IMAGES (-1)
1036 * Appends an empty image to a WIM file. This empty image will initially
1037 * contain no files or directories, although if written without further
1038 * modifications, a root directory will be created automatically for it.
1041 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1044 * Name to give the new image. If @c NULL or empty, the new image is given
1045 * no name. If nonempty, it must specify a name that does not already
1047 * @param new_idx_ret
1048 * If non-<code>NULL</code>, the index of the newly added image is returned
1051 * @return 0 on success; nonzero on failure. The possible error codes are:
1053 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1054 * @a wim is part of a split WIM.
1055 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1056 * There is already an image in @a wim named @a name.
1057 * @retval ::WIMLIB_ERR_NOMEM
1058 * Failed to allocate the memory needed to add the new image.
1061 wimlib_add_empty_image(WIMStruct *wim,
1062 const wimlib_tchar *name,
1066 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1068 * The directory tree or NTFS volume is scanned immediately to load the dentry
1069 * tree into memory, and file attributes and symbolic links are read. However,
1070 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1073 * See the manual page for the @b wimlib-imagex program for more information
1074 * about the "normal" capture mode versus the NTFS capture mode (entered by
1075 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1077 * Note that @b no changes are committed to the underlying WIM file (if
1078 * any) until wimlib_write() or wimlib_overwrite() is called.
1081 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1084 * A path to a directory or unmounted NTFS volume that will be captured as
1087 * Name to give the new image. If @c NULL or empty, the new image is given
1088 * no name. If nonempty, it must specify a name that does not already
1091 * Capture configuration that specifies files, directories, or path globs
1092 * to exclude from being captured. If @c NULL, a dummy configuration where
1093 * no paths are treated specially is used.
1095 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1096 * @param progress_func
1097 * If non-NULL, a function that will be called periodically with the
1098 * progress of the current operation.
1100 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1101 * discarded so that it appears to be in the same state as when this function
1104 * This function is implemented by calling wimlib_add_empty_image(), then
1105 * calling wimlib_update_image() with a single "add" command, so any error code
1106 * returned by wimlib_add_empty_image() may be returned, as well as any error
1107 * codes returned by wimlib_update_image() other than ones documented as only
1108 * being returned specifically by an update involving delete or rename commands.
1111 wimlib_add_image(WIMStruct *wim,
1112 const wimlib_tchar *source,
1113 const wimlib_tchar *name,
1114 const struct wimlib_capture_config *config,
1116 wimlib_progress_func_t progress_func);
1118 /** This function is equivalent to wimlib_add_image() except it allows for
1119 * multiple sources to be combined into a single WIM image. This is done by
1120 * specifying the @a sources and @a num_sources parameters instead of the @a
1121 * source parameter of wimlib_add_image(). The rest of the parameters are the
1122 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1123 * capture</b> for full details on how this mode works.
1125 * In addition to the error codes that wimlib_add_image() can return,
1126 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1127 * when trying to overlay a non-directory on a directory or when otherwise
1128 * trying to overlay multiple conflicting files to the same location in the WIM
1129 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1130 * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1131 * was not exactly one capture source with the target being the root directory.
1132 * (In this respect, there is no advantage to using
1133 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1136 wimlib_add_image_multisource(WIMStruct *wim,
1137 const struct wimlib_capture_source *sources,
1139 const wimlib_tchar *name,
1140 const struct wimlib_capture_config *config,
1142 wimlib_progress_func_t progress_func);
1145 * Creates a ::WIMStruct for a new WIM file.
1147 * This only creates an in-memory structure for a WIM that initially contains no
1148 * images. No on-disk file is created until wimlib_write() is called.
1151 * The type of compression to be used in the new WIM file. Must be
1152 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1153 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1155 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1156 * written to the memory location pointed to by this paramater. The
1157 * ::WIMStruct must be freed using using wimlib_free() when finished with
1159 * @return 0 on success; nonzero on error.
1160 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1161 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1162 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1163 * @retval ::WIMLIB_ERR_NOMEM
1164 * Failed to allocate needed memory.
1167 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1170 * Deletes an image, or all images, from a WIM file.
1172 * All streams referenced by the image(s) being deleted are removed from the
1173 * lookup table of the WIM if they are not referenced by any other images in the
1176 * Please note that @b no changes are committed to the underlying WIM file (if
1177 * any) until wimlib_write() or wimlib_overwrite() is called.
1180 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1183 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1185 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1186 * to be left unmodified only if @a image specified a single image. If instead
1187 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1188 * possible for some but not all of the images to have been deleted when a
1189 * failure status is returned.
1191 * @retval ::WIMLIB_ERR_DECOMPRESSION
1192 * Could not decompress the metadata resource for @a image.
1193 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1194 * A directory entry in the metadata resource for @a image in the WIM is
1196 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1197 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1198 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1199 * The metadata resource for @a image in the WIM is invalid.
1200 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1201 * The security data for @a image in the WIM is invalid.
1202 * @retval ::WIMLIB_ERR_NOMEM
1203 * Failed to allocate needed memory.
1204 * @retval ::WIMLIB_ERR_READ
1205 * Could not read the metadata resource for @a image from the WIM.
1206 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1207 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1211 wimlib_delete_image(WIMStruct *wim, int image);
1214 * Exports an image, or all the images, from a WIM file, into another WIM file.
1216 * The destination image is made to share the same dentry tree and security data
1217 * structure as the source image. This places some restrictions on additional
1218 * functions that may be called. wimlib_mount_image() may not be called on
1219 * either the source image or the destination image without an intervening call
1220 * to a function that un-shares the images, such as wimlib_free() on @a
1221 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1222 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1223 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1224 * have references back to @a src_wim.
1226 * If this function fails, all changes to @a dest_wim are rolled back.
1228 * No changes shall be made to @a src_wim by this function.
1230 * Please note that no changes are committed to the underlying WIM file of @a
1231 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1234 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1235 * WIM that contains the image(s) being exported.
1237 * The image to export from @a src_wim. Can be the number of an image, or
1238 * ::WIMLIB_ALL_IMAGES to export all images.
1240 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1243 * The name to give the exported image in the new WIM file. If left @c
1244 * NULL, the name from @a src_wim is used. This parameter must be left @c
1245 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1246 * than one image; in that case, the names are all taken from the @a
1247 * src_wim. (This is allowed even if one or more images being exported has
1249 * @param dest_description
1250 * The description to give the exported image in the new WIM file. If left
1251 * @c NULL, the description from the @a src_wim is used. This parameter must
1252 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1253 * more than one image; in that case, the descriptions are all taken from
1254 * @a src_wim. (This is allowed even if one or more images being exported
1255 * has no description.)
1256 * @param export_flags
1257 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1258 * bootable, or 0 if which image is marked as bootable in the destination
1259 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1260 * there are multiple images in @a src_wim, specifying
1261 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1262 * currently marked as bootable in @a src_wim; if that is the case, then
1263 * that image is marked as bootable in the destination WIM.
1264 * @param additional_swms
1265 * Array of pointers to the ::WIMStruct for each additional part in the
1266 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1267 * need to be in any particular order, but they must include all parts of
1268 * the split WIM other than the first part, which must be provided in the
1270 * @param num_additional_swms
1271 * Number of additional WIM parts provided in the @a additional_swms array.
1272 * This number should be one less than the total number of parts in the
1273 * split WIM. Set to 0 if the WIM is a standalone WIM.
1274 * @param progress_func
1275 * If non-NULL, a function that will be called periodically with the
1276 * progress of the current operation.
1278 * @return 0 on success; nonzero on error.
1279 * @retval ::WIMLIB_ERR_DECOMPRESSION
1280 * Could not decompress the metadata resource for @a src_image
1282 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1283 * One or more of the names being given to an exported image was already in
1284 * use in the destination WIM.
1285 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1286 * A directory entry in the metadata resource for @a src_image in @a
1287 * src_wim is invalid.
1288 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1289 * @a src_image does not exist in @a src_wim.
1290 * @retval ::WIMLIB_ERR_INVALID_PARAM
1291 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1292 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1293 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1294 * dest_description were non-<code>NULL</code>, @a src_image was
1295 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1296 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1297 * The metadata resource for @a src_image in @a src_wim is invalid.
1298 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1299 * The security data for @a src_image in @a src_wim is invalid.
1300 * @retval ::WIMLIB_ERR_NOMEM
1301 * Failed to allocate needed memory.
1302 * @retval ::WIMLIB_ERR_READ
1303 * Could not read the metadata resource for @a src_image from @a src_wim.
1304 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1305 * The source WIM is a split WIM, but the parts specified do not form a
1306 * complete split WIM because they do not include all the parts of the
1307 * original WIM, there are duplicate parts, or not all the parts have the
1308 * same GUID and compression type.
1309 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1310 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1314 wimlib_export_image(WIMStruct *src_wim, int src_image,
1315 WIMStruct *dest_wim,
1316 const wimlib_tchar *dest_name,
1317 const wimlib_tchar *dest_description,
1319 WIMStruct **additional_swms,
1320 unsigned num_additional_swms,
1321 wimlib_progress_func_t progress_func);
1324 * Extract zero or more files or directory trees from a WIM image.
1326 * This generalizes the single-image extraction functionality of
1327 * wimlib_extract_image() to allow extracting only the specified subsets of the
1331 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1335 * The 1-based number of the image in @a wim from which the files or
1336 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1339 * An array of ::wimlib_extract_command structures that specifies the
1340 * extractions to perform.
1343 * Number of commands in the @a cmds array.
1345 * @param default_extract_flags
1346 * Default extraction flags; the behavior shall be as if these flags had
1347 * been specified in the ::wimlib_extract_command.extract_flags member in
1348 * each extraction command, in combination with any flags already present.
1350 * @param additional_swms
1351 * Array of pointers to the ::WIMStruct for each additional part in the
1352 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1353 * need to be in any particular order, but they must include all parts of
1354 * the split WIM other than the first part, which must be provided in the
1357 * @param num_additional_swms
1358 * Number of additional WIM parts provided in the @a additional_swms array.
1359 * This number should be one less than the total number of parts in the
1360 * split WIM. Set to 0 if the WIM is a standalone WIM.
1362 * @param progress_func
1363 * If non-NULL, a function that will be called periodically with the
1364 * progress of the current operation.
1366 * @return 0 on success; nonzero on error. The possible error codes include
1367 * those documented as returned by wimlib_extract_image() as well as the
1368 * following additional error codes:
1370 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1371 * The ::wimlib_extract_command.wim_source_path member in one of the
1372 * extract commands did not exist in the WIM.
1373 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1374 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1375 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1376 * regular file or directory.
1377 * @retval ::WIMLIB_ERR_INVALID_PARAM
1378 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1379 * specified for some commands but not all; or
1380 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1381 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1382 * for a command in which ::wimlib_extract_command.wim_source_path did not
1383 * specify the root directory of the WIM image.
1386 wimlib_extract_files(WIMStruct *wim,
1388 const struct wimlib_extract_command *cmds,
1390 int default_extract_flags,
1391 WIMStruct **additional_swms,
1392 unsigned num_additional_swms,
1393 wimlib_progress_func_t progress_func);
1396 * Extracts an image, or all images, from a standalone or split WIM file to a
1397 * directory or a NTFS volume.
1399 * Please see the manual page for the @c wimlib-imagex program for more
1400 * information about the "normal" extraction mode versus the NTFS extraction
1401 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1403 * Extraction is done with one thread.
1405 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1406 * returned if any resulting SHA1 message digests do not match the values
1407 * provided in the WIM file. Therefore, if this function is successful, you can
1408 * be fairly sure that any compressed data in the WIM was uncompressed
1412 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1415 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1416 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1417 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1419 * Directory to extract the WIM image(s) to (created if it does not already
1420 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1421 * path to the unmounted NTFS volume to extract the image to.
1422 * @param extract_flags
1423 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1425 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1426 * a NTFS volume to extract the image to. The volume will be opened using
1427 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1428 * Otherwise, @a target is interpreted as a directory to extract the
1431 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1432 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1433 * specified. These flags cause extracted files that are identical to be
1434 * hardlinked or symlinked together, depending on the flag. These flags
1435 * override the hard link groups that are specified in the WIM file itself.
1436 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1437 * hardlinked or symlinked across images if a file is found to occur in
1438 * more than one image.
1440 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1441 * name of each file or directory as it is extracted.
1443 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1444 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1445 * each image is considered separately with regards to the sequential
1446 * order. It is also possible for alternate data streams to break the
1447 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1449 * @param additional_swms
1450 * Array of pointers to the ::WIMStruct for each additional part in the
1451 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1452 * need to be in any particular order, but they must include all parts of
1453 * the split WIM other than the first part, which must be provided in the
1455 * @param num_additional_swms
1456 * Number of additional WIM parts provided in the @a additional_swms array.
1457 * This number should be one less than the total number of parts in the
1458 * split WIM. Set to 0 if the WIM is a standalone WIM.
1460 * @param progress_func
1461 * If non-NULL, a function that will be called periodically with the
1462 * progress of the current operation.
1464 * @return 0 on success; nonzero on error.
1465 * @retval ::WIMLIB_ERR_DECOMPRESSION
1466 * Could not decompress a resource (file or metadata) for @a image in @a
1468 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1469 * A directory entry in the metadata resource for @a image in @a wim is
1471 * @retval ::WIMLIB_ERR_INVALID_PARAM
1472 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1473 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1474 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1475 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1476 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1477 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1478 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1479 * specified in @a extract_flag.
1480 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1481 * The SHA1 message digest of an extracted stream did not match the SHA1
1482 * message digest given in the WIM file.
1483 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1484 * A resource (file or metadata) for @a image in @a wim is invalid.
1485 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1486 * The security data for @a image in @a wim is invalid.
1487 * @retval ::WIMLIB_ERR_LINK
1488 * Failed to create a symbolic link or a hard link (only if
1489 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1490 * @retval ::WIMLIB_ERR_MKDIR
1491 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1492 * not specified in @a extract_flags).
1493 * @retval ::WIMLIB_ERR_NOMEM
1494 * Failed to allocate needed memory.
1495 * @retval ::WIMLIB_ERR_NTFS_3G
1496 * An error was returned from a libntfs-3g function while the WIM image was
1497 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1498 * was specified in @a extract_flags).
1499 * @retval ::WIMLIB_ERR_OPEN
1500 * Could not open one of the files being extracted for writing (only if
1501 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1502 * @retval ::WIMLIB_ERR_READ
1503 * A unexpected end-of-file or read error occurred when trying to read data
1504 * from the WIM file associated with @a wim.
1505 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1506 * The WIM is a split WIM, but the parts specified do not form a complete
1507 * split WIM because they do not include all the parts of the original WIM,
1508 * there are duplicate parts, or not all the parts have the same GUID and
1510 * @retval ::WIMLIB_ERR_UNSUPPORTED
1511 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1512 * was configured with the @c --without-ntfs-3g flag.
1513 * @retval ::WIMLIB_ERR_WRITE
1514 * Failed to write a file being extracted (only if
1515 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1518 wimlib_extract_image(WIMStruct *wim, int image,
1519 const wimlib_tchar *target,
1521 WIMStruct **additional_swms,
1522 unsigned num_additional_swms,
1523 wimlib_progress_func_t progress_func);
1526 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1527 * includes a string of XML that describes the images contained in the WIM.
1528 * This function works on standalone WIMs as well as split WIM parts.
1531 * Pointer to the ::WIMStruct for a WIM file.
1533 * @c stdout, or a FILE* opened for writing, to extract the data to.
1535 * @return 0 on success; nonzero on error.
1536 * @retval ::WIMLIB_ERR_INVALID_PARAM
1537 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1538 * @retval ::WIMLIB_ERR_NOMEM
1539 * Failed to allocate needed memory.
1540 * @retval ::WIMLIB_ERR_READ
1541 * Failed to read the XML data from the WIM.
1542 * @retval ::WIMLIB_ERR_WRITE
1543 * Failed to completely write the XML data to @a fp.
1546 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1549 * Frees all memory allocated for a WIMStruct and closes all files associated
1553 * Pointer to the ::WIMStruct for a WIM file.
1555 * @return This function has no return value.
1558 wimlib_free(WIMStruct *wim);
1561 * Returns the index of the bootable image of the WIM.
1564 * Pointer to the ::WIMStruct for a WIM file.
1567 * 0 if no image is marked as bootable, or the number of the image marked
1568 * as bootable (numbered starting at 1).
1571 wimlib_get_boot_idx(const WIMStruct *wim);
1574 * Returns the compression type used in the WIM.
1577 * Pointer to the ::WIMStruct for a WIM file
1580 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1581 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1584 wimlib_get_compression_type(const WIMStruct *wim);
1587 * Converts a ::wimlib_compression_type value into a string.
1590 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1591 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1594 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1597 extern const wimlib_tchar *
1598 wimlib_get_compression_type_string(int ctype);
1601 * Converts an error code into a string describing it.
1604 * The error code returned by one of wimlib's functions.
1607 * Pointer to a statically allocated string describing the error code,
1608 * or @c NULL if the error code is not valid.
1610 extern const wimlib_tchar *
1611 wimlib_get_error_string(enum wimlib_error_code code);
1614 * Returns the description of the specified image.
1617 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1618 * standalone WIM or a split WIM part.
1620 * The number of the image, numbered starting at 1.
1623 * The description of the image, or @c NULL if there is no such image, or
1624 * @c NULL if the specified image has no description. The description
1625 * string is in library-internal memory and may not be modified or freed;
1626 * in addition, the string will become invalid if the description of the
1627 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1629 extern const wimlib_tchar *
1630 wimlib_get_image_description(const WIMStruct *wim, int image);
1633 * Returns the name of the specified image.
1636 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1637 * standalone WIM or a split WIM part.
1639 * The number of the image, numbered starting at 1.
1642 * The name of the image, or @c NULL if there is no such image. The name
1643 * string is in library-internal memory and may not be modified or freed;
1644 * in addition, the string will become invalid if the name of the image is
1645 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1647 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1648 * the WIM to be unnamed, in which case an empty string will be returned
1649 * when the corresponding name is requested.
1651 extern const wimlib_tchar *
1652 wimlib_get_image_name(const WIMStruct *wim, int image);
1656 * Returns the number of images contained in a WIM.
1659 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1660 * standalone WIM or a split WIM part.
1663 * The number of images contained in the WIM file.
1666 wimlib_get_num_images(const WIMStruct *wim);
1669 * Returns the part number of a WIM in a split WIM and the total number of parts
1673 * Pointer to the ::WIMStruct for a WIM file.
1674 * @param total_parts_ret
1675 * If non-@c NULL, the total number of parts in the split WIM (1 for
1676 * non-split WIMs) is written to this location.
1679 * The part number of the WIM (1 for non-split WIMs)
1682 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1685 * Initialization function for wimlib. Call before using any other wimlib
1689 * On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1690 * that all input data, including filenames, are in UTF-8 rather than the
1691 * locale-dependent character encoding which may or may not be UTF-8, and
1692 * that UTF-8 data can be directly printed to the console. On Windows, use
1693 * 0 for this parameter.
1695 * @return 0; other error codes may be returned in future releases.
1698 wimlib_global_init(int init_flags);
1701 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1702 * You are not required to call this function, but it will release any global
1703 * memory allocated by the library.
1706 wimlib_global_cleanup(void);
1709 * Returns true if the WIM has an integrity table.
1712 * Pointer to the ::WIMStruct for a WIM file.
1714 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1715 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1716 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1717 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1720 wimlib_has_integrity_table(const WIMStruct *wim);
1723 * Determines if an image name is already used by some image in the WIM.
1726 * Pointer to the ::WIMStruct for a WIM file.
1728 * The name to check.
1731 * @c true if there is already an image in @a wim named @a name; @c false
1732 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1733 * the empty string, @c false is returned.
1736 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1739 * Joins a split WIM into a stand-alone one-part WIM.
1742 * An array of strings that gives the filenames of all parts of the split
1743 * WIM. No specific order is required, but all parts must be included with
1746 * Number of filenames in @a swms.
1747 * @param swm_open_flags
1748 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1749 * part should be verified, if integrity tables are present. Otherwise,
1751 * @param wim_write_flags
1752 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1753 * @param output_path
1754 * The path to write the one-part WIM to.
1755 * @param progress_func
1756 * If non-NULL, a function that will be called periodically with the
1757 * progress of the current operation.
1759 * @return 0 on success; nonzero on error. This function may return any value
1760 * returned by wimlib_open_wim() and wimlib_write() except
1761 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1763 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1764 * The split WIMs do not form a valid WIM because they do not include all
1765 * the parts of the original WIM, there are duplicate parts, or not all the
1766 * parts have the same GUID and compression type.
1768 * Note: the WIM's uncompressed and compressed resources are not checksummed
1769 * when they are copied from the split WIM parts to the joined WIM, nor are
1770 * compressed resources re-compressed.
1772 * Note: wimlib_export_image() can provide similar functionality to
1773 * wimlib_join(), since it is possible to export all images from a split WIM.
1776 wimlib_join(const wimlib_tchar * const *swms,
1778 const wimlib_tchar *output_path,
1780 int wim_write_flags,
1781 wimlib_progress_func_t progress_func);
1784 * Compress a chunk of a WIM resource using LZX compression.
1786 * This function is exported for convenience only and need not be used.
1789 * Uncompressed data of the chunk.
1791 * Size of the uncompressed chunk, in bytes.
1793 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1796 * The size of the compressed data written to @a out in bytes, or 0 if the
1797 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1799 * As a special requirement, the compression code is optimized for the WIM
1800 * format and therefore requires (@a chunk_size <= 32768).
1803 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1806 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1808 * Note that this will NOT work unmodified for LZX as used in the cabinet
1809 * format, which is not the same as in the WIM format!
1811 * This function is exported for convenience only and need not be used.
1813 * @param compressed_data
1814 * Pointer to the compressed data.
1816 * @param compressed_len
1817 * Length of the compressed data, in bytes.
1819 * @param uncompressed_data
1820 * Pointer to the buffer into which to write the uncompressed data.
1822 * @param uncompressed_len
1823 * Length of the uncompressed data. It must be 32768 bytes or less.
1826 * 0 on success; non-zero on failure.
1829 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1830 void *uncompressed_data, unsigned uncompressed_len);
1834 * Mounts an image in a WIM file on a directory read-only or read-write.
1836 * This is not supported on Windows.
1838 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1839 * process will be daemonized.
1841 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1842 * modifications to the WIM are staged in a temporary directory.
1844 * It is safe to mount multiple images from the same WIM file read-only at the
1845 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1846 * to mount multiple images from the same WIM file read-write at the same time.
1848 * wimlib_mount_image() cannot be used on an image that was exported with
1849 * wimlib_export_image() while the dentry trees for both images are still in
1850 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1851 * that has just been added with wimlib_add_image(), unless the WIM has been
1852 * written and read into a new ::WIMStruct.
1855 * Pointer to the ::WIMStruct containing the image to be mounted.
1857 * The number of the image to mount, indexed starting from it. It must be
1858 * an existing, single image.
1860 * The path to an existing empty directory to mount the image on.
1861 * @param mount_flags
1862 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1864 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1865 * rather than the default of read-only.
1867 * WIMs may contain named (alternate) data streams, which are a somewhat
1868 * obscure NTFS feature. They can be read and written on a mounted WIM
1869 * through one of several interfaces. The interface to use if specified by
1870 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1871 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1872 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1873 * the XATTR interface.
1874 * @param additional_swms
1875 * Array of pointers to the ::WIMStruct for each additional part in the
1876 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1877 * need to be in any particular order, but they must include all parts of
1878 * the split WIM other than the first part, which must be provided in the
1880 * @param num_additional_swms
1881 * Number of additional WIM parts provided in the @a additional_swms array.
1882 * This number should be one less than the total number of parts in the
1883 * split WIM. Set to 0 if the WIM is a standalone WIM.
1884 * @param staging_dir
1885 * If non-NULL, the name of a directory in which the staging directory will
1886 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1887 * in @a mount_flags. If left @c NULL, the staging directory is created in
1888 * the same directory as the WIM file that @a wim was originally read from.
1890 * @return 0 on success; nonzero on error.
1892 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1893 * A read-write mount was requested, but an an exclusive advisory lock on
1894 * the on-disk WIM file could not be acquired because another thread or
1895 * process has mounted an image from the WIM read-write or is currently
1896 * modifying the WIM in-place.
1897 * @retval ::WIMLIB_ERR_DECOMPRESSION
1898 * Could not decompress the metadata resource for @a image in @a wim.
1899 * @retval ::WIMLIB_ERR_FUSE
1900 * A non-zero status was returned by @c fuse_main().
1901 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1902 * A directory entry in the metadata resource for @a image in @a wim is
1904 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1905 * @a image does not specify an existing, single image in @a wim.
1906 * @retval ::WIMLIB_ERR_INVALID_PARAM
1907 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1908 * wimlib_export_image(), or @a image has been added with
1909 * wimlib_add_image().
1910 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1911 * The metadata resource for @a image in @a wim is invalid.
1912 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1913 * The security data for @a image in @a wim is invalid.
1914 * @retval ::WIMLIB_ERR_MKDIR
1915 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1916 * staging directory could not be created.
1917 * @retval ::WIMLIB_ERR_NOMEM
1918 * Failed to allocate needed memory.
1919 * @retval ::WIMLIB_ERR_NOTDIR
1920 * Could not determine the current working directory.
1921 * @retval ::WIMLIB_ERR_READ
1922 * An unexpected end-of-file or read error occurred when trying to read
1923 * data from the WIM file associated with @a wim.
1924 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1925 * The WIM is a split WIM, but the parts specified do not form a complete
1926 * split WIM because they do not include all the parts of the original WIM,
1927 * there are duplicate parts, or not all the parts have the same GUID and
1929 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1930 * The WIM is a split WIM and a read-write mount was requested. We only
1931 * support mounting a split WIM read-only.
1932 * @retval ::WIMLIB_ERR_UNSUPPORTED
1933 * Mounting is not supported, either because the platform is Windows, or
1934 * because the platform is UNIX and wimlib was compiled with @c
1938 wimlib_mount_image(WIMStruct *wim,
1940 const wimlib_tchar *dir,
1942 WIMStruct **additional_swms,
1943 unsigned num_additional_swms,
1944 const wimlib_tchar *staging_dir);
1947 * Opens a WIM file and creates a ::WIMStruct for it.
1950 * The path to the WIM file to open.
1952 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1953 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1955 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1956 * the WIM, if it exists, is checked, and this function will fail with an
1957 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1958 * digests of the WIM do not exactly match the corresponding message
1959 * digests given in the integrity table.
1961 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1962 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1963 * returned. (This flag may be removed in the future, in which case no
1964 * error will be issued when opening a split WIM.)
1966 * @param progress_func
1967 * If non-NULL, a function that will be called periodically with the
1968 * progress of the current operation.
1971 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1972 * is written to the memory location pointed to by this parameter. The
1973 * ::WIMStruct must be freed using using wimlib_free() when finished with
1976 * @return 0 on success; nonzero on error.
1977 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1978 * The lookup table of @a wim_file is compressed. Support for this can be
1979 * added to wimlib if needed, but it appears to be the case that the lookup
1980 * table is never compressed.
1981 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1982 * The WIM is not the non-first part of a split WIM, and the number of
1983 * metadata resources found in the WIM did not match the image count given
1984 * in the WIM header, or the number of <IMAGE> elements in the XML
1985 * data for the WIM did not match the image count given in the WIM header.
1986 * @retval ::WIMLIB_ERR_INTEGRITY
1987 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1988 * wim_file contains an integrity table, but the SHA1 message digest for a
1989 * chunk of the WIM does not match the corresponding message digest given
1990 * in the integrity table.
1991 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1992 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1993 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1994 * The header of @a wim_file says that resources in the WIM are compressed,
1995 * but the header flag indicating LZX or XPRESS compression is not set.
1996 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1997 * The length field of the WIM header is not 208.
1998 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1999 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2000 * wim_file contains an integrity table, but the integrity table is
2002 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2003 * The lookup table for the WIM contained duplicate entries that are not
2004 * for metadata resources, or it contained an entry with a SHA1 message
2005 * digest of all 0's.
2006 * @retval ::WIMLIB_ERR_NOMEM
2007 * Failed to allocated needed memory.
2008 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2009 * @a wim_file does not begin with the expected magic characters.
2010 * @retval ::WIMLIB_ERR_OPEN
2011 * Failed to open the file @a wim_file for reading.
2012 * @retval ::WIMLIB_ERR_READ
2013 * An unexpected end-of-file or read error occurred when trying to read
2014 * data from @a wim_file.
2015 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2016 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2017 * specified in @a open_flags.
2018 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2019 * A number other than 0x10d00 is written in the version field of the WIM
2020 * header of @a wim_file. (Probably a pre-Vista WIM).
2021 * @retval ::WIMLIB_ERR_XML
2022 * The XML data for @a wim_file is invalid.
2025 wimlib_open_wim(const wimlib_tchar *wim_file,
2027 WIMStruct **wim_ret,
2028 wimlib_progress_func_t progress_func);
2031 * Overwrites the file that the WIM was originally read from, with changes made.
2032 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2033 * rather than wimlib_create_new_wim().
2035 * There are two ways that a WIM may be overwritten. The first is to do a full
2036 * rebuild. In this mode, the new WIM is written to a temporary file and then
2037 * renamed to the original file after it is has been completely written. The
2038 * temporary file is made in the same directory as the original WIM file. A
2039 * full rebuild may take a while, but can be used even if images have been
2040 * modified or deleted, will produce a WIM with no holes, and has little chance
2041 * of unintentional data loss because the temporary WIM is fsync()ed before
2042 * being renamed to the original WIM.
2044 * The second way to overwrite a WIM is by appending to the end of it and
2045 * overwriting the header. This can be much faster than a full rebuild, but the
2046 * disadvantage is that some space will be wasted. Writing a WIM in this mode
2047 * begins with writing any new file resources *after* everything in the old WIM,
2048 * even though this will leave a hole where the old lookup table, XML data, and
2049 * integrity were. This is done so that the WIM remains valid even if the
2050 * operation is aborted mid-write. The WIM header is only overwritten at the
2051 * very last moment, and up until that point the WIM will be seen as the old
2054 * By default, wimlib_overwrite() does the append-style overwrite described
2055 * above, unless resources in the WIM are arranged in an unusual way or if
2056 * images have been deleted from the WIM. Use the flag
2057 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2058 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2059 * images have been deleted from the WIM.
2061 * In the temporary-file overwrite mode, no changes are made to the WIM on
2062 * failure, and the temporary file is deleted if possible. Abnormal termination
2063 * of the program will result in the temporary file being orphaned. In the
2064 * direct append mode, the WIM is truncated to the original length on failure;
2065 * and while abnormal termination of the program will result in extra data
2066 * appended to the original WIM, it should still be a valid WIM.
2068 * If this function completes successfully, no more functions should be called
2069 * on @a wim other than wimlib_free(). You must use wimlib_open_wim() to read
2070 * the WIM file anew.
2073 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2074 * been in-memory changes made to it, which are then reflected in the
2076 * @param write_flags
2077 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2078 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2079 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2080 * @param num_threads
2081 * Number of threads to use for compression (see wimlib_write()).
2082 * @param progress_func
2083 * If non-NULL, a function that will be called periodically with the
2084 * progress of the current operation.
2086 * @return 0 on success; nonzero on error. This function may return any value
2087 * returned by wimlib_write() as well as the following error codes:
2088 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2089 * The WIM was going to be modifien in-place (with no temporary file), but
2090 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2091 * because another thread or process has mounted an image from the WIM
2092 * read-write or is currently modifying the WIM in-place.
2093 * @retval ::WIMLIB_ERR_NO_FILENAME
2094 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2095 * than a WIM read with wimlib_open_wim().
2096 * @retval ::WIMLIB_ERR_RENAME
2097 * The temporary file that the WIM was written to could not be renamed to
2098 * the original filename of @a wim.
2101 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2102 wimlib_progress_func_t progress_func);
2105 * Prints information about one image, or all images, contained in a WIM.
2108 * Pointer to the ::WIMStruct for a WIM file.
2110 * The image about which to print information. Can be the number of an
2111 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2114 * @return This function has no return value. No error checking is done when
2115 * printing the information. If @a image is invalid, an error message is
2119 wimlib_print_available_images(const WIMStruct *wim, int image);
2122 * Prints the full paths to all files contained in an image, or all images, in a
2126 * Pointer to the ::WIMStruct for a WIM file.
2128 * Which image to print files for. Can be the number of an image, or
2129 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2131 * @return 0 on success; nonzero on error.
2132 * @retval ::WIMLIB_ERR_DECOMPRESSION
2133 * The metadata resource for one of the specified images could not be
2135 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2136 * A directory entry in the metadata resource for one of the specified
2137 * images is invaled.
2138 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2139 * @a image does not specify a valid image in @a wim, and is not
2140 * ::WIMLIB_ALL_IMAGES.
2141 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2142 * The metadata resource for one of the specified images is invalid.
2143 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2144 * The security data for one of the specified images is invalid.
2145 * @retval ::WIMLIB_ERR_NOMEM
2146 * Failed to allocate needed memory.
2147 * @retval ::WIMLIB_ERR_READ
2148 * An unexpected read error or end-of-file occurred when reading the
2149 * metadata resource for one of the specified images.
2150 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2151 * @a wim was not a standalone WIM and was not the first part of a split
2155 wimlib_print_files(WIMStruct *wim, int image);
2158 * Prints detailed information from the header of a WIM file.
2161 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2162 * standalone WIM or part of a split WIM.
2164 * @return This function has no return value.
2168 wimlib_print_header(const WIMStruct *wim);
2171 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2172 * digests, as found in the directory entry tree in the WIM file, to file
2173 * resources in the WIM file. This table includes one entry for each unique
2174 * file in the WIM, so it can be quite long. There is only one lookup table per
2175 * WIM file, but each split WIM part has its own lookup table.
2178 * Pointer to the ::WIMStruct for a WIM file.
2180 * @return This function has no return value.
2183 wimlib_print_lookup_table(WIMStruct *wim);
2186 * Prints the metadata of the specified image in a WIM file. The metadata
2187 * consists of the security data as well as the directory entry tree. Each
2188 * image has its own metadata.
2191 * Pointer to the ::WIMStruct for a WIM file.
2193 * Which image to print the metadata for. Can be the number of an image,
2194 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2196 * @return 0 on success; nonzero on error.
2197 * @retval ::WIMLIB_ERR_DECOMPRESSION
2198 * The metadata resource for one of the specified images could not be
2200 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2201 * A directory entry in the metadata resource for one of the specified
2202 * images is invaled.
2203 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2204 * @a image does not specify a valid image in @a wim, and is not
2205 * ::WIMLIB_ALL_IMAGES.
2206 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2207 * The metadata resource for one of the specified images is invalid.
2208 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2209 * The security data for one of the specified images is invalid.
2210 * @retval ::WIMLIB_ERR_NOMEM
2211 * Failed to allocate needed memory.
2212 * @retval ::WIMLIB_ERR_READ
2213 * An unexpected read error or end-of-file occurred when reading the
2214 * metadata resource for one of the specified images.
2215 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2216 * @a wim was not a standalone WIM and was not the first part of a split
2220 wimlib_print_metadata(WIMStruct *wim, int image);
2223 * Prints some basic information about a WIM file. All information printed by
2224 * this function is also printed by wimlib_print_header(), but
2225 * wimlib_print_wim_information() prints some of this information more concisely
2226 * and in a more readable form.
2229 * Pointer to the ::WIMStruct for a WIM file.
2231 * @return This function has no return value.
2234 wimlib_print_wim_information(const WIMStruct *wim);
2237 * Translates a string specifying the name or number of an image in the WIM into
2238 * the number of the image. The images are numbered starting at 1.
2241 * Pointer to the ::WIMStruct for a WIM file.
2242 * @param image_name_or_num
2243 * A string specifying the name or number of an image in the WIM. If it
2244 * parses to a positive integer, this integer is taken to specify the
2245 * number of the image, indexed starting at 1. Otherwise, it is taken to
2246 * be the name of an image, as given in the XML data for the WIM file. It
2247 * also may be the keyword "all" or the string "*", both of which will
2248 * resolve to ::WIMLIB_ALL_IMAGES.
2250 * There is no way to search for an image actually named "all", "*", or an
2251 * integer number, or an image that has no name. However, you can use
2252 * wimlib_get_image_name() to get the name of any image.
2255 * If the string resolved to a single existing image, the number of that
2256 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2257 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2258 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2259 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2260 * images in @a wim has no name.
2263 wimlib_resolve_image(WIMStruct *wim,
2264 const wimlib_tchar *image_name_or_num);
2267 * Sets which image in the WIM is marked as bootable.
2270 * Pointer to the ::WIMStruct for a WIM file.
2272 * The number of the image to mark as bootable, or 0 to mark no image as
2274 * @return 0 on success; nonzero on error.
2275 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2276 * @a boot_idx does not specify an existing image in @a wim, and it was not
2278 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2279 * @a wim is part of a split WIM.
2282 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2285 * Changes the description of an image in the WIM.
2288 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2289 * standalone WIM or part of a split WIM; however, you should set the same
2290 * description on all parts of a split WIM.
2292 * The number of the image for which to change the description.
2293 * @param description
2294 * The new description to give the image. It may be @c NULL, which
2295 * indicates that the image is to be given no description.
2297 * @return 0 on success; nonzero on error.
2298 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2299 * @a image does not specify a single existing image in @a wim.
2300 * @retval ::WIMLIB_ERR_NOMEM
2301 * Failed to allocate the memory needed to duplicate the @a description
2303 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2304 * @a wim is part of a split WIM.
2307 wimlib_set_image_descripton(WIMStruct *wim, int image,
2308 const wimlib_tchar *description);
2311 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2312 * (something like "Core" or "Ultimate")
2315 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2316 * standalone WIM or part of a split WIM; however, you should set the same
2317 * \<FLAGS\> element on all parts of a split WIM.
2319 * The number of the image for which to change the description.
2321 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2322 * indicates that the image is to be given no \<FLAGS\> element.
2324 * @return 0 on success; nonzero on error.
2325 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2326 * @a image does not specify a single existing image in @a wim.
2327 * @retval ::WIMLIB_ERR_NOMEM
2328 * Failed to allocate the memory needed to duplicate the @a flags string.
2329 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2330 * @a wim is part of a split WIM.
2332 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2333 const wimlib_tchar *flags);
2336 * Changes the name of an image in the WIM.
2339 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2340 * standalone WIM or part of a split WIM; however, you should set the same
2341 * name on all parts of a split WIM.
2343 * The number of the image for which to change the name.
2345 * New name to give the new image. If @c NULL or empty, the new image is
2346 * given no name. If nonempty, it must specify a name that does not
2347 * already exist in @a wim.
2349 * @return 0 on success; nonzero on error.
2350 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2351 * There is already an image named @a name in @a wim.
2352 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2353 * @a image does not specify a single existing image in @a wim.
2354 * @retval ::WIMLIB_ERR_NOMEM
2355 * Failed to allocate the memory needed to duplicate the @a name string.
2356 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2357 * @a wim is part of a split WIM.
2359 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2360 const wimlib_tchar *name);
2363 * Set the functions that wimlib uses to allocate and free memory.
2365 * These settings are global and not per-WIM.
2367 * The default is to use the default @c malloc() and @c free() from the C
2370 * Please note that some external functions, such as those in @c libntfs-3g, may
2371 * use the standard memory allocation functions.
2373 * @param malloc_func
2374 * A function equivalent to @c malloc() that wimlib will use to allocate
2375 * memory. If @c NULL, the allocator function is set back to the default
2376 * @c malloc() from the C library.
2378 * A function equivalent to @c free() that wimlib will use to free memory.
2379 * If @c NULL, the free function is set back to the default @c free() from
2381 * @param realloc_func
2382 * A function equivalent to @c realloc() that wimlib will use to reallocate
2383 * memory. If @c NULL, the free function is set back to the default @c
2384 * realloc() from the C library.
2385 * @return 0 on success; nonzero on error.
2386 * @retval ::WIMLIB_ERR_UNSUPPORTED
2387 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2388 * so custom memory allocators are unsupported.
2391 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2392 void (*free_func)(void *),
2393 void *(*realloc_func)(void *, size_t));
2396 * Sets whether wimlib is to print error messages to @c stderr when a function
2397 * fails. These error messages may provide information that cannot be
2398 * determined only from the error code that is returned. Not every error will
2399 * result in an error message being printed.
2401 * This setting is global and not per-WIM.
2403 * By default, error messages are not printed.
2405 * @param show_messages
2406 * @c true if error messages are to be printed; @c false if error messages
2407 * are not to be printed.
2409 * @return 0 on success; nonzero on error.
2410 * @retval ::WIMLIB_ERR_UNSUPPORTED
2411 * @a show_messages was @c true, but wimlib was compiled with the @c
2412 * --without-error-messages option. Therefore, error messages cannot be
2416 wimlib_set_print_errors(bool show_messages);
2419 * Splits a WIM into multiple parts.
2422 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2425 * Name of the SWM file to create. This will be the name of the first
2426 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2427 * appended before the suffix.
2429 * The maximum size per part, in bytes. It is not guaranteed that this
2430 * will really be the maximum size per part, because some file resources in
2431 * the WIM may be larger than this size, and the WIM file format provides
2432 * no way to split up file resources among multiple WIMs.
2433 * @param write_flags
2434 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2435 * included in the split WIM parts.
2436 * @param progress_func
2437 * If non-NULL, a function that will be called periodically with the
2438 * progress of the current operation.
2440 * @return 0 on success; nonzero on error. This function may return any value
2441 * returned by wimlib_write() as well as the following error codes:
2443 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2444 * @a wim is not part 1 of a stand-alone WIM.
2445 * @retval ::WIMLIB_ERR_INVALID_PARAM
2446 * @a swm_name was @c NULL, or @a part_size was 0.
2448 * Note: the WIM's uncompressed and compressed resources are not checksummed
2449 * when they are copied from the joined WIM to the split WIM parts, nor are
2450 * compressed resources re-compressed.
2453 wimlib_split(WIMStruct *wim,
2454 const wimlib_tchar *swm_name,
2457 wimlib_progress_func_t progress_func);
2460 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2462 * The image to unmount is specified by the path to the mountpoint, not the
2463 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2464 * touched and also may have been allocated in a different process.
2466 * To unmount the image, the thread calling this function communicates with the
2467 * thread that is managing the mounted WIM image. This function blocks until it
2468 * is known whether the unmount succeeded or failed. In the case of a
2469 * read-write mounted WIM, the unmount is not considered to have succeeded until
2470 * all changes have been saved to the underlying WIM file.
2473 * The directory that the WIM image was mounted on.
2474 * @param unmount_flags
2475 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2476 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2477 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2479 * @param progress_func
2480 * If non-NULL, a function that will be called periodically with the
2481 * progress of the current operation.
2483 * @return 0 on success; nonzero on error.
2485 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2486 * The filesystem daemon was unable to remove the staging directory and the
2487 * temporary files that it contains.
2488 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2489 * The filesystem daemon appears to have terminated before sending an exit
2491 * @retval ::WIMLIB_ERR_FORK
2492 * Could not @c fork() the process.
2493 * @retval ::WIMLIB_ERR_FUSERMOUNT
2494 * The @b fusermount program could not be executed or exited with a failure
2496 * @retval ::WIMLIB_ERR_MQUEUE
2497 * Could not open a POSIX message queue to communicate with the filesystem
2498 * daemon servicing the mounted filesystem, could not send a message
2499 * through the queue, or could not receive a message through the queue.
2500 * @retval ::WIMLIB_ERR_NOMEM
2501 * Failed to allocate needed memory.
2502 * @retval ::WIMLIB_ERR_OPEN
2503 * The filesystem daemon could not open a temporary file for writing the
2505 * @retval ::WIMLIB_ERR_READ
2506 * A read error occurred when the filesystem daemon tried to a file from
2507 * the staging directory
2508 * @retval ::WIMLIB_ERR_RENAME
2509 * The filesystem daemon failed to rename the newly written WIM file to the
2510 * original WIM file.
2511 * @retval ::WIMLIB_ERR_UNSUPPORTED
2512 * Mounting is not supported, either because the platform is Windows, or
2513 * because the platform is UNIX and wimlib was compiled with @c
2515 * @retval ::WIMLIB_ERR_WRITE
2516 * A write error occurred when the filesystem daemon was writing to the new
2517 * WIM file, or the filesystem daemon was unable to flush changes that had
2518 * been made to files in the staging directory.
2521 wimlib_unmount_image(const wimlib_tchar *dir,
2523 wimlib_progress_func_t progress_func);
2526 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2529 * Pointer to the ::WIMStruct for the WIM file to update.
2531 * The 1-based index of the image in the WIM to update. It cannot be
2532 * ::WIMLIB_ALL_IMAGES.
2534 * An array of ::wimlib_update_command's that specify the update operations
2537 * Number of commands in @a cmds.
2538 * @param update_flags
2539 * ::WIMLIB_UPDATE_FLAG_SEND_PROGRESS or 0.
2540 * @param progress_func
2541 * If non-NULL, a function that will be called periodically with the
2542 * progress of the current operation.
2544 * @return 0 on success; nonzero on error. On failure, some but not all of the
2545 * update commands may have been executed. No individual update command will
2546 * have been partially executed. Possible error codes include:
2548 * @retval ::WIMLIB_ERR_DECOMPRESSION
2549 * Failed to decompress the metadata resource from @a image in @a wim.
2550 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2551 * The capture configuration structure specified for an add command was
2553 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2554 * A directory entry for @a image in @a wim is invalid.
2555 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2556 * @a image did not specify a single, existing image in @a wim.
2557 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2558 * Attempted to perform an add command that conflicted with previously
2559 * existing files in the WIM when an overlay was attempted.
2560 * @retval ::WIMLIB_ERR_INVALID_PARAM
2561 * An unknown operation type was specified in the update commands; or,
2562 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2563 * in the @a add_flags, but the same image had previously already been
2564 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2565 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2566 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2567 * specified in the @a add_flags for an add command in which @a
2568 * wim_target_path was not the root directory of the WIM image.
2569 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2570 * (Windows only): While executing an add command, tried to capture a
2571 * reparse point with invalid data.
2572 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2573 * The metadata resource for @a image in @a wim is invalid.
2574 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2575 * The security data for image @a image in @a wim is invalid.
2576 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2577 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2578 * for a WIM path that corresponded to a directory; or, a rename command
2579 * attempted to rename a directory to a non-directory.
2580 * @retval ::WIMLIB_ERR_NOMEM
2581 * Failed to allocate needed memory.
2582 * @retval ::WIMLIB_ERR_NOTDIR
2583 * A rename command attempted to rename a directory to a non-directory; or,
2584 * an add command was executed that attempted to set the root of the WIM
2585 * image as a non-directory; or, a path component used as a directory in a
2586 * rename command was not, in fact, a directory.
2587 * @retval ::WIMLIB_ERR_NOTEMPTY
2588 * A rename command attempted to rename a directory to a non-empty
2590 * @retval ::WIMLIB_ERR_NTFS_3G
2591 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2592 * error occurred while reading data from the NTFS volume using libntfs-3g.
2593 * @retval ::WIMLIB_ERR_OPEN
2594 * Failed to open a file to be captured while executing an add command.
2595 * @retval ::WIMLIB_ERR_OPENDIR
2596 * Failed to open a directory to be captured while executing an add command.
2597 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2598 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2599 * WIM path that did not exist; or, a rename command attempted to rename a
2600 * file that does not exist.
2601 * @retval ::WIMLIB_ERR_READ
2602 * Failed to read the metadata resource for @a image in @a wim; or, while
2603 * executing an add command, failed to read data from a file or directory
2605 * @retval ::WIMLIB_ERR_READLINK
2606 * While executing an add command, failed to read the target of a symbolic
2607 * link or junction point.
2608 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2609 * (Windows only) Failed to perform a reparse point fixup because of
2610 * problems with the data of a reparse point.
2611 * @retval ::WIMLIB_ERR_SPECIAL_FILE
2612 * While executing an add command, attempted to capture a file that was not
2613 * a supported file type, such as a regular file, directory, symbolic link,
2614 * or (on Windows) a reparse point.
2615 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2616 * @a wim is part of a split WIM. Updating a split WIM is unsupported.
2617 * @retval ::WIMLIB_ERR_STAT
2618 * While executing an add command, failed to get attributes for a file or
2620 * @retval ::WIMLIB_ERR_UNSUPPORTED
2621 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2622 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
2623 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2624 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2625 * add_flags for an update command.
2628 wimlib_update_image(WIMStruct *wim,
2630 const struct wimlib_update_command *cmds,
2633 wimlib_progress_func_t progress_func);
2636 * Writes a standalone WIM to a file.
2638 * This brings in resources from any external locations, such as directory trees
2639 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2640 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2643 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2644 * changes made to it, which are then reflected in the output file.
2646 * The path to the file to write the WIM to.
2648 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2650 * @param write_flags
2651 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2652 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2653 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2654 * @param num_threads
2655 * Number of threads to use for compressing data. If 0, the number of
2656 * threads is taken to be the number of online processors. Note: if no
2657 * data compression needs to be done, no additional threads will be created
2658 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2659 * exporting an image from a compressed WIM to another WIM of the same
2660 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2662 * @param progress_func
2663 * If non-NULL, a function that will be called periodically with the
2664 * progress of the current operation.
2666 * @return 0 on success; nonzero on error.
2667 * @retval ::WIMLIB_ERR_DECOMPRESSION
2668 * Failed to decompress a metadata or file resource in @a wim.
2669 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2670 * A directory entry in the metadata resource for @a image in @a wim is
2672 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2673 * @a image does not specify a single existing image in @a wim, and is not
2674 * ::WIMLIB_ALL_IMAGES.
2675 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2676 * A file that had previously been scanned for inclusion in the WIM by
2677 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2678 * message digest check.
2679 * @retval ::WIMLIB_ERR_INVALID_PARAM
2680 * @a path was @c NULL.
2681 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2682 * The metadata resource for @a image in @a wim is invalid.
2683 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2684 * The security data for @a image in @a wim is invalid.
2685 * @retval ::WIMLIB_ERR_NOMEM
2686 * Failed to allocate needed memory.
2687 * @retval ::WIMLIB_ERR_OPEN
2688 * Failed to open @a path for writing, or some file resources in @a
2689 * wim refer to files in the outside filesystem, and one of these files
2690 * could not be opened for reading.
2691 * @retval ::WIMLIB_ERR_READ
2692 * An error occurred when trying to read data from the WIM file associated
2693 * with @a wim, or some file resources in @a wim refer to files in the
2694 * outside filesystem, and a read error occurred when reading one of these
2696 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2697 * @a wim is part of a split WIM. You may not call this function on a
2699 * @retval ::WIMLIB_ERR_WRITE
2700 * An error occurred when trying to write data to the new WIM file at @a
2704 wimlib_write(WIMStruct *wim,
2705 const wimlib_tchar *path,
2708 unsigned num_threads,
2709 wimlib_progress_func_t progress_func);
2712 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2713 * the data using "XPRESS" compression.
2716 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2719 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2720 * the data is compressed using "XPRESS" compression.
2723 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2724 void *uncompressed_data, unsigned uncompressed_len);
2726 #endif /* _WIMLIB_H */