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.3.1. If you
35 * have installed wimlib and want to know how to use the @b wimlib-imagex
36 * program, please see the man pages instead. Also: the actual project page
37 * where you can download the source code for the library is at <a
38 * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
40 * wimlib is a C library to read, write, and mount archive files in the Windows
41 * Imaging Format (WIM files). These files are normally created using the
42 * ImageX (@a imagex.exe) utility on Windows, but this library provides a free
43 * implementation of ImageX for UNIX-based systems (and, since v1.3.0, for
44 * Windows systems) and an API to allow other programs to read, write, and mount
45 * WIM files. wimlib is comparable to Microsoft's WIMGAPI, but was designed
46 * independently and is not a clone of it.
48 * \section format WIM files
50 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
51 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
52 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
53 * Both are based on LZ77 and Huffman encoding, and both are supported by
56 * Unlike ZIP files, WIM files can contain multiple independent toplevel
57 * directory trees known as @a images. While each image has its own metadata,
58 * files are not duplicated for each image; instead, each file is included only
59 * once in the entire WIM. Microsoft did this so that in one WIM file, they
60 * could do things like have 5 different versions of Windows that are almost
63 * Microsoft provides documentation for the WIM file format, XPRESS compression
64 * format, and LZX compression format. The XPRESS documentation is acceptable,
65 * but the LZX documentation is not entirely correct, and the WIM documentation
66 * itself is incomplete.
68 * A WIM file may be either stand-alone or split into multiple parts.
70 * \section ntfs NTFS support
72 * As of version 1.0.0, wimlib supports capturing and applying images directly
73 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
74 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
75 * data such as security descriptors, alternate data streams, and reparse point
78 * The code for NTFS image capture and image application is complete enough that
79 * it is possible to apply an image from the "install.wim" contained in recent
80 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
81 * NTFS volume, and then boot Windows from it after preparing the Boot
82 * Configuration Data. In addition, a Windows installation can be captured (or
83 * backed up) into a WIM file, and then re-applied later.
85 * wimlib v1.3.0 and later also supports NTFS capture and apply in the native
86 * Windows build, which works slightly differently and relies on native Win32
87 * API calls rather than libntfs-3g.
89 * \section winpe Windows PE
91 * A major use for this library is to create customized images of Windows PE, the
92 * Windows Preinstallation Environment, without having to rely on Windows. Windows
93 * PE is a lightweight version of Windows that can run entirely from memory and can
94 * be used to install Windows from local media or a network drive or perform
95 * maintenance. Windows PE is the operating system that runs when you boot from
96 * the Windows installation media.
98 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
99 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
100 * in the Windows Automated Installation Kit (WAIK), which is free to download
101 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
102 * install either the @c cabextract or @c p7zip programs.
104 * In addition, Windows installations and recovery partitions frequently contain a
105 * WIM containing an image of the Windows Recovery Environment, which is similar to
108 * \section starting Getting Started
110 * wimlib uses the GNU autotools, so it should be easy to install with
111 * <code>configure && make && sudo make install</code>; however, please see the
112 * README for more information about installing it. To use wimlib in a program
113 * after installing it, include @c wimlib.h and link your program with @c -lwim.
115 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
116 * may represent either a stand-alone WIM or one part of a split WIM.
118 * All functions in wimlib's public API are prefixed with @c wimlib. Most
119 * return an integer error code on failure. Use wimlib_get_error_string() to
120 * get a string that describes an error code. wimlib also can print error
121 * messages itself when an error happens, and these may be more informative than
122 * the error code; to enable this, call wimlib_set_print_errors(). Please note
123 * that this is for convenience only, and some errors can occur without a
124 * message being printed.
126 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
127 * the following exceptions:
128 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
129 * - You also must call wimlib_global_init() in the main thread to avoid any
130 * race conditions with one-time allocations of memory.
131 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
132 * concurrently in the same process, will daemonize the entire process when it
133 * does so for the first time. This includes changing the working directory
134 * to the root directory.
136 * To open an existing WIM, use wimlib_open_wim().
138 * To create a new WIM that initially contains no images, use
139 * wimlib_create_new_wim().
141 * To add an image to a WIM file from a directory tree on your filesystem, call
142 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
143 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
144 * also capture a WIM image directly from a NTFS volume if you provide the
145 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
146 * the <code>--without-ntfs-3g</code> flag.
148 * To extract an image from a WIM file, call wimlib_extract_image(). You may
149 * extract an image either to a directory or directly to a NTFS volume, the
150 * latter of which will preserve NTFS-specific data such as security
153 * wimlib supports mounting WIM files either read-only or read-write. Mounting
154 * is done using wimlib_mount_image() and unmounting is done using
155 * wimlib_unmount_image(). Mounting can be done without root privileges because
156 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
157 * compiled with the <code>--without-fuse</code> flag, these functions will be
158 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
160 * After creating or modifying a WIM file, you can write it to a file using
161 * wimlib_write(). Alternatively, if the WIM was originally read from a file
162 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
163 * wimlib_overwrite() to overwrite the original file.
165 * Please note: merely by calling wimlib_add_image() or many of the other
166 * functions in this library that operate on ::WIMStruct's, you are @b not
167 * modifying the WIM file on disk. Changes are not saved until you explicitly
168 * call wimlib_write() or wimlib_overwrite().
170 * After you are done with the WIM file, use wimlib_free() to free all memory
171 * associated with a ::WIMStruct and close all files associated with it.
173 * A number of functions take a pointer to a progress function of type
174 * ::wimlib_progress_func_t. This function will be called periodically during
175 * the WIM operation(s) to report on the progress of the operation (for example,
176 * how many bytes have been written so far).
178 * \section imagex wimlib-imagex
180 * wimlib comes with a command-line interface, the @b wimlib-imagex program. It
181 * is documented with man pages. This program was originally just called @b
182 * imagex, but has been changed to @b wimlib-imagex to avoid confusion with
183 * Microsoft's @a imagex.exe (which would otherwise have exactly the same
184 * filename on Windows).
186 * \section mkwinpeimg mkwinpeimg
188 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
191 * \section encodings Locales and character encodings
193 * wimlib 1.3.0 has improved handling of different character encodings compared
194 * to previous versions. Functions are explictly noted as taking
195 * ::wimlib_mbchar strings, which are encoded in the locale-dependent multibyte
196 * encoding (e.g. ASCII, ISO-8859-1, or UTF-8), or ::wimlib_utf8char strings,
197 * which are encoded in UTF-8. Generally, filenames and paths are in the
198 * locale-dependent multibyte encoding, while other types of data must be
199 * provided in UTF-8. Please see the man page for @b wimlib-imagex for more
200 * information. However, I strongly recommend that you use UTF-8 for your
201 * locale's encoding so that ::wimlib_mbchar strings will be encoded the same
202 * way as ::wimlib_utf8char strings.
204 * \section Limitations
206 * While wimlib supports the main features of WIM files, wimlib currently has
207 * the following limitations:
208 * - There is no way to add, remove, modify, or extract specific files in a WIM
209 * without mounting it, other than by adding, removing, or extracting an
210 * entire image. The FUSE mount feature should be used for this purpose.
211 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
212 * than wimlib when using maximum (LZX) compression because it knows how to
213 * split up LZX compressed blocks, which is not yet implemented in wimlib.
214 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
215 * imagex.exe if you want to make sure your WIM files are made "correctly".
216 * - The old WIM format from Vista pre-releases is not supported.
217 * - Compressed resource chunk sizes other than 32768 are not supported,
218 * although this doesn't seem to be a problem because the chunk size always
219 * seems to be this value.
220 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
221 * make certain Windows-specific modifications to a Windows PE image, such as
222 * adding a driver or Windows component. Such a tool could conceivably be
223 * implemented on top of wimlib, although it likely would be hard to implement
224 * because it would have to do very Windows-specific things such as
225 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
226 * script for a similar purpose, however. With regards to adding drivers to
227 * Windows PE, you have the option of putting them anywhere in the Windows PE
228 * image, then loading them after boot using @b drvload.exe.
229 * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
230 * Windows build has some limitations compared to the UNIX build.
231 * (The differences are documented better in the man pages for
232 * @b wimlib-imagex than here.)
234 * \section legal License
236 * The wimlib library, as well as the programs and scripts distributed with it
237 * (@b wimlib-imagex and @b mkwinpeimg), is licensed under the GNU General
238 * Public License version 3 or later.
247 #include <inttypes.h>
249 /** Major version of the library (for example, the 1 in 1.2.5). */
250 #define WIMLIB_MAJOR_VERSION 1
252 /** Minor version of the library (for example, the 2 in 1.2.5). */
253 #define WIMLIB_MINOR_VERSION 3
255 /** Patch version of the library (for example, the 5 in 1.2.5). */
256 #define WIMLIB_PATCH_VERSION 1
259 * Opaque structure that represents a WIM file. This is an in-memory structure
260 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
261 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
262 * continuing to exist so that data can be read from it as needed.
264 * Most functions in this library will work the same way regardless of whether a
265 * given ::WIMStruct was obtained through wimlib_open_wim() or
266 * wimlib_create_new_wim(). Exceptions are documented.
268 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
269 * file from a ::WIMStruct.
271 typedef struct WIMStruct WIMStruct;
274 typedef wchar_t wimlib_tchar;
276 typedef char wimlib_tchar;
280 * Specifies the compression type of a WIM file.
282 enum wimlib_compression_type {
283 /** An invalid compression type. */
284 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
286 /** The WIM does not include any compressed resources. */
287 WIMLIB_COMPRESSION_TYPE_NONE = 0,
289 /** Compressed resources in the WIM use LZX compression. */
290 WIMLIB_COMPRESSION_TYPE_LZX = 1,
292 /** Compressed resources in the WIM use XPRESS compression. */
293 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
296 /** Possible values of the first parameter to the user-supplied
297 * ::wimlib_progress_func_t progress function */
298 enum wimlib_progress_msg {
300 /** A WIM image is about to be extracted. @a info will point to
301 * ::wimlib_progress_info.extract. */
302 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
304 /** The directory structure of the WIM image is about to be extracted.
305 * @a info will point to ::wimlib_progress_info.extract. */
306 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
308 /** The directory structure of the WIM image has been successfully
309 * extracted. @a info will point to ::wimlib_progress_info.extract. */
310 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
312 /** The WIM image's files resources are currently being extracted. @a
313 * info will point to ::wimlib_progress_info.extract. */
314 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
316 /** A file or directory is being extracted. @a info will point to
317 * ::wimlib_progress_info.extract, and the @a cur_path member will be
319 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
321 /** All the WIM files and directories have been extracted, and
322 * timestamps are about to be applied. @a info will point to
323 * ::wimlib_progress_info.extract. */
324 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
326 /** A WIM image has been successfully extracted. @a info will point to
327 * ::wimlib_progress_info.extract. */
328 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
330 /** The directory or NTFS volume is about to be scanned to build a tree
331 * of WIM dentries in-memory. @a info will point to
332 * ::wimlib_progress_info.scan. */
333 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
335 /** A directory or file is being scanned. @a info will point to
336 * ::wimlib_progress_info.scan, and its @a cur_path member will be
337 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
338 * is passed to wimlib_add_image(). */
339 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
341 /** The directory or NTFS volume has been successfully scanned, and a
342 * tree of WIM dentries has been built in-memory. @a info will point to
343 * ::wimlib_progress_info.scan. */
344 WIMLIB_PROGRESS_MSG_SCAN_END,
347 * File resources are currently being written to the WIM.
348 * @a info will point to ::wimlib_progress_info.write_streams. */
349 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
352 * The metadata resource for each image is about to be written to the
353 * WIM. @a info will not be valid. */
354 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
357 * The metadata resource for each image has successfully been writen to
358 * the WIM. @a info will not be valid. */
359 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
362 * The temporary file has successfully been renamed to the original WIM
363 * file. Only happens when wimlib_overwrite() is called and the
364 * overwrite is not done in-place.
365 * @a info will point to ::wimlib_progress_info.rename. */
366 WIMLIB_PROGRESS_MSG_RENAME,
368 /** The contents of the WIM are being checked against the integrity
369 * table. Only happens when wimlib_open_wim() is called with the
370 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
371 * ::wimlib_progress_info.integrity. */
372 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
374 /** An integrity table is being calculated for the WIM being written.
375 * Only happens when wimlib_write() or wimlib_overwrite() is called with
376 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
377 * ::wimlib_progress_info.integrity. */
378 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
380 /** A wimlib_join() operation is in progress. @a info will point to
381 * ::wimlib_progress_info.join. */
382 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
384 /** A wimlib_split() operation is in progress, and a new split part is
385 * about to be started. @a info will point to
386 * ::wimlib_progress_info.split. */
387 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
389 /** A wimlib_split() operation is in progress, and a split part has been
390 * finished. @a info will point to ::wimlib_progress_info.split. */
391 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
394 /** A pointer to this union is passed to the user-supplied
395 * ::wimlib_progress_func_t progress function. One (or none) of the structures
396 * contained in this union will be applicable for the operation
397 * (::wimlib_progress_msg) indicated in the first argument to the progress
399 union wimlib_progress_info {
401 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
402 * document them if they aren't given a name... */
404 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
405 struct wimlib_progress_info_write_streams {
406 /** Number of bytes that are going to be written for all the
407 * streams combined. This is the amount in uncompressed data.
408 * (The actual number of bytes will be less if the data is being
409 * written compressed.) */
410 uint64_t total_bytes;
411 /** Number of streams that are going to be written. */
412 uint64_t total_streams;
414 /** Number of uncompressed bytes that have been written so far.
415 * Will be 0 initially, and equal to @a total_bytes at the end.
417 uint64_t completed_bytes;
419 /** Number of streams that have been written. Will be 0
420 * initially, and equal to @a total_streams at the end. */
421 uint64_t completed_streams;
423 /** Number of threads that are being used to compress resources
424 * (if applicable). */
425 unsigned num_threads;
427 /** The compression type being used to write the streams; either
428 * ::WIMLIB_COMPRESSION_TYPE_NONE,
429 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
430 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
431 int compression_type;
434 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
435 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
436 struct wimlib_progress_info_scan {
437 /** Directory or NTFS volume that is being scanned. */
438 const wimlib_tchar *source;
440 /** Path to the file or directory that is about to be scanned,
441 * relative to the root of the image capture or the NTFS volume.
443 const wimlib_tchar *cur_path;
445 /** True iff @a cur_path is being excluded from the image
446 * capture due to the capture configuration file. */
449 /** Target path in the WIM. Only valid on messages
450 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
451 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
452 const wimlib_tchar *wim_target_path;
455 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
456 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
457 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
458 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
459 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
460 struct wimlib_progress_info_extract {
461 /** Number of the image being extracted (1-based). */
464 /** Flags passed to to wimlib_extract_image() */
467 /** Full path to the WIM file being extracted. */
468 const wimlib_tchar *wimfile_name;
470 /** Name of the image being extracted. */
471 const wimlib_tchar *image_name;
473 /** Directory or NTFS volume to which the image is being
475 const wimlib_tchar *target;
477 /** Current dentry being extracted. (Valid only if message is
478 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
479 const wimlib_tchar *cur_path;
481 /** Number of bytes of uncompressed data that will be extracted.
482 * Takes into account hard links (they are not counted for each
485 uint64_t total_bytes;
487 /** Number of bytes that have been written so far. Will be 0
488 * initially, and equal to @a total_bytes at the end. */
489 uint64_t completed_bytes;
491 /** Number of streams that will be extracted. This may more or
492 * less than the number of "files" to be extracted due to
493 * special cases (hard links, symbolic links, and alternate data
495 uint64_t num_streams;
498 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
499 struct wimlib_progress_info_rename {
500 /** Name of the temporary file that the WIM was written to. */
501 const wimlib_tchar *from;
503 /** Name of the original WIM file to which the temporary file is
505 const wimlib_tchar *to;
508 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
509 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
510 struct wimlib_progress_info_integrity {
511 /** Number of bytes from the end of the WIM header to the end of
512 * the lookup table (the area that is covered by the SHA1
513 * integrity checks.) */
514 uint64_t total_bytes;
516 /** Number of bytes that have been SHA1-summed so far. Will be
517 * 0 initially, and equal @a total_bytes at the end. */
518 uint64_t completed_bytes;
520 /** Number of chunks that the checksummed region is divided
522 uint32_t total_chunks;
524 /** Number of chunks that have been SHA1-summed so far. Will
525 * be 0 initially, and equal to @a total_chunks at the end. */
526 uint32_t completed_chunks;
528 /** Size of the chunks used for the integrity calculation. */
531 /** Filename of the WIM (only valid if the message is
532 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
533 const wimlib_tchar *filename;
536 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
537 struct wimlib_progress_info_join {
538 /** Total number of bytes of compressed data contained in all
539 * the split WIM part's file and metadata resources. */
540 uint64_t total_bytes;
542 /** Number of bytes that have been copied to the joined WIM so
543 * far. Will be 0 initially, and equal to @a total_bytes at the
545 uint64_t completed_bytes;
547 /** Number of split WIM parts that have had all their file and
548 * metadata resources copied over to the joined WIM so far. */
549 unsigned completed_parts;
551 /** Number of split WIM parts. */
552 unsigned total_parts;
555 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
556 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
557 struct wimlib_progress_info_split {
558 /** Total size of the original WIM's file and metadata resources
560 uint64_t total_bytes;
562 /** Number of bytes of file and metadata resources that have
563 * been copied out of the original WIM so far. Will be 0
564 * initially, and equal to @a total_bytes at the end. */
565 uint64_t completed_bytes;
567 /** Number of the split WIM part that is about to be started
568 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
569 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
570 unsigned cur_part_number;
572 /** Name of the split WIM part that is about to be started
573 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
574 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
575 const wimlib_tchar *part_name;
579 /** A user-supplied function that will be called periodically during certain WIM
580 * operations. The first argument will be the type of operation that is being
581 * performed or is about to be started or has been completed. The second
582 * argument will be a pointer to one of a number of structures depending on the
583 * first argument. It may be @c NULL for some message types.
585 * The return value of the progress function is currently ignored, but it may do
586 * something in the future. (Set it to 0 for now.)
588 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
589 const union wimlib_progress_info *info);
591 /** An array of these structures is passed to wimlib_add_image_multisource() to
592 * specify the sources from which to create a WIM image. */
593 struct wimlib_capture_source {
594 /** Absolute or relative path to a file or directory on the external
595 * filesystem to be included in the WIM image. */
596 wimlib_tchar *fs_source_path;
598 /** Destination path in the WIM image. Leading and trailing slashes are
599 * ignored. The empty string or @c NULL means the root directory of the
601 wimlib_tchar *wim_target_path;
603 /** Reserved; set to 0. */
608 /*****************************
609 * WIMLIB_ADD_IMAGE_FLAG_* *
610 *****************************/
612 /** Directly capture a NTFS volume rather than a generic directory. This flag
613 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
614 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
615 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
617 /** Follow symlinks; archive and dump the files they point to. Cannot be used
618 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
619 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
621 /** Call the progress function with the message
622 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
624 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
626 /** Mark the image being added as the bootable image of the WIM. */
627 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
629 /** Store the UNIX owner, group, and mode. This is done by adding a special
630 * alternate data stream to each regular file, symbolic link, and directory to
631 * contain this information. Please note that this flag is for convenience
632 * only; Microsoft's @a imagex.exe will not understand this special information.
633 * This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
634 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
636 /** Do not capture security descriptors. Only has an effect in NTFS capture
637 * mode, or in Win32 native builds. */
638 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020
640 /******************************
641 * WIMLIB_EXPORT_FLAG_* *
642 ******************************/
644 /** See documentation for wimlib_export_image(). */
645 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
647 /******************************
648 * WIMLIB_EXTRACT_FLAG_* *
649 ******************************/
651 /** Extract the image directly to a NTFS volume rather than a generic directory.
653 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
655 /** When identical files are extracted from the WIM, always hard link them
656 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
657 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
659 /** When identical files are extracted from the WIM, always symlink them
660 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
661 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
663 /** Call the progress function with the argument
664 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
665 * extracted. Note: these calls will be interspersed with calls for the message
666 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
667 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
669 /** Read the WIM file sequentially while extracting the image. */
670 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
672 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
673 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
674 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
676 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
677 * or in Win32 native builds. */
678 #define WIMLIB_EXTRACT_FLAG_NOACLS 0x00000040
680 /******************************
681 * WIMLIB_MOUNT_FLAG_* *
682 ******************************/
684 /** Mount the WIM image read-write rather than the default of read-only. */
685 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
687 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
688 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
690 /** Do not allow accessing alternate data streams in the mounted WIM image. */
691 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
693 /** Access alternate data streams in the mounted WIM image through extended file
694 * attributes. This is the default mode. */
695 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
697 /** Access alternate data streams in the mounted WIM image by specifying the
698 * file name, a colon, then the alternate file stream name. */
699 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
701 /** Use UNIX file owners, groups, and modes if available in the WIM (see
702 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
703 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
705 /** Allow other users to see the mounted filesystem. (this passes the @c
706 * allow_other option to FUSE mount) */
707 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
709 /******************************
710 * WIMLIB_OPEN_FLAG_* *
711 ******************************/
713 /** Verify the WIM contents against the WIM's integrity table, if present. */
714 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
716 /** Do not issue an error if the WIM is part of a split WIM. */
717 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
719 /******************************
720 * WIMLIB_UNMOUNT_FLAG_* *
721 ******************************/
723 /** Include an integrity table in the WIM after it's been unmounted. Ignored
724 * for read-only mounts. */
725 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
727 /** Unless this flag is given, changes to a read-write mounted WIM are
728 * discarded. Ignored for read-only mounts. */
729 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
731 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
732 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
734 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
735 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
737 /******************************
738 * WIMLIB_WRITE_FLAG_* *
739 ******************************/
741 /** Include an integrity table in the new WIM file. */
742 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
744 /** Re-build the entire WIM file rather than appending data to it, if possible.
745 * (Applies to wimlib_overwrite(), not wimlib_write()). */
746 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
748 /** Recompress all resources, even if they could otherwise be copied from a
749 * different WIM with the same compression type (in the case of
750 * wimlib_export_image() being called previously). */
751 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
753 /** Call fsync() when the WIM file is closed */
754 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
756 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
757 * after one or more calls to wimlib_delete_image(), which is to rebuild the
760 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
761 * correctly remove the image from the WIM will be taken. In particular, all
762 * streams will be left alone, even if they are no longer referenced. This is
763 * probably not what you want, because almost no space will be spaced by
764 * deleting an image in this way. */
765 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
769 /****************************************************************
770 * Definition of struct wimlib_modify_command, with various flags
771 ****************************************************************/
774 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_ALL = 0x1,
775 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_NONDIRECTORIES = 0x2,
776 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_EMPTY_DIRECTORIES = 0x4,
777 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_DIRECTORIES = 0x8,
781 WIMLIB_DELETE_TREE_FLAG_FORCE = 0x1,
782 WIMLIB_DELETE_TREE_FLAG_RECURSIVE = 0x2,
783 WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR = 0x4,
787 WIMLIB_ADD_TREE_FLAG_DEREFERENCE = 0x1,
788 WIMLIB_ADD_TREE_FLAG_VERBOSE = 0x2,
789 WIMLIB_ADD_TREE_FLAG_UNIX_DATA = 0x4,
790 WIMLIB_ADD_TREE_FLAG_NOACLS = 0x8,
791 WIMLIB_ADD_TREE_FLAG_NTFS_VOLUME = 0x01,
792 WIMLIB_ADD_TREE_FLAG_OVERLAY = 0x02,
793 WIMLIB_ADD_TREE_FLAG_MAKE_NECESSARY_DIRS = 0x04,
796 enum wimlib_modify_op {
797 WIMLIB_MODIFY_OP_DELETE_TREE,
798 WIMLIB_MODIFY_OP_ADD_TREE,
799 WIMLIB_MODIFY_OP_MOVE_TREE,
802 struct wimlib_modify_command {
803 enum wimlib_modify_op op;
805 struct wimlib_modify_command_delete_tree {
806 int delete_tree_flags;
807 const wimlib_tchar *tree_wim_path;
808 unsigned long reserved;
811 struct wimlib_modify_command_add_tree {
813 const wimlib_tchar *fs_source_path;
814 const wimlib_tchar *wim_target_path;
815 unsigned long reserved;
818 struct wimlib_modify_command_move_tree {
820 const wimlib_tchar *wim_source_path;
821 const wimlib_tchar *wim_target_path;
822 unsigned long reserved;
830 * Possible values of the error code returned by many functions in wimlib.
832 * See the documentation for each wimlib function to see specifically what error
833 * codes can be returned by a given function, and what they mean.
835 /* Note: these are currently in alphabetic order, but new error codes should be
836 * added at the end to maintain a compatible ABI, except when it's being broken
838 enum wimlib_error_code {
839 WIMLIB_ERR_SUCCESS = 0,
840 WIMLIB_ERR_ALREADY_LOCKED,
841 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
842 WIMLIB_ERR_DECOMPRESSION,
843 WIMLIB_ERR_DELETE_STAGING_DIR,
844 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
847 WIMLIB_ERR_FUSERMOUNT,
848 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
849 WIMLIB_ERR_IMAGE_COUNT,
850 WIMLIB_ERR_IMAGE_NAME_COLLISION,
851 WIMLIB_ERR_INTEGRITY,
852 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
853 WIMLIB_ERR_INVALID_CHUNK_SIZE,
854 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
855 WIMLIB_ERR_INVALID_DENTRY,
856 WIMLIB_ERR_INVALID_HEADER_SIZE,
857 WIMLIB_ERR_INVALID_IMAGE,
858 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
859 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
860 WIMLIB_ERR_INVALID_PARAM,
861 WIMLIB_ERR_INVALID_PART_NUMBER,
862 WIMLIB_ERR_INVALID_RESOURCE_HASH,
863 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
864 WIMLIB_ERR_INVALID_SECURITY_DATA,
865 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
866 WIMLIB_ERR_INVALID_UTF8_STRING,
867 WIMLIB_ERR_INVALID_UTF16_STRING,
868 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
874 WIMLIB_ERR_NOT_A_WIM_FILE,
875 WIMLIB_ERR_NO_FILENAME,
883 WIMLIB_ERR_RESOURCE_ORDER,
884 WIMLIB_ERR_SPECIAL_FILE,
885 WIMLIB_ERR_SPLIT_INVALID,
886 WIMLIB_ERR_SPLIT_UNSUPPORTED,
889 WIMLIB_ERR_UNKNOWN_VERSION,
890 WIMLIB_ERR_UNSUPPORTED,
893 WIMLIB_ERR_INVALID_OVERLAY,
894 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
895 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
899 /** Used to indicate that no WIM image or an invalid WIM image. */
900 #define WIMLIB_NO_IMAGE 0
902 /** Used to specify all images in the WIM. */
903 #define WIMLIB_ALL_IMAGES (-1)
906 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
908 * The directory tree of NTFS volume is read immediately for the purpose of
909 * constructing a directory entry tree in-memory. Also, all files are read to
910 * calculate their SHA1 message digests. However, because the directory tree
911 * may contain a very large amount of data, the files themselves are not read
912 * into memory permanently, and instead references to their paths saved. The
913 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
916 * See the manual page for the @b wimlib-imagex program for more information
917 * about the "normal" capture mode versus the NTFS capture mode (entered by
918 * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
920 * Note that @b no changes are committed to the underlying WIM file (if
921 * any) until wimlib_write() or wimlib_overwrite() is called.
924 * Pointer to the ::WIMStruct for a WIM file to which the image will be
927 * A path to a directory or unmounted NTFS volume that will be captured as
930 * The name to give the image. This must be non-@c NULL.
932 * Pointer to the contents of an image capture configuration file. If @c
933 * NULL, a default string is used. Please see the manual page for
934 * <b>wimlib-imagex capture</b> for more information.
936 * Length of the string @a config in bytes, not including an optional
937 * null-terminator. Ignored if @a config is @c NULL.
938 * @param add_image_flags
939 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
940 * @param progress_func
941 * If non-NULL, a function that will be called periodically with the
942 * progress of the current operation.
944 * @return 0 on success; nonzero on error. On error, changes to @a wim are
945 * discarded so that it appears to be in the same state as when this function
948 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
949 * There is already an image named @a name in @a wim.
950 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
951 * @a config was not @c NULL and did not specify a valid image capture
953 * @retval ::WIMLIB_ERR_INVALID_PARAM
954 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
955 * @retval ::WIMLIB_ERR_NOMEM
956 * Failed to allocate needed memory.
957 * @retval ::WIMLIB_ERR_NOTDIR
958 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
959 * not specified in @a add_image_flags).
960 * @retval ::WIMLIB_ERR_NTFS_3G
961 * An error was returned from a libntfs-3g function when the NTFS volume
962 * was being opened, scanned, or closed (only if
963 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
964 * @retval ::WIMLIB_ERR_OPEN
965 * Failed to open a file or directory in the directory tree rooted at @a
966 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
968 * @retval ::WIMLIB_ERR_READ
969 * Failed to read a file in the directory tree rooted at @a source (only if
970 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
971 * @retval ::WIMLIB_ERR_SPECIAL_FILE
972 * The directory tree rooted at @a source contains a special file that is
973 * not a directory, regular file, or symbolic link. This currently can
974 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
975 * add_image_flags, but it may be returned for unsupported NTFS files in
977 * @retval ::WIMLIB_ERR_STAT
978 * Failed obtain the metadata for a file or directory in the directory tree
979 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
980 * specified in @a add_image_flags).
981 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
982 * @a wim is part of a split WIM. Adding an image to a split WIM is
984 * @retval ::WIMLIB_ERR_UNSUPPORTED
985 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
986 * wimlib was configured with the @c --without-ntfs-3g flag.
989 wimlib_add_image(WIMStruct *wim,
990 const wimlib_tchar *source,
991 const wimlib_tchar *name,
992 const wimlib_tchar *config,
995 wimlib_progress_func_t progress_func);
997 /** This function is equivalent to wimlib_add_image() except it allows for
998 * multiple sources to be combined into a single WIM image. This is done by
999 * specifying the @a sources and @a num_sources parameters instead of the @a
1000 * source parameter of wimlib_add_image(). The rest of the parameters are the
1001 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1002 * capture</b> for full details on how this mode works.
1004 * Additional note: @a sources is not a @c const parameter and you cannot
1005 * assume that its contents are valid after this function returns. You must
1006 * save pointers to the strings in these structures if you need to free them
1007 * later, and/or save copies if needed.
1009 * In addition to the error codes that wimlib_add_image() can return,
1010 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1011 * when trying to overlay a non-directory on a directory or when otherwise
1012 * trying to overlay multiple conflicting files to the same location in the WIM
1013 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1014 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
1015 * was not exactly one capture source with the target being the root directory.
1016 * (In this respect, there is no advantage to using
1017 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1020 wimlib_add_image_multisource(WIMStruct *w,
1021 struct wimlib_capture_source *sources,
1023 const wimlib_tchar *name,
1024 const wimlib_tchar *config_str,
1026 int add_image_flags,
1027 wimlib_progress_func_t progress_func);
1030 * Creates a ::WIMStruct for a new WIM file.
1032 * This only creates an in-memory structure for a WIM that initially contains no
1033 * images. No on-disk file is created until wimlib_write() is called.
1036 * The type of compression to be used in the new WIM file. Must be
1037 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1038 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1040 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1041 * written to the memory location pointed to by this paramater. The
1042 * ::WIMStruct must be freed using using wimlib_free() when finished with
1044 * @return 0 on success; nonzero on error.
1045 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1046 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1047 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1048 * @retval ::WIMLIB_ERR_NOMEM
1049 * Failed to allocate needed memory.
1052 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1055 * Deletes an image, or all images, from a WIM file.
1057 * All streams referenced by the image(s) being deleted are removed from the
1058 * lookup table of the WIM if they are not referenced by any other images in the
1061 * Please note that @b no changes are committed to the underlying WIM file (if
1062 * any) until wimlib_write() or wimlib_overwrite() is called.
1065 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1068 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1070 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1071 * to be left unmodified only if @a image specified a single image. If instead
1072 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1073 * possible for some but not all of the images to have been deleted when a
1074 * failure status is returned.
1076 * @retval ::WIMLIB_ERR_DECOMPRESSION
1077 * Could not decompress the metadata resource for @a image.
1078 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1079 * A directory entry in the metadata resource for @a image in the WIM is
1081 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1082 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1083 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1084 * The metadata resource for @a image in the WIM is invalid.
1085 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1086 * The security data for @a image in the WIM is invalid.
1087 * @retval ::WIMLIB_ERR_NOMEM
1088 * Failed to allocate needed memory.
1089 * @retval ::WIMLIB_ERR_READ
1090 * Could not read the metadata resource for @a image from the WIM.
1091 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1092 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1096 wimlib_delete_image(WIMStruct *wim, int image);
1099 * Exports an image, or all the images, from a WIM file, into another WIM file.
1101 * The destination image is made to share the same dentry tree and security data
1102 * structure as the source image. This places some restrictions on additional
1103 * functions that may be called. wimlib_mount_image() may not be called on
1104 * either the source image or the destination image without an intervening call
1105 * to a function that un-shares the images, such as wimlib_free() on @a
1106 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1107 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1108 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1109 * have references back to @a src_wim.
1111 * Previous versions of this function left @a dest_wim in an indeterminate state
1112 * on failure. This is no longer the case; all changes to @a dest_wim made by
1113 * this function are rolled back on failure.
1115 * Previous versions of this function did not allow exporting an image that had
1116 * been added by wimlib_add_image(). This is no longer the case; you may now
1117 * export an image regardless of how it was added.
1119 * Regardless of whether this function succeeds or fails, no changes are made to
1122 * Please note that no changes are committed to the underlying WIM file of @a
1123 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1126 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1127 * WIM that contains the image(s) being exported.
1129 * The image to export from @a src_wim. Can be the number of an image, or
1130 * ::WIMLIB_ALL_IMAGES to export all images.
1132 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1135 * The name to give the exported image in the new WIM file. If left @c
1136 * NULL, the name from @a src_wim is used. This parameter must be left @c
1137 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1138 * than one image; in that case, the names are all taken from the @a
1139 * src_wim. (This is allowed even if one or more images being exported has
1141 * @param dest_description
1142 * The description to give the exported image in the new WIM file. If left
1143 * @c NULL, the description from the @a src_wim is used. This parameter must
1144 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1145 * more than one image; in that case, the descriptions are all taken from
1146 * @a src_wim. (This is allowed even if one or more images being exported
1147 * has no description.)
1148 * @param export_flags
1149 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1150 * bootable, or 0 if which image is marked as bootable in the destination
1151 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1152 * there are multiple images in @a src_wim, specifying
1153 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1154 * currently marked as bootable in @a src_wim; if that is the case, then
1155 * that image is marked as bootable in the destination WIM.
1156 * @param additional_swms
1157 * Array of pointers to the ::WIMStruct for each additional part in the
1158 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1159 * need to be in any particular order, but they must include all parts of
1160 * the split WIM other than the first part, which must be provided in the
1162 * @param num_additional_swms
1163 * Number of additional WIM parts provided in the @a additional_swms array.
1164 * This number should be one less than the total number of parts in the
1165 * split WIM. Set to 0 if the WIM is a standalone WIM.
1166 * @param progress_func
1167 * If non-NULL, a function that will be called periodically with the
1168 * progress of the current operation.
1170 * @return 0 on success; nonzero on error.
1171 * @retval ::WIMLIB_ERR_DECOMPRESSION
1172 * Could not decompress the metadata resource for @a src_image
1174 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1175 * One or more of the names being given to an exported image was already in
1176 * use in the destination WIM.
1177 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1178 * A directory entry in the metadata resource for @a src_image in @a
1179 * src_wim is invalid.
1180 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1181 * @a src_image does not exist in @a src_wim.
1182 * @retval ::WIMLIB_ERR_INVALID_PARAM
1183 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1184 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1185 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1186 * dest_description were non-<code>NULL</code>, @a src_image was
1187 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1188 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1189 * The metadata resource for @a src_image in @a src_wim is invalid.
1190 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1191 * The security data for @a src_image in @a src_wim is invalid.
1192 * @retval ::WIMLIB_ERR_NOMEM
1193 * Failed to allocate needed memory.
1194 * @retval ::WIMLIB_ERR_READ
1195 * Could not read the metadata resource for @a src_image from @a src_wim.
1196 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1197 * The source WIM is a split WIM, but the parts specified do not form a
1198 * complete split WIM because they do not include all the parts of the
1199 * original WIM, there are duplicate parts, or not all the parts have the
1200 * same GUID and compression type.
1201 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1202 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1206 wimlib_export_image(WIMStruct *src_wim, int src_image,
1207 WIMStruct *dest_wim,
1208 const wimlib_tchar *dest_name,
1209 const wimlib_tchar *dest_description,
1211 WIMStruct **additional_swms,
1212 unsigned num_additional_swms,
1213 wimlib_progress_func_t progress_func);
1216 * Extracts an image, or all images, from a standalone or split WIM file to a
1217 * directory or a NTFS volume.
1219 * Please see the manual page for the @c wimlib-imagex program for more
1220 * information about the "normal" extraction mode versus the NTFS extraction
1221 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1223 * Extraction is done with one thread.
1225 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1226 * returned if any resulting SHA1 message digests do not match the values
1227 * provided in the WIM file. Therefore, if this function is successful, you can
1228 * be fairly sure that any compressed data in the WIM was uncompressed
1232 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1235 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1236 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1237 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1239 * Directory to extract the WIM image(s) to (created if it does not already
1240 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1241 * path to the unmounted NTFS volume to extract the image to.
1242 * @param extract_flags
1243 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1245 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1246 * a NTFS volume to extract the image to. The volume will be opened using
1247 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1248 * Otherwise, @a target is interpreted as a directory to extract the
1251 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1252 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1253 * specified. These flags cause extracted files that are identical to be
1254 * hardlinked or symlinked together, depending on the flag. These flags
1255 * override the hard link groups that are specified in the WIM file itself.
1256 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1257 * hardlinked or symlinked across images if a file is found to occur in
1258 * more than one image.
1260 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1261 * name of each file or directory as it is extracted.
1263 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1264 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1265 * each image is considered separately with regards to the sequential
1266 * order. It is also possible for alternate data streams to break the
1267 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1269 * @param additional_swms
1270 * Array of pointers to the ::WIMStruct for each additional part in the
1271 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1272 * need to be in any particular order, but they must include all parts of
1273 * the split WIM other than the first part, which must be provided in the
1275 * @param num_additional_swms
1276 * Number of additional WIM parts provided in the @a additional_swms array.
1277 * This number should be one less than the total number of parts in the
1278 * split WIM. Set to 0 if the WIM is a standalone WIM.
1280 * @param progress_func
1281 * If non-NULL, a function that will be called periodically with the
1282 * progress of the current operation.
1284 * @return 0 on success; nonzero on error.
1285 * @retval ::WIMLIB_ERR_DECOMPRESSION
1286 * Could not decompress a resource (file or metadata) for @a image in @a
1288 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1289 * A directory entry in the metadata resource for @a image in @a wim is
1291 * @retval ::WIMLIB_ERR_INVALID_PARAM
1292 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1293 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1294 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1295 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1296 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1297 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1298 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1299 * specified in @a extract_flag.
1300 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1301 * The SHA1 message digest of an extracted stream did not match the SHA1
1302 * message digest given in the WIM file.
1303 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1304 * A resource (file or metadata) for @a image in @a wim is invalid.
1305 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1306 * The security data for @a image in @a wim is invalid.
1307 * @retval ::WIMLIB_ERR_LINK
1308 * Failed to create a symbolic link or a hard link (only if
1309 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1310 * @retval ::WIMLIB_ERR_MKDIR
1311 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1312 * not specified in @a extract_flags).
1313 * @retval ::WIMLIB_ERR_NOMEM
1314 * Failed to allocate needed memory.
1315 * @retval ::WIMLIB_ERR_NTFS_3G
1316 * An error was returned from a libntfs-3g function while the WIM image was
1317 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1318 * was specified in @a extract_flags).
1319 * @retval ::WIMLIB_ERR_OPEN
1320 * Could not open one of the files being extracted for writing (only if
1321 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1322 * @retval ::WIMLIB_ERR_READ
1323 * A unexpected end-of-file or read error occurred when trying to read data
1324 * from the WIM file associated with @a wim.
1325 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1326 * The WIM is a split WIM, but the parts specified do not form a complete
1327 * split WIM because they do not include all the parts of the original WIM,
1328 * there are duplicate parts, or not all the parts have the same GUID and
1330 * @retval ::WIMLIB_ERR_UNSUPPORTED
1331 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1332 * was configured with the @c --without-ntfs-3g flag.
1333 * @retval ::WIMLIB_ERR_WRITE
1334 * Failed to write a file being extracted (only if
1335 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1338 wimlib_extract_image(WIMStruct *wim, int image,
1339 const wimlib_tchar *target,
1341 WIMStruct **additional_swms,
1342 unsigned num_additional_swms,
1343 wimlib_progress_func_t progress_func);
1346 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1347 * includes a string of XML that describes the images contained in the WIM.
1348 * This function works on standalone WIMs as well as split WIM parts.
1351 * Pointer to the ::WIMStruct for a WIM file.
1353 * @c stdout, or a FILE* opened for writing, to extract the data to.
1355 * @return 0 on success; nonzero on error.
1356 * @retval ::WIMLIB_ERR_WRITE
1357 * Failed to completely write the XML data to @a fp.
1358 * @retval ::WIMLIB_ERR_INVALID_PARAM
1359 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1362 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1365 * Frees all memory allocated for a WIMStruct and closes all files associated
1369 * Pointer to the ::WIMStruct for a WIM file.
1371 * @return This function has no return value.
1374 wimlib_free(WIMStruct *wim);
1377 * Returns the index of the bootable image of the WIM.
1380 * Pointer to the ::WIMStruct for a WIM file.
1383 * 0 if no image is marked as bootable, or the number of the image marked
1384 * as bootable (numbered starting at 1).
1387 wimlib_get_boot_idx(const WIMStruct *wim);
1390 * Returns the compression type used in the WIM.
1393 * Pointer to the ::WIMStruct for a WIM file
1396 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1397 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1400 wimlib_get_compression_type(const WIMStruct *wim);
1403 * Converts a ::wimlib_compression_type value into a string.
1406 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1407 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1410 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1413 extern const wimlib_tchar *
1414 wimlib_get_compression_type_string(int ctype);
1417 * Converts an error code into a string describing it.
1420 * The error code returned by one of wimlib's functions.
1423 * Pointer to a statically allocated string describing the error code,
1424 * or @c NULL if the error code is not valid.
1426 extern const wimlib_tchar *
1427 wimlib_get_error_string(enum wimlib_error_code code);
1430 * Returns the description of the specified image.
1433 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1434 * standalone WIM or a split WIM part.
1436 * The number of the image, numbered starting at 1.
1439 * The description of the image, or @c NULL if there is no such image, or
1440 * @c NULL if the specified image has no description. The description
1441 * string is in library-internal memory and may not be modified or freed;
1442 * in addition, the string will become invalid if the description of the
1443 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1445 extern const wimlib_tchar *
1446 wimlib_get_image_description(const WIMStruct *wim, int image);
1449 * Returns the name of the specified image.
1452 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1453 * standalone WIM or a split WIM part.
1455 * The number of the image, numbered starting at 1.
1458 * The name of the image, or @c NULL if there is no such image. The name
1459 * string is in library-internal memory and may not be modified or freed;
1460 * in addition, the string will become invalid if the name of the image is
1461 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1463 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1464 * the WIM to be unnamed, in which case an empty string will be returned
1465 * when the corresponding name is requested.
1467 extern const wimlib_tchar *
1468 wimlib_get_image_name(const WIMStruct *wim, int image);
1472 * Returns the number of images contained in a WIM.
1475 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1476 * standalone WIM or a split WIM part.
1479 * The number of images contained in the WIM file.
1482 wimlib_get_num_images(const WIMStruct *wim);
1485 * Returns the part number of a WIM in a split WIM and the total number of parts
1489 * Pointer to the ::WIMStruct for a WIM file.
1490 * @param total_parts_ret
1491 * If non-@c NULL, the total number of parts in the split WIM (1 for
1492 * non-split WIMs) is written to this location.
1495 * The part number of the WIM (1 for non-split WIMs)
1498 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1501 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1502 * re-entrant. If you are calling wimlib functions concurrently in different
1503 * threads, then you must call this function serially first. Also, since wimlib
1504 * 1.3.0, you must call this function if the character encoding of the current
1505 * locale is not UTF-8. Otherwise, calling this function this function is not
1508 * This function always returns 0.
1511 wimlib_global_init();
1514 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1515 * You are not required to call this function, but it will release any global
1516 * memory allocated by the library.
1519 wimlib_global_cleanup();
1522 * Returns true if the WIM has an integrity table.
1525 * Pointer to the ::WIMStruct for a WIM file.
1527 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1528 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1529 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1530 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1533 wimlib_has_integrity_table(const WIMStruct *wim);
1536 * Determines if an image name is already used by some image in the WIM.
1539 * Pointer to the ::WIMStruct for a WIM file.
1541 * The name to check.
1544 * @c true if there is already an image in @a wim named @a name; @c false
1545 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1546 * the empty string, @c false is returned.
1549 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1552 * Joins a split WIM into a stand-alone one-part WIM.
1555 * An array of strings that gives the filenames of all parts of the split
1556 * WIM. No specific order is required, but all parts must be included with
1559 * Number of filenames in @a swms.
1560 * @param swm_open_flags
1561 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1562 * part should be verified, if integrity tables are present. Otherwise,
1564 * @param wim_write_flags
1565 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1566 * @param output_path
1567 * The path to write the one-part WIM to.
1568 * @param progress_func
1569 * If non-NULL, a function that will be called periodically with the
1570 * progress of the current operation.
1572 * @return 0 on success; nonzero on error. This function may return any value
1573 * returned by wimlib_open_wim() and wimlib_write() except
1574 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1576 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1577 * The split WIMs do not form a valid WIM because they do not include all
1578 * the parts of the original WIM, there are duplicate parts, or not all the
1579 * parts have the same GUID and compression type.
1581 * Note: the WIM's uncompressed and compressed resources are not checksummed
1582 * when they are copied from the split WIM parts to the joined WIM, nor are
1583 * compressed resources re-compressed.
1585 * Note: wimlib_export_image() can provide similar functionality to
1586 * wimlib_join(), since it is possible to export all images from a split WIM.
1589 wimlib_join(const wimlib_tchar * const *swms,
1591 const wimlib_tchar *output_path,
1593 int wim_write_flags,
1594 wimlib_progress_func_t progress_func);
1597 * Mounts an image in a WIM file on a directory read-only or read-write.
1599 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1600 * process shall be daemonized.
1602 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1603 * modifications to the WIM are staged in a temporary directory.
1605 * It is safe to mount multiple images from the same WIM file read-only at the
1606 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1607 * to mount multiple images from the same WIM file read-write at the same time.
1609 * wimlib_mount_image() cannot be used on an image that was exported with
1610 * wimlib_export_image() while the dentry trees for both images are still in
1611 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1612 * that has just been added with wimlib_add_image(), unless the WIM has been
1613 * written and read into a new ::WIMStruct.
1616 * Pointer to the ::WIMStruct containing the image to be mounted.
1618 * The number of the image to mount, indexed starting from it. It must be
1619 * an existing, single image.
1621 * The path to an existing empty directory to mount the image on.
1622 * @param mount_flags
1623 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1625 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1626 * rather than the default of read-only.
1628 * WIMs may contain named (alternate) data streams, which are a somewhat
1629 * obscure NTFS feature. They can be read and written on a mounted WIM
1630 * through one of several interfaces. The interface to use if specified by
1631 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1632 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1633 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1634 * the XATTR interface.
1635 * @param additional_swms
1636 * Array of pointers to the ::WIMStruct for each additional part in the
1637 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1638 * need to be in any particular order, but they must include all parts of
1639 * the split WIM other than the first part, which must be provided in the
1641 * @param num_additional_swms
1642 * Number of additional WIM parts provided in the @a additional_swms array.
1643 * This number should be one less than the total number of parts in the
1644 * split WIM. Set to 0 if the WIM is a standalone WIM.
1645 * @param staging_dir
1646 * If non-NULL, the name of a directory in which the staging directory will
1647 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1648 * in @a mount_flags. If left @c NULL, the staging directory is created in
1649 * the same directory as the WIM file that @a wim was originally read from.
1651 * @return 0 on success; nonzero on error.
1653 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1654 * A read-write mount was requested, but an an exclusive advisory lock on
1655 * the on-disk WIM file could not be acquired because another thread or
1656 * process has mounted an image from the WIM read-write or is currently
1657 * modifying the WIM in-place.
1658 * @retval ::WIMLIB_ERR_DECOMPRESSION
1659 * Could not decompress the metadata resource for @a image in @a wim.
1660 * @retval ::WIMLIB_ERR_FUSE
1661 * A non-zero status was returned by @c fuse_main().
1662 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1663 * A directory entry in the metadata resource for @a image in @a wim is
1665 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1666 * @a image does not specify an existing, single image in @a wim.
1667 * @retval ::WIMLIB_ERR_INVALID_PARAM
1668 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1669 * wimlib_export_image(), or @a image has been added with
1670 * wimlib_add_image().
1671 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1672 * The metadata resource for @a image in @a wim is invalid.
1673 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1674 * The security data for @a image in @a wim is invalid.
1675 * @retval ::WIMLIB_ERR_MKDIR
1676 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1677 * staging directory could not be created.
1678 * @retval ::WIMLIB_ERR_NOMEM
1679 * Failed to allocate needed memory.
1680 * @retval ::WIMLIB_ERR_NOTDIR
1681 * Could not determine the current working directory.
1682 * @retval ::WIMLIB_ERR_READ
1683 * An unexpected end-of-file or read error occurred when trying to read
1684 * data from the WIM file associated with @a wim.
1685 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1686 * The WIM is a split WIM, but the parts specified do not form a complete
1687 * split WIM because they do not include all the parts of the original WIM,
1688 * there are duplicate parts, or not all the parts have the same GUID and
1690 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1691 * The WIM is a split WIM and a read-write mount was requested. We only
1692 * support mounting a split WIM read-only.
1695 wimlib_mount_image(WIMStruct *wim,
1697 const wimlib_tchar *dir,
1699 WIMStruct **additional_swms,
1700 unsigned num_additional_swms,
1701 const wimlib_tchar *staging_dir);
1704 * Opens a WIM file and creates a ::WIMStruct for it.
1707 * The path to the WIM file to open.
1709 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1710 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1712 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1713 * the WIM, if it exists, is checked, and this function will fail with an
1714 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1715 * digests of the WIM do not exactly match the corresponding message
1716 * digests given in the integrity table.
1718 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1719 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1720 * returned. (This flag may be removed in the future, in which case no
1721 * error will be issued when opening a split WIM.)
1723 * @param progress_func
1724 * If non-NULL, a function that will be called periodically with the
1725 * progress of the current operation.
1728 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1729 * is written to the memory location pointed to by this parameter. The
1730 * ::WIMStruct must be freed using using wimlib_free() when finished with
1733 * @return 0 on success; nonzero on error.
1734 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1735 * The lookup table of @a wim_file is compressed. Support for this can be
1736 * added to wimlib if needed, but it appears to be the case that the lookup
1737 * table is never compressed.
1738 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1739 * The WIM is not the non-first part of a split WIM, and the number of
1740 * metadata resources found in the WIM did not match the image count given
1741 * in the WIM header, or the number of <IMAGE> elements in the XML
1742 * data for the WIM did not match the image count given in the WIM header.
1743 * @retval ::WIMLIB_ERR_INTEGRITY
1744 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1745 * wim_file contains an integrity table, but the SHA1 message digest for a
1746 * chunk of the WIM does not match the corresponding message digest given
1747 * in the integrity table.
1748 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1749 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1750 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1751 * The header of @a wim_file says that resources in the WIM are compressed,
1752 * but the header flag indicating LZX or XPRESS compression is not set.
1753 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1754 * The length field of the WIM header is not 208.
1755 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1756 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1757 * wim_file contains an integrity table, but the integrity table is
1759 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1760 * The lookup table for the WIM contained duplicate entries that are not
1761 * for metadata resources, or it contained an entry with a SHA1 message
1762 * digest of all 0's.
1763 * @retval ::WIMLIB_ERR_NOMEM
1764 * Failed to allocated needed memory.
1765 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1766 * @a wim_file does not begin with the expected magic characters.
1767 * @retval ::WIMLIB_ERR_OPEN
1768 * Failed to open the file @a wim_file for reading.
1769 * @retval ::WIMLIB_ERR_READ
1770 * An unexpected end-of-file or read error occurred when trying to read
1771 * data from @a wim_file.
1772 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1773 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1774 * specified in @a open_flags.
1775 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1776 * A number other than 0x10d00 is written in the version field of the WIM
1777 * header of @a wim_file. (Probably a pre-Vista WIM).
1778 * @retval ::WIMLIB_ERR_XML
1779 * The XML data for @a wim_file is invalid.
1782 wimlib_open_wim(const wimlib_tchar *wim_file,
1784 WIMStruct **wim_ret,
1785 wimlib_progress_func_t progress_func);
1788 * Overwrites the file that the WIM was originally read from, with changes made.
1789 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1790 * rather than wimlib_create_new_wim().
1792 * There are two ways that a WIM may be overwritten. The first is to do a full
1793 * rebuild. In this mode, the new WIM is written to a temporary file and then
1794 * renamed to the original file after it is has been completely written. The
1795 * temporary file is made in the same directory as the original WIM file. A
1796 * full rebuild may take a while, but can be used even if images have been
1797 * modified or deleted, will produce a WIM with no holes, and has little chance
1798 * of unintentional data loss because the temporary WIM is fsync()ed before
1799 * being renamed to the original WIM.
1801 * The second way to overwrite a WIM is by appending to the end of it and
1802 * overwriting the header. This can be much faster than a full rebuild, but it
1803 * only works if the only operations on the WIM have been to change the header
1804 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1805 * with writing any new file resources *after* everything in the old WIM, even
1806 * though this will leave a hole where the old lookup table, XML data, and
1807 * integrity were. This is done so that the WIM remains valid even if the
1808 * operation is aborted mid-write. The WIM header is only overwritten at the
1809 * very last moment, and up until that point the WIM will be seen as the old
1812 * By default, the overwrite mode is determine automatically based on the past
1813 * operations performed on the ::WIMStruct. Use the flag
1814 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1815 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1816 * images have been deleted from the WIM.
1818 * In the temporary-file overwrite mode, no changes are made to the WIM on
1819 * failure, and the temporary file is deleted if possible. Abnormal termination
1820 * of the program will result in the temporary file being orphaned. In the
1821 * direct append mode, the WIM is truncated to the original length on failure;
1822 * and while abnormal termination of the program will result in extra data
1823 * appended to the original WIM, it should still be a valid WIM.
1826 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1827 * been in-memory changes made to it, which are then reflected in the
1829 * @param write_flags
1830 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1831 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1832 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1833 * @param num_threads
1834 * Number of threads to use for compression (see wimlib_write()).
1835 * @param progress_func
1836 * If non-NULL, a function that will be called periodically with the
1837 * progress of the current operation.
1839 * @return 0 on success; nonzero on error. This function may return any value
1840 * returned by wimlib_write() as well as the following error codes:
1841 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1842 * The WIM was going to be modifien in-place (with no temporary file), but
1843 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1844 * because another thread or process has mounted an image from the WIM
1845 * read-write or is currently modifying the WIM in-place.
1846 * @retval ::WIMLIB_ERR_NO_FILENAME
1847 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1848 * than a WIM read with wimlib_open_wim().
1849 * @retval ::WIMLIB_ERR_RENAME
1850 * The temporary file that the WIM was written to could not be renamed to
1851 * the original filename of @a wim.
1852 * @retval ::WIMLIB_ERR_REOPEN
1853 * The WIM was overwritten successfully, but it could not be re-opened
1854 * read-only. Therefore, the resources in the WIM can no longer be
1855 * accessed, so this limits the functions that can be called on @a wim
1856 * before calling wimlib_free().
1859 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
1860 wimlib_progress_func_t progress_func);
1863 * Prints information about one image, or all images, contained in a WIM.
1866 * Pointer to the ::WIMStruct for a WIM file.
1868 * The image about which to print information. Can be the number of an
1869 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1872 * @return This function has no return value. No error checking is done when
1873 * printing the information. If @a image is invalid, an error message is
1877 wimlib_print_available_images(const WIMStruct *wim, int image);
1880 * Prints the full paths to all files contained in an image, or all images, in a
1884 * Pointer to the ::WIMStruct for a WIM file.
1886 * Which image to print files for. Can be the number of an image, or
1887 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1889 * @return 0 on success; nonzero on error.
1890 * @retval ::WIMLIB_ERR_DECOMPRESSION
1891 * The metadata resource for one of the specified images could not be
1893 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1894 * A directory entry in the metadata resource for one of the specified
1895 * images is invaled.
1896 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1897 * @a image does not specify a valid image in @a wim, and is not
1898 * ::WIMLIB_ALL_IMAGES.
1899 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1900 * The metadata resource for one of the specified images is invalid.
1901 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1902 * The security data for one of the specified images is invalid.
1903 * @retval ::WIMLIB_ERR_NOMEM
1904 * Failed to allocate needed memory.
1905 * @retval ::WIMLIB_ERR_READ
1906 * An unexpected read error or end-of-file occurred when reading the
1907 * metadata resource for one of the specified images.
1908 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1909 * @a wim was not a standalone WIM and was not the first part of a split
1913 wimlib_print_files(WIMStruct *wim, int image);
1916 * Prints detailed information from the header of a WIM file.
1919 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1920 * standalone WIM or part of a split WIM.
1922 * @return This function has no return value.
1926 wimlib_print_header(const WIMStruct *wim);
1929 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1930 * digests, as found in the directory entry tree in the WIM file, to file
1931 * resources in the WIM file. This table includes one entry for each unique
1932 * file in the WIM, so it can be quite long. There is only one lookup table per
1933 * WIM file, but each split WIM part has its own lookup table.
1936 * Pointer to the ::WIMStruct for a WIM file.
1938 * @return This function has no return value.
1941 wimlib_print_lookup_table(WIMStruct *wim);
1944 * Prints the metadata of the specified image in a WIM file. The metadata
1945 * consists of the security data as well as the directory entry tree. Each
1946 * image has its own metadata.
1949 * Pointer to the ::WIMStruct for a WIM file.
1951 * Which image to print the metadata for. Can be the number of an image,
1952 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1954 * @return 0 on success; nonzero on error.
1955 * @retval ::WIMLIB_ERR_DECOMPRESSION
1956 * The metadata resource for one of the specified images could not be
1958 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1959 * A directory entry in the metadata resource for one of the specified
1960 * images is invaled.
1961 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1962 * @a image does not specify a valid image in @a wim, and is not
1963 * ::WIMLIB_ALL_IMAGES.
1964 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1965 * The metadata resource for one of the specified images is invalid.
1966 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1967 * The security data for one of the specified images is invalid.
1968 * @retval ::WIMLIB_ERR_NOMEM
1969 * Failed to allocate needed memory.
1970 * @retval ::WIMLIB_ERR_READ
1971 * An unexpected read error or end-of-file occurred when reading the
1972 * metadata resource for one of the specified images.
1973 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1974 * @a wim was not a standalone WIM and was not the first part of a split
1978 wimlib_print_metadata(WIMStruct *wim, int image);
1981 * Prints some basic information about a WIM file. All information printed by
1982 * this function is also printed by wimlib_print_header(), but
1983 * wimlib_print_wim_information() prints some of this information more concisely
1984 * and in a more readable form.
1987 * Pointer to the ::WIMStruct for a WIM file.
1989 * @return This function has no return value.
1992 wimlib_print_wim_information(const WIMStruct *wim);
1995 * Translates a string specifying the name or number of an image in the WIM into
1996 * the number of the image. The images are numbered starting at 1.
1999 * Pointer to the ::WIMStruct for a WIM file.
2000 * @param image_name_or_num
2001 * A string specifying the name or number of an image in the WIM. If it
2002 * parses to a positive integer, this integer is taken to specify the
2003 * number of the image, indexed starting at 1. Otherwise, it is taken to
2004 * be the name of an image, as given in the XML data for the WIM file. It
2005 * also may be the keyword "all" or the string "*", both of which will
2006 * resolve to ::WIMLIB_ALL_IMAGES.
2008 * There is no way to search for an image actually named "all", "*", or an
2009 * integer number, or an image that has no name. However, you can use
2010 * wimlib_get_image_name() to get the name of any image.
2013 * If the string resolved to a single existing image, the number of that
2014 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2015 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2016 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2017 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2018 * images in @a wim has no name.
2021 wimlib_resolve_image(WIMStruct *wim,
2022 const wimlib_tchar *image_name_or_num);
2025 * Sets which image in the WIM is marked as bootable.
2028 * Pointer to the ::WIMStruct for a WIM file.
2030 * The number of the image to mark as bootable, or 0 to mark no image as
2032 * @return 0 on success; nonzero on error.
2033 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2034 * @a boot_idx does not specify an existing image in @a wim, and it was not
2036 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2037 * @a wim is part of a split WIM. We do not support changing the boot
2038 * index of a split WIM.
2041 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2044 * Changes the description of an image in the WIM.
2047 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2048 * standalone WIM or part of a split WIM; however, you should set the same
2049 * description on all parts of a split WIM.
2051 * The number of the image for which to change the description.
2052 * @param description
2053 * The new description to give the image. It may be @c NULL, which
2054 * indicates that the image is to be given no description.
2056 * @return 0 on success; nonzero on error.
2057 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2058 * @a image does not specify a single existing image in @a wim.
2059 * @retval ::WIMLIB_ERR_NOMEM
2060 * Failed to allocate the memory needed to duplicate the @a description
2064 wimlib_set_image_descripton(WIMStruct *wim, int image,
2065 const wimlib_tchar *description);
2068 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2069 * (something like "Core" or "Ultimate")
2072 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2073 * standalone WIM or part of a split WIM; however, you should set the same
2074 * \<FLAGS\> element on all parts of a split WIM.
2076 * The number of the image for which to change the description.
2078 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2079 * indicates that the image is to be given no \<FLAGS\> element.
2081 * @return 0 on success; nonzero on error.
2082 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2083 * @a image does not specify a single existing image in @a wim.
2084 * @retval ::WIMLIB_ERR_NOMEM
2085 * Failed to allocate the memory needed to duplicate the @a flags string.
2087 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2088 const wimlib_tchar *flags);
2091 * Changes the name of an image in the WIM.
2094 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2095 * standalone WIM or part of a split WIM; however, you should set the same
2096 * name on all parts of a split WIM.
2098 * The number of the image for which to change the name.
2100 * The new name to give the image. It must be a nonempty string.
2102 * @return 0 on success; nonzero on error.
2103 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2104 * There is already an image named @a name in @a wim.
2105 * @retval ::WIMLIB_ERR_INVALID_PARAM
2106 * @a name was @c NULL or the empty string.
2107 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2108 * @a image does not specify a single existing image in @a wim.
2109 * @retval ::WIMLIB_ERR_NOMEM
2110 * Failed to allocate the memory needed to duplicate the @a name string.
2112 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2113 const wimlib_tchar *name);
2116 * Set the functions that wimlib uses to allocate and free memory.
2118 * These settings are global and not per-WIM.
2120 * The default is to use the default @c malloc() and @c free() from the C
2123 * Please note that some external functions, such as those in @c libntfs-3g, may
2124 * use the standard memory allocation functions.
2126 * @param malloc_func
2127 * A function equivalent to @c malloc() that wimlib will use to allocate
2128 * memory. If @c NULL, the allocator function is set back to the default
2129 * @c malloc() from the C library.
2131 * A function equivalent to @c free() that wimlib will use to free memory.
2132 * If @c NULL, the free function is set back to the default @c free() from
2134 * @param realloc_func
2135 * A function equivalent to @c realloc() that wimlib will use to reallocate
2136 * memory. If @c NULL, the free function is set back to the default @c
2137 * realloc() from the C library.
2138 * @return 0 on success; nonzero on error.
2139 * @retval ::WIMLIB_ERR_UNSUPPORTED
2140 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2141 * so custom memory allocators are unsupported.
2144 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2145 void (*free_func)(void *),
2146 void *(*realloc_func)(void *, size_t));
2149 * Sets whether wimlib is to print error messages to @c stderr when a function
2150 * fails. These error messages may provide information that cannot be
2151 * determined only from the error code that is returned. Not every error will
2152 * result in an error message being printed.
2154 * This setting is global and not per-WIM.
2156 * By default, error messages are not printed.
2158 * @param show_messages
2159 * @c true if error messages are to be printed; @c false if error messages
2160 * are not to be printed.
2162 * @return 0 on success; nonzero on error.
2163 * @retval ::WIMLIB_ERR_UNSUPPORTED
2164 * @a show_messages was @c true, but wimlib was compiled with the @c
2165 * --without-error-messages option. Therefore, error messages cannot be
2169 wimlib_set_print_errors(bool show_messages);
2172 * Splits a WIM into multiple parts.
2175 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2178 * Name of the SWM file to create. This will be the name of the first
2179 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2180 * appended before the suffix.
2182 * The maximum size per part, in bytes. It is not guaranteed that this
2183 * will really be the maximum size per part, because some file resources in
2184 * the WIM may be larger than this size, and the WIM file format provides
2185 * no way to split up file resources among multiple WIMs.
2186 * @param write_flags
2187 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2188 * included in the split WIM parts.
2189 * @param progress_func
2190 * If non-NULL, a function that will be called periodically with the
2191 * progress of the current operation.
2193 * @return 0 on success; nonzero on error. This function may return any value
2194 * returned by wimlib_write() as well as the following error codes:
2196 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2197 * @a wim is not part 1 of a stand-alone WIM.
2198 * @retval ::WIMLIB_ERR_INVALID_PARAM
2199 * @a swm_name was @c NULL, or @a part_size was 0.
2201 * Note: the WIM's uncompressed and compressed resources are not checksummed
2202 * when they are copied from the joined WIM to the split WIM parts, nor are
2203 * compressed resources re-compressed.
2206 wimlib_split(WIMStruct *wim,
2207 const wimlib_tchar *swm_name,
2210 wimlib_progress_func_t progress_func);
2213 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2215 * The image to unmount is specified by the path to the mountpoint, not the
2216 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2217 * touched and also may have been allocated in a different process.
2219 * To unmount the image, the thread calling this function communicates with the
2220 * thread that is managing the mounted WIM image. This function blocks until it
2221 * is known whether the unmount succeeded or failed. In the case of a
2222 * read-write mounted WIM, the unmount is not considered to have succeeded until
2223 * all changes have been saved to the underlying WIM file.
2226 * The directory that the WIM image was mounted on.
2227 * @param unmount_flags
2228 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2229 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2230 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2232 * @param progress_func
2233 * If non-NULL, a function that will be called periodically with the
2234 * progress of the current operation.
2236 * @return 0 on success; nonzero on error.
2238 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2239 * The filesystem daemon was unable to remove the staging directory and the
2240 * temporary files that it contains.
2241 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2242 * The filesystem daemon appears to have terminated before sending an exit
2244 * @retval ::WIMLIB_ERR_FORK
2245 * Could not @c fork() the process.
2246 * @retval ::WIMLIB_ERR_FUSERMOUNT
2247 * The @b fusermount program could not be executed or exited with a failure
2249 * @retval ::WIMLIB_ERR_MQUEUE
2250 * Could not open a POSIX message queue to communicate with the filesystem
2251 * daemon servicing the mounted filesystem, could not send a message
2252 * through the queue, or could not receive a message through the queue.
2253 * @retval ::WIMLIB_ERR_NOMEM
2254 * Failed to allocate needed memory.
2255 * @retval ::WIMLIB_ERR_OPEN
2256 * The filesystem daemon could not open a temporary file for writing the
2258 * @retval ::WIMLIB_ERR_READ
2259 * A read error occurred when the filesystem daemon tried to a file from
2260 * the staging directory
2261 * @retval ::WIMLIB_ERR_RENAME
2262 * The filesystem daemon failed to rename the newly written WIM file to the
2263 * original WIM file.
2264 * @retval ::WIMLIB_ERR_WRITE
2265 * A write error occurred when the filesystem daemon was writing to the new
2266 * WIM file, or the filesystem daemon was unable to flush changes that had
2267 * been made to files in the staging directory.
2270 wimlib_unmount_image(const wimlib_tchar *dir,
2272 wimlib_progress_func_t progress_func);
2275 * Writes a standalone WIM to a file.
2277 * This brings in resources from any external locations, such as directory trees
2278 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2279 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2282 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2283 * changes made to it, which are then reflected in the output file.
2285 * The path to the file to write the WIM to.
2287 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2289 * @param write_flags
2290 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2291 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2292 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2293 * @param num_threads
2294 * Number of threads to use for compressing data. If 0, the number of
2295 * threads is taken to be the number of online processors. Note: if no
2296 * data compression needs to be done, no additional threads will be created
2297 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2298 * exporting an image from a compressed WIM to another WIM of the same
2299 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2301 * @param progress_func
2302 * If non-NULL, a function that will be called periodically with the
2303 * progress of the current operation.
2305 * @return 0 on success; nonzero on error.
2306 * @retval ::WIMLIB_ERR_DECOMPRESSION
2307 * Failed to decompress a metadata or file resource in @a wim.
2308 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2309 * A directory entry in the metadata resource for @a image in @a wim is
2311 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2312 * @a image does not specify a single existing image in @a wim, and is not
2313 * ::WIMLIB_ALL_IMAGES.
2314 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2315 * A file that had previously been scanned for inclusion in the WIM by
2316 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2317 * message digest check.
2318 * @retval ::WIMLIB_ERR_INVALID_PARAM
2319 * @a path was @c NULL.
2320 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2321 * The metadata resource for @a image in @a wim is invalid.
2322 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2323 * The security data for @a image in @a wim is invalid.
2324 * @retval ::WIMLIB_ERR_NOMEM
2325 * Failed to allocate needed memory.
2326 * @retval ::WIMLIB_ERR_OPEN
2327 * Failed to open @a path for writing, or some file resources in @a
2328 * wim refer to files in the outside filesystem, and one of these files
2329 * could not be opened for reading.
2330 * @retval ::WIMLIB_ERR_READ
2331 * An error occurred when trying to read data from the WIM file associated
2332 * with @a wim, or some file resources in @a wim refer to files in the
2333 * outside filesystem, and a read error occurred when reading one of these
2335 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2336 * @a wim is part of a split WIM. You may not call this function on a
2338 * @retval ::WIMLIB_ERR_WRITE
2339 * An error occurred when trying to write data to the new WIM file at @a
2343 wimlib_write(WIMStruct *wim,
2344 const wimlib_tchar *path,
2347 unsigned num_threads,
2348 wimlib_progress_func_t progress_func);
2350 #endif /* _WIMLIB_H */