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.0. If you
35 * have installed wimlib and want to know how to use the @c imagex program,
36 * please see the man pages instead. Also: the actual project page where you
37 * 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 @c
42 * imagex.exe utility on Windows, but this library provides a free
43 * implementetion of @c imagex for UNIX-based systems and an API to allow other
44 * programs to read, write, and mount WIM files. wimlib is comparable to
45 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
47 * \section format WIM files
49 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
50 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
51 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
52 * Both are based on LZ77 and Huffman encoding, and both are supported by
55 * Unlike ZIP files, WIM files can contain multiple independent toplevel
56 * directory trees known as @a images. While each image has its own metadata,
57 * files are not duplicated for each image; instead, each file is included only
58 * once in the entire WIM. Microsoft did this so that in one WIM file, they
59 * could do things like have 5 different versions of Windows that are almost
62 * Microsoft provides documentation for the WIM file format, XPRESS compression
63 * format, and LZX compression format. The XPRESS documentation is acceptable,
64 * but the LZX documentation is not entirely correct, and the WIM documentation
65 * itself is incomplete.
67 * A WIM file may be either stand-alone or split into multiple parts.
69 * \section ntfs NTFS support
71 * As of version 1.0.0, wimlib supports capturing and applying images directly
72 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
73 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
74 * data such as security descriptors, alternate data streams, and reparse point
77 * The code for NTFS image capture and image application is complete enough that
78 * it is possible to apply an image from the "install.wim" contained in recent
79 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
80 * NTFS volume, and then boot Windows from it after preparing the Boot
81 * Configuration Data. In addition, a Windows installation can be captured (or
82 * backed up) into a WIM file, and then re-applied later.
84 * \section winpe Windows PE
86 * A major use for this library is to create customized images of Windows PE, the
87 * Windows Preinstallation Environment, without having to rely on Windows. Windows
88 * PE is a lightweight version of Windows that can run entirely from memory and can
89 * be used to install Windows from local media or a network drive or perform
90 * maintenance. Windows PE is the operating system that runs when you boot from
91 * the Windows installation media.
93 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
94 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
95 * in the Windows Automated Installation Kit (WAIK), which is free to download
96 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
97 * install either the @c cabextract or @c p7zip programs.
99 * In addition, Windows installations and recovery partitions frequently contain a
100 * WIM containing an image of the Windows Recovery Environment, which is similar to
103 * \section starting Getting Started
105 * wimlib uses the GNU autotools, so it should be easy to install with
106 * <code>configure && make && sudo make install</code>; however, please see the
107 * README for more information about installing it. To use wimlib in a program
108 * after installing it, include @c wimlib.h and link your program with @c -lwim.
110 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
111 * may represent either a stand-alone WIM or one part of a split WIM.
113 * All functions in wimlib's public API are prefixed with @c wimlib. Most
114 * return an integer error code on failure. Use wimlib_get_error_string() to
115 * get a string that describes an error code. wimlib also can print error
116 * messages itself when an error happens, and these may be more informative than
117 * the error code; to enable this, call wimlib_set_print_errors(). Please note
118 * that this is for convenience only, and some errors can occur without a
119 * message being printed.
121 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
122 * the following exceptions:
123 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
124 * - You also must call wimlib_global_init() in the main thread to avoid any
125 * race conditions with one-time allocations of memory.
126 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
127 * concurrently in the same process, will daemonize the entire process when it
128 * does so for the first time. This includes changing the working directory
129 * to the root directory.
131 * To open an existing WIM, use wimlib_open_wim().
133 * To create a new WIM that initially contains no images, use
134 * wimlib_create_new_wim().
136 * To add an image to a WIM file from a directory tree on your filesystem, call
137 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
138 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
139 * also capture a WIM image directly from a NTFS volume if you provide the
140 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
141 * the <code>--without-ntfs-3g</code> flag.
143 * To extract an image from a WIM file, call wimlib_extract_image(). You may
144 * extract an image either to a directory or directly to a NTFS volume, the
145 * latter of which will preserve NTFS-specific data such as security
148 * wimlib supports mounting WIM files either read-only or read-write. Mounting
149 * is done using wimlib_mount_image() and unmounting is done using
150 * wimlib_unmount_image(). Mounting can be done without root privileges because
151 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
152 * compiled with the <code>--without-fuse</code> flag, these functions will be
153 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
155 * After creating or modifying a WIM file, you can write it to a file using
156 * wimlib_write(). Alternatively, if the WIM was originally read from a file
157 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
158 * wimlib_overwrite() to overwrite the original file.
160 * Please note: merely by calling wimlib_add_image() or many of the other
161 * functions in this library that operate on ::WIMStruct's, you are @b not
162 * modifying the WIM file on disk. Changes are not saved until you explicitly
163 * call wimlib_write() or wimlib_overwrite().
165 * After you are done with the WIM file, use wimlib_free() to free all memory
166 * associated with a ::WIMStruct and close all files associated with it.
168 * A number of functions take a pointer to a progress function of type
169 * ::wimlib_progress_func_t. This function will be called periodically during
170 * the WIM operation(s) to report on the progress of the operation (for example,
171 * how many bytes have been written so far).
173 * \section imagex imagex
175 * wimlib comes with a command-line interface, the @b imagex program. It is
176 * documented with man pages. See its source code (@c programs/imagex.c in
177 * wimlib's source tree) for an example of how to use wimlib in your program.
179 * \section mkwinpeimg mkwinpeimg
181 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
184 * \section encodings Locales and character encodings
186 * wimlib 1.3.0 has improved handling of different character encodings compared
187 * to previous versions. Functions are explictly noted as taking
188 * ::wimlib_mbchar strings, which are encoded in the locale-dependent multibyte
189 * encoding (e.g. ASCII, ISO-8859-1, or UTF-8), or ::wimlib_utf8char strings,
190 * which are encoded in UTF-8. Generally, filenames and paths are in the
191 * locale-dependent multibyte encoding, while other types of data must be
192 * provided in UTF-8. Please see the man page for @b imagex for more
193 * information. However, I strongly recommend that you use UTF-8 for your
194 * locale's encoding so that ::wimlib_mbchar strings will be encoded the same
195 * way as ::wimlib_utf8char strings.
197 * \section Limitations
199 * While wimlib supports the main features of WIM files, wimlib currently has
200 * the following limitations:
201 * - There is no way to add, remove, modify, or extract specific files in a WIM
202 * without mounting it, other than by adding, removing, or extracting an
203 * entire image. The FUSE mount feature should be used for this purpose.
204 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
205 * than wimlib when using maximum (LZX) compression because it knows how to
206 * split up LZX compressed blocks, which is not yet implemented in wimlib.
207 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
208 * imagex.exe if you want to make sure your WIM files are made "correctly".
209 * - The old WIM format from Vista pre-releases is not supported.
210 * - Compressed resource chunk sizes other than 32768 are not supported,
211 * although this doesn't seem to be a problem because the chunk size always
212 * seems to be this value.
213 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
214 * make certain Windows-specific modifications to a Windows PE image, such as
215 * adding a driver or Windows component. Such a tool could conceivably be
216 * implemented on top of wimlib, although it likely would be hard to implement
217 * because it would have to do very Windows-specific things such as
218 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
219 * script for a similar purpose, however. With regards to adding drivers to
220 * Windows PE, you have the option of putting them anywhere in the Windows PE
221 * image, then loading them after boot using @b drvload.exe.
222 * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
223 * Windows build has some limitations compared to the UNIX build.
224 * (The differences are documented better in the man pages for @b imagex than
227 * \section legal License
229 * The wimlib library, as well as the programs and scripts distributed with it
230 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
231 * License version 3 or later.
240 #include <inttypes.h>
242 /** Major version of the library (for example, the 1 in 1.2.5). */
243 #define WIMLIB_MAJOR_VERSION 1
245 /** Minor version of the library (for example, the 2 in 1.2.5). */
246 #define WIMLIB_MINOR_VERSION 3
248 /** Patch version of the library (for example, the 5 in 1.2.5). */
249 #define WIMLIB_PATCH_VERSION 0
252 * Opaque structure that represents a WIM file. This is an in-memory structure
253 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
254 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
255 * continuing to exist so that data can be read from it as needed.
257 * Most functions in this library will work the same way regardless of whether a
258 * given ::WIMStruct was obtained through wimlib_open_wim() or
259 * wimlib_create_new_wim(). Exceptions are documented.
261 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
262 * file from a ::WIMStruct.
264 typedef struct WIMStruct WIMStruct;
266 /** Byte of a string encoded in the locale-dependent encoding */
267 typedef char wimlib_mbchar;
269 /** Byte of a string encoded in UTF-8 */
270 typedef char wimlib_utf8char;
273 * Specifies the compression type of a WIM file.
275 enum wimlib_compression_type {
276 /** An invalid compression type. */
277 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
279 /** The WIM does not include any compressed resources. */
280 WIMLIB_COMPRESSION_TYPE_NONE = 0,
282 /** Compressed resources in the WIM use LZX compression. */
283 WIMLIB_COMPRESSION_TYPE_LZX = 1,
285 /** Compressed resources in the WIM use XPRESS compression. */
286 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
289 /** Possible values of the first parameter to the user-supplied
290 * ::wimlib_progress_func_t progress function */
291 enum wimlib_progress_msg {
293 /** A WIM image is about to be extracted. @a info will point to
294 * ::wimlib_progress_info.extract. */
295 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
297 /** The directory structure of the WIM image is about to be extracted.
298 * @a info will point to ::wimlib_progress_info.extract. */
299 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
301 /** The directory structure of the WIM image has been successfully
302 * extracted. @a info will point to ::wimlib_progress_info.extract. */
303 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
305 /** The WIM image's files resources are currently being extracted. @a
306 * info will point to ::wimlib_progress_info.extract. */
307 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
309 /** A file or directory is being extracted. @a info will point to
310 * ::wimlib_progress_info.extract, and the @a cur_path member will be
312 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
314 /** All the WIM files and directories have been extracted, and
315 * timestamps are about to be applied. @a info will point to
316 * ::wimlib_progress_info.extract. */
317 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
319 /** A WIM image has been successfully extracted. @a info will point to
320 * ::wimlib_progress_info.extract. */
321 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
323 /** The directory or NTFS volume is about to be scanned to build a tree
324 * of WIM dentries in-memory. @a info will point to
325 * ::wimlib_progress_info.scan. */
326 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
328 /** A directory or file is being scanned. @a info will point to
329 * ::wimlib_progress_info.scan, and its @a cur_path member will be
330 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
331 * is passed to wimlib_add_image(). */
332 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
334 /** The directory or NTFS volume has been successfully scanned, and a
335 * tree of WIM dentries has been built in-memory. @a info will point to
336 * ::wimlib_progress_info.scan. */
337 WIMLIB_PROGRESS_MSG_SCAN_END,
340 * File resources are currently being written to the WIM.
341 * @a info will point to ::wimlib_progress_info.write_streams. */
342 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
345 * The metadata resource for each image is about to be written to the
346 * WIM. @a info will not be valid. */
347 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
350 * The metadata resource for each image has successfully been writen to
351 * the WIM. @a info will not be valid. */
352 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
355 * The temporary file has successfully been renamed to the original WIM
356 * file. Only happens when wimlib_overwrite() is called and the
357 * overwrite is not done in-place.
358 * @a info will point to ::wimlib_progress_info.rename. */
359 WIMLIB_PROGRESS_MSG_RENAME,
361 /** The contents of the WIM are being checked against the integrity
362 * table. Only happens when wimlib_open_wim() is called with the
363 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
364 * ::wimlib_progress_info.integrity. */
365 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
367 /** An integrity table is being calculated for the WIM being written.
368 * Only happens when wimlib_write() or wimlib_overwrite() is called with
369 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
370 * ::wimlib_progress_info.integrity. */
371 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
373 /** A wimlib_join() operation is in progress. @a info will point to
374 * ::wimlib_progress_info.join. */
375 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
377 /** A wimlib_split() operation is in progress, and a new split part is
378 * about to be started. @a info will point to
379 * ::wimlib_progress_info.split. */
380 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
382 /** A wimlib_split() operation is in progress, and a split part has been
383 * finished. @a info will point to ::wimlib_progress_info.split. */
384 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
387 /** A pointer to this union is passed to the user-supplied
388 * ::wimlib_progress_func_t progress function. One (or none) of the structures
389 * contained in this union will be applicable for the operation
390 * (::wimlib_progress_msg) indicated in the first argument to the progress
392 union wimlib_progress_info {
394 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
395 * document them if they aren't given a name... */
397 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
398 struct wimlib_progress_info_write_streams {
399 /** Number of bytes that are going to be written for all the
400 * streams combined. This is the amount in uncompressed data.
401 * (The actual number of bytes will be less if the data is being
402 * written compressed.) */
403 uint64_t total_bytes;
404 /** Number of streams that are going to be written. */
405 uint64_t total_streams;
407 /** Number of uncompressed bytes that have been written so far.
408 * Will be 0 initially, and equal to @a total_bytes at the end.
410 uint64_t completed_bytes;
412 /** Number of streams that have been written. Will be 0
413 * initially, and equal to @a total_streams at the end. */
414 uint64_t completed_streams;
416 /** Number of threads that are being used to compress resources
417 * (if applicable). */
418 unsigned num_threads;
420 /** The compression type being used to write the streams; either
421 * ::WIMLIB_COMPRESSION_TYPE_NONE,
422 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
423 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
424 int compression_type;
427 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
428 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
429 struct wimlib_progress_info_scan {
430 /** Directory or NTFS volume that is being scanned. */
431 const wimlib_mbchar *source;
433 /** Path to the file or directory that is about to be scanned,
434 * relative to the root of the image capture or the NTFS volume.
436 const wimlib_mbchar *cur_path;
438 /** True iff @a cur_path is being excluded from the image
439 * capture due to the capture configuration file. */
442 /** Target path in the WIM. Only valid on messages
443 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
444 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
445 const wimlib_mbchar *wim_target_path;
448 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
449 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
450 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
451 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
452 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
453 struct wimlib_progress_info_extract {
454 /** Number of the image being extracted (1-based). */
457 /** Flags passed to to wimlib_extract_image() */
460 /** Full path to the WIM file being extracted. */
461 const wimlib_mbchar *wimfile_name;
463 /** Name of the image being extracted. */
464 const wimlib_utf8char *image_name;
466 /** Directory or NTFS volume to which the image is being
468 const wimlib_mbchar *target;
470 /** Current dentry being extracted. (Valid only if message is
471 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
472 const wimlib_mbchar *cur_path;
474 /** Number of bytes of uncompressed data that will be extracted.
475 * Takes into account hard links (they are not counted for each
478 uint64_t total_bytes;
480 /** Number of bytes that have been written so far. Will be 0
481 * initially, and equal to @a total_bytes at the end. */
482 uint64_t completed_bytes;
484 /** Number of streams that will be extracted. This may more or
485 * less than the number of "files" to be extracted due to
486 * special cases (hard links, symbolic links, and alternate data
488 uint64_t num_streams;
491 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
492 struct wimlib_progress_info_rename {
493 /** Name of the temporary file that the WIM was written to. */
494 const wimlib_mbchar *from;
496 /** Name of the original WIM file to which the temporary file is
498 const wimlib_mbchar *to;
501 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
502 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
503 struct wimlib_progress_info_integrity {
504 /** Number of bytes from the end of the WIM header to the end of
505 * the lookup table (the area that is covered by the SHA1
506 * integrity checks.) */
507 uint64_t total_bytes;
509 /** Number of bytes that have been SHA1-summed so far. Will be
510 * 0 initially, and equal @a total_bytes at the end. */
511 uint64_t completed_bytes;
513 /** Number of chunks that the checksummed region is divided
515 uint32_t total_chunks;
517 /** Number of chunks that have been SHA1-summed so far. Will
518 * be 0 initially, and equal to @a total_chunks at the end. */
519 uint32_t completed_chunks;
521 /** Size of the chunks used for the integrity calculation. */
524 /** Filename of the WIM (only valid if the message is
525 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
526 const wimlib_mbchar *filename;
529 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
530 struct wimlib_progress_info_join {
531 /** Total number of bytes of compressed data contained in all
532 * the split WIM part's file and metadata resources. */
533 uint64_t total_bytes;
535 /** Number of bytes that have been copied to the joined WIM so
536 * far. Will be 0 initially, and equal to @a total_bytes at the
538 uint64_t completed_bytes;
540 /** Number of split WIM parts that have had all their file and
541 * metadata resources copied over to the joined WIM so far. */
542 unsigned completed_parts;
544 /** Number of split WIM parts. */
545 unsigned total_parts;
548 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
549 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
550 struct wimlib_progress_info_split {
551 /** Total size of the original WIM's file and metadata resources
553 uint64_t total_bytes;
555 /** Number of bytes of file and metadata resources that have
556 * been copied out of the original WIM so far. Will be 0
557 * initially, and equal to @a total_bytes at the end. */
558 uint64_t completed_bytes;
560 /** Number of the split WIM part that is about to be started
561 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
562 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
563 unsigned cur_part_number;
565 /** Name of the split WIM part that is about to be started
566 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
567 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
568 const wimlib_mbchar *part_name;
572 /** A user-supplied function that will be called periodically during certain WIM
573 * operations. The first argument will be the type of operation that is being
574 * performed or is about to be started or has been completed. The second
575 * argument will be a pointer to one of a number of structures depending on the
576 * first argument. It may be @c NULL for some message types.
578 * The return value of the progress function is currently ignored, but it may do
579 * something in the future. (Set it to 0 for now.)
581 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
582 const union wimlib_progress_info *info);
584 /** An array of these structures is passed to wimlib_add_image_multisource() to
585 * specify the sources from which to create a WIM image. */
586 struct wimlib_capture_source {
587 /** Absolute or relative path to a file or directory on the external
588 * filesystem to be included in the WIM image. */
589 wimlib_mbchar *fs_source_path;
591 /** Destination path in the WIM image. Leading and trailing slashes are
592 * ignored. The empty string or @c NULL means the root directory of the
594 wimlib_mbchar *wim_target_path;
596 /** Reserved; set to 0. */
601 /*****************************
602 * WIMLIB_ADD_IMAGE_FLAG_* *
603 *****************************/
605 /** Directly capture a NTFS volume rather than a generic directory. This flag
606 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
607 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
608 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
610 /** Follow symlinks; archive and dump the files they point to. Cannot be used
611 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
612 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
614 /** Call the progress function with the message
615 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
617 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
619 /** Mark the image being added as the bootable image of the WIM. */
620 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
622 /** Store the UNIX owner, group, and mode. This is done by adding a special
623 * alternate data stream to each regular file, symbolic link, and directory to
624 * contain this information. Please note that this flag is for convenience
625 * only; Microsoft's version of imagex.exe will not understand this special
626 * information. This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS.
628 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
630 /******************************
631 * WIMLIB_EXPORT_FLAG_* *
632 ******************************/
634 /** See documentation for wimlib_export_image(). */
635 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
637 /******************************
638 * WIMLIB_EXTRACT_FLAG_* *
639 ******************************/
641 /** Extract the image directly to a NTFS volume rather than a generic directory.
643 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
645 /** When identical files are extracted from the WIM, always hard link them
646 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
647 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
649 /** When identical files are extracted from the WIM, always symlink them
650 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
651 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
653 /** Call the progress function with the argument
654 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
655 * extracted. Note: these calls will be interspersed with calls for the message
656 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
657 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
659 /** Read the WIM file sequentially while extracting the image. */
660 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
662 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
663 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
664 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
666 /******************************
667 * WIMLIB_MOUNT_FLAG_* *
668 ******************************/
670 /** Mount the WIM image read-write rather than the default of read-only. */
671 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
673 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
674 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
676 /** Do not allow accessing alternate data streams in the mounted WIM image. */
677 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
679 /** Access alternate data streams in the mounted WIM image through extended file
680 * attributes. This is the default mode. */
681 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
683 /** Access alternate data streams in the mounted WIM image by specifying the
684 * file name, a colon, then the alternate file stream name. */
685 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
687 /** Use UNIX file owners, groups, and modes if available in the WIM (see
688 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
689 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
691 /** Allow other users to see the mounted filesystem. (this passes the @c
692 * allow_other option to FUSE mount) */
693 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
695 /******************************
696 * WIMLIB_OPEN_FLAG_* *
697 ******************************/
699 /** Verify the WIM contents against the WIM's integrity table, if present. */
700 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
702 /** Do not issue an error if the WIM is part of a split WIM. */
703 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
705 /******************************
706 * WIMLIB_UNMOUNT_FLAG_* *
707 ******************************/
709 /** Include an integrity table in the WIM after it's been unmounted. Ignored
710 * for read-only mounts. */
711 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
713 /** Unless this flag is given, changes to a read-write mounted WIM are
714 * discarded. Ignored for read-only mounts. */
715 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
717 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
718 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
720 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
721 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
723 /******************************
724 * WIMLIB_WRITE_FLAG_* *
725 ******************************/
727 /** Include an integrity table in the new WIM file. */
728 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
730 /** Re-build the entire WIM file rather than appending data to it, if possible.
731 * (Applies to wimlib_overwrite(), not wimlib_write()). */
732 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
734 /** Recompress all resources, even if they could otherwise be copied from a
735 * different WIM with the same compression type (in the case of
736 * wimlib_export_image() being called previously). */
737 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
739 /** Call fsync() when the WIM file is closed */
740 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
742 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
743 * after one or more calls to wimlib_delete_image(), which is to rebuild the
746 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
747 * correctly remove the image from the WIM will be taken. In particular, all
748 * streams will be left alone, even if they are no longer referenced. This is
749 * probably not what you want, because almost no space will be spaced by
750 * deleting an image in this way. */
751 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
754 * Possible values of the error code returned by many functions in wimlib.
756 * See the documentation for each wimlib function to see specifically what error
757 * codes can be returned by a given function, and what they mean.
759 /* Note: these are currently in alphabetic order, but new error codes should be
760 * added at the end to maintain a compatible ABI, except when it's being broken
762 enum wimlib_error_code {
763 WIMLIB_ERR_SUCCESS = 0,
764 WIMLIB_ERR_ALREADY_LOCKED,
765 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
766 WIMLIB_ERR_DECOMPRESSION,
767 WIMLIB_ERR_DELETE_STAGING_DIR,
768 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
771 WIMLIB_ERR_FUSERMOUNT,
772 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
773 WIMLIB_ERR_IMAGE_COUNT,
774 WIMLIB_ERR_IMAGE_NAME_COLLISION,
775 WIMLIB_ERR_INTEGRITY,
776 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
777 WIMLIB_ERR_INVALID_CHUNK_SIZE,
778 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
779 WIMLIB_ERR_INVALID_DENTRY,
780 WIMLIB_ERR_INVALID_HEADER_SIZE,
781 WIMLIB_ERR_INVALID_IMAGE,
782 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
783 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
784 WIMLIB_ERR_INVALID_PARAM,
785 WIMLIB_ERR_INVALID_PART_NUMBER,
786 WIMLIB_ERR_INVALID_RESOURCE_HASH,
787 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
788 WIMLIB_ERR_INVALID_SECURITY_DATA,
789 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
790 WIMLIB_ERR_INVALID_UTF8_STRING,
791 WIMLIB_ERR_INVALID_UTF16_STRING,
792 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
798 WIMLIB_ERR_NOT_A_WIM_FILE,
799 WIMLIB_ERR_NO_FILENAME,
807 WIMLIB_ERR_RESOURCE_ORDER,
808 WIMLIB_ERR_SPECIAL_FILE,
809 WIMLIB_ERR_SPLIT_INVALID,
810 WIMLIB_ERR_SPLIT_UNSUPPORTED,
813 WIMLIB_ERR_UNKNOWN_VERSION,
814 WIMLIB_ERR_UNSUPPORTED,
817 WIMLIB_ERR_INVALID_OVERLAY,
818 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
819 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
823 /** Used to indicate that no WIM image or an invalid WIM image. */
824 #define WIMLIB_NO_IMAGE 0
826 /** Used to specify all images in the WIM. */
827 #define WIMLIB_ALL_IMAGES (-1)
830 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
832 * The directory tree of NTFS volume is read immediately for the purpose of
833 * constructing a directory entry tree in-memory. Also, all files are read to
834 * calculate their SHA1 message digests. However, because the directory tree
835 * may contain a very large amount of data, the files themselves are not read
836 * into memory permanently, and instead references to their paths saved. The
837 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
840 * See the manual page for the @c imagex program for more information about the
841 * "normal" capture mode versus the NTFS capture mode (entered by providing the
842 * flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
844 * Note that @b no changes are committed to the underlying WIM file (if
845 * any) until wimlib_write() or wimlib_overwrite() is called.
848 * Pointer to the ::WIMStruct for a WIM file to which the image will be
851 * A path to a directory or unmounted NTFS volume that will be captured as
854 * The name to give the image. This must be non-@c NULL.
856 * Pointer to the contents of an image capture configuration file. If @c
857 * NULL, a default string is used. Please see the manual page for
858 * <b>imagex capture</b> for more information.
860 * Length of the string @a config in bytes, not including an optional
861 * null-terminator. Ignored if @a config is @c NULL.
862 * @param add_image_flags
863 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
864 * @param progress_func
865 * If non-NULL, a function that will be called periodically with the
866 * progress of the current operation.
868 * @return 0 on success; nonzero on error. On error, changes to @a wim are
869 * discarded so that it appears to be in the same state as when this function
872 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
873 * There is already an image named @a name in @a wim.
874 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
875 * @a config was not @c NULL and did not specify a valid image capture
877 * @retval ::WIMLIB_ERR_INVALID_PARAM
878 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
879 * @retval ::WIMLIB_ERR_NOMEM
880 * Failed to allocate needed memory.
881 * @retval ::WIMLIB_ERR_NOTDIR
882 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
883 * not specified in @a add_image_flags).
884 * @retval ::WIMLIB_ERR_NTFS_3G
885 * An error was returned from a libntfs-3g function when the NTFS volume
886 * was being opened, scanned, or closed (only if
887 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
888 * @retval ::WIMLIB_ERR_OPEN
889 * Failed to open a file or directory in the directory tree rooted at @a
890 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
892 * @retval ::WIMLIB_ERR_READ
893 * Failed to read a file in the directory tree rooted at @a source (only if
894 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
895 * @retval ::WIMLIB_ERR_SPECIAL_FILE
896 * The directory tree rooted at @a source contains a special file that is
897 * not a directory, regular file, or symbolic link. This currently can
898 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
899 * add_image_flags, but it may be returned for unsupported NTFS files in
901 * @retval ::WIMLIB_ERR_STAT
902 * Failed obtain the metadata for a file or directory in the directory tree
903 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
904 * specified in @a add_image_flags).
905 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
906 * @a wim is part of a split WIM. Adding an image to a split WIM is
908 * @retval ::WIMLIB_ERR_UNSUPPORTED
909 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
910 * wimlib was configured with the @c --without-ntfs-3g flag.
913 wimlib_add_image(WIMStruct *wim, const wimlib_mbchar *source,
914 const wimlib_utf8char *name,
915 const wimlib_mbchar *config,
916 size_t config_len, int add_image_flags,
917 wimlib_progress_func_t progress_func);
919 /** This function is equivalent to wimlib_add_image() except it allows for
920 * multiple sources to be combined into a single WIM image. This is done by
921 * specifying the @a sources and @a num_sources parameters instead of the @a
922 * source parameter of wimlib_add_image(). The rest of the parameters are the
923 * same as wimlib_add_image(). See the documentation for <b>imagex capture</b>
924 * for full details on how this mode works.
926 * Additional note: @a sources is not a @c const parameter and you cannot
927 * assume that its contents are valid after this function returns. You must
928 * save pointers to the strings in these structures if you need to free them
929 * later, and/or save copies if needed.
931 * In addition to the error codes that wimlib_add_image() can return,
932 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
933 * when trying to overlay a non-directory on a directory or when otherwise
934 * trying to overlay multiple conflicting files to the same location in the WIM
935 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
936 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
937 * was not exactly one capture source with the target being the root directory.
938 * (In this respect, there is no advantage to using
939 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
942 wimlib_add_image_multisource(WIMStruct *w,
943 struct wimlib_capture_source *sources,
945 const wimlib_utf8char *name,
946 const wimlib_mbchar *config_str,
949 wimlib_progress_func_t progress_func);
952 * Creates a ::WIMStruct for a new WIM file.
954 * This only creates an in-memory structure for a WIM that initially contains no
955 * images. No on-disk file is created until wimlib_write() is called.
958 * The type of compression to be used in the new WIM file. Must be
959 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
960 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
962 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
963 * written to the memory location pointed to by this paramater. The
964 * ::WIMStruct must be freed using using wimlib_free() when finished with
966 * @return 0 on success; nonzero on error.
967 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
968 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
969 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
970 * @retval ::WIMLIB_ERR_NOMEM
971 * Failed to allocate needed memory.
974 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
977 * Deletes an image, or all images, from a WIM file.
979 * All streams referenced by the image(s) being deleted are removed from the
980 * lookup table of the WIM if they are not referenced by any other images in the
983 * Please note that @b no changes are committed to the underlying WIM file (if
984 * any) until wimlib_write() or wimlib_overwrite() is called.
987 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
990 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
992 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
993 * to be left unmodified only if @a image specified a single image. If instead
994 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
995 * possible for some but not all of the images to have been deleted when a
996 * failure status is returned.
998 * @retval ::WIMLIB_ERR_DECOMPRESSION
999 * Could not decompress the metadata resource for @a image.
1000 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1001 * A directory entry in the metadata resource for @a image in the WIM is
1003 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1004 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1005 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1006 * The metadata resource for @a image in the WIM is invalid.
1007 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1008 * The security data for @a image in the WIM is invalid.
1009 * @retval ::WIMLIB_ERR_NOMEM
1010 * Failed to allocate needed memory.
1011 * @retval ::WIMLIB_ERR_READ
1012 * Could not read the metadata resource for @a image from the WIM.
1013 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1014 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1018 wimlib_delete_image(WIMStruct *wim, int image);
1021 * Exports an image, or all the images, from a WIM file, into another WIM file.
1023 * The destination image is made to share the same dentry tree and security data
1024 * structure as the source image. This places some restrictions on additional
1025 * functions that may be called. wimlib_mount_image() may not be called on
1026 * either the source image or the destination image without an intervening call
1027 * to a function that un-shares the images, such as wimlib_free() on @a
1028 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1029 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1030 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1031 * have references back to @a src_wim.
1033 * Previous versions of this function left @a dest_wim in an indeterminate state
1034 * on failure. This is no longer the case; all changes to @a dest_wim made by
1035 * this function are rolled back on failure.
1037 * Previous versions of this function did not allow exporting an image that had
1038 * been added by wimlib_add_image(). This is no longer the case; you may now
1039 * export an image regardless of how it was added.
1041 * Regardless of whether this function succeeds or fails, no changes are made to
1044 * Please note that no changes are committed to the underlying WIM file of @a
1045 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1048 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1049 * WIM that contains the image(s) being exported.
1051 * The image to export from @a src_wim. Can be the number of an image, or
1052 * ::WIMLIB_ALL_IMAGES to export all images.
1054 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1057 * The name to give the exported image in the new WIM file. If left @c
1058 * NULL, the name from @a src_wim is used. This parameter must be left @c
1059 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1060 * than one image; in that case, the names are all taken from the @a
1061 * src_wim. (This is allowed even if one or more images being exported has
1063 * @param dest_description
1064 * The description to give the exported image in the new WIM file. If left
1065 * @c NULL, the description from the @a src_wim is used. This parameter must
1066 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1067 * more than one image; in that case, the descriptions are all taken from
1068 * @a src_wim. (This is allowed even if one or more images being exported
1069 * has no description.)
1070 * @param export_flags
1071 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1072 * bootable, or 0 if which image is marked as bootable in the destination
1073 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1074 * there are multiple images in @a src_wim, specifying
1075 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1076 * currently marked as bootable in @a src_wim; if that is the case, then
1077 * that image is marked as bootable in the destination WIM.
1078 * @param additional_swms
1079 * Array of pointers to the ::WIMStruct for each additional part in the
1080 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1081 * need to be in any particular order, but they must include all parts of
1082 * the split WIM other than the first part, which must be provided in the
1084 * @param num_additional_swms
1085 * Number of additional WIM parts provided in the @a additional_swms array.
1086 * This number should be one less than the total number of parts in the
1087 * split WIM. Set to 0 if the WIM is a standalone WIM.
1088 * @param progress_func
1089 * If non-NULL, a function that will be called periodically with the
1090 * progress of the current operation.
1092 * @return 0 on success; nonzero on error.
1093 * @retval ::WIMLIB_ERR_DECOMPRESSION
1094 * Could not decompress the metadata resource for @a src_image
1096 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1097 * One or more of the names being given to an exported image was already in
1098 * use in the destination WIM.
1099 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1100 * A directory entry in the metadata resource for @a src_image in @a
1101 * src_wim is invalid.
1102 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1103 * @a src_image does not exist in @a src_wim.
1104 * @retval ::WIMLIB_ERR_INVALID_PARAM
1105 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1106 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1107 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1108 * dest_description were non-<code>NULL</code>, @a src_image was
1109 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1110 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1111 * The metadata resource for @a src_image in @a src_wim is invalid.
1112 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1113 * The security data for @a src_image in @a src_wim is invalid.
1114 * @retval ::WIMLIB_ERR_NOMEM
1115 * Failed to allocate needed memory.
1116 * @retval ::WIMLIB_ERR_READ
1117 * Could not read the metadata resource for @a src_image from @a src_wim.
1118 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1119 * The source WIM is a split WIM, but the parts specified do not form a
1120 * complete split WIM because they do not include all the parts of the
1121 * original WIM, there are duplicate parts, or not all the parts have the
1122 * same GUID and compression type.
1123 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1124 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1128 wimlib_export_image(WIMStruct *src_wim, int src_image,
1129 WIMStruct *dest_wim,
1130 const wimlib_utf8char *dest_name,
1131 const wimlib_utf8char *dest_description,
1133 WIMStruct **additional_swms,
1134 unsigned num_additional_swms,
1135 wimlib_progress_func_t progress_func);
1138 * Extracts an image, or all images, from a standalone or split WIM file to a
1139 * directory or a NTFS volume.
1141 * Please see the manual page for the @c imagex program for more information
1142 * about the "normal" extraction mode versus the NTFS extraction mode
1143 * (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1145 * Extraction is done with one thread.
1147 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1148 * returned if any resulting SHA1 message digests do not match the values
1149 * provided in the WIM file. Therefore, if this function is successful, you can
1150 * be fairly sure that any compressed data in the WIM was uncompressed
1154 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1157 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1158 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1159 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1161 * Directory to extract the WIM image(s) to (created if it does not already
1162 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1163 * path to the unmounted NTFS volume to extract the image to.
1164 * @param extract_flags
1165 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1167 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1168 * a NTFS volume to extract the image to. The volume will be opened using
1169 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1170 * Otherwise, @a target is interpreted as a directory to extract the
1173 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1174 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1175 * specified. These flags cause extracted files that are identical to be
1176 * hardlinked or symlinked together, depending on the flag. These flags
1177 * override the hard link groups that are specified in the WIM file itself.
1178 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1179 * hardlinked or symlinked across images if a file is found to occur in
1180 * more than one image.
1182 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1183 * name of each file or directory as it is extracted.
1185 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1186 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1187 * each image is considered separately with regards to the sequential
1188 * order. It is also possible for alternate data streams to break the
1189 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1191 * @param additional_swms
1192 * Array of pointers to the ::WIMStruct for each additional part in the
1193 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1194 * need to be in any particular order, but they must include all parts of
1195 * the split WIM other than the first part, which must be provided in the
1197 * @param num_additional_swms
1198 * Number of additional WIM parts provided in the @a additional_swms array.
1199 * This number should be one less than the total number of parts in the
1200 * split WIM. Set to 0 if the WIM is a standalone WIM.
1202 * @param progress_func
1203 * If non-NULL, a function that will be called periodically with the
1204 * progress of the current operation.
1206 * @return 0 on success; nonzero on error.
1207 * @retval ::WIMLIB_ERR_DECOMPRESSION
1208 * Could not decompress a resource (file or metadata) for @a image in @a
1210 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1211 * A directory entry in the metadata resource for @a image in @a wim is
1213 * @retval ::WIMLIB_ERR_INVALID_PARAM
1214 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1215 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1216 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1217 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1218 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1219 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1220 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1221 * specified in @a extract_flag.
1222 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1223 * The SHA1 message digest of an extracted stream did not match the SHA1
1224 * message digest given in the WIM file.
1225 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1226 * A resource (file or metadata) for @a image in @a wim is invalid.
1227 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1228 * The security data for @a image in @a wim is invalid.
1229 * @retval ::WIMLIB_ERR_LINK
1230 * Failed to create a symbolic link or a hard link (only if
1231 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1232 * @retval ::WIMLIB_ERR_MKDIR
1233 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1234 * not specified in @a extract_flags).
1235 * @retval ::WIMLIB_ERR_NOMEM
1236 * Failed to allocate needed memory.
1237 * @retval ::WIMLIB_ERR_NTFS_3G
1238 * An error was returned from a libntfs-3g function while the WIM image was
1239 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1240 * was specified in @a extract_flags).
1241 * @retval ::WIMLIB_ERR_OPEN
1242 * Could not open one of the files being extracted for writing (only if
1243 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1244 * @retval ::WIMLIB_ERR_READ
1245 * A unexpected end-of-file or read error occurred when trying to read data
1246 * from the WIM file associated with @a wim.
1247 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1248 * The WIM is a split WIM, but the parts specified do not form a complete
1249 * split WIM because they do not include all the parts of the original WIM,
1250 * there are duplicate parts, or not all the parts have the same GUID and
1252 * @retval ::WIMLIB_ERR_UNSUPPORTED
1253 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1254 * was configured with the @c --without-ntfs-3g flag.
1255 * @retval ::WIMLIB_ERR_WRITE
1256 * Failed to write a file being extracted (only if
1257 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1260 wimlib_extract_image(WIMStruct *wim, int image,
1261 const wimlib_mbchar *target,
1263 WIMStruct **additional_swms,
1264 unsigned num_additional_swms,
1265 wimlib_progress_func_t progress_func);
1268 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1269 * includes a string of XML that describes the images contained in the WIM.
1270 * This function works on standalone WIMs as well as split WIM parts.
1273 * Pointer to the ::WIMStruct for a WIM file.
1275 * @c stdout, or a FILE* opened for writing, to extract the data to.
1277 * @return 0 on success; nonzero on error.
1278 * @retval ::WIMLIB_ERR_WRITE
1279 * Failed to completely write the XML data to @a fp.
1280 * @retval ::WIMLIB_ERR_INVALID_PARAM
1281 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1284 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1287 * Frees all memory allocated for a WIMStruct and closes all files associated
1291 * Pointer to the ::WIMStruct for a WIM file.
1293 * @return This function has no return value.
1296 wimlib_free(WIMStruct *wim);
1299 * Returns the index of the bootable image of the WIM.
1302 * Pointer to the ::WIMStruct for a WIM file.
1305 * 0 if no image is marked as bootable, or the number of the image marked
1306 * as bootable (numbered starting at 1).
1309 wimlib_get_boot_idx(const WIMStruct *wim);
1312 * Returns the compression type used in the WIM.
1315 * Pointer to the ::WIMStruct for a WIM file
1318 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1319 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1322 wimlib_get_compression_type(const WIMStruct *wim);
1325 * Converts a ::wimlib_compression_type value into a string.
1328 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1329 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1332 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1335 extern const wimlib_mbchar *
1336 wimlib_get_compression_type_string(int ctype);
1339 * Converts an error code into a string describing it.
1342 * The error code returned by one of wimlib's functions.
1345 * Pointer to a statically allocated string describing the error code,
1346 * or @c NULL if the error code is not valid.
1348 extern const wimlib_mbchar *
1349 wimlib_get_error_string(enum wimlib_error_code code);
1352 * Returns the description of the specified image.
1355 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1356 * standalone WIM or a split WIM part.
1358 * The number of the image, numbered starting at 1.
1361 * The description of the image, or @c NULL if there is no such image, or
1362 * @c NULL if the specified image has no description. The description
1363 * string is in library-internal memory and may not be modified or freed;
1364 * in addition, the string will become invalid if the description of the
1365 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1367 extern const wimlib_utf8char *
1368 wimlib_get_image_description(const WIMStruct *wim, int image);
1371 * Returns the name of the specified image.
1374 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1375 * standalone WIM or a split WIM part.
1377 * The number of the image, numbered starting at 1.
1380 * The name of the image, or @c NULL if there is no such image. The name
1381 * string is in library-internal memory and may not be modified or freed;
1382 * in addition, the string will become invalid if the name of the image is
1383 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1385 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1386 * the WIM to be unnamed, in which case an empty string will be returned
1387 * when the corresponding name is requested.
1389 extern const wimlib_utf8char *
1390 wimlib_get_image_name(const WIMStruct *wim, int image);
1394 * Returns the number of images contained in a WIM.
1397 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1398 * standalone WIM or a split WIM part.
1401 * The number of images contained in the WIM file.
1404 wimlib_get_num_images(const WIMStruct *wim);
1407 * Returns the part number of a WIM in a split WIM and the total number of parts
1411 * Pointer to the ::WIMStruct for a WIM file.
1412 * @param total_parts_ret
1413 * If non-@c NULL, the total number of parts in the split WIM (1 for
1414 * non-split WIMs) is written to this location.
1417 * The part number of the WIM (1 for non-split WIMs)
1420 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1423 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1424 * re-entrant. If you are calling wimlib functions concurrently in different
1425 * threads, then you must call this function serially first. Also, since wimlib
1426 * 1.3.0, you must call this function if the character encoding of the current
1427 * locale is not UTF-8. Otherwise, calling this function this function is not
1430 * This function always returns 0.
1433 wimlib_global_init();
1436 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1437 * You are not required to call this function, but it will release any global
1438 * memory allocated by the library.
1441 wimlib_global_cleanup();
1444 * Returns true if the WIM has an integrity table.
1447 * Pointer to the ::WIMStruct for a WIM file.
1449 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1450 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1451 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1452 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1455 wimlib_has_integrity_table(const WIMStruct *wim);
1458 * Determines if an image name is already used by some image in the WIM.
1461 * Pointer to the ::WIMStruct for a WIM file.
1463 * The name to check.
1466 * @c true if there is already an image in @a wim named @a name; @c false
1467 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1468 * the empty string, @c false is returned.
1471 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_utf8char *name);
1474 * Joins a split WIM into a stand-alone one-part WIM.
1477 * An array of strings that gives the filenames of all parts of the split
1478 * WIM. No specific order is required, but all parts must be included with
1481 * Number of filenames in @a swms.
1482 * @param swm_open_flags
1483 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1484 * part should be verified, if integrity tables are present. Otherwise,
1486 * @param wim_write_flags
1487 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1488 * @param output_path
1489 * The path to write the one-part WIM to.
1490 * @param progress_func
1491 * If non-NULL, a function that will be called periodically with the
1492 * progress of the current operation.
1494 * @return 0 on success; nonzero on error. This function may return any value
1495 * returned by wimlib_open_wim() and wimlib_write() except
1496 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1498 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1499 * The split WIMs do not form a valid WIM because they do not include all
1500 * the parts of the original WIM, there are duplicate parts, or not all the
1501 * parts have the same GUID and compression type.
1503 * Note: the WIM's uncompressed and compressed resources are not checksummed
1504 * when they are copied from the split WIM parts to the joined WIM, nor are
1505 * compressed resources re-compressed.
1507 * Note: wimlib_export_image() can provide similar functionality to
1508 * wimlib_join(), since it is possible to export all images from a split WIM.
1511 wimlib_join(const wimlib_mbchar * const *swms,
1513 const wimlib_mbchar *output_path,
1515 int wim_write_flags,
1516 wimlib_progress_func_t progress_func);
1519 * Mounts an image in a WIM file on a directory read-only or read-write.
1521 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1522 * process shall be daemonized.
1524 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1525 * modifications to the WIM are staged in a temporary directory.
1527 * It is safe to mount multiple images from the same WIM file read-only at the
1528 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1529 * to mount multiple images from the same WIM file read-write at the same time.
1531 * wimlib_mount_image() cannot be used on an image that was exported with
1532 * wimlib_export_image() while the dentry trees for both images are still in
1533 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1534 * that has just been added with wimlib_add_image(), unless the WIM has been
1535 * written and read into a new ::WIMStruct.
1538 * Pointer to the ::WIMStruct containing the image to be mounted.
1540 * The number of the image to mount, indexed starting from it. It must be
1541 * an existing, single image.
1543 * The path to an existing empty directory to mount the image on.
1544 * @param mount_flags
1545 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1547 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1548 * rather than the default of read-only.
1550 * WIMs may contain named (alternate) data streams, which are a somewhat
1551 * obscure NTFS feature. They can be read and written on a mounted WIM
1552 * through one of several interfaces. The interface to use if specified by
1553 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1554 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1555 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1556 * the XATTR interface.
1557 * @param additional_swms
1558 * Array of pointers to the ::WIMStruct for each additional part in the
1559 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1560 * need to be in any particular order, but they must include all parts of
1561 * the split WIM other than the first part, which must be provided in the
1563 * @param num_additional_swms
1564 * Number of additional WIM parts provided in the @a additional_swms array.
1565 * This number should be one less than the total number of parts in the
1566 * split WIM. Set to 0 if the WIM is a standalone WIM.
1567 * @param staging_dir
1568 * If non-NULL, the name of a directory in which the staging directory will
1569 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1570 * in @a mount_flags. If left @c NULL, the staging directory is created in
1571 * the same directory as the WIM file that @a wim was originally read from.
1573 * @return 0 on success; nonzero on error.
1575 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1576 * A read-write mount was requested, but an an exclusive advisory lock on
1577 * the on-disk WIM file could not be acquired because another thread or
1578 * process has mounted an image from the WIM read-write or is currently
1579 * modifying the WIM in-place.
1580 * @retval ::WIMLIB_ERR_DECOMPRESSION
1581 * Could not decompress the metadata resource for @a image in @a wim.
1582 * @retval ::WIMLIB_ERR_FUSE
1583 * A non-zero status was returned by @c fuse_main().
1584 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1585 * A directory entry in the metadata resource for @a image in @a wim is
1587 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1588 * @a image does not specify an existing, single image in @a wim.
1589 * @retval ::WIMLIB_ERR_INVALID_PARAM
1590 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1591 * wimlib_export_image(), or @a image has been added with
1592 * wimlib_add_image().
1593 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1594 * The metadata resource for @a image in @a wim is invalid.
1595 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1596 * The security data for @a image in @a wim is invalid.
1597 * @retval ::WIMLIB_ERR_MKDIR
1598 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1599 * staging directory could not be created.
1600 * @retval ::WIMLIB_ERR_NOMEM
1601 * Failed to allocate needed memory.
1602 * @retval ::WIMLIB_ERR_NOTDIR
1603 * Could not determine the current working directory.
1604 * @retval ::WIMLIB_ERR_READ
1605 * An unexpected end-of-file or read error occurred when trying to read
1606 * data from the WIM file associated with @a wim.
1607 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1608 * The WIM is a split WIM, but the parts specified do not form a complete
1609 * split WIM because they do not include all the parts of the original WIM,
1610 * there are duplicate parts, or not all the parts have the same GUID and
1612 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1613 * The WIM is a split WIM and a read-write mount was requested. We only
1614 * support mounting a split WIM read-only.
1617 wimlib_mount_image(WIMStruct *wim, int image, const wimlib_mbchar *dir,
1618 int mount_flags, WIMStruct **additional_swms,
1619 unsigned num_additional_swms,
1620 const wimlib_mbchar *staging_dir);
1623 * Opens a WIM file and creates a ::WIMStruct for it.
1626 * The path to the WIM file to open.
1628 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1629 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1631 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1632 * the WIM, if it exists, is checked, and this function will fail with an
1633 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1634 * digests of the WIM do not exactly match the corresponding message
1635 * digests given in the integrity table.
1637 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1638 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1639 * returned. (This flag may be removed in the future, in which case no
1640 * error will be issued when opening a split WIM.)
1642 * @param progress_func
1643 * If non-NULL, a function that will be called periodically with the
1644 * progress of the current operation.
1647 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1648 * is written to the memory location pointed to by this parameter. The
1649 * ::WIMStruct must be freed using using wimlib_free() when finished with
1652 * @return 0 on success; nonzero on error.
1653 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1654 * The lookup table of @a wim_file is compressed. Support for this can be
1655 * added to wimlib if needed, but it appears to be the case that the lookup
1656 * table is never compressed.
1657 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1658 * The WIM is not the non-first part of a split WIM, and the number of
1659 * metadata resources found in the WIM did not match the image count given
1660 * in the WIM header, or the number of <IMAGE> elements in the XML
1661 * data for the WIM did not match the image count given in the WIM header.
1662 * @retval ::WIMLIB_ERR_INTEGRITY
1663 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1664 * wim_file contains an integrity table, but the SHA1 message digest for a
1665 * chunk of the WIM does not match the corresponding message digest given
1666 * in the integrity table.
1667 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1668 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1669 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1670 * The header of @a wim_file says that resources in the WIM are compressed,
1671 * but the header flag indicating LZX or XPRESS compression is not set.
1672 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1673 * The length field of the WIM header is not 208.
1674 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1675 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1676 * wim_file contains an integrity table, but the integrity table is
1678 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1679 * The lookup table for the WIM contained duplicate entries that are not
1680 * for metadata resources, or it contained an entry with a SHA1 message
1681 * digest of all 0's.
1682 * @retval ::WIMLIB_ERR_NOMEM
1683 * Failed to allocated needed memory.
1684 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1685 * @a wim_file does not begin with the expected magic characters.
1686 * @retval ::WIMLIB_ERR_OPEN
1687 * Failed to open the file @a wim_file for reading.
1688 * @retval ::WIMLIB_ERR_READ
1689 * An unexpected end-of-file or read error occurred when trying to read
1690 * data from @a wim_file.
1691 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1692 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1693 * specified in @a open_flags.
1694 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1695 * A number other than 0x10d00 is written in the version field of the WIM
1696 * header of @a wim_file. (Probably a pre-Vista WIM).
1697 * @retval ::WIMLIB_ERR_XML
1698 * The XML data for @a wim_file is invalid.
1701 wimlib_open_wim(const wimlib_mbchar *wim_file, int open_flags,
1702 WIMStruct **wim_ret, wimlib_progress_func_t progress_func);
1705 * Overwrites the file that the WIM was originally read from, with changes made.
1706 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1707 * rather than wimlib_create_new_wim().
1709 * There are two ways that a WIM may be overwritten. The first is to do a full
1710 * rebuild. In this mode, the new WIM is written to a temporary file and then
1711 * renamed to the original file after it is has been completely written. The
1712 * temporary file is made in the same directory as the original WIM file. A
1713 * full rebuild may take a while, but can be used even if images have been
1714 * modified or deleted, will produce a WIM with no holes, and has little chance
1715 * of unintentional data loss because the temporary WIM is fsync()ed before
1716 * being renamed to the original WIM.
1718 * The second way to overwrite a WIM is by appending to the end of it and
1719 * overwriting the header. This can be much faster than a full rebuild, but it
1720 * only works if the only operations on the WIM have been to change the header
1721 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1722 * with writing any new file resources *after* everything in the old WIM, even
1723 * though this will leave a hole where the old lookup table, XML data, and
1724 * integrity were. This is done so that the WIM remains valid even if the
1725 * operation is aborted mid-write. The WIM header is only overwritten at the
1726 * very last moment, and up until that point the WIM will be seen as the old
1729 * By default, the overwrite mode is determine automatically based on the past
1730 * operations performed on the ::WIMStruct. Use the flag
1731 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1732 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1733 * images have been deleted from the WIM.
1735 * In the temporary-file overwrite mode, no changes are made to the WIM on
1736 * failure, and the temporary file is deleted if possible. Abnormal termination
1737 * of the program will result in the temporary file being orphaned. In the
1738 * direct append mode, the WIM is truncated to the original length on failure;
1739 * and while abnormal termination of the program will result in extra data
1740 * appended to the original WIM, it should still be a valid WIM.
1743 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1744 * been in-memory changes made to it, which are then reflected in the
1746 * @param write_flags
1747 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1748 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1749 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1750 * @param num_threads
1751 * Number of threads to use for compression (see wimlib_write()).
1752 * @param progress_func
1753 * If non-NULL, a function that will be called periodically with the
1754 * progress of the current operation.
1756 * @return 0 on success; nonzero on error. This function may return any value
1757 * returned by wimlib_write() as well as the following error codes:
1758 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1759 * The WIM was going to be modifien in-place (with no temporary file), but
1760 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1761 * because another thread or process has mounted an image from the WIM
1762 * read-write or is currently modifying the WIM in-place.
1763 * @retval ::WIMLIB_ERR_NO_FILENAME
1764 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1765 * than a WIM read with wimlib_open_wim().
1766 * @retval ::WIMLIB_ERR_RENAME
1767 * The temporary file that the WIM was written to could not be renamed to
1768 * the original filename of @a wim.
1769 * @retval ::WIMLIB_ERR_REOPEN
1770 * The WIM was overwritten successfully, but it could not be re-opened
1771 * read-only. Therefore, the resources in the WIM can no longer be
1772 * accessed, so this limits the functions that can be called on @a wim
1773 * before calling wimlib_free().
1776 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
1777 wimlib_progress_func_t progress_func);
1780 * Prints information about one image, or all images, contained in a WIM.
1783 * Pointer to the ::WIMStruct for a WIM file.
1785 * The image about which to print information. Can be the number of an
1786 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1789 * @return This function has no return value. No error checking is done when
1790 * printing the information. If @a image is invalid, an error message is
1794 wimlib_print_available_images(const WIMStruct *wim, int image);
1797 * Prints the full paths to all files contained in an image, or all images, in a
1801 * Pointer to the ::WIMStruct for a WIM file.
1803 * Which image to print files for. Can be the number of an image, or
1804 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
1806 * @return 0 on success; nonzero on error.
1807 * @retval ::WIMLIB_ERR_DECOMPRESSION
1808 * The metadata resource for one of the specified images could not be
1810 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1811 * A directory entry in the metadata resource for one of the specified
1812 * images is invaled.
1813 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1814 * @a image does not specify a valid image in @a wim, and is not
1815 * ::WIMLIB_ALL_IMAGES.
1816 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1817 * The metadata resource for one of the specified images is invalid.
1818 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1819 * The security data for one of the specified images is invalid.
1820 * @retval ::WIMLIB_ERR_NOMEM
1821 * Failed to allocate needed memory.
1822 * @retval ::WIMLIB_ERR_READ
1823 * An unexpected read error or end-of-file occurred when reading the
1824 * metadata resource for one of the specified images.
1825 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1826 * @a wim was not a standalone WIM and was not the first part of a split
1830 wimlib_print_files(WIMStruct *wim, int image);
1833 * Prints detailed information from the header of a WIM file.
1836 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1837 * standalone WIM or part of a split WIM.
1839 * @return This function has no return value.
1843 wimlib_print_header(const WIMStruct *wim);
1846 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1847 * digests, as found in the directory entry tree in the WIM file, to file
1848 * resources in the WIM file. This table includes one entry for each unique
1849 * file in the WIM, so it can be quite long. There is only one lookup table per
1850 * WIM file, but each split WIM part has its own lookup table.
1853 * Pointer to the ::WIMStruct for a WIM file.
1855 * @return This function has no return value.
1858 wimlib_print_lookup_table(WIMStruct *wim);
1861 * Prints the metadata of the specified image in a WIM file. The metadata
1862 * consists of the security data as well as the directory entry tree. Each
1863 * image has its own metadata.
1866 * Pointer to the ::WIMStruct for a WIM file.
1868 * Which image to print the metadata for. Can be the number of an image,
1869 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
1871 * @return 0 on success; nonzero on error.
1872 * @retval ::WIMLIB_ERR_DECOMPRESSION
1873 * The metadata resource for one of the specified images could not be
1875 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1876 * A directory entry in the metadata resource for one of the specified
1877 * images is invaled.
1878 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1879 * @a image does not specify a valid image in @a wim, and is not
1880 * ::WIMLIB_ALL_IMAGES.
1881 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1882 * The metadata resource for one of the specified images is invalid.
1883 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1884 * The security data for one of the specified images is invalid.
1885 * @retval ::WIMLIB_ERR_NOMEM
1886 * Failed to allocate needed memory.
1887 * @retval ::WIMLIB_ERR_READ
1888 * An unexpected read error or end-of-file occurred when reading the
1889 * metadata resource for one of the specified images.
1890 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1891 * @a wim was not a standalone WIM and was not the first part of a split
1895 wimlib_print_metadata(WIMStruct *wim, int image);
1898 * Prints some basic information about a WIM file. All information printed by
1899 * this function is also printed by wimlib_print_header(), but
1900 * wimlib_print_wim_information() prints some of this information more concisely
1901 * and in a more readable form.
1904 * Pointer to the ::WIMStruct for a WIM file.
1906 * @return This function has no return value.
1909 wimlib_print_wim_information(const WIMStruct *wim);
1912 * Translates a string specifying the name or number of an image in the WIM into
1913 * the number of the image. The images are numbered starting at 1.
1916 * Pointer to the ::WIMStruct for a WIM file.
1917 * @param image_name_or_num
1918 * A string specifying the name or number of an image in the WIM. If it
1919 * parses to a positive integer, this integer is taken to specify the
1920 * number of the image, indexed starting at 1. Otherwise, it is taken to
1921 * be the name of an image, as given in the XML data for the WIM file. It
1922 * also may be the keyword "all" or the string "*", both of which will
1923 * resolve to ::WIMLIB_ALL_IMAGES.
1925 * There is no way to search for an image actually named "all", "*", or an
1926 * integer number, or an image that has no name. However, you can use
1927 * wimlib_get_image_name() to get the name of any image.
1930 * If the string resolved to a single existing image, the number of that
1931 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
1932 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
1933 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
1934 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
1935 * images in @a wim has no name.
1938 wimlib_resolve_image(WIMStruct *wim,
1939 const wimlib_utf8char *image_name_or_num);
1942 * Sets which image in the WIM is marked as bootable.
1945 * Pointer to the ::WIMStruct for a WIM file.
1947 * The number of the image to mark as bootable, or 0 to mark no image as
1949 * @return 0 on success; nonzero on error.
1950 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1951 * @a boot_idx does not specify an existing image in @a wim, and it was not
1953 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1954 * @a wim is part of a split WIM. We do not support changing the boot
1955 * index of a split WIM.
1958 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1961 * Changes the description of an image in the WIM.
1964 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1965 * standalone WIM or part of a split WIM; however, you should set the same
1966 * description on all parts of a split WIM.
1968 * The number of the image for which to change the description.
1969 * @param description
1970 * The new description to give the image. It may be @c NULL, which
1971 * indicates that the image is to be given no description.
1973 * @return 0 on success; nonzero on error.
1974 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1975 * @a image does not specify a single existing image in @a wim.
1976 * @retval ::WIMLIB_ERR_NOMEM
1977 * Failed to allocate the memory needed to duplicate the @a description
1981 wimlib_set_image_descripton(WIMStruct *wim, int image,
1982 const wimlib_utf8char *description);
1985 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1986 * (something like "Core" or "Ultimate")
1989 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1990 * standalone WIM or part of a split WIM; however, you should set the same
1991 * \<FLAGS\> element on all parts of a split WIM.
1993 * The number of the image for which to change the description.
1995 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1996 * indicates that the image is to be given no \<FLAGS\> element.
1998 * @return 0 on success; nonzero on error.
1999 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2000 * @a image does not specify a single existing image in @a wim.
2001 * @retval ::WIMLIB_ERR_NOMEM
2002 * Failed to allocate the memory needed to duplicate the @a flags string.
2004 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2005 const wimlib_utf8char *flags);
2008 * Changes the name of an image in the WIM.
2011 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2012 * standalone WIM or part of a split WIM; however, you should set the same
2013 * name on all parts of a split WIM.
2015 * The number of the image for which to change the name.
2017 * The new name to give the image. It must be a nonempty string.
2019 * @return 0 on success; nonzero on error.
2020 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2021 * There is already an image named @a name in @a wim.
2022 * @retval ::WIMLIB_ERR_INVALID_PARAM
2023 * @a name was @c NULL or the empty string.
2024 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2025 * @a image does not specify a single existing image in @a wim.
2026 * @retval ::WIMLIB_ERR_NOMEM
2027 * Failed to allocate the memory needed to duplicate the @a name string.
2029 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2030 const wimlib_utf8char *name);
2033 * Set the functions that wimlib uses to allocate and free memory.
2035 * These settings are global and not per-WIM.
2037 * The default is to use the default @c malloc() and @c free() from the C
2040 * Please note that some external functions, such as those in @c libntfs-3g, may
2041 * use the standard memory allocation functions.
2043 * @param malloc_func
2044 * A function equivalent to @c malloc() that wimlib will use to allocate
2045 * memory. If @c NULL, the allocator function is set back to the default
2046 * @c malloc() from the C library.
2048 * A function equivalent to @c free() that wimlib will use to free memory.
2049 * If @c NULL, the free function is set back to the default @c free() from
2051 * @param realloc_func
2052 * A function equivalent to @c realloc() that wimlib will use to reallocate
2053 * memory. If @c NULL, the free function is set back to the default @c
2054 * realloc() from the C library.
2055 * @return 0 on success; nonzero on error.
2056 * @retval ::WIMLIB_ERR_UNSUPPORTED
2057 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2058 * so custom memory allocators are unsupported.
2061 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2062 void (*free_func)(void *),
2063 void *(*realloc_func)(void *, size_t));
2066 * Sets whether wimlib is to print error messages to @c stderr when a function
2067 * fails. These error messages may provide information that cannot be
2068 * determined only from the error code that is returned. Not every error will
2069 * result in an error message being printed.
2071 * This setting is global and not per-WIM.
2073 * By default, error messages are not printed.
2075 * @param show_messages
2076 * @c true if error messages are to be printed; @c false if error messages
2077 * are not to be printed.
2079 * @return 0 on success; nonzero on error.
2080 * @retval ::WIMLIB_ERR_UNSUPPORTED
2081 * @a show_messages was @c true, but wimlib was compiled with the @c
2082 * --without-error-messages option. Therefore, error messages cannot be
2086 wimlib_set_print_errors(bool show_messages);
2089 * Splits a WIM into multiple parts.
2092 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2095 * Name of the SWM file to create. This will be the name of the first
2096 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2097 * appended before the suffix.
2099 * The maximum size per part, in bytes. It is not guaranteed that this
2100 * will really be the maximum size per part, because some file resources in
2101 * the WIM may be larger than this size, and the WIM file format provides
2102 * no way to split up file resources among multiple WIMs.
2103 * @param write_flags
2104 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2105 * included in the split WIM parts.
2106 * @param progress_func
2107 * If non-NULL, a function that will be called periodically with the
2108 * progress of the current operation.
2110 * @return 0 on success; nonzero on error. This function may return any value
2111 * returned by wimlib_write() as well as the following error codes:
2113 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2114 * @a wim is not part 1 of a stand-alone WIM.
2115 * @retval ::WIMLIB_ERR_INVALID_PARAM
2116 * @a swm_name was @c NULL, or @a part_size was 0.
2118 * Note: the WIM's uncompressed and compressed resources are not checksummed
2119 * when they are copied from the joined WIM to the split WIM parts, nor are
2120 * compressed resources re-compressed.
2123 wimlib_split(WIMStruct *wim, const wimlib_mbchar *swm_name,
2124 size_t part_size, int write_flags,
2125 wimlib_progress_func_t progress_func);
2128 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2130 * The image to unmount is specified by the path to the mountpoint, not the
2131 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2132 * touched and also may have been allocated in a different process.
2134 * To unmount the image, the thread calling this function communicates with the
2135 * thread that is managing the mounted WIM image. This function blocks until it
2136 * is known whether the unmount succeeded or failed. In the case of a
2137 * read-write mounted WIM, the unmount is not considered to have succeeded until
2138 * all changes have been saved to the underlying WIM file.
2141 * The directory that the WIM image was mounted on.
2142 * @param unmount_flags
2143 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2144 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2145 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2147 * @param progress_func
2148 * If non-NULL, a function that will be called periodically with the
2149 * progress of the current operation.
2151 * @return 0 on success; nonzero on error.
2153 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2154 * The filesystem daemon was unable to remove the staging directory and the
2155 * temporary files that it contains.
2156 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2157 * The filesystem daemon appears to have terminated before sending an exit
2159 * @retval ::WIMLIB_ERR_FORK
2160 * Could not @c fork() the process.
2161 * @retval ::WIMLIB_ERR_FUSERMOUNT
2162 * The @b fusermount program could not be executed or exited with a failure
2164 * @retval ::WIMLIB_ERR_MQUEUE
2165 * Could not open a POSIX message queue to communicate with the filesystem
2166 * daemon servicing the mounted filesystem, could not send a message
2167 * through the queue, or could not receive a message through the queue.
2168 * @retval ::WIMLIB_ERR_NOMEM
2169 * Failed to allocate needed memory.
2170 * @retval ::WIMLIB_ERR_OPEN
2171 * The filesystem daemon could not open a temporary file for writing the
2173 * @retval ::WIMLIB_ERR_READ
2174 * A read error occurred when the filesystem daemon tried to a file from
2175 * the staging directory
2176 * @retval ::WIMLIB_ERR_RENAME
2177 * The filesystem daemon failed to rename the newly written WIM file to the
2178 * original WIM file.
2179 * @retval ::WIMLIB_ERR_WRITE
2180 * A write error occurred when the filesystem daemon was writing to the new
2181 * WIM file, or the filesystem daemon was unable to flush changes that had
2182 * been made to files in the staging directory.
2185 wimlib_unmount_image(const wimlib_mbchar *dir, int unmount_flags,
2186 wimlib_progress_func_t progress_func);
2189 * Writes a standalone WIM to a file.
2191 * This brings in resources from any external locations, such as directory trees
2192 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2193 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2196 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2197 * changes made to it, which are then reflected in the output file.
2199 * The path to the file to write the WIM to.
2201 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2203 * @param write_flags
2204 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2205 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2206 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2207 * @param num_threads
2208 * Number of threads to use for compressing data. If 0, the number of
2209 * threads is taken to be the number of online processors. Note: if no
2210 * data compression needs to be done, no additional threads will be created
2211 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2212 * exporting an image from a compressed WIM to another WIM of the same
2213 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2215 * @param progress_func
2216 * If non-NULL, a function that will be called periodically with the
2217 * progress of the current operation.
2219 * @return 0 on success; nonzero on error.
2220 * @retval ::WIMLIB_ERR_DECOMPRESSION
2221 * Failed to decompress a metadata or file resource in @a wim.
2222 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2223 * A directory entry in the metadata resource for @a image in @a wim is
2225 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2226 * @a image does not specify a single existing image in @a wim, and is not
2227 * ::WIMLIB_ALL_IMAGES.
2228 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2229 * A file that had previously been scanned for inclusion in the WIM by
2230 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2231 * message digest check.
2232 * @retval ::WIMLIB_ERR_INVALID_PARAM
2233 * @a path was @c NULL.
2234 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2235 * The metadata resource for @a image in @a wim is invalid.
2236 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2237 * The security data for @a image in @a wim is invalid.
2238 * @retval ::WIMLIB_ERR_NOMEM
2239 * Failed to allocate needed memory.
2240 * @retval ::WIMLIB_ERR_OPEN
2241 * Failed to open @a path for writing, or some file resources in @a
2242 * wim refer to files in the outside filesystem, and one of these files
2243 * could not be opened for reading.
2244 * @retval ::WIMLIB_ERR_READ
2245 * An error occurred when trying to read data from the WIM file associated
2246 * with @a wim, or some file resources in @a wim refer to files in the
2247 * outside filesystem, and a read error occurred when reading one of these
2249 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2250 * @a wim is part of a split WIM. You may not call this function on a
2252 * @retval ::WIMLIB_ERR_WRITE
2253 * An error occurred when trying to write data to the new WIM file at @a
2257 wimlib_write(WIMStruct *wim, const wimlib_mbchar *path, int image,
2258 int write_flags, unsigned num_threads,
2259 wimlib_progress_func_t progress_func);
2261 #endif /* _WIMLIB_H */