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.0, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the README file.
40 * \section starting Getting Started
42 * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43 * install with <code>configure && make && sudo make install</code>; however,
44 * please see the README for more information about installing it. To use
45 * wimlib in a program after installing it, include @c wimlib.h and link your
46 * program with @c -lwim.
48 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
49 * may represent either a stand-alone WIM or one part of a split WIM.
51 * All functions in wimlib's public API are prefixed with @c wimlib. Most
52 * return 0 on success and a positive error code on failure. Use
53 * wimlib_get_error_string() to get a string that describes an error code.
54 * wimlib also can print error messages itself when an error happens, and these
55 * may be more informative than the error code; to enable this, call
56 * wimlib_set_print_errors(). Please note that this is for convenience only,
57 * and some errors can occur without a message being printed.
59 * First before calling any other functions, you should call
60 * wimlib_global_init() to initialize the library.
62 * To open an existing WIM, use wimlib_open_wim().
64 * To create a new WIM that initially contains no images, use
65 * wimlib_create_new_wim().
67 * To add an image to a WIM file from a directory tree on your filesystem, call
68 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
69 * wimlib_open_wim() or from wimlib_create_new_wim(). On UNIX,
70 * wimlib_add_image() can also capture a WIM image directly from a block device
71 * containing a NTFS filesystem.
73 * To extract an image from a WIM file, call wimlib_extract_image(). This can
74 * be done either to a directory, or, on UNIX, directly to a block device
75 * containing a NTFS filesystem.
77 * To extract individual files or directories from a WIM image, rather than a
78 * full image, call wimlib_extract_files().
80 * To programatically make changes to a WIM image without mounting it, call
81 * wimlib_update_image().
83 * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84 * Mounting is done using wimlib_mount_image() and unmounting is done using
85 * wimlib_unmount_image(). Mounting can be done without root privileges because
86 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
87 * compiled with the <code>--without-fuse</code> flag, these functions will be
88 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
90 * After creating or modifying a WIM file, you can write it to a file using
91 * wimlib_write(). Alternatively, if the WIM was originally read from a file
92 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93 * wimlib_overwrite() to overwrite the original file.
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 0
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 typedef struct WIMStruct WIMStruct;
185 typedef wchar_t wimlib_tchar;
187 /** See \ref encodings */
188 typedef char wimlib_tchar;
192 * Specifies the compression type of a WIM file.
194 enum wimlib_compression_type {
195 /** An invalid compression type. */
196 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
198 /** The WIM does not include any compressed resources. */
199 WIMLIB_COMPRESSION_TYPE_NONE = 0,
201 /** Compressed resources in the WIM use LZX compression. */
202 WIMLIB_COMPRESSION_TYPE_LZX = 1,
204 /** Compressed resources in the WIM use XPRESS compression. */
205 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
208 /** Possible values of the first parameter to the user-supplied
209 * ::wimlib_progress_func_t progress function */
210 enum wimlib_progress_msg {
212 /** A WIM image is about to be extracted. @a info will point to
213 * ::wimlib_progress_info.extract. */
214 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
216 /** A file or directory tree within a WIM image (not the full image) is
217 * about to be extracted. @a info will point to
218 * ::wimlib_progress_info.extract. */
219 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
221 /** The directory structure of the WIM image is about to be extracted.
222 * @a info will point to ::wimlib_progress_info.extract. */
223 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
225 /** The directory structure of the WIM image has been successfully
226 * extracted. @a info will point to ::wimlib_progress_info.extract. */
227 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
229 /** The WIM image's files resources are currently being extracted. @a
230 * info will point to ::wimlib_progress_info.extract. */
231 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
233 /** A file or directory is being extracted. @a info will point to
234 * ::wimlib_progress_info.extract, and the @a cur_path member will be
236 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
238 /** All the WIM files and directories have been extracted, and
239 * timestamps are about to be applied. @a info will point to
240 * ::wimlib_progress_info.extract. */
241 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
243 /** A WIM image has been successfully extracted. @a info will point to
244 * ::wimlib_progress_info.extract. */
245 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
247 /** A file or directory tree within a WIM image (not the full image) has
248 * been successfully extracted. @a info will point to
249 * ::wimlib_progress_info.extract. */
250 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
252 /** The directory or NTFS volume is about to be scanned to build a tree
253 * of WIM dentries in-memory. @a info will point to
254 * ::wimlib_progress_info.scan. */
255 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
257 /** A directory or file is being scanned. @a info will point to
258 * ::wimlib_progress_info.scan, and its @a cur_path member will be
259 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
260 * is passed to wimlib_add_image(). */
261 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
263 /** The directory or NTFS volume has been successfully scanned, and a
264 * tree of WIM dentries has been built in-memory. @a info will point to
265 * ::wimlib_progress_info.scan. */
266 WIMLIB_PROGRESS_MSG_SCAN_END,
269 * File resources are currently being written to the WIM.
270 * @a info will point to ::wimlib_progress_info.write_streams. */
271 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
274 * The metadata resource for each image is about to be written to the
275 * WIM. @a info will not be valid. */
276 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
279 * The metadata resource for each image has successfully been writen to
280 * the WIM. @a info will not be valid. */
281 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
284 * The temporary file has successfully been renamed to the original WIM
285 * file. Only happens when wimlib_overwrite() is called and the
286 * overwrite is not done in-place.
287 * @a info will point to ::wimlib_progress_info.rename. */
288 WIMLIB_PROGRESS_MSG_RENAME,
290 /** The contents of the WIM are being checked against the integrity
291 * table. Only happens when wimlib_open_wim() is called with the
292 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
293 * ::wimlib_progress_info.integrity. */
294 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
296 /** An integrity table is being calculated for the WIM being written.
297 * Only happens when wimlib_write() or wimlib_overwrite() is called with
298 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
299 * ::wimlib_progress_info.integrity. */
300 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
302 /** A wimlib_join() operation is in progress. @a info will point to
303 * ::wimlib_progress_info.join. */
304 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
306 /** A wimlib_split() operation is in progress, and a new split part is
307 * about to be started. @a info will point to
308 * ::wimlib_progress_info.split. */
309 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
311 /** A wimlib_split() operation is in progress, and a split part has been
312 * finished. @a info will point to ::wimlib_progress_info.split. */
313 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
316 /** A pointer to this union is passed to the user-supplied
317 * ::wimlib_progress_func_t progress function. One (or none) of the structures
318 * contained in this union will be applicable for the operation
319 * (::wimlib_progress_msg) indicated in the first argument to the progress
321 union wimlib_progress_info {
323 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
324 * document them if they aren't given a name... */
326 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
327 struct wimlib_progress_info_write_streams {
328 /** Number of bytes that are going to be written for all the
329 * streams combined. This is the amount in uncompressed data.
330 * (The actual number of bytes will be less if the data is being
331 * written compressed.) */
332 uint64_t total_bytes;
333 /** Number of streams that are going to be written. */
334 uint64_t total_streams;
336 /** Number of uncompressed bytes that have been written so far.
337 * Will be 0 initially, and equal to @a total_bytes at the end.
339 uint64_t completed_bytes;
341 /** Number of streams that have been written. Will be 0
342 * initially, and equal to @a total_streams at the end. */
343 uint64_t completed_streams;
345 /** Number of threads that are being used to compress resources
346 * (if applicable). */
347 unsigned num_threads;
349 /** The compression type being used to write the streams; either
350 * ::WIMLIB_COMPRESSION_TYPE_NONE,
351 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
352 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
353 int compression_type;
355 /** Library internal use only. */
359 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
360 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
361 struct wimlib_progress_info_scan {
362 /** Directory or NTFS volume that is being scanned. */
363 const wimlib_tchar *source;
365 /** Path to the file or directory that is about to be scanned,
366 * relative to the root of the image capture or the NTFS volume.
368 const wimlib_tchar *cur_path;
370 /** True iff @a cur_path is being excluded from the image
371 * capture due to the capture configuration file. */
374 /** Target path in the WIM. Only valid on messages
375 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
376 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
377 const wimlib_tchar *wim_target_path;
380 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
381 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
382 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
383 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
384 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
385 struct wimlib_progress_info_extract {
386 /** Number of the image being extracted (1-based). */
389 /** Flags passed to to wimlib_extract_image() */
392 /** Full path to the WIM file being extracted. */
393 const wimlib_tchar *wimfile_name;
395 /** Name of the image being extracted. */
396 const wimlib_tchar *image_name;
398 /** Directory or NTFS volume to which the image is being
400 const wimlib_tchar *target;
402 /** Current dentry being extracted. (Valid only if message is
403 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
404 const wimlib_tchar *cur_path;
406 /** Number of bytes of uncompressed data that will be extracted.
407 * Takes into account hard links (they are not counted for each
410 uint64_t total_bytes;
412 /** Number of bytes that have been written so far. Will be 0
413 * initially, and equal to @a total_bytes at the end. */
414 uint64_t completed_bytes;
416 /** Number of streams that will be extracted. This may more or
417 * less than the number of "files" to be extracted due to
418 * special cases (hard links, symbolic links, and alternate data
420 uint64_t num_streams;
422 /** Path to the root dentry within the WIM for the tree that is
423 * being extracted. Will be the empty string when extracting a
425 const wimlib_tchar *extract_root_wim_source_path;
428 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
429 struct wimlib_progress_info_rename {
430 /** Name of the temporary file that the WIM was written to. */
431 const wimlib_tchar *from;
433 /** Name of the original WIM file to which the temporary file is
435 const wimlib_tchar *to;
438 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
439 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
440 struct wimlib_progress_info_integrity {
441 /** Number of bytes from the end of the WIM header to the end of
442 * the lookup table (the area that is covered by the SHA1
443 * integrity checks.) */
444 uint64_t total_bytes;
446 /** Number of bytes that have been SHA1-summed so far. Will be
447 * 0 initially, and equal @a total_bytes at the end. */
448 uint64_t completed_bytes;
450 /** Number of chunks that the checksummed region is divided
452 uint32_t total_chunks;
454 /** Number of chunks that have been SHA1-summed so far. Will
455 * be 0 initially, and equal to @a total_chunks at the end. */
456 uint32_t completed_chunks;
458 /** Size of the chunks used for the integrity calculation. */
461 /** Filename of the WIM (only valid if the message is
462 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
463 const wimlib_tchar *filename;
466 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
467 struct wimlib_progress_info_join {
468 /** Total number of bytes of compressed data contained in all
469 * the split WIM part's file and metadata resources. */
470 uint64_t total_bytes;
472 /** Number of bytes that have been copied to the joined WIM so
473 * far. Will be 0 initially, and equal to @a total_bytes at the
475 uint64_t completed_bytes;
477 /** Number of split WIM parts that have had all their file and
478 * metadata resources copied over to the joined WIM so far. */
479 unsigned completed_parts;
481 /** Number of split WIM parts. */
482 unsigned total_parts;
485 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
486 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
487 struct wimlib_progress_info_split {
488 /** Total size of the original WIM's file and metadata resources
490 uint64_t total_bytes;
492 /** Number of bytes of file and metadata resources that have
493 * been copied out of the original WIM so far. Will be 0
494 * initially, and equal to @a total_bytes at the end. */
495 uint64_t completed_bytes;
497 /** Number of the split WIM part that is about to be started
498 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
499 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
500 unsigned cur_part_number;
502 /** Name of the split WIM part that is about to be started
503 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
504 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
505 const wimlib_tchar *part_name;
509 /** A user-supplied function that will be called periodically during certain WIM
510 * operations. The first argument will be the type of operation that is being
511 * performed or is about to be started or has been completed. The second
512 * argument will be a pointer to one of a number of structures depending on the
513 * first argument. It may be @c NULL for some message types.
515 * The return value of the progress function is currently ignored, but it may do
516 * something in the future. (Set it to 0 for now.)
518 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
519 const union wimlib_progress_info *info);
521 /** An array of these structures is passed to wimlib_add_image_multisource() to
522 * specify the sources from which to create a WIM image. */
523 struct wimlib_capture_source {
524 /** Absolute or relative path to a file or directory on the external
525 * filesystem to be included in the WIM image. */
526 wimlib_tchar *fs_source_path;
528 /** Destination path in the WIM image. Leading and trailing slashes are
529 * ignored. The empty string or @c NULL means the root directory of the
531 wimlib_tchar *wim_target_path;
533 /** Reserved; set to 0. */
537 /** Structure that specifies a list of path patterns. */
538 struct wimlib_pattern_list {
539 /** Array of patterns. The patterns may be modified by library code,
540 * but the @a pats pointer itself will not. See the man page for
541 * <b>wimlib-imagex capture</b> for more information about allowed
545 /** Number of patterns in the @a pats array. */
548 /** Ignored; may be used by the calling code. */
549 size_t num_allocated_pats;
552 /** A structure that contains lists of wildcards that match paths to treat
553 * specially when capturing a WIM image. */
554 struct wimlib_capture_config {
555 /** Paths matching any pattern this list are excluded from being
556 * captured, except if the same path appears in @a
557 * exclusion_exception_pats. */
558 struct wimlib_pattern_list exclusion_pats;
560 /** Paths matching any pattern in this list are never excluded from
562 struct wimlib_pattern_list exclusion_exception_pats;
564 /** Reserved for future capture configuration options. */
565 struct wimlib_pattern_list reserved1;
567 /** Reserved for future capture configuration options. */
568 struct wimlib_pattern_list reserved2;
570 /** Library internal use only. */
571 const wimlib_tchar *_prefix;
573 /** Library internal use only. */
574 size_t _prefix_num_tchars;
578 /*****************************
580 *****************************/
582 /** Directly capture a NTFS volume rather than a generic directory. This flag
583 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
584 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
585 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
587 /** Follow symlinks; archive and dump the files they point to. Cannot be used
588 * with ::WIMLIB_ADD_FLAG_NTFS. */
589 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
591 /** Call the progress function with the message
592 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
594 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
596 /** Mark the image being added as the bootable image of the WIM. */
597 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
599 /** Store the UNIX owner, group, and mode. This is done by adding a special
600 * alternate data stream to each regular file, symbolic link, and directory to
601 * contain this information. Please note that this flag is for convenience
602 * only; Microsoft's @a imagex.exe will not understand this special information.
603 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
604 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
606 /** Do not capture security descriptors. Only has an effect in NTFS capture
607 * mode, or in Win32 native builds. */
608 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
610 /** Fail immediately if the full security descriptor of any file or directory
611 * cannot be accessed. Only has an effect in Win32 native builds. The default
612 * behavior without this flag is to first try omitting the SACL from the
613 * security descriptor, then to try omitting the security descriptor entirely.
615 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
617 /** Call the progress function with the message
618 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
619 * capture. This is a subset of the messages provided by
620 * ::WIMLIB_ADD_FLAG_VERBOSE. */
621 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
623 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
624 * in the case of Windows) that point inside the directory being captured to
625 * instead be absolute relative to the directory being captured, rather than the
626 * current root; also exclude absolute symbolic links that point outside the
627 * directory tree being captured.
629 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
630 * the WIM header or if this is the first image being added.
631 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
632 * reparse point fixups enabled and currently cannot be unset. */
633 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
635 /** Don't do reparse point fixups. The default behavior is described in the
636 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
637 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
639 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
640 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
641 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
642 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
643 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
644 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
645 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
646 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
647 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
648 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
650 /******************************
651 * WIMLIB_DELETE_FLAG_*
652 ******************************/
654 /** Do not issue an error if the path to delete does not exist. */
655 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
657 /** Delete the file or directory tree recursively; if not specified, an error is
658 * issued if the path to delete is a directory. */
659 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
661 /******************************
662 * WIMLIB_EXPORT_FLAG_*
663 ******************************/
665 /** See documentation for wimlib_export_image(). */
666 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
668 /******************************
669 * WIMLIB_EXTRACT_FLAG_*
670 ******************************/
672 /** Extract the image directly to a NTFS volume rather than a generic directory.
674 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
676 /** When identical files are extracted from the WIM, always hard link them
677 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
678 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
680 /** When identical files are extracted from the WIM, always symlink them
681 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
682 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
684 /** Call the progress function with the argument
685 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
686 * extracted. Note: these calls will be interspersed with calls for the message
687 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
688 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
690 /** Read the WIM file sequentially while extracting the image. */
691 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
693 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
694 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
695 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
697 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
698 * or in Win32 native builds. */
699 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
701 /** Fail immediately if the full security descriptor of any file or directory
702 * cannot be set exactly as specified in the WIM file. The default behavior
703 * without this flag is to fall back to setting the security descriptor with the
704 * SACL omitted, then only the default inherited security descriptor, if we do
705 * not have permission to set the desired one. */
706 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
708 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
709 * fixups on, so absolute symbolic links or junction points will be fixed to be
710 * absolute relative to the actual extraction root. Done by default if
711 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
712 * specified when extracting a full image. */
713 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
715 /** Force reparse-point fixups on extraction off, regardless of the state of the
716 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
717 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
719 /** Extract files to standard output rather than to the filesystem. */
720 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
722 /******************************
723 * WIMLIB_MOUNT_FLAG_*
724 ******************************/
726 /** Mount the WIM image read-write rather than the default of read-only. */
727 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
729 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
730 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
732 /** Do not allow accessing alternate data streams in the mounted WIM image. */
733 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
735 /** Access alternate data streams in the mounted WIM image through extended file
736 * attributes. This is the default mode. */
737 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
739 /** Access alternate data streams in the mounted WIM image by specifying the
740 * file name, a colon, then the alternate file stream name. */
741 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
743 /** Use UNIX file owners, groups, and modes if available in the WIM (see
744 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
745 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
747 /** Allow other users to see the mounted filesystem. (this passes the @c
748 * allow_other option to FUSE mount) */
749 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
751 /******************************
753 ******************************/
755 /** Verify the WIM contents against the WIM's integrity table, if present. */
756 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
758 /** Do not issue an error if the WIM is part of a split WIM. */
759 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
761 /******************************
762 * WIMLIB_UNMOUNT_FLAG_*
763 ******************************/
765 /** Include an integrity table in the WIM after it's been unmounted. Ignored
766 * for read-only mounts. */
767 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
769 /** Unless this flag is given, changes to a read-write mounted WIM are
770 * discarded. Ignored for read-only mounts. */
771 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
773 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
774 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
776 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
777 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
779 /******************************
780 * WIMLIB_WRITE_FLAG_*
781 ******************************/
783 /** Include an integrity table in the new WIM file. */
784 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
786 /** Re-build the entire WIM file rather than appending data to it, if possible.
787 * (Applies to wimlib_overwrite(), not wimlib_write()). */
788 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
790 /** Recompress all resources, even if they could otherwise be copied from a
791 * different WIM with the same compression type (in the case of
792 * wimlib_export_image() being called previously). */
793 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
795 /** Call fsync() when the WIM file is closed */
796 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
798 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
799 * after one or more calls to wimlib_delete_image(), which is to rebuild the
802 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
803 * correctly remove the image from the WIM will be taken. In particular, all
804 * streams will be left alone, even if they are no longer referenced. This is
805 * probably not what you want, because almost no space will be spaced by
806 * deleting an image in this way. */
807 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
809 /******************************
811 ******************************/
813 /** Assume that strings are represented in UTF-8, even if this is not the
814 * locale's character encoding. */
815 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
817 /** Specification of an update to perform on a WIM image. */
818 struct wimlib_update_command {
820 /** The specific type of update to perform. */
821 enum wimlib_update_op {
822 /** Add a new file or directory tree to the WIM image in a
823 * certain location. */
824 WIMLIB_UPDATE_OP_ADD = 0,
826 /** Delete a file or directory tree from the WIM image. */
827 WIMLIB_UPDATE_OP_DELETE,
829 /** Rename a file or directory tree in the WIM image. */
830 WIMLIB_UPDATE_OP_RENAME,
833 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
834 struct wimlib_add_command {
835 /** Filesystem path to the file or directory tree to
837 wimlib_tchar *fs_source_path;
838 /** Path, specified from the root of the WIM image, at
839 * which to add the file or directory tree within the
841 wimlib_tchar *wim_target_path;
843 /** Configuration for excluded files. @c NULL means
844 * exclude no files. */
845 struct wimlib_capture_config *config;
847 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
850 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
851 struct wimlib_delete_command {
852 /** Path, specified from the root of the WIM image, for
853 * the file or directory tree within the WIM image to be
855 wimlib_tchar *wim_path;
856 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
859 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
860 struct wimlib_rename_command {
861 /** Path, specified from the root of the WIM image, for
862 * the source file or directory tree within the WIM
864 wimlib_tchar *wim_source_path;
865 /** Path, specified from the root of the WIM image, for
866 * the destination file or directory tree within the WIM
868 wimlib_tchar *wim_target_path;
869 /** Reserved; set to 0. */
875 /** Specification of a file or directory tree to extract from a WIM image. */
876 struct wimlib_extract_command {
877 /** Path to file or directory tree within the WIM image to extract. It
878 * must be provided as an absolute path from the root of the WIM image.
879 * The path separators may be either forward slashes or backslashes. */
880 wimlib_tchar *wim_source_path;
882 /** Filesystem path to extract the file or directory tree to. */
883 wimlib_tchar *fs_dest_path;
885 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
890 * Possible values of the error code returned by many functions in wimlib.
892 * See the documentation for each wimlib function to see specifically what error
893 * codes can be returned by a given function, and what they mean.
895 enum wimlib_error_code {
896 WIMLIB_ERR_SUCCESS = 0,
897 WIMLIB_ERR_ALREADY_LOCKED,
898 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
899 WIMLIB_ERR_DECOMPRESSION,
900 WIMLIB_ERR_DELETE_STAGING_DIR,
901 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
904 WIMLIB_ERR_FUSERMOUNT,
905 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
906 WIMLIB_ERR_IMAGE_COUNT,
907 WIMLIB_ERR_IMAGE_NAME_COLLISION,
908 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
909 WIMLIB_ERR_INTEGRITY,
910 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
911 WIMLIB_ERR_INVALID_CHUNK_SIZE,
912 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
913 WIMLIB_ERR_INVALID_DENTRY,
914 WIMLIB_ERR_INVALID_HEADER_SIZE,
915 WIMLIB_ERR_INVALID_IMAGE,
916 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
917 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
918 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
919 WIMLIB_ERR_INVALID_OVERLAY,
920 WIMLIB_ERR_INVALID_PARAM,
921 WIMLIB_ERR_INVALID_PART_NUMBER,
922 WIMLIB_ERR_INVALID_REPARSE_DATA,
923 WIMLIB_ERR_INVALID_RESOURCE_HASH,
924 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
925 WIMLIB_ERR_INVALID_SECURITY_DATA,
926 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
927 WIMLIB_ERR_INVALID_UTF16_STRING,
928 WIMLIB_ERR_INVALID_UTF8_STRING,
929 WIMLIB_ERR_IS_DIRECTORY,
930 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
937 WIMLIB_ERR_NOT_A_REGULAR_FILE,
938 WIMLIB_ERR_NOT_A_WIM_FILE,
939 WIMLIB_ERR_NO_FILENAME,
943 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
948 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
949 WIMLIB_ERR_RESOURCE_ORDER,
950 WIMLIB_ERR_SPECIAL_FILE,
951 WIMLIB_ERR_SPLIT_INVALID,
952 WIMLIB_ERR_SPLIT_UNSUPPORTED,
955 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
956 WIMLIB_ERR_UNKNOWN_VERSION,
957 WIMLIB_ERR_UNSUPPORTED,
958 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
964 /** Used to indicate no WIM image or an invalid WIM image. */
965 #define WIMLIB_NO_IMAGE 0
967 /** Used to specify all images in the WIM. */
968 #define WIMLIB_ALL_IMAGES (-1)
971 * Appends an empty image to a WIM file. This empty image will initially
972 * contain no files or directories, although if written without further
973 * modifications, a root directory will be created automatically for it.
976 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
979 * Name to give the new image.
981 * If non-<code>NULL</code>, the index of the newly added image is returned
984 * @return 0 on success; nonzero on failure. The possible error codes are:
986 * @retval ::WIMLIB_ERR_INVALID_PARAM
987 * @a name was @c NULL or an empty string.
988 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
989 * @a wim is part of a split WIM.
990 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
991 * There is already an image in @a wim named @a name.
992 * @retval ::WIMLIB_ERR_NOMEM
993 * Failed to allocate the memory needed to add the new image.
996 wimlib_add_empty_image(WIMStruct *wim,
997 const wimlib_tchar *name,
1001 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1003 * The directory tree or NTFS volume is scanned immediately to load the dentry
1004 * tree into memory, and file attributes and symbolic links are read. However,
1005 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1008 * See the manual page for the @b wimlib-imagex program for more information
1009 * about the "normal" capture mode versus the NTFS capture mode (entered by
1010 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1012 * Note that @b no changes are committed to the underlying WIM file (if
1013 * any) until wimlib_write() or wimlib_overwrite() is called.
1016 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1019 * A path to a directory or unmounted NTFS volume that will be captured as
1022 * The name to give the image. It must be nonempty and must specify a name
1023 * that does not yet exist in @a wim.
1025 * Capture configuration that specifies files, directories, or path globs
1026 * to exclude from being captured. If @c NULL, a dummy configuration where
1027 * no paths are treated specially is used.
1029 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1030 * @param progress_func
1031 * If non-NULL, a function that will be called periodically with the
1032 * progress of the current operation.
1034 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1035 * discarded so that it appears to be in the same state as when this function
1038 * This function is implemented by calling wimlib_add_empty_image(), then
1039 * calling wimlib_update_image() with a single "add" command, so any error code
1040 * returned by wimlib_add_empty_image() may be returned, as well as any error
1041 * codes returned by wimlib_update_image() other than ones documented as only
1042 * being returned specifically by an update involving delete or rename commands.
1045 wimlib_add_image(WIMStruct *wim,
1046 const wimlib_tchar *source,
1047 const wimlib_tchar *name,
1048 const struct wimlib_capture_config *config,
1050 wimlib_progress_func_t progress_func);
1052 /** This function is equivalent to wimlib_add_image() except it allows for
1053 * multiple sources to be combined into a single WIM image. This is done by
1054 * specifying the @a sources and @a num_sources parameters instead of the @a
1055 * source parameter of wimlib_add_image(). The rest of the parameters are the
1056 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1057 * capture</b> for full details on how this mode works.
1059 * In addition to the error codes that wimlib_add_image() can return,
1060 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1061 * when trying to overlay a non-directory on a directory or when otherwise
1062 * trying to overlay multiple conflicting files to the same location in the WIM
1063 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1064 * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1065 * was not exactly one capture source with the target being the root directory.
1066 * (In this respect, there is no advantage to using
1067 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1070 wimlib_add_image_multisource(WIMStruct *wim,
1071 const struct wimlib_capture_source *sources,
1073 const wimlib_tchar *name,
1074 const struct wimlib_capture_config *config,
1076 wimlib_progress_func_t progress_func);
1079 * Creates a ::WIMStruct for a new WIM file.
1081 * This only creates an in-memory structure for a WIM that initially contains no
1082 * images. No on-disk file is created until wimlib_write() is called.
1085 * The type of compression to be used in the new WIM file. Must be
1086 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1087 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1089 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1090 * written to the memory location pointed to by this paramater. The
1091 * ::WIMStruct must be freed using using wimlib_free() when finished with
1093 * @return 0 on success; nonzero on error.
1094 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1095 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1096 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1097 * @retval ::WIMLIB_ERR_NOMEM
1098 * Failed to allocate needed memory.
1101 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1104 * Deletes an image, or all images, from a WIM file.
1106 * All streams referenced by the image(s) being deleted are removed from the
1107 * lookup table of the WIM if they are not referenced by any other images in the
1110 * Please note that @b no changes are committed to the underlying WIM file (if
1111 * any) until wimlib_write() or wimlib_overwrite() is called.
1114 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1117 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1119 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1120 * to be left unmodified only if @a image specified a single image. If instead
1121 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1122 * possible for some but not all of the images to have been deleted when a
1123 * failure status is returned.
1125 * @retval ::WIMLIB_ERR_DECOMPRESSION
1126 * Could not decompress the metadata resource for @a image.
1127 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1128 * A directory entry in the metadata resource for @a image in the WIM is
1130 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1131 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1132 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1133 * The metadata resource for @a image in the WIM is invalid.
1134 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1135 * The security data for @a image in the WIM is invalid.
1136 * @retval ::WIMLIB_ERR_NOMEM
1137 * Failed to allocate needed memory.
1138 * @retval ::WIMLIB_ERR_READ
1139 * Could not read the metadata resource for @a image from the WIM.
1140 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1141 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1145 wimlib_delete_image(WIMStruct *wim, int image);
1148 * Exports an image, or all the images, from a WIM file, into another WIM file.
1150 * The destination image is made to share the same dentry tree and security data
1151 * structure as the source image. This places some restrictions on additional
1152 * functions that may be called. wimlib_mount_image() may not be called on
1153 * either the source image or the destination image without an intervening call
1154 * to a function that un-shares the images, such as wimlib_free() on @a
1155 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1156 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1157 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1158 * have references back to @a src_wim.
1160 * If this function fails, all changes to @a dest_wim are rolled back.
1162 * No changes shall be made to @a src_wim by this function.
1164 * Please note that no changes are committed to the underlying WIM file of @a
1165 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1168 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1169 * WIM that contains the image(s) being exported.
1171 * The image to export from @a src_wim. Can be the number of an image, or
1172 * ::WIMLIB_ALL_IMAGES to export all images.
1174 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1177 * The name to give the exported image in the new WIM file. If left @c
1178 * NULL, the name from @a src_wim is used. This parameter must be left @c
1179 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1180 * than one image; in that case, the names are all taken from the @a
1181 * src_wim. (This is allowed even if one or more images being exported has
1183 * @param dest_description
1184 * The description to give the exported image in the new WIM file. If left
1185 * @c NULL, the description from the @a src_wim is used. This parameter must
1186 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1187 * more than one image; in that case, the descriptions are all taken from
1188 * @a src_wim. (This is allowed even if one or more images being exported
1189 * has no description.)
1190 * @param export_flags
1191 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1192 * bootable, or 0 if which image is marked as bootable in the destination
1193 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1194 * there are multiple images in @a src_wim, specifying
1195 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1196 * currently marked as bootable in @a src_wim; if that is the case, then
1197 * that image is marked as bootable in the destination WIM.
1198 * @param additional_swms
1199 * Array of pointers to the ::WIMStruct for each additional part in the
1200 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1201 * need to be in any particular order, but they must include all parts of
1202 * the split WIM other than the first part, which must be provided in the
1204 * @param num_additional_swms
1205 * Number of additional WIM parts provided in the @a additional_swms array.
1206 * This number should be one less than the total number of parts in the
1207 * split WIM. Set to 0 if the WIM is a standalone WIM.
1208 * @param progress_func
1209 * If non-NULL, a function that will be called periodically with the
1210 * progress of the current operation.
1212 * @return 0 on success; nonzero on error.
1213 * @retval ::WIMLIB_ERR_DECOMPRESSION
1214 * Could not decompress the metadata resource for @a src_image
1216 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1217 * One or more of the names being given to an exported image was already in
1218 * use in the destination WIM.
1219 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1220 * A directory entry in the metadata resource for @a src_image in @a
1221 * src_wim is invalid.
1222 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1223 * @a src_image does not exist in @a src_wim.
1224 * @retval ::WIMLIB_ERR_INVALID_PARAM
1225 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1226 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1227 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1228 * dest_description were non-<code>NULL</code>, @a src_image was
1229 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1230 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1231 * The metadata resource for @a src_image in @a src_wim is invalid.
1232 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1233 * The security data for @a src_image in @a src_wim is invalid.
1234 * @retval ::WIMLIB_ERR_NOMEM
1235 * Failed to allocate needed memory.
1236 * @retval ::WIMLIB_ERR_READ
1237 * Could not read the metadata resource for @a src_image from @a src_wim.
1238 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1239 * The source WIM is a split WIM, but the parts specified do not form a
1240 * complete split WIM because they do not include all the parts of the
1241 * original WIM, there are duplicate parts, or not all the parts have the
1242 * same GUID and compression type.
1243 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1244 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1248 wimlib_export_image(WIMStruct *src_wim, int src_image,
1249 WIMStruct *dest_wim,
1250 const wimlib_tchar *dest_name,
1251 const wimlib_tchar *dest_description,
1253 WIMStruct **additional_swms,
1254 unsigned num_additional_swms,
1255 wimlib_progress_func_t progress_func);
1258 * Extract zero or more files or directory trees from a WIM image.
1260 * This generalizes the single-image extraction functionality of
1261 * wimlib_extract_image() to allow extracting only the specified subsets of the
1265 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1269 * The 1-based number of the image in @a wim from which the files or
1270 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1273 * An array of ::wimlib_extract_command structures that specifies the
1274 * extractions to perform.
1277 * Number of commands in the @a cmds array.
1279 * @param default_extract_flags
1280 * Default extraction flags; the behavior shall be as if these flags had
1281 * been specified in the ::wimlib_extract_command.extract_flags member in
1282 * each extraction command, in combination with any flags already present.
1284 * @param additional_swms
1285 * Array of pointers to the ::WIMStruct for each additional part in the
1286 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1287 * need to be in any particular order, but they must include all parts of
1288 * the split WIM other than the first part, which must be provided in the
1291 * @param num_additional_swms
1292 * Number of additional WIM parts provided in the @a additional_swms array.
1293 * This number should be one less than the total number of parts in the
1294 * split WIM. Set to 0 if the WIM is a standalone WIM.
1296 * @param progress_func
1297 * If non-NULL, a function that will be called periodically with the
1298 * progress of the current operation.
1300 * @return 0 on success; nonzero on error. The possible error codes include
1301 * those documented as returned by wimlib_extract_image() as well as the
1302 * following additional error codes:
1304 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1305 * The ::wimlib_extract_command.wim_source_path member in one of the
1306 * extract commands did not exist in the WIM.
1307 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1308 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1309 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1310 * regular file or directory.
1311 * @retval ::WIMLIB_ERR_INVALID_PARAM
1312 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1313 * specified for some commands but not all; or
1314 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1315 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1316 * for a command in which ::wimlib_extract_command.wim_source_path did not
1317 * specify the root directory of the WIM image.
1320 wimlib_extract_files(WIMStruct *wim,
1322 const struct wimlib_extract_command *cmds,
1324 int default_extract_flags,
1325 WIMStruct **additional_swms,
1326 unsigned num_additional_swms,
1327 wimlib_progress_func_t progress_func);
1330 * Extracts an image, or all images, from a standalone or split WIM file to a
1331 * directory or a NTFS volume.
1333 * Please see the manual page for the @c wimlib-imagex program for more
1334 * information about the "normal" extraction mode versus the NTFS extraction
1335 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1337 * Extraction is done with one thread.
1339 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1340 * returned if any resulting SHA1 message digests do not match the values
1341 * provided in the WIM file. Therefore, if this function is successful, you can
1342 * be fairly sure that any compressed data in the WIM was uncompressed
1346 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1349 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1350 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1351 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1353 * Directory to extract the WIM image(s) to (created if it does not already
1354 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1355 * path to the unmounted NTFS volume to extract the image to.
1356 * @param extract_flags
1357 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1359 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1360 * a NTFS volume to extract the image to. The volume will be opened using
1361 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1362 * Otherwise, @a target is interpreted as a directory to extract the
1365 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1366 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1367 * specified. These flags cause extracted files that are identical to be
1368 * hardlinked or symlinked together, depending on the flag. These flags
1369 * override the hard link groups that are specified in the WIM file itself.
1370 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1371 * hardlinked or symlinked across images if a file is found to occur in
1372 * more than one image.
1374 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1375 * name of each file or directory as it is extracted.
1377 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1378 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1379 * each image is considered separately with regards to the sequential
1380 * order. It is also possible for alternate data streams to break the
1381 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1383 * @param additional_swms
1384 * Array of pointers to the ::WIMStruct for each additional part in the
1385 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1386 * need to be in any particular order, but they must include all parts of
1387 * the split WIM other than the first part, which must be provided in the
1389 * @param num_additional_swms
1390 * Number of additional WIM parts provided in the @a additional_swms array.
1391 * This number should be one less than the total number of parts in the
1392 * split WIM. Set to 0 if the WIM is a standalone WIM.
1394 * @param progress_func
1395 * If non-NULL, a function that will be called periodically with the
1396 * progress of the current operation.
1398 * @return 0 on success; nonzero on error.
1399 * @retval ::WIMLIB_ERR_DECOMPRESSION
1400 * Could not decompress a resource (file or metadata) for @a image in @a
1402 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1403 * A directory entry in the metadata resource for @a image in @a wim is
1405 * @retval ::WIMLIB_ERR_INVALID_PARAM
1406 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1407 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1408 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1409 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1410 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1411 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1412 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1413 * specified in @a extract_flag.
1414 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1415 * The SHA1 message digest of an extracted stream did not match the SHA1
1416 * message digest given in the WIM file.
1417 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1418 * A resource (file or metadata) for @a image in @a wim is invalid.
1419 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1420 * The security data for @a image in @a wim is invalid.
1421 * @retval ::WIMLIB_ERR_LINK
1422 * Failed to create a symbolic link or a hard link (only if
1423 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1424 * @retval ::WIMLIB_ERR_MKDIR
1425 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1426 * not specified in @a extract_flags).
1427 * @retval ::WIMLIB_ERR_NOMEM
1428 * Failed to allocate needed memory.
1429 * @retval ::WIMLIB_ERR_NTFS_3G
1430 * An error was returned from a libntfs-3g function while the WIM image was
1431 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1432 * was specified in @a extract_flags).
1433 * @retval ::WIMLIB_ERR_OPEN
1434 * Could not open one of the files being extracted for writing (only if
1435 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1436 * @retval ::WIMLIB_ERR_READ
1437 * A unexpected end-of-file or read error occurred when trying to read data
1438 * from the WIM file associated with @a wim.
1439 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1440 * The WIM is a split WIM, but the parts specified do not form a complete
1441 * split WIM because they do not include all the parts of the original WIM,
1442 * there are duplicate parts, or not all the parts have the same GUID and
1444 * @retval ::WIMLIB_ERR_UNSUPPORTED
1445 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1446 * was configured with the @c --without-ntfs-3g flag.
1447 * @retval ::WIMLIB_ERR_WRITE
1448 * Failed to write a file being extracted (only if
1449 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1452 wimlib_extract_image(WIMStruct *wim, int image,
1453 const wimlib_tchar *target,
1455 WIMStruct **additional_swms,
1456 unsigned num_additional_swms,
1457 wimlib_progress_func_t progress_func);
1460 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1461 * includes a string of XML that describes the images contained in the WIM.
1462 * This function works on standalone WIMs as well as split WIM parts.
1465 * Pointer to the ::WIMStruct for a WIM file.
1467 * @c stdout, or a FILE* opened for writing, to extract the data to.
1469 * @return 0 on success; nonzero on error.
1470 * @retval ::WIMLIB_ERR_INVALID_PARAM
1471 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1472 * @retval ::WIMLIB_ERR_NOMEM
1473 * Failed to allocate needed memory.
1474 * @retval ::WIMLIB_ERR_READ
1475 * Failed to read the XML data from the WIM.
1476 * @retval ::WIMLIB_ERR_WRITE
1477 * Failed to completely write the XML data to @a fp.
1480 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1483 * Frees all memory allocated for a WIMStruct and closes all files associated
1487 * Pointer to the ::WIMStruct for a WIM file.
1489 * @return This function has no return value.
1492 wimlib_free(WIMStruct *wim);
1495 * Returns the index of the bootable image of the WIM.
1498 * Pointer to the ::WIMStruct for a WIM file.
1501 * 0 if no image is marked as bootable, or the number of the image marked
1502 * as bootable (numbered starting at 1).
1505 wimlib_get_boot_idx(const WIMStruct *wim);
1508 * Returns the compression type used in the WIM.
1511 * Pointer to the ::WIMStruct for a WIM file
1514 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1515 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1518 wimlib_get_compression_type(const WIMStruct *wim);
1521 * Converts a ::wimlib_compression_type value into a string.
1524 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1525 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1528 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1531 extern const wimlib_tchar *
1532 wimlib_get_compression_type_string(int ctype);
1535 * Converts an error code into a string describing it.
1538 * The error code returned by one of wimlib's functions.
1541 * Pointer to a statically allocated string describing the error code,
1542 * or @c NULL if the error code is not valid.
1544 extern const wimlib_tchar *
1545 wimlib_get_error_string(enum wimlib_error_code code);
1548 * Returns the description of the specified image.
1551 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1552 * standalone WIM or a split WIM part.
1554 * The number of the image, numbered starting at 1.
1557 * The description of the image, or @c NULL if there is no such image, or
1558 * @c NULL if the specified image has no description. The description
1559 * string is in library-internal memory and may not be modified or freed;
1560 * in addition, the string will become invalid if the description of the
1561 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1563 extern const wimlib_tchar *
1564 wimlib_get_image_description(const WIMStruct *wim, int image);
1567 * Returns the name of the specified image.
1570 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1571 * standalone WIM or a split WIM part.
1573 * The number of the image, numbered starting at 1.
1576 * The name of the image, or @c NULL if there is no such image. The name
1577 * string is in library-internal memory and may not be modified or freed;
1578 * in addition, the string will become invalid if the name of the image is
1579 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1581 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1582 * the WIM to be unnamed, in which case an empty string will be returned
1583 * when the corresponding name is requested.
1585 extern const wimlib_tchar *
1586 wimlib_get_image_name(const WIMStruct *wim, int image);
1590 * Returns the number of images contained in a WIM.
1593 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1594 * standalone WIM or a split WIM part.
1597 * The number of images contained in the WIM file.
1600 wimlib_get_num_images(const WIMStruct *wim);
1603 * Returns the part number of a WIM in a split WIM and the total number of parts
1607 * Pointer to the ::WIMStruct for a WIM file.
1608 * @param total_parts_ret
1609 * If non-@c NULL, the total number of parts in the split WIM (1 for
1610 * non-split WIMs) is written to this location.
1613 * The part number of the WIM (1 for non-split WIMs)
1616 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1619 * Initialization function for wimlib. Call before using any other wimlib
1623 * On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1624 * that all input data, including filenames, are in UTF-8 rather than the
1625 * locale-dependent character encoding which may or may not be UTF-8, and
1626 * that UTF-8 data can be directly printed to the console. On Windows, use
1627 * 0 for this parameter.
1629 * @return 0; other error codes may be returned in future releases.
1632 wimlib_global_init(int init_flags);
1635 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1636 * You are not required to call this function, but it will release any global
1637 * memory allocated by the library.
1640 wimlib_global_cleanup();
1643 * Returns true if the WIM has an integrity table.
1646 * Pointer to the ::WIMStruct for a WIM file.
1648 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1649 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1650 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1651 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1654 wimlib_has_integrity_table(const WIMStruct *wim);
1657 * Determines if an image name is already used by some image in the WIM.
1660 * Pointer to the ::WIMStruct for a WIM file.
1662 * The name to check.
1665 * @c true if there is already an image in @a wim named @a name; @c false
1666 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1667 * the empty string, @c false is returned.
1670 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1673 * Joins a split WIM into a stand-alone one-part WIM.
1676 * An array of strings that gives the filenames of all parts of the split
1677 * WIM. No specific order is required, but all parts must be included with
1680 * Number of filenames in @a swms.
1681 * @param swm_open_flags
1682 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1683 * part should be verified, if integrity tables are present. Otherwise,
1685 * @param wim_write_flags
1686 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1687 * @param output_path
1688 * The path to write the one-part WIM to.
1689 * @param progress_func
1690 * If non-NULL, a function that will be called periodically with the
1691 * progress of the current operation.
1693 * @return 0 on success; nonzero on error. This function may return any value
1694 * returned by wimlib_open_wim() and wimlib_write() except
1695 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1697 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1698 * The split WIMs do not form a valid WIM because they do not include all
1699 * the parts of the original WIM, there are duplicate parts, or not all the
1700 * parts have the same GUID and compression type.
1702 * Note: the WIM's uncompressed and compressed resources are not checksummed
1703 * when they are copied from the split WIM parts to the joined WIM, nor are
1704 * compressed resources re-compressed.
1706 * Note: wimlib_export_image() can provide similar functionality to
1707 * wimlib_join(), since it is possible to export all images from a split WIM.
1710 wimlib_join(const wimlib_tchar * const *swms,
1712 const wimlib_tchar *output_path,
1714 int wim_write_flags,
1715 wimlib_progress_func_t progress_func);
1718 * Compress a chunk of a WIM resource using LZX compression.
1720 * This function is exported for convenience only and need not be used.
1723 * Uncompressed data of the chunk.
1725 * Size of the uncompressed chunk, in bytes.
1727 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1730 * The size of the compressed data written to @a out in bytes, or 0 if the
1731 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1733 * As a special requirement, the compression code is optimized for the WIM
1734 * format and therefore requires (@a chunk_size <= 32768).
1737 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1740 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1742 * Note that this will NOT work unmodified for LZX as used in the cabinet
1743 * format, which is not the same as in the WIM format!
1745 * This function is exported for convenience only and need not be used.
1747 * @param compressed_data
1748 * Pointer to the compressed data.
1750 * @param compressed_len
1751 * Length of the compressed data, in bytes.
1753 * @param uncompressed_data
1754 * Pointer to the buffer into which to write the uncompressed data.
1756 * @param uncompressed_len
1757 * Length of the uncompressed data. It must be 32768 bytes or less.
1760 * 0 on success; non-zero on failure.
1763 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1764 void *uncompressed_data, unsigned uncompressed_len);
1768 * Mounts an image in a WIM file on a directory read-only or read-write.
1770 * This is not supported on Windows.
1772 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1773 * process will be daemonized.
1775 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1776 * modifications to the WIM are staged in a temporary directory.
1778 * It is safe to mount multiple images from the same WIM file read-only at the
1779 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1780 * to mount multiple images from the same WIM file read-write at the same time.
1782 * wimlib_mount_image() cannot be used on an image that was exported with
1783 * wimlib_export_image() while the dentry trees for both images are still in
1784 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1785 * that has just been added with wimlib_add_image(), unless the WIM has been
1786 * written and read into a new ::WIMStruct.
1789 * Pointer to the ::WIMStruct containing the image to be mounted.
1791 * The number of the image to mount, indexed starting from it. It must be
1792 * an existing, single image.
1794 * The path to an existing empty directory to mount the image on.
1795 * @param mount_flags
1796 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1798 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1799 * rather than the default of read-only.
1801 * WIMs may contain named (alternate) data streams, which are a somewhat
1802 * obscure NTFS feature. They can be read and written on a mounted WIM
1803 * through one of several interfaces. The interface to use if specified by
1804 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1805 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1806 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1807 * the XATTR interface.
1808 * @param additional_swms
1809 * Array of pointers to the ::WIMStruct for each additional part in the
1810 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1811 * need to be in any particular order, but they must include all parts of
1812 * the split WIM other than the first part, which must be provided in the
1814 * @param num_additional_swms
1815 * Number of additional WIM parts provided in the @a additional_swms array.
1816 * This number should be one less than the total number of parts in the
1817 * split WIM. Set to 0 if the WIM is a standalone WIM.
1818 * @param staging_dir
1819 * If non-NULL, the name of a directory in which the staging directory will
1820 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1821 * in @a mount_flags. If left @c NULL, the staging directory is created in
1822 * the same directory as the WIM file that @a wim was originally read from.
1824 * @return 0 on success; nonzero on error.
1826 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1827 * A read-write mount was requested, but an an exclusive advisory lock on
1828 * the on-disk WIM file could not be acquired because another thread or
1829 * process has mounted an image from the WIM read-write or is currently
1830 * modifying the WIM in-place.
1831 * @retval ::WIMLIB_ERR_DECOMPRESSION
1832 * Could not decompress the metadata resource for @a image in @a wim.
1833 * @retval ::WIMLIB_ERR_FUSE
1834 * A non-zero status was returned by @c fuse_main().
1835 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1836 * A directory entry in the metadata resource for @a image in @a wim is
1838 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1839 * @a image does not specify an existing, single image in @a wim.
1840 * @retval ::WIMLIB_ERR_INVALID_PARAM
1841 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1842 * wimlib_export_image(), or @a image has been added with
1843 * wimlib_add_image().
1844 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1845 * The metadata resource for @a image in @a wim is invalid.
1846 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1847 * The security data for @a image in @a wim is invalid.
1848 * @retval ::WIMLIB_ERR_MKDIR
1849 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1850 * staging directory could not be created.
1851 * @retval ::WIMLIB_ERR_NOMEM
1852 * Failed to allocate needed memory.
1853 * @retval ::WIMLIB_ERR_NOTDIR
1854 * Could not determine the current working directory.
1855 * @retval ::WIMLIB_ERR_READ
1856 * An unexpected end-of-file or read error occurred when trying to read
1857 * data from the WIM file associated with @a wim.
1858 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1859 * The WIM is a split WIM, but the parts specified do not form a complete
1860 * split WIM because they do not include all the parts of the original WIM,
1861 * there are duplicate parts, or not all the parts have the same GUID and
1863 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1864 * The WIM is a split WIM and a read-write mount was requested. We only
1865 * support mounting a split WIM read-only.
1866 * @retval ::WIMLIB_ERR_UNSUPPORTED
1867 * Mounting is not supported, either because the platform is Windows, or
1868 * because the platform is UNIX and wimlib was compiled with @c
1872 wimlib_mount_image(WIMStruct *wim,
1874 const wimlib_tchar *dir,
1876 WIMStruct **additional_swms,
1877 unsigned num_additional_swms,
1878 const wimlib_tchar *staging_dir);
1881 * Opens a WIM file and creates a ::WIMStruct for it.
1884 * The path to the WIM file to open.
1886 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1887 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1889 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1890 * the WIM, if it exists, is checked, and this function will fail with an
1891 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1892 * digests of the WIM do not exactly match the corresponding message
1893 * digests given in the integrity table.
1895 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1896 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1897 * returned. (This flag may be removed in the future, in which case no
1898 * error will be issued when opening a split WIM.)
1900 * @param progress_func
1901 * If non-NULL, a function that will be called periodically with the
1902 * progress of the current operation.
1905 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1906 * is written to the memory location pointed to by this parameter. The
1907 * ::WIMStruct must be freed using using wimlib_free() when finished with
1910 * @return 0 on success; nonzero on error.
1911 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1912 * The lookup table of @a wim_file is compressed. Support for this can be
1913 * added to wimlib if needed, but it appears to be the case that the lookup
1914 * table is never compressed.
1915 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1916 * The WIM is not the non-first part of a split WIM, and the number of
1917 * metadata resources found in the WIM did not match the image count given
1918 * in the WIM header, or the number of <IMAGE> elements in the XML
1919 * data for the WIM did not match the image count given in the WIM header.
1920 * @retval ::WIMLIB_ERR_INTEGRITY
1921 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1922 * wim_file contains an integrity table, but the SHA1 message digest for a
1923 * chunk of the WIM does not match the corresponding message digest given
1924 * in the integrity table.
1925 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1926 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1927 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1928 * The header of @a wim_file says that resources in the WIM are compressed,
1929 * but the header flag indicating LZX or XPRESS compression is not set.
1930 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1931 * The length field of the WIM header is not 208.
1932 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1933 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1934 * wim_file contains an integrity table, but the integrity table is
1936 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1937 * The lookup table for the WIM contained duplicate entries that are not
1938 * for metadata resources, or it contained an entry with a SHA1 message
1939 * digest of all 0's.
1940 * @retval ::WIMLIB_ERR_NOMEM
1941 * Failed to allocated needed memory.
1942 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1943 * @a wim_file does not begin with the expected magic characters.
1944 * @retval ::WIMLIB_ERR_OPEN
1945 * Failed to open the file @a wim_file for reading.
1946 * @retval ::WIMLIB_ERR_READ
1947 * An unexpected end-of-file or read error occurred when trying to read
1948 * data from @a wim_file.
1949 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1950 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1951 * specified in @a open_flags.
1952 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1953 * A number other than 0x10d00 is written in the version field of the WIM
1954 * header of @a wim_file. (Probably a pre-Vista WIM).
1955 * @retval ::WIMLIB_ERR_XML
1956 * The XML data for @a wim_file is invalid.
1959 wimlib_open_wim(const wimlib_tchar *wim_file,
1961 WIMStruct **wim_ret,
1962 wimlib_progress_func_t progress_func);
1965 * Overwrites the file that the WIM was originally read from, with changes made.
1966 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1967 * rather than wimlib_create_new_wim().
1969 * There are two ways that a WIM may be overwritten. The first is to do a full
1970 * rebuild. In this mode, the new WIM is written to a temporary file and then
1971 * renamed to the original file after it is has been completely written. The
1972 * temporary file is made in the same directory as the original WIM file. A
1973 * full rebuild may take a while, but can be used even if images have been
1974 * modified or deleted, will produce a WIM with no holes, and has little chance
1975 * of unintentional data loss because the temporary WIM is fsync()ed before
1976 * being renamed to the original WIM.
1978 * The second way to overwrite a WIM is by appending to the end of it and
1979 * overwriting the header. This can be much faster than a full rebuild, but the
1980 * disadvantage is that some space will be wasted. Writing a WIM in this mode
1981 * begins with writing any new file resources *after* everything in the old WIM,
1982 * even though this will leave a hole where the old lookup table, XML data, and
1983 * integrity were. This is done so that the WIM remains valid even if the
1984 * operation is aborted mid-write. The WIM header is only overwritten at the
1985 * very last moment, and up until that point the WIM will be seen as the old
1988 * By default, wimlib_overwrite() does the append-style overwrite described
1989 * above, unless resources in the WIM are arranged in an unusual way or if
1990 * images have been deleted from the WIM. Use the flag
1991 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1992 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1993 * images have been deleted from the WIM.
1995 * In the temporary-file overwrite mode, no changes are made to the WIM on
1996 * failure, and the temporary file is deleted if possible. Abnormal termination
1997 * of the program will result in the temporary file being orphaned. In the
1998 * direct append mode, the WIM is truncated to the original length on failure;
1999 * and while abnormal termination of the program will result in extra data
2000 * appended to the original WIM, it should still be a valid WIM.
2002 * If this function completes successfully, no more functions should be called
2003 * on @a wim other than wimlib_free(). You must use wimlib_open_wim() to read
2004 * the WIM file anew.
2007 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2008 * been in-memory changes made to it, which are then reflected in the
2010 * @param write_flags
2011 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2012 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2013 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2014 * @param num_threads
2015 * Number of threads to use for compression (see wimlib_write()).
2016 * @param progress_func
2017 * If non-NULL, a function that will be called periodically with the
2018 * progress of the current operation.
2020 * @return 0 on success; nonzero on error. This function may return any value
2021 * returned by wimlib_write() as well as the following error codes:
2022 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2023 * The WIM was going to be modifien in-place (with no temporary file), but
2024 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2025 * because another thread or process has mounted an image from the WIM
2026 * read-write or is currently modifying the WIM in-place.
2027 * @retval ::WIMLIB_ERR_NO_FILENAME
2028 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2029 * than a WIM read with wimlib_open_wim().
2030 * @retval ::WIMLIB_ERR_RENAME
2031 * The temporary file that the WIM was written to could not be renamed to
2032 * the original filename of @a wim.
2035 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2036 wimlib_progress_func_t progress_func);
2039 * Prints information about one image, or all images, contained in a WIM.
2042 * Pointer to the ::WIMStruct for a WIM file.
2044 * The image about which to print information. Can be the number of an
2045 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2048 * @return This function has no return value. No error checking is done when
2049 * printing the information. If @a image is invalid, an error message is
2053 wimlib_print_available_images(const WIMStruct *wim, int image);
2056 * Prints the full paths to all files contained in an image, or all images, in a
2060 * Pointer to the ::WIMStruct for a WIM file.
2062 * Which image to print files for. Can be the number of an image, or
2063 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2065 * @return 0 on success; nonzero on error.
2066 * @retval ::WIMLIB_ERR_DECOMPRESSION
2067 * The metadata resource for one of the specified images could not be
2069 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2070 * A directory entry in the metadata resource for one of the specified
2071 * images is invaled.
2072 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2073 * @a image does not specify a valid image in @a wim, and is not
2074 * ::WIMLIB_ALL_IMAGES.
2075 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2076 * The metadata resource for one of the specified images is invalid.
2077 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2078 * The security data for one of the specified images is invalid.
2079 * @retval ::WIMLIB_ERR_NOMEM
2080 * Failed to allocate needed memory.
2081 * @retval ::WIMLIB_ERR_READ
2082 * An unexpected read error or end-of-file occurred when reading the
2083 * metadata resource for one of the specified images.
2084 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2085 * @a wim was not a standalone WIM and was not the first part of a split
2089 wimlib_print_files(WIMStruct *wim, int image);
2092 * Prints detailed information from the header of a WIM file.
2095 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2096 * standalone WIM or part of a split WIM.
2098 * @return This function has no return value.
2102 wimlib_print_header(const WIMStruct *wim);
2105 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2106 * digests, as found in the directory entry tree in the WIM file, to file
2107 * resources in the WIM file. This table includes one entry for each unique
2108 * file in the WIM, so it can be quite long. There is only one lookup table per
2109 * WIM file, but each split WIM part has its own lookup table.
2112 * Pointer to the ::WIMStruct for a WIM file.
2114 * @return This function has no return value.
2117 wimlib_print_lookup_table(WIMStruct *wim);
2120 * Prints the metadata of the specified image in a WIM file. The metadata
2121 * consists of the security data as well as the directory entry tree. Each
2122 * image has its own metadata.
2125 * Pointer to the ::WIMStruct for a WIM file.
2127 * Which image to print the metadata for. Can be the number of an image,
2128 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2130 * @return 0 on success; nonzero on error.
2131 * @retval ::WIMLIB_ERR_DECOMPRESSION
2132 * The metadata resource for one of the specified images could not be
2134 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2135 * A directory entry in the metadata resource for one of the specified
2136 * images is invaled.
2137 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2138 * @a image does not specify a valid image in @a wim, and is not
2139 * ::WIMLIB_ALL_IMAGES.
2140 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2141 * The metadata resource for one of the specified images is invalid.
2142 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2143 * The security data for one of the specified images is invalid.
2144 * @retval ::WIMLIB_ERR_NOMEM
2145 * Failed to allocate needed memory.
2146 * @retval ::WIMLIB_ERR_READ
2147 * An unexpected read error or end-of-file occurred when reading the
2148 * metadata resource for one of the specified images.
2149 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2150 * @a wim was not a standalone WIM and was not the first part of a split
2154 wimlib_print_metadata(WIMStruct *wim, int image);
2157 * Prints some basic information about a WIM file. All information printed by
2158 * this function is also printed by wimlib_print_header(), but
2159 * wimlib_print_wim_information() prints some of this information more concisely
2160 * and in a more readable form.
2163 * Pointer to the ::WIMStruct for a WIM file.
2165 * @return This function has no return value.
2168 wimlib_print_wim_information(const WIMStruct *wim);
2171 * Translates a string specifying the name or number of an image in the WIM into
2172 * the number of the image. The images are numbered starting at 1.
2175 * Pointer to the ::WIMStruct for a WIM file.
2176 * @param image_name_or_num
2177 * A string specifying the name or number of an image in the WIM. If it
2178 * parses to a positive integer, this integer is taken to specify the
2179 * number of the image, indexed starting at 1. Otherwise, it is taken to
2180 * be the name of an image, as given in the XML data for the WIM file. It
2181 * also may be the keyword "all" or the string "*", both of which will
2182 * resolve to ::WIMLIB_ALL_IMAGES.
2184 * There is no way to search for an image actually named "all", "*", or an
2185 * integer number, or an image that has no name. However, you can use
2186 * wimlib_get_image_name() to get the name of any image.
2189 * If the string resolved to a single existing image, the number of that
2190 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2191 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2192 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2193 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2194 * images in @a wim has no name.
2197 wimlib_resolve_image(WIMStruct *wim,
2198 const wimlib_tchar *image_name_or_num);
2201 * Sets which image in the WIM is marked as bootable.
2204 * Pointer to the ::WIMStruct for a WIM file.
2206 * The number of the image to mark as bootable, or 0 to mark no image as
2208 * @return 0 on success; nonzero on error.
2209 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2210 * @a boot_idx does not specify an existing image in @a wim, and it was not
2212 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2213 * @a wim is part of a split WIM. We do not support changing the boot
2214 * index of a split WIM.
2217 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2220 * Changes the description of an image in the WIM.
2223 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2224 * standalone WIM or part of a split WIM; however, you should set the same
2225 * description on all parts of a split WIM.
2227 * The number of the image for which to change the description.
2228 * @param description
2229 * The new description to give the image. It may be @c NULL, which
2230 * indicates that the image is to be given no description.
2232 * @return 0 on success; nonzero on error.
2233 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2234 * @a image does not specify a single existing image in @a wim.
2235 * @retval ::WIMLIB_ERR_NOMEM
2236 * Failed to allocate the memory needed to duplicate the @a description
2240 wimlib_set_image_descripton(WIMStruct *wim, int image,
2241 const wimlib_tchar *description);
2244 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2245 * (something like "Core" or "Ultimate")
2248 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2249 * standalone WIM or part of a split WIM; however, you should set the same
2250 * \<FLAGS\> element on all parts of a split WIM.
2252 * The number of the image for which to change the description.
2254 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2255 * indicates that the image is to be given no \<FLAGS\> element.
2257 * @return 0 on success; nonzero on error.
2258 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2259 * @a image does not specify a single existing image in @a wim.
2260 * @retval ::WIMLIB_ERR_NOMEM
2261 * Failed to allocate the memory needed to duplicate the @a flags string.
2263 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2264 const wimlib_tchar *flags);
2267 * Changes the name of an image in the WIM.
2270 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2271 * standalone WIM or part of a split WIM; however, you should set the same
2272 * name on all parts of a split WIM.
2274 * The number of the image for which to change the name.
2276 * The new name to give the image. It must be a nonempty string.
2278 * @return 0 on success; nonzero on error.
2279 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2280 * There is already an image named @a name in @a wim.
2281 * @retval ::WIMLIB_ERR_INVALID_PARAM
2282 * @a name was @c NULL or the empty string.
2283 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2284 * @a image does not specify a single existing image in @a wim.
2285 * @retval ::WIMLIB_ERR_NOMEM
2286 * Failed to allocate the memory needed to duplicate the @a name string.
2288 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2289 const wimlib_tchar *name);
2292 * Set the functions that wimlib uses to allocate and free memory.
2294 * These settings are global and not per-WIM.
2296 * The default is to use the default @c malloc() and @c free() from the C
2299 * Please note that some external functions, such as those in @c libntfs-3g, may
2300 * use the standard memory allocation functions.
2302 * @param malloc_func
2303 * A function equivalent to @c malloc() that wimlib will use to allocate
2304 * memory. If @c NULL, the allocator function is set back to the default
2305 * @c malloc() from the C library.
2307 * A function equivalent to @c free() that wimlib will use to free memory.
2308 * If @c NULL, the free function is set back to the default @c free() from
2310 * @param realloc_func
2311 * A function equivalent to @c realloc() that wimlib will use to reallocate
2312 * memory. If @c NULL, the free function is set back to the default @c
2313 * realloc() from the C library.
2314 * @return 0 on success; nonzero on error.
2315 * @retval ::WIMLIB_ERR_UNSUPPORTED
2316 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2317 * so custom memory allocators are unsupported.
2320 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2321 void (*free_func)(void *),
2322 void *(*realloc_func)(void *, size_t));
2325 * Sets whether wimlib is to print error messages to @c stderr when a function
2326 * fails. These error messages may provide information that cannot be
2327 * determined only from the error code that is returned. Not every error will
2328 * result in an error message being printed.
2330 * This setting is global and not per-WIM.
2332 * By default, error messages are not printed.
2334 * @param show_messages
2335 * @c true if error messages are to be printed; @c false if error messages
2336 * are not to be printed.
2338 * @return 0 on success; nonzero on error.
2339 * @retval ::WIMLIB_ERR_UNSUPPORTED
2340 * @a show_messages was @c true, but wimlib was compiled with the @c
2341 * --without-error-messages option. Therefore, error messages cannot be
2345 wimlib_set_print_errors(bool show_messages);
2348 * Splits a WIM into multiple parts.
2351 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2354 * Name of the SWM file to create. This will be the name of the first
2355 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2356 * appended before the suffix.
2358 * The maximum size per part, in bytes. It is not guaranteed that this
2359 * will really be the maximum size per part, because some file resources in
2360 * the WIM may be larger than this size, and the WIM file format provides
2361 * no way to split up file resources among multiple WIMs.
2362 * @param write_flags
2363 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2364 * included in the split WIM parts.
2365 * @param progress_func
2366 * If non-NULL, a function that will be called periodically with the
2367 * progress of the current operation.
2369 * @return 0 on success; nonzero on error. This function may return any value
2370 * returned by wimlib_write() as well as the following error codes:
2372 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2373 * @a wim is not part 1 of a stand-alone WIM.
2374 * @retval ::WIMLIB_ERR_INVALID_PARAM
2375 * @a swm_name was @c NULL, or @a part_size was 0.
2377 * Note: the WIM's uncompressed and compressed resources are not checksummed
2378 * when they are copied from the joined WIM to the split WIM parts, nor are
2379 * compressed resources re-compressed.
2382 wimlib_split(WIMStruct *wim,
2383 const wimlib_tchar *swm_name,
2386 wimlib_progress_func_t progress_func);
2389 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2391 * The image to unmount is specified by the path to the mountpoint, not the
2392 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2393 * touched and also may have been allocated in a different process.
2395 * To unmount the image, the thread calling this function communicates with the
2396 * thread that is managing the mounted WIM image. This function blocks until it
2397 * is known whether the unmount succeeded or failed. In the case of a
2398 * read-write mounted WIM, the unmount is not considered to have succeeded until
2399 * all changes have been saved to the underlying WIM file.
2402 * The directory that the WIM image was mounted on.
2403 * @param unmount_flags
2404 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2405 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2406 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2408 * @param progress_func
2409 * If non-NULL, a function that will be called periodically with the
2410 * progress of the current operation.
2412 * @return 0 on success; nonzero on error.
2414 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2415 * The filesystem daemon was unable to remove the staging directory and the
2416 * temporary files that it contains.
2417 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2418 * The filesystem daemon appears to have terminated before sending an exit
2420 * @retval ::WIMLIB_ERR_FORK
2421 * Could not @c fork() the process.
2422 * @retval ::WIMLIB_ERR_FUSERMOUNT
2423 * The @b fusermount program could not be executed or exited with a failure
2425 * @retval ::WIMLIB_ERR_MQUEUE
2426 * Could not open a POSIX message queue to communicate with the filesystem
2427 * daemon servicing the mounted filesystem, could not send a message
2428 * through the queue, or could not receive a message through the queue.
2429 * @retval ::WIMLIB_ERR_NOMEM
2430 * Failed to allocate needed memory.
2431 * @retval ::WIMLIB_ERR_OPEN
2432 * The filesystem daemon could not open a temporary file for writing the
2434 * @retval ::WIMLIB_ERR_READ
2435 * A read error occurred when the filesystem daemon tried to a file from
2436 * the staging directory
2437 * @retval ::WIMLIB_ERR_RENAME
2438 * The filesystem daemon failed to rename the newly written WIM file to the
2439 * original WIM file.
2440 * @retval ::WIMLIB_ERR_UNSUPPORTED
2441 * Mounting is not supported, either because the platform is Windows, or
2442 * because the platform is UNIX and wimlib was compiled with @c
2444 * @retval ::WIMLIB_ERR_WRITE
2445 * A write error occurred when the filesystem daemon was writing to the new
2446 * WIM file, or the filesystem daemon was unable to flush changes that had
2447 * been made to files in the staging directory.
2450 wimlib_unmount_image(const wimlib_tchar *dir,
2452 wimlib_progress_func_t progress_func);
2455 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2458 * Pointer to the ::WIMStruct for the WIM file to update.
2460 * The 1-based index of the image in the WIM to update. It cannot be
2461 * ::WIMLIB_ALL_IMAGES.
2463 * An array of ::wimlib_update_command's that specify the update operations
2466 * Number of commands in @a cmds.
2467 * @param update_flags
2468 * Reserved; must be 0.
2469 * @param progress_func
2470 * If non-NULL, a function that will be called periodically with the
2471 * progress of the current operation.
2473 * @return 0 on success; nonzero on error. On failure, some but not all of the
2474 * update commands may have been executed. No individual update command will
2475 * have been partially executed. Possible error codes include:
2477 * @retval ::WIMLIB_ERR_DECOMPRESSION
2478 * Failed to decompress the metadata resource from @a image in @a wim.
2479 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2480 * The capture configuration structure specified for an add command was
2482 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2483 * A directory entry for @a image in @a wim is invalid.
2484 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2485 * @a image did not specify a single, existing image in @a wim.
2486 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2487 * Attempted to perform an add command that conflicted with previously
2488 * existing files in the WIM when an overlay was attempted.
2489 * @retval ::WIMLIB_ERR_INVALID_PARAM
2490 * An unknown operation type was specified in the update commands; or,
2491 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2492 * in the @a add_flags, but the same image had previously already been
2493 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2494 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2495 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2496 * specified in the @a add_flags for an add command in which @a
2497 * wim_target_path was not the root directory of the WIM image.
2498 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2499 * (Windows only): While executing an add command, tried to capture a
2500 * reparse point with invalid data.
2501 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2502 * The metadata resource for @a image in @a wim is invalid.
2503 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2504 * The security data for image @a image in @a wim is invalid.
2505 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2506 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2507 * for a WIM path that corresponded to a directory; or, a rename command
2508 * attempted to rename a directory to a non-directory.
2509 * @retval ::WIMLIB_ERR_NOMEM
2510 * Failed to allocate needed memory.
2511 * @retval ::WIMLIB_ERR_NOTDIR
2512 * A rename command attempted to rename a directory to a non-directory; or,
2513 * an add command was executed that attempted to set the root of the WIM
2514 * image as a non-directory; or, a path component used as a directory in a
2515 * rename command was not, in fact, a directory.
2516 * @retval ::WIMLIB_ERR_NOTEMPTY
2517 * A rename command attempted to rename a directory to a non-empty
2519 * @retval ::WIMLIB_ERR_NTFS_3G
2520 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2521 * error occurred while reading data from the NTFS volume using libntfs-3g.
2522 * @retval ::WIMLIB_ERR_OPEN
2523 * Failed to open a file to be captured while executing an add command.
2524 * @retval ::WIMLIB_ERR_OPENDIR
2525 * Failed to open a directory to be captured while executing an add command.
2526 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2527 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2528 * WIM path that did not exist; or, a rename command attempted to rename a
2529 * file that does not exist.
2530 * @retval ::WIMLIB_ERR_READ
2531 * Failed to read the metadata resource for @a image in @a wim; or, while
2532 * executing an add command, failed to read data from a file or directory
2534 * @retval ::WIMLIB_ERR_READLINK
2535 * While executing an add command, failed to read the target of a symbolic
2536 * link or junction point.
2537 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2538 * (Windows only) Failed to perform a reparse point fixup because of
2539 * problems with the data of a reparse point.
2540 * @retval ::WIMLIB_ERR_SPECIAL_FILE
2541 * While executing an add command, attempted to capture a file that was not
2542 * a supported file type, such as a regular file, directory, symbolic link,
2543 * or (on Windows) a reparse point.
2544 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2545 * @a wim is part of a split WIM. Updating a split WIM is unsupported.
2546 * @retval ::WIMLIB_ERR_STAT
2547 * While executing an add command, failed to get attributes for a file or
2549 * @retval ::WIMLIB_ERR_UNSUPPORTED
2550 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2551 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
2552 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2553 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2554 * add_flags for an update command.
2557 wimlib_update_image(WIMStruct *wim,
2559 const struct wimlib_update_command *cmds,
2562 wimlib_progress_func_t progress_func);
2565 * Writes a standalone WIM to a file.
2567 * This brings in resources from any external locations, such as directory trees
2568 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2569 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2572 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2573 * changes made to it, which are then reflected in the output file.
2575 * The path to the file to write the WIM to.
2577 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2579 * @param write_flags
2580 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2581 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2582 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2583 * @param num_threads
2584 * Number of threads to use for compressing data. If 0, the number of
2585 * threads is taken to be the number of online processors. Note: if no
2586 * data compression needs to be done, no additional threads will be created
2587 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2588 * exporting an image from a compressed WIM to another WIM of the same
2589 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2591 * @param progress_func
2592 * If non-NULL, a function that will be called periodically with the
2593 * progress of the current operation.
2595 * @return 0 on success; nonzero on error.
2596 * @retval ::WIMLIB_ERR_DECOMPRESSION
2597 * Failed to decompress a metadata or file resource in @a wim.
2598 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2599 * A directory entry in the metadata resource for @a image in @a wim is
2601 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2602 * @a image does not specify a single existing image in @a wim, and is not
2603 * ::WIMLIB_ALL_IMAGES.
2604 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2605 * A file that had previously been scanned for inclusion in the WIM by
2606 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2607 * message digest check.
2608 * @retval ::WIMLIB_ERR_INVALID_PARAM
2609 * @a path was @c NULL.
2610 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2611 * The metadata resource for @a image in @a wim is invalid.
2612 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2613 * The security data for @a image in @a wim is invalid.
2614 * @retval ::WIMLIB_ERR_NOMEM
2615 * Failed to allocate needed memory.
2616 * @retval ::WIMLIB_ERR_OPEN
2617 * Failed to open @a path for writing, or some file resources in @a
2618 * wim refer to files in the outside filesystem, and one of these files
2619 * could not be opened for reading.
2620 * @retval ::WIMLIB_ERR_READ
2621 * An error occurred when trying to read data from the WIM file associated
2622 * with @a wim, or some file resources in @a wim refer to files in the
2623 * outside filesystem, and a read error occurred when reading one of these
2625 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2626 * @a wim is part of a split WIM. You may not call this function on a
2628 * @retval ::WIMLIB_ERR_WRITE
2629 * An error occurred when trying to write data to the new WIM file at @a
2633 wimlib_write(WIMStruct *wim,
2634 const wimlib_tchar *path,
2637 unsigned num_threads,
2638 wimlib_progress_func_t progress_func);
2641 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2642 * the data using "XPRESS" compression.
2645 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2648 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2649 * the data is compressed using "XPRESS" compression.
2652 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2653 void *uncompressed_data, unsigned uncompressed_len);
2655 #endif /* _WIMLIB_H */