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.2. If you
35 * have installed wimlib and want to know how to use the @b wimlib-imagex
36 * program, please see the man pages instead. Also: the actual project page
37 * where you can download the source code for the library is at <a
38 * href="https://sourceforge.net/projects/wimlib">https://sourceforge.net/projects/wimlib</a>.
40 * wimlib is a C library to read, write, and mount archive files in the Windows
41 * Imaging Format (WIM files). These files are normally created using the
42 * ImageX (@a imagex.exe) utility on Windows, but this library provides a free
43 * implementation of ImageX for UNIX-based systems (and, since v1.3.0, for
44 * Windows systems) and an API to allow other programs to read, write, and mount
45 * WIM files. wimlib is comparable to Microsoft's WIMGAPI, but was designed
46 * independently and is not a clone of it.
48 * \section format WIM files
50 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
51 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
52 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
53 * Both are based on LZ77 and Huffman encoding, and both are supported by
56 * Unlike ZIP files, WIM files can contain multiple independent toplevel
57 * directory trees known as @a images. While each image has its own metadata,
58 * files are not duplicated for each image; instead, each file is included only
59 * once in the entire WIM. Microsoft did this so that in one WIM file, they
60 * could do things like have 5 different versions of Windows that are almost
63 * Microsoft provides documentation for the WIM file format, XPRESS compression
64 * format, and LZX compression format. The XPRESS documentation is acceptable,
65 * but the LZX documentation is not entirely correct, and the WIM documentation
66 * itself is incomplete.
68 * A WIM file may be either stand-alone or split into multiple parts.
70 * \section ntfs NTFS support
72 * As of version 1.0.0, wimlib supports capturing and applying images directly
73 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
74 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
75 * data such as security descriptors, alternate data streams, and reparse point
78 * The code for NTFS image capture and image application is complete enough that
79 * it is possible to apply an image from the "install.wim" contained in recent
80 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
81 * NTFS volume, and then boot Windows from it after preparing the Boot
82 * Configuration Data. In addition, a Windows installation can be captured (or
83 * backed up) into a WIM file, and then re-applied later.
85 * wimlib v1.3.0 and later also supports NTFS capture and apply in the native
86 * Windows build, which works slightly differently and relies on native Win32
87 * API calls rather than libntfs-3g.
89 * \section winpe Windows PE
91 * A major use for this library is to create customized images of Windows PE, the
92 * Windows Preinstallation Environment, without having to rely on Windows. Windows
93 * PE is a lightweight version of Windows that can run entirely from memory and can
94 * be used to install Windows from local media or a network drive or perform
95 * maintenance. Windows PE is the operating system that runs when you boot from
96 * the Windows installation media.
98 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
99 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
100 * in the Windows Automated Installation Kit (WAIK), which is free to download
101 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
102 * install either the @c cabextract or @c p7zip programs.
104 * In addition, Windows installations and recovery partitions frequently contain a
105 * WIM containing an image of the Windows Recovery Environment, which is similar to
108 * \section starting Getting Started
110 * wimlib uses the GNU autotools, so it should be easy to install with
111 * <code>configure && make && sudo make install</code>; however, please see the
112 * README for more information about installing it. To use wimlib in a program
113 * after installing it, include @c wimlib.h and link your program with @c -lwim.
115 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
116 * may represent either a stand-alone WIM or one part of a split WIM.
118 * All functions in wimlib's public API are prefixed with @c wimlib. Most
119 * return an integer error code on failure. Use wimlib_get_error_string() to
120 * get a string that describes an error code. wimlib also can print error
121 * messages itself when an error happens, and these may be more informative than
122 * the error code; to enable this, call wimlib_set_print_errors(). Please note
123 * that this is for convenience only, and some errors can occur without a
124 * message being printed.
126 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
127 * the following exceptions:
128 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
129 * - You also must call wimlib_global_init() in the main thread to avoid any
130 * race conditions with one-time allocations of memory.
131 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
132 * concurrently in the same process, will daemonize the entire process when it
133 * does so for the first time. This includes changing the working directory
134 * to the root directory.
136 * To open an existing WIM, use wimlib_open_wim().
138 * To create a new WIM that initially contains no images, use
139 * wimlib_create_new_wim().
141 * To add an image to a WIM file from a directory tree on your filesystem, call
142 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
143 * wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
144 * also capture a WIM image directly from a NTFS volume if you provide the
145 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
146 * the <code>--without-ntfs-3g</code> flag.
148 * To extract an image from a WIM file, call wimlib_extract_image(). You may
149 * extract an image either to a directory or directly to a NTFS volume, the
150 * latter of which will preserve NTFS-specific data such as security
153 * wimlib supports mounting WIM files either read-only or read-write. Mounting
154 * is done using wimlib_mount_image() and unmounting is done using
155 * wimlib_unmount_image(). Mounting can be done without root privileges because
156 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
157 * compiled with the <code>--without-fuse</code> flag, these functions will be
158 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
160 * After creating or modifying a WIM file, you can write it to a file using
161 * wimlib_write(). Alternatively, if the WIM was originally read from a file
162 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
163 * wimlib_overwrite() to overwrite the original file.
165 * Please note: merely by calling wimlib_add_image() or many of the other
166 * functions in this library that operate on ::WIMStruct's, you are @b not
167 * modifying the WIM file on disk. Changes are not saved until you explicitly
168 * call wimlib_write() or wimlib_overwrite().
170 * After you are done with the WIM file, use wimlib_free() to free all memory
171 * associated with a ::WIMStruct and close all files associated with it.
173 * A number of functions take a pointer to a progress function of type
174 * ::wimlib_progress_func_t. This function will be called periodically during
175 * the WIM operation(s) to report on the progress of the operation (for example,
176 * how many bytes have been written so far).
178 * \section imagex wimlib-imagex
180 * wimlib comes with a command-line interface, the @b wimlib-imagex program. It
181 * is documented with man pages. This program was originally just called @b
182 * imagex, but has been changed to @b wimlib-imagex to avoid confusion with
183 * Microsoft's @a imagex.exe (which would otherwise have exactly the same
184 * filename on Windows).
186 * \section mkwinpeimg mkwinpeimg
188 * wimlib also comes with the <b>mkwinpeimg</b> script, which is documented in a
191 * \section encodings Locales and character encodings
193 * To support Windows as well as UNIX, wimlib's API typically takes and returns
194 * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
196 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
197 * and the encoding is UTF-16LE.
199 * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
200 * encoding is the locale-dependent multibyte encoding. I recommend you set your
201 * locale to a UTF-8 capable locale to avoid any issues. Also, by default,
202 * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
203 * wimlib_global_init() after having set your desired locale.
205 * \section Limitations
207 * While wimlib supports the main features of WIM files, wimlib currently has
208 * the following limitations:
209 * - There is no way to add, remove, modify, or extract specific files in a WIM
210 * without mounting it, other than by adding, removing, or extracting an
211 * entire image. The FUSE mount feature should be used for this purpose.
212 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
213 * than wimlib (~2% or 3% smaller) when using maximum (LZX) compression.
214 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
215 * imagex.exe if you want to make sure your WIM files are made "correctly".
216 * - The old WIM format from Vista pre-releases is not supported.
217 * - Compressed resource chunk sizes other than 32768 are not supported,
218 * although this doesn't seem to be a problem because the chunk size always
219 * seems to be this value.
220 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
221 * make certain Windows-specific modifications to a Windows PE image, such as
222 * adding a driver or Windows component. Such a tool could conceivably be
223 * implemented on top of wimlib, although it likely would be hard to implement
224 * because it would have to do very Windows-specific things such as
225 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
226 * script for a similar purpose, however. With regards to adding drivers to
227 * Windows PE, you have the option of putting them anywhere in the Windows PE
228 * image, then loading them after boot using @b drvload.exe.
229 * - Although wimlib 1.3.0 and later can be used on Windows as well as UNIX, the
230 * Windows build has some limitations compared to the UNIX build.
231 * (The differences are documented better in the man pages for
232 * @b wimlib-imagex than here.)
234 * \section legal License
236 * The wimlib library, as well as the programs and scripts distributed with it
237 * (@b wimlib-imagex and @b mkwinpeimg), is licensed under the GNU General
238 * Public License version 3 or later.
247 #include <inttypes.h>
249 /** Major version of the library (for example, the 1 in 1.2.5). */
250 #define WIMLIB_MAJOR_VERSION 1
252 /** Minor version of the library (for example, the 2 in 1.2.5). */
253 #define WIMLIB_MINOR_VERSION 3
255 /** Patch version of the library (for example, the 5 in 1.2.5). */
256 #define WIMLIB_PATCH_VERSION 2
259 * Opaque structure that represents a WIM file. This is an in-memory structure
260 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
261 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
262 * continuing to exist so that data can be read from it as needed.
264 * Most functions in this library will work the same way regardless of whether a
265 * given ::WIMStruct was obtained through wimlib_open_wim() or
266 * wimlib_create_new_wim(). Exceptions are documented.
268 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
269 * file from a ::WIMStruct.
271 typedef struct WIMStruct WIMStruct;
274 typedef wchar_t wimlib_tchar;
276 /** See \ref encodings */
277 typedef char wimlib_tchar;
281 * Specifies the compression type of a WIM file.
283 enum wimlib_compression_type {
284 /** An invalid compression type. */
285 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
287 /** The WIM does not include any compressed resources. */
288 WIMLIB_COMPRESSION_TYPE_NONE = 0,
290 /** Compressed resources in the WIM use LZX compression. */
291 WIMLIB_COMPRESSION_TYPE_LZX = 1,
293 /** Compressed resources in the WIM use XPRESS compression. */
294 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
297 /** Possible values of the first parameter to the user-supplied
298 * ::wimlib_progress_func_t progress function */
299 enum wimlib_progress_msg {
301 /** A WIM image is about to be extracted. @a info will point to
302 * ::wimlib_progress_info.extract. */
303 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
305 /** The directory structure of the WIM image is about to be extracted.
306 * @a info will point to ::wimlib_progress_info.extract. */
307 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
309 /** The directory structure of the WIM image has been successfully
310 * extracted. @a info will point to ::wimlib_progress_info.extract. */
311 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
313 /** The WIM image's files resources are currently being extracted. @a
314 * info will point to ::wimlib_progress_info.extract. */
315 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
317 /** A file or directory is being extracted. @a info will point to
318 * ::wimlib_progress_info.extract, and the @a cur_path member will be
320 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
322 /** All the WIM files and directories have been extracted, and
323 * timestamps are about to be applied. @a info will point to
324 * ::wimlib_progress_info.extract. */
325 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
327 /** A WIM image has been successfully extracted. @a info will point to
328 * ::wimlib_progress_info.extract. */
329 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
331 /** The directory or NTFS volume is about to be scanned to build a tree
332 * of WIM dentries in-memory. @a info will point to
333 * ::wimlib_progress_info.scan. */
334 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
336 /** A directory or file is being scanned. @a info will point to
337 * ::wimlib_progress_info.scan, and its @a cur_path member will be
338 * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
339 * is passed to wimlib_add_image(). */
340 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
342 /** The directory or NTFS volume has been successfully scanned, and a
343 * tree of WIM dentries has been built in-memory. @a info will point to
344 * ::wimlib_progress_info.scan. */
345 WIMLIB_PROGRESS_MSG_SCAN_END,
348 * File resources are currently being written to the WIM.
349 * @a info will point to ::wimlib_progress_info.write_streams. */
350 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
353 * The metadata resource for each image is about to be written to the
354 * WIM. @a info will not be valid. */
355 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
358 * The metadata resource for each image has successfully been writen to
359 * the WIM. @a info will not be valid. */
360 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
363 * The temporary file has successfully been renamed to the original WIM
364 * file. Only happens when wimlib_overwrite() is called and the
365 * overwrite is not done in-place.
366 * @a info will point to ::wimlib_progress_info.rename. */
367 WIMLIB_PROGRESS_MSG_RENAME,
369 /** The contents of the WIM are being checked against the integrity
370 * table. Only happens when wimlib_open_wim() is called with the
371 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
372 * ::wimlib_progress_info.integrity. */
373 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
375 /** An integrity table is being calculated for the WIM being written.
376 * Only happens when wimlib_write() or wimlib_overwrite() is called with
377 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
378 * ::wimlib_progress_info.integrity. */
379 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
381 /** A wimlib_join() operation is in progress. @a info will point to
382 * ::wimlib_progress_info.join. */
383 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
385 /** A wimlib_split() operation is in progress, and a new split part is
386 * about to be started. @a info will point to
387 * ::wimlib_progress_info.split. */
388 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
390 /** A wimlib_split() operation is in progress, and a split part has been
391 * finished. @a info will point to ::wimlib_progress_info.split. */
392 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
395 /** A pointer to this union is passed to the user-supplied
396 * ::wimlib_progress_func_t progress function. One (or none) of the structures
397 * contained in this union will be applicable for the operation
398 * (::wimlib_progress_msg) indicated in the first argument to the progress
400 union wimlib_progress_info {
402 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
403 * document them if they aren't given a name... */
405 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
406 struct wimlib_progress_info_write_streams {
407 /** Number of bytes that are going to be written for all the
408 * streams combined. This is the amount in uncompressed data.
409 * (The actual number of bytes will be less if the data is being
410 * written compressed.) */
411 uint64_t total_bytes;
412 /** Number of streams that are going to be written. */
413 uint64_t total_streams;
415 /** Number of uncompressed bytes that have been written so far.
416 * Will be 0 initially, and equal to @a total_bytes at the end.
418 uint64_t completed_bytes;
420 /** Number of streams that have been written. Will be 0
421 * initially, and equal to @a total_streams at the end. */
422 uint64_t completed_streams;
424 /** Number of threads that are being used to compress resources
425 * (if applicable). */
426 unsigned num_threads;
428 /** The compression type being used to write the streams; either
429 * ::WIMLIB_COMPRESSION_TYPE_NONE,
430 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
431 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
432 int compression_type;
437 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
438 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
439 struct wimlib_progress_info_scan {
440 /** Directory or NTFS volume that is being scanned. */
441 const wimlib_tchar *source;
443 /** Path to the file or directory that is about to be scanned,
444 * relative to the root of the image capture or the NTFS volume.
446 const wimlib_tchar *cur_path;
448 /** True iff @a cur_path is being excluded from the image
449 * capture due to the capture configuration file. */
452 /** Target path in the WIM. Only valid on messages
453 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
454 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
455 const wimlib_tchar *wim_target_path;
458 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
459 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
460 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
461 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
462 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
463 struct wimlib_progress_info_extract {
464 /** Number of the image being extracted (1-based). */
467 /** Flags passed to to wimlib_extract_image() */
470 /** Full path to the WIM file being extracted. */
471 const wimlib_tchar *wimfile_name;
473 /** Name of the image being extracted. */
474 const wimlib_tchar *image_name;
476 /** Directory or NTFS volume to which the image is being
478 const wimlib_tchar *target;
480 /** Current dentry being extracted. (Valid only if message is
481 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
482 const wimlib_tchar *cur_path;
484 /** Number of bytes of uncompressed data that will be extracted.
485 * Takes into account hard links (they are not counted for each
488 uint64_t total_bytes;
490 /** Number of bytes that have been written so far. Will be 0
491 * initially, and equal to @a total_bytes at the end. */
492 uint64_t completed_bytes;
494 /** Number of streams that will be extracted. This may more or
495 * less than the number of "files" to be extracted due to
496 * special cases (hard links, symbolic links, and alternate data
498 uint64_t num_streams;
501 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
502 struct wimlib_progress_info_rename {
503 /** Name of the temporary file that the WIM was written to. */
504 const wimlib_tchar *from;
506 /** Name of the original WIM file to which the temporary file is
508 const wimlib_tchar *to;
511 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
512 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
513 struct wimlib_progress_info_integrity {
514 /** Number of bytes from the end of the WIM header to the end of
515 * the lookup table (the area that is covered by the SHA1
516 * integrity checks.) */
517 uint64_t total_bytes;
519 /** Number of bytes that have been SHA1-summed so far. Will be
520 * 0 initially, and equal @a total_bytes at the end. */
521 uint64_t completed_bytes;
523 /** Number of chunks that the checksummed region is divided
525 uint32_t total_chunks;
527 /** Number of chunks that have been SHA1-summed so far. Will
528 * be 0 initially, and equal to @a total_chunks at the end. */
529 uint32_t completed_chunks;
531 /** Size of the chunks used for the integrity calculation. */
534 /** Filename of the WIM (only valid if the message is
535 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
536 const wimlib_tchar *filename;
539 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
540 struct wimlib_progress_info_join {
541 /** Total number of bytes of compressed data contained in all
542 * the split WIM part's file and metadata resources. */
543 uint64_t total_bytes;
545 /** Number of bytes that have been copied to the joined WIM so
546 * far. Will be 0 initially, and equal to @a total_bytes at the
548 uint64_t completed_bytes;
550 /** Number of split WIM parts that have had all their file and
551 * metadata resources copied over to the joined WIM so far. */
552 unsigned completed_parts;
554 /** Number of split WIM parts. */
555 unsigned total_parts;
558 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
559 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
560 struct wimlib_progress_info_split {
561 /** Total size of the original WIM's file and metadata resources
563 uint64_t total_bytes;
565 /** Number of bytes of file and metadata resources that have
566 * been copied out of the original WIM so far. Will be 0
567 * initially, and equal to @a total_bytes at the end. */
568 uint64_t completed_bytes;
570 /** Number of the split WIM part that is about to be started
571 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
572 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
573 unsigned cur_part_number;
575 /** Name of the split WIM part that is about to be started
576 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
577 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
578 const wimlib_tchar *part_name;
582 /** A user-supplied function that will be called periodically during certain WIM
583 * operations. The first argument will be the type of operation that is being
584 * performed or is about to be started or has been completed. The second
585 * argument will be a pointer to one of a number of structures depending on the
586 * first argument. It may be @c NULL for some message types.
588 * The return value of the progress function is currently ignored, but it may do
589 * something in the future. (Set it to 0 for now.)
591 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
592 const union wimlib_progress_info *info);
594 /** An array of these structures is passed to wimlib_add_image_multisource() to
595 * specify the sources from which to create a WIM image. */
596 struct wimlib_capture_source {
597 /** Absolute or relative path to a file or directory on the external
598 * filesystem to be included in the WIM image. */
599 wimlib_tchar *fs_source_path;
601 /** Destination path in the WIM image. Leading and trailing slashes are
602 * ignored. The empty string or @c NULL means the root directory of the
604 wimlib_tchar *wim_target_path;
606 /** Reserved; set to 0. */
610 /** Structure that specifies a list of path patterns. */
611 struct wimlib_pattern_list {
612 /** Array of patterns. The patterns may be modified by library code,
613 * but the @a pats pointer itself will not. See the man page for
614 * <b>wimlib-imagex capture</b> for more information about allowed
618 /** Number of patterns in the @a pats array. */
621 /** Ignored; may be used by the calling code. */
622 size_t num_allocated_pats;
625 /** A structure that contains lists of wildcards that match paths to treat
626 * specially when capturing a WIM image. */
627 struct wimlib_capture_config {
628 /** Paths matching any pattern this list are excluded from being
629 * captured, except if the same path appears in @a
630 * exclusion_exception_pats. */
631 struct wimlib_pattern_list exclusion_pats;
633 /** Paths matching any pattern in this list are never excluded from
635 struct wimlib_pattern_list exclusion_exception_pats;
637 /** Reserved for future capture configuration options. */
638 struct wimlib_pattern_list reserved1;
640 /** Reserved for future capture configuration options. */
641 struct wimlib_pattern_list reserved2;
643 /** Library internal use only. */
644 wimlib_tchar *_prefix;
646 /** Library internal use only. */
647 size_t _prefix_num_tchars;
651 /*****************************
652 * WIMLIB_ADD_IMAGE_FLAG_* *
653 *****************************/
655 /** Directly capture a NTFS volume rather than a generic directory. This flag
656 * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
657 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
658 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
660 /** Follow symlinks; archive and dump the files they point to. Cannot be used
661 * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
662 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
664 /** Call the progress function with the message
665 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
667 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
669 /** Mark the image being added as the bootable image of the WIM. */
670 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
672 /** Store the UNIX owner, group, and mode. This is done by adding a special
673 * alternate data stream to each regular file, symbolic link, and directory to
674 * contain this information. Please note that this flag is for convenience
675 * only; Microsoft's @a imagex.exe will not understand this special information.
676 * This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
677 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
679 /** Do not capture security descriptors. Only has an effect in NTFS capture
680 * mode, or in Win32 native builds. */
681 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020
683 /** Fail immediately if the full security descriptor of any file or directory
684 * cannot be accessed. Only has an effect in Win32 native builds. The default
685 * behavior without this flag is to first try omitting the SACL from the
686 * security descriptor, then to try omitting the security descriptor entirely.
688 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS 0x00000040
690 /** Call the progress function with the message
691 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
692 * capture. This is a subset of the messages provided by
693 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
694 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE 0x00000080
696 /******************************
697 * WIMLIB_EXPORT_FLAG_* *
698 ******************************/
700 /** See documentation for wimlib_export_image(). */
701 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
703 /******************************
704 * WIMLIB_EXTRACT_FLAG_* *
705 ******************************/
707 /** Extract the image directly to a NTFS volume rather than a generic directory.
709 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
711 /** When identical files are extracted from the WIM, always hard link them
712 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
713 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
715 /** When identical files are extracted from the WIM, always symlink them
716 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
717 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
719 /** Call the progress function with the argument
720 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
721 * extracted. Note: these calls will be interspersed with calls for the message
722 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
723 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
725 /** Read the WIM file sequentially while extracting the image. */
726 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
728 /** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
729 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
730 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
732 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
733 * or in Win32 native builds. */
734 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
736 /** Fail immediately if the full security descriptor of any file or directory
737 * cannot be set exactly as specified in the WIM file. The default behavior
738 * without this flag is to fall back to setting the security descriptor with the
739 * SACL omitted, then only the default inherited security descriptor, if we do
740 * not have permission to set the desired one. */
741 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
743 /******************************
744 * WIMLIB_MOUNT_FLAG_* *
745 ******************************/
747 /** Mount the WIM image read-write rather than the default of read-only. */
748 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
750 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
751 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
753 /** Do not allow accessing alternate data streams in the mounted WIM image. */
754 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
756 /** Access alternate data streams in the mounted WIM image through extended file
757 * attributes. This is the default mode. */
758 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
760 /** Access alternate data streams in the mounted WIM image by specifying the
761 * file name, a colon, then the alternate file stream name. */
762 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
764 /** Use UNIX file owners, groups, and modes if available in the WIM (see
765 * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
766 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
768 /** Allow other users to see the mounted filesystem. (this passes the @c
769 * allow_other option to FUSE mount) */
770 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
772 /******************************
773 * WIMLIB_OPEN_FLAG_* *
774 ******************************/
776 /** Verify the WIM contents against the WIM's integrity table, if present. */
777 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
779 /** Do not issue an error if the WIM is part of a split WIM. */
780 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
782 /******************************
783 * WIMLIB_UNMOUNT_FLAG_* *
784 ******************************/
786 /** Include an integrity table in the WIM after it's been unmounted. Ignored
787 * for read-only mounts. */
788 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
790 /** Unless this flag is given, changes to a read-write mounted WIM are
791 * discarded. Ignored for read-only mounts. */
792 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
794 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
795 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
797 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
798 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
800 /******************************
801 * WIMLIB_WRITE_FLAG_* *
802 ******************************/
804 /** Include an integrity table in the new WIM file. */
805 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
807 /** Re-build the entire WIM file rather than appending data to it, if possible.
808 * (Applies to wimlib_overwrite(), not wimlib_write()). */
809 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
811 /** Recompress all resources, even if they could otherwise be copied from a
812 * different WIM with the same compression type (in the case of
813 * wimlib_export_image() being called previously). */
814 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
816 /** Call fsync() when the WIM file is closed */
817 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
819 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
820 * after one or more calls to wimlib_delete_image(), which is to rebuild the
823 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
824 * correctly remove the image from the WIM will be taken. In particular, all
825 * streams will be left alone, even if they are no longer referenced. This is
826 * probably not what you want, because almost no space will be spaced by
827 * deleting an image in this way. */
828 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
832 /****************************************************************
833 * Definition of struct wimlib_modify_command, with various flags
834 ****************************************************************/
837 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_ALL = 0x1,
838 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_NONDIRECTORIES = 0x2,
839 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_EMPTY_DIRECTORIES = 0x4,
840 WIMLIB_MOVE_TREE_FLAG_OVERWRITE_DIRECTORIES = 0x8,
844 WIMLIB_DELETE_TREE_FLAG_FORCE = 0x1,
845 WIMLIB_DELETE_TREE_FLAG_RECURSIVE = 0x2,
846 WIMLIB_DELETE_TREE_FLAG_REMOVE_EMPTY_DIR = 0x4,
850 WIMLIB_ADD_TREE_FLAG_DEREFERENCE = 0x1,
851 WIMLIB_ADD_TREE_FLAG_VERBOSE = 0x2,
852 WIMLIB_ADD_TREE_FLAG_UNIX_DATA = 0x4,
853 WIMLIB_ADD_TREE_FLAG_NOACLS = 0x8,
854 WIMLIB_ADD_TREE_FLAG_NTFS_VOLUME = 0x01,
855 WIMLIB_ADD_TREE_FLAG_OVERLAY = 0x02,
856 WIMLIB_ADD_TREE_FLAG_MAKE_NECESSARY_DIRS = 0x04,
859 enum wimlib_modify_op {
860 WIMLIB_MODIFY_OP_DELETE_TREE,
861 WIMLIB_MODIFY_OP_ADD_TREE,
862 WIMLIB_MODIFY_OP_MOVE_TREE,
865 struct wimlib_modify_command {
866 enum wimlib_modify_op op;
868 struct wimlib_modify_command_delete_tree {
869 int delete_tree_flags;
870 const wimlib_tchar *tree_wim_path;
871 unsigned long reserved;
874 struct wimlib_modify_command_add_tree {
876 const wimlib_tchar *fs_source_path;
877 const wimlib_tchar *wim_target_path;
878 unsigned long reserved;
881 struct wimlib_modify_command_move_tree {
883 const wimlib_tchar *wim_source_path;
884 const wimlib_tchar *wim_target_path;
885 unsigned long reserved;
893 * Possible values of the error code returned by many functions in wimlib.
895 * See the documentation for each wimlib function to see specifically what error
896 * codes can be returned by a given function, and what they mean.
898 /* Note: these are currently in alphabetic order, but new error codes should be
899 * added at the end to maintain a compatible ABI, except when it's being broken
901 enum wimlib_error_code {
902 WIMLIB_ERR_SUCCESS = 0,
903 WIMLIB_ERR_ALREADY_LOCKED,
904 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
905 WIMLIB_ERR_DECOMPRESSION,
906 WIMLIB_ERR_DELETE_STAGING_DIR,
907 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
910 WIMLIB_ERR_FUSERMOUNT,
911 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
912 WIMLIB_ERR_IMAGE_COUNT,
913 WIMLIB_ERR_IMAGE_NAME_COLLISION,
914 WIMLIB_ERR_INTEGRITY,
915 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
916 WIMLIB_ERR_INVALID_CHUNK_SIZE,
917 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
918 WIMLIB_ERR_INVALID_DENTRY,
919 WIMLIB_ERR_INVALID_HEADER_SIZE,
920 WIMLIB_ERR_INVALID_IMAGE,
921 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
922 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
923 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
924 WIMLIB_ERR_INVALID_OVERLAY,
925 WIMLIB_ERR_INVALID_PARAM,
926 WIMLIB_ERR_INVALID_PART_NUMBER,
927 WIMLIB_ERR_INVALID_RESOURCE_HASH,
928 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
929 WIMLIB_ERR_INVALID_SECURITY_DATA,
930 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
931 WIMLIB_ERR_INVALID_UTF16_STRING,
932 WIMLIB_ERR_INVALID_UTF8_STRING,
933 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
939 WIMLIB_ERR_NOT_A_WIM_FILE,
940 WIMLIB_ERR_NO_FILENAME,
948 WIMLIB_ERR_RESOURCE_ORDER,
949 WIMLIB_ERR_SPECIAL_FILE,
950 WIMLIB_ERR_SPLIT_INVALID,
951 WIMLIB_ERR_SPLIT_UNSUPPORTED,
954 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
955 WIMLIB_ERR_UNKNOWN_VERSION,
956 WIMLIB_ERR_UNSUPPORTED,
962 /** Used to indicate that no WIM image or an invalid WIM image. */
963 #define WIMLIB_NO_IMAGE 0
965 /** Used to specify all images in the WIM. */
966 #define WIMLIB_ALL_IMAGES (-1)
969 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
971 * The directory tree of NTFS volume is read immediately for the purpose of
972 * constructing a directory entry tree in-memory. Also, all files are read to
973 * calculate their SHA1 message digests. However, because the directory tree
974 * may contain a very large amount of data, the files themselves are not read
975 * into memory permanently, and instead references to their paths saved. The
976 * files are then read on-demand if wimlib_write() or wimlib_overwrite() is
979 * See the manual page for the @b wimlib-imagex program for more information
980 * about the "normal" capture mode versus the NTFS capture mode (entered by
981 * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
983 * 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 a WIM file to which the image will be
990 * A path to a directory or unmounted NTFS volume that will be captured as
993 * The name to give the image. This must be non-@c NULL.
995 * Capture configuration that specifies files, directories, or path globs
996 * to exclude from being captured. If @c NULL, a dummy configuration where
997 * no paths are treated specially is used.
998 * @param add_image_flags
999 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
1000 * @param progress_func
1001 * If non-NULL, a function that will be called periodically with the
1002 * progress of the current operation.
1004 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1005 * discarded so that it appears to be in the same state as when this function
1008 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1009 * There is already an image named @a name in @a wim.
1010 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
1011 * @a config was not @c NULL and did not specify a valid image capture
1013 * @retval ::WIMLIB_ERR_INVALID_PARAM
1014 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
1015 * @retval ::WIMLIB_ERR_NOMEM
1016 * Failed to allocate needed memory.
1017 * @retval ::WIMLIB_ERR_NOTDIR
1018 * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
1019 * not specified in @a add_image_flags).
1020 * @retval ::WIMLIB_ERR_NTFS_3G
1021 * An error was returned from a libntfs-3g function when the NTFS volume
1022 * was being opened, scanned, or closed (only if
1023 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
1024 * @retval ::WIMLIB_ERR_OPEN
1025 * Failed to open a file or directory in the directory tree rooted at @a
1026 * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
1028 * @retval ::WIMLIB_ERR_READ
1029 * Failed to read a file in the directory tree rooted at @a source (only if
1030 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
1031 * @retval ::WIMLIB_ERR_SPECIAL_FILE
1032 * The directory tree rooted at @a source contains a special file that is
1033 * not a directory, regular file, or symbolic link. This currently can
1034 * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
1035 * add_image_flags, but it may be returned for unsupported NTFS files in
1037 * @retval ::WIMLIB_ERR_STAT
1038 * Failed obtain the metadata for a file or directory in the directory tree
1039 * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
1040 * specified in @a add_image_flags).
1041 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1042 * @a wim is part of a split WIM. Adding an image to a split WIM is
1044 * @retval ::WIMLIB_ERR_UNSUPPORTED
1045 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
1046 * wimlib was configured with the @c --without-ntfs-3g flag.
1049 wimlib_add_image(WIMStruct *wim,
1050 const wimlib_tchar *source,
1051 const wimlib_tchar *name,
1052 struct wimlib_capture_config *config,
1053 int add_image_flags,
1054 wimlib_progress_func_t progress_func);
1056 /** This function is equivalent to wimlib_add_image() except it allows for
1057 * multiple sources to be combined into a single WIM image. This is done by
1058 * specifying the @a sources and @a num_sources parameters instead of the @a
1059 * source parameter of wimlib_add_image(). The rest of the parameters are the
1060 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1061 * capture</b> for full details on how this mode works.
1063 * Additional note: @a sources is not a @c const parameter and you cannot
1064 * assume that its contents are valid after this function returns. You must
1065 * save pointers to the strings in these structures if you need to free them
1066 * later, and/or save copies if needed.
1068 * In addition to the error codes that wimlib_add_image() can return,
1069 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1070 * when trying to overlay a non-directory on a directory or when otherwise
1071 * trying to overlay multiple conflicting files to the same location in the WIM
1072 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1073 * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
1074 * was not exactly one capture source with the target being the root directory.
1075 * (In this respect, there is no advantage to using
1076 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1079 wimlib_add_image_multisource(WIMStruct *w,
1080 struct wimlib_capture_source *sources,
1082 const wimlib_tchar *name,
1083 struct wimlib_capture_config *config,
1084 int add_image_flags,
1085 wimlib_progress_func_t progress_func);
1088 * Creates a ::WIMStruct for a new WIM file.
1090 * This only creates an in-memory structure for a WIM that initially contains no
1091 * images. No on-disk file is created until wimlib_write() is called.
1094 * The type of compression to be used in the new WIM file. Must be
1095 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1096 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1098 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1099 * written to the memory location pointed to by this paramater. The
1100 * ::WIMStruct must be freed using using wimlib_free() when finished with
1102 * @return 0 on success; nonzero on error.
1103 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1104 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1105 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1106 * @retval ::WIMLIB_ERR_NOMEM
1107 * Failed to allocate needed memory.
1110 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1113 * Deletes an image, or all images, from a WIM file.
1115 * All streams referenced by the image(s) being deleted are removed from the
1116 * lookup table of the WIM if they are not referenced by any other images in the
1119 * Please note that @b no changes are committed to the underlying WIM file (if
1120 * any) until wimlib_write() or wimlib_overwrite() is called.
1123 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1126 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1128 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1129 * to be left unmodified only if @a image specified a single image. If instead
1130 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1131 * possible for some but not all of the images to have been deleted when a
1132 * failure status is returned.
1134 * @retval ::WIMLIB_ERR_DECOMPRESSION
1135 * Could not decompress the metadata resource for @a image.
1136 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1137 * A directory entry in the metadata resource for @a image in the WIM is
1139 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1140 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1141 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1142 * The metadata resource for @a image in the WIM is invalid.
1143 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1144 * The security data for @a image in the WIM is invalid.
1145 * @retval ::WIMLIB_ERR_NOMEM
1146 * Failed to allocate needed memory.
1147 * @retval ::WIMLIB_ERR_READ
1148 * Could not read the metadata resource for @a image from the WIM.
1149 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1150 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1154 wimlib_delete_image(WIMStruct *wim, int image);
1157 * Exports an image, or all the images, from a WIM file, into another WIM file.
1159 * The destination image is made to share the same dentry tree and security data
1160 * structure as the source image. This places some restrictions on additional
1161 * functions that may be called. wimlib_mount_image() may not be called on
1162 * either the source image or the destination image without an intervening call
1163 * to a function that un-shares the images, such as wimlib_free() on @a
1164 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1165 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1166 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1167 * have references back to @a src_wim.
1169 * Previous versions of this function left @a dest_wim in an indeterminate state
1170 * on failure. This is no longer the case; all changes to @a dest_wim made by
1171 * this function are rolled back on failure.
1173 * Previous versions of this function did not allow exporting an image that had
1174 * been added by wimlib_add_image(). This is no longer the case; you may now
1175 * export an image regardless of how it was added.
1177 * Regardless of whether this function succeeds or fails, no changes are made to
1180 * Please note that no changes are committed to the underlying WIM file of @a
1181 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1184 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1185 * WIM that contains the image(s) being exported.
1187 * The image to export from @a src_wim. Can be the number of an image, or
1188 * ::WIMLIB_ALL_IMAGES to export all images.
1190 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1193 * The name to give the exported image in the new WIM file. If left @c
1194 * NULL, the name from @a src_wim is used. This parameter must be left @c
1195 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1196 * than one image; in that case, the names are all taken from the @a
1197 * src_wim. (This is allowed even if one or more images being exported has
1199 * @param dest_description
1200 * The description to give the exported image in the new WIM file. If left
1201 * @c NULL, the description from the @a src_wim is used. This parameter must
1202 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1203 * more than one image; in that case, the descriptions are all taken from
1204 * @a src_wim. (This is allowed even if one or more images being exported
1205 * has no description.)
1206 * @param export_flags
1207 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1208 * bootable, or 0 if which image is marked as bootable in the destination
1209 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1210 * there are multiple images in @a src_wim, specifying
1211 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1212 * currently marked as bootable in @a src_wim; if that is the case, then
1213 * that image is marked as bootable in the destination WIM.
1214 * @param additional_swms
1215 * Array of pointers to the ::WIMStruct for each additional part in the
1216 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1217 * need to be in any particular order, but they must include all parts of
1218 * the split WIM other than the first part, which must be provided in the
1220 * @param num_additional_swms
1221 * Number of additional WIM parts provided in the @a additional_swms array.
1222 * This number should be one less than the total number of parts in the
1223 * split WIM. Set to 0 if the WIM is a standalone WIM.
1224 * @param progress_func
1225 * If non-NULL, a function that will be called periodically with the
1226 * progress of the current operation.
1228 * @return 0 on success; nonzero on error.
1229 * @retval ::WIMLIB_ERR_DECOMPRESSION
1230 * Could not decompress the metadata resource for @a src_image
1232 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1233 * One or more of the names being given to an exported image was already in
1234 * use in the destination WIM.
1235 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1236 * A directory entry in the metadata resource for @a src_image in @a
1237 * src_wim is invalid.
1238 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1239 * @a src_image does not exist in @a src_wim.
1240 * @retval ::WIMLIB_ERR_INVALID_PARAM
1241 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1242 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1243 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1244 * dest_description were non-<code>NULL</code>, @a src_image was
1245 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1246 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1247 * The metadata resource for @a src_image in @a src_wim is invalid.
1248 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1249 * The security data for @a src_image in @a src_wim is invalid.
1250 * @retval ::WIMLIB_ERR_NOMEM
1251 * Failed to allocate needed memory.
1252 * @retval ::WIMLIB_ERR_READ
1253 * Could not read the metadata resource for @a src_image from @a src_wim.
1254 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1255 * The source WIM is a split WIM, but the parts specified do not form a
1256 * complete split WIM because they do not include all the parts of the
1257 * original WIM, there are duplicate parts, or not all the parts have the
1258 * same GUID and compression type.
1259 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1260 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1264 wimlib_export_image(WIMStruct *src_wim, int src_image,
1265 WIMStruct *dest_wim,
1266 const wimlib_tchar *dest_name,
1267 const wimlib_tchar *dest_description,
1269 WIMStruct **additional_swms,
1270 unsigned num_additional_swms,
1271 wimlib_progress_func_t progress_func);
1274 * Extracts an image, or all images, from a standalone or split WIM file to a
1275 * directory or a NTFS volume.
1277 * Please see the manual page for the @c wimlib-imagex program for more
1278 * information about the "normal" extraction mode versus the NTFS extraction
1279 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1281 * Extraction is done with one thread.
1283 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1284 * returned if any resulting SHA1 message digests do not match the values
1285 * provided in the WIM file. Therefore, if this function is successful, you can
1286 * be fairly sure that any compressed data in the WIM was uncompressed
1290 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1293 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1294 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1295 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1297 * Directory to extract the WIM image(s) to (created if it does not already
1298 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1299 * path to the unmounted NTFS volume to extract the image to.
1300 * @param extract_flags
1301 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1303 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1304 * a NTFS volume to extract the image to. The volume will be opened using
1305 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1306 * Otherwise, @a target is interpreted as a directory to extract the
1309 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1310 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1311 * specified. These flags cause extracted files that are identical to be
1312 * hardlinked or symlinked together, depending on the flag. These flags
1313 * override the hard link groups that are specified in the WIM file itself.
1314 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1315 * hardlinked or symlinked across images if a file is found to occur in
1316 * more than one image.
1318 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1319 * name of each file or directory as it is extracted.
1321 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1322 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1323 * each image is considered separately with regards to the sequential
1324 * order. It is also possible for alternate data streams to break the
1325 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1327 * @param additional_swms
1328 * Array of pointers to the ::WIMStruct for each additional part in the
1329 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1330 * need to be in any particular order, but they must include all parts of
1331 * the split WIM other than the first part, which must be provided in the
1333 * @param num_additional_swms
1334 * Number of additional WIM parts provided in the @a additional_swms array.
1335 * This number should be one less than the total number of parts in the
1336 * split WIM. Set to 0 if the WIM is a standalone WIM.
1338 * @param progress_func
1339 * If non-NULL, a function that will be called periodically with the
1340 * progress of the current operation.
1342 * @return 0 on success; nonzero on error.
1343 * @retval ::WIMLIB_ERR_DECOMPRESSION
1344 * Could not decompress a resource (file or metadata) for @a image in @a
1346 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1347 * A directory entry in the metadata resource for @a image in @a wim is
1349 * @retval ::WIMLIB_ERR_INVALID_PARAM
1350 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1351 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1352 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1353 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1354 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1355 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1356 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1357 * specified in @a extract_flag.
1358 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1359 * The SHA1 message digest of an extracted stream did not match the SHA1
1360 * message digest given in the WIM file.
1361 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1362 * A resource (file or metadata) for @a image in @a wim is invalid.
1363 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1364 * The security data for @a image in @a wim is invalid.
1365 * @retval ::WIMLIB_ERR_LINK
1366 * Failed to create a symbolic link or a hard link (only if
1367 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1368 * @retval ::WIMLIB_ERR_MKDIR
1369 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1370 * not specified in @a extract_flags).
1371 * @retval ::WIMLIB_ERR_NOMEM
1372 * Failed to allocate needed memory.
1373 * @retval ::WIMLIB_ERR_NTFS_3G
1374 * An error was returned from a libntfs-3g function while the WIM image was
1375 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1376 * was specified in @a extract_flags).
1377 * @retval ::WIMLIB_ERR_OPEN
1378 * Could not open one of the files being extracted for writing (only if
1379 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1380 * @retval ::WIMLIB_ERR_READ
1381 * A unexpected end-of-file or read error occurred when trying to read data
1382 * from the WIM file associated with @a wim.
1383 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1384 * The WIM is a split WIM, but the parts specified do not form a complete
1385 * split WIM because they do not include all the parts of the original WIM,
1386 * there are duplicate parts, or not all the parts have the same GUID and
1388 * @retval ::WIMLIB_ERR_UNSUPPORTED
1389 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1390 * was configured with the @c --without-ntfs-3g flag.
1391 * @retval ::WIMLIB_ERR_WRITE
1392 * Failed to write a file being extracted (only if
1393 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1396 wimlib_extract_image(WIMStruct *wim, int image,
1397 const wimlib_tchar *target,
1399 WIMStruct **additional_swms,
1400 unsigned num_additional_swms,
1401 wimlib_progress_func_t progress_func);
1404 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1405 * includes a string of XML that describes the images contained in the WIM.
1406 * This function works on standalone WIMs as well as split WIM parts.
1409 * Pointer to the ::WIMStruct for a WIM file.
1411 * @c stdout, or a FILE* opened for writing, to extract the data to.
1413 * @return 0 on success; nonzero on error.
1414 * @retval ::WIMLIB_ERR_WRITE
1415 * Failed to completely write the XML data to @a fp.
1416 * @retval ::WIMLIB_ERR_INVALID_PARAM
1417 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1420 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1423 * Frees all memory allocated for a WIMStruct and closes all files associated
1427 * Pointer to the ::WIMStruct for a WIM file.
1429 * @return This function has no return value.
1432 wimlib_free(WIMStruct *wim);
1435 * Returns the index of the bootable image of the WIM.
1438 * Pointer to the ::WIMStruct for a WIM file.
1441 * 0 if no image is marked as bootable, or the number of the image marked
1442 * as bootable (numbered starting at 1).
1445 wimlib_get_boot_idx(const WIMStruct *wim);
1448 * Returns the compression type used in the WIM.
1451 * Pointer to the ::WIMStruct for a WIM file
1454 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1455 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1458 wimlib_get_compression_type(const WIMStruct *wim);
1461 * Converts a ::wimlib_compression_type value into a string.
1464 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1465 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1468 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1471 extern const wimlib_tchar *
1472 wimlib_get_compression_type_string(int ctype);
1475 * Converts an error code into a string describing it.
1478 * The error code returned by one of wimlib's functions.
1481 * Pointer to a statically allocated string describing the error code,
1482 * or @c NULL if the error code is not valid.
1484 extern const wimlib_tchar *
1485 wimlib_get_error_string(enum wimlib_error_code code);
1488 * Returns the description of the specified image.
1491 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1492 * standalone WIM or a split WIM part.
1494 * The number of the image, numbered starting at 1.
1497 * The description of the image, or @c NULL if there is no such image, or
1498 * @c NULL if the specified image has no description. The description
1499 * string is in library-internal memory and may not be modified or freed;
1500 * in addition, the string will become invalid if the description of the
1501 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1503 extern const wimlib_tchar *
1504 wimlib_get_image_description(const WIMStruct *wim, int image);
1507 * Returns the name of the specified image.
1510 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1511 * standalone WIM or a split WIM part.
1513 * The number of the image, numbered starting at 1.
1516 * The name of the image, or @c NULL if there is no such image. The name
1517 * string is in library-internal memory and may not be modified or freed;
1518 * in addition, the string will become invalid if the name of the image is
1519 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1521 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1522 * the WIM to be unnamed, in which case an empty string will be returned
1523 * when the corresponding name is requested.
1525 extern const wimlib_tchar *
1526 wimlib_get_image_name(const WIMStruct *wim, int image);
1530 * Returns the number of images contained in a WIM.
1533 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1534 * standalone WIM or a split WIM part.
1537 * The number of images contained in the WIM file.
1540 wimlib_get_num_images(const WIMStruct *wim);
1543 * Returns the part number of a WIM in a split WIM and the total number of parts
1547 * Pointer to the ::WIMStruct for a WIM file.
1548 * @param total_parts_ret
1549 * If non-@c NULL, the total number of parts in the split WIM (1 for
1550 * non-split WIMs) is written to this location.
1553 * The part number of the WIM (1 for non-split WIMs)
1556 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1559 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1560 * re-entrant. If you are calling wimlib functions concurrently in different
1561 * threads, then you must call this function serially first.
1563 * Since wimlib 1.3.0, you must call this function if the character encoding of
1564 * the current locale is not UTF-8.
1566 * Since wimlib 1.3.2, you must call this function if using the Windows-native
1567 * build of the library so that certain functions can be dynamically loaded from
1570 * This function currently always returns 0, but it may return other error codes
1571 * in future releases.
1574 wimlib_global_init();
1577 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1578 * You are not required to call this function, but it will release any global
1579 * memory allocated by the library.
1582 wimlib_global_cleanup();
1585 * Returns true if the WIM has an integrity table.
1588 * Pointer to the ::WIMStruct for a WIM file.
1590 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1591 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1592 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1593 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1596 wimlib_has_integrity_table(const WIMStruct *wim);
1599 * Determines if an image name is already used by some image in the WIM.
1602 * Pointer to the ::WIMStruct for a WIM file.
1604 * The name to check.
1607 * @c true if there is already an image in @a wim named @a name; @c false
1608 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1609 * the empty string, @c false is returned.
1612 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1615 * Joins a split WIM into a stand-alone one-part WIM.
1618 * An array of strings that gives the filenames of all parts of the split
1619 * WIM. No specific order is required, but all parts must be included with
1622 * Number of filenames in @a swms.
1623 * @param swm_open_flags
1624 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1625 * part should be verified, if integrity tables are present. Otherwise,
1627 * @param wim_write_flags
1628 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1629 * @param output_path
1630 * The path to write the one-part WIM to.
1631 * @param progress_func
1632 * If non-NULL, a function that will be called periodically with the
1633 * progress of the current operation.
1635 * @return 0 on success; nonzero on error. This function may return any value
1636 * returned by wimlib_open_wim() and wimlib_write() except
1637 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1639 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1640 * The split WIMs do not form a valid WIM because they do not include all
1641 * the parts of the original WIM, there are duplicate parts, or not all the
1642 * parts have the same GUID and compression type.
1644 * Note: the WIM's uncompressed and compressed resources are not checksummed
1645 * when they are copied from the split WIM parts to the joined WIM, nor are
1646 * compressed resources re-compressed.
1648 * Note: wimlib_export_image() can provide similar functionality to
1649 * wimlib_join(), since it is possible to export all images from a split WIM.
1652 wimlib_join(const wimlib_tchar * const *swms,
1654 const wimlib_tchar *output_path,
1656 int wim_write_flags,
1657 wimlib_progress_func_t progress_func);
1660 * Compress a chunk of a WIM resource using LZX compression.
1662 * This function is exported for convenience only and need not be used.
1665 * Uncompressed data of the chunk.
1667 * Size of the uncompressed chunk, in bytes.
1669 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1672 * The size of the compressed data written to @a out in bytes, or 0 if the
1673 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1675 * As a special requirement, the compression code is optimized for the WIM
1676 * format and therefore requires (@a chunk_size <= 32768).
1678 * As another special requirement, the compression code will read up to 8 bytes
1679 * off the end of the @a chunk array for performance reasons. The values of
1680 * these bytes will not affect the output of the compression, but the calling
1681 * code must make sure that the buffer holding the uncompressed chunk is
1682 * actually at least (@a chunk_size + 8) bytes, or at least that these extra
1683 * bytes are in mapped memory that will not cause a memory access violation if
1687 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1690 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1692 * Note that this will NOT work unmodified for LZX as used in the cabinet
1693 * format, which is not the same as in the WIM format!
1695 * This function is exported for convenience only and need not be used.
1697 * @param compressed_data
1698 * Pointer to the compressed data.
1700 * @param compressed_len
1701 * Length of the compressed data, in bytes.
1703 * @param uncompressed_data
1704 * Pointer to the buffer into which to write the uncompressed data.
1706 * @param uncompressed_len
1707 * Length of the uncompressed data. It must be 32768 bytes or less.
1710 * 0 on success; non-zero on failure.
1713 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1714 void *uncompressed_data, unsigned uncompressed_len);
1718 * Mounts an image in a WIM file on a directory read-only or read-write.
1720 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1721 * process shall be daemonized.
1723 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1724 * modifications to the WIM are staged in a temporary directory.
1726 * It is safe to mount multiple images from the same WIM file read-only at the
1727 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1728 * to mount multiple images from the same WIM file read-write at the same time.
1730 * wimlib_mount_image() cannot be used on an image that was exported with
1731 * wimlib_export_image() while the dentry trees for both images are still in
1732 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1733 * that has just been added with wimlib_add_image(), unless the WIM has been
1734 * written and read into a new ::WIMStruct.
1737 * Pointer to the ::WIMStruct containing the image to be mounted.
1739 * The number of the image to mount, indexed starting from it. It must be
1740 * an existing, single image.
1742 * The path to an existing empty directory to mount the image on.
1743 * @param mount_flags
1744 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1746 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1747 * rather than the default of read-only.
1749 * WIMs may contain named (alternate) data streams, which are a somewhat
1750 * obscure NTFS feature. They can be read and written on a mounted WIM
1751 * through one of several interfaces. The interface to use if specified by
1752 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1753 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1754 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1755 * the XATTR interface.
1756 * @param additional_swms
1757 * Array of pointers to the ::WIMStruct for each additional part in the
1758 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1759 * need to be in any particular order, but they must include all parts of
1760 * the split WIM other than the first part, which must be provided in the
1762 * @param num_additional_swms
1763 * Number of additional WIM parts provided in the @a additional_swms array.
1764 * This number should be one less than the total number of parts in the
1765 * split WIM. Set to 0 if the WIM is a standalone WIM.
1766 * @param staging_dir
1767 * If non-NULL, the name of a directory in which the staging directory will
1768 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1769 * in @a mount_flags. If left @c NULL, the staging directory is created in
1770 * the same directory as the WIM file that @a wim was originally read from.
1772 * @return 0 on success; nonzero on error.
1774 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1775 * A read-write mount was requested, but an an exclusive advisory lock on
1776 * the on-disk WIM file could not be acquired because another thread or
1777 * process has mounted an image from the WIM read-write or is currently
1778 * modifying the WIM in-place.
1779 * @retval ::WIMLIB_ERR_DECOMPRESSION
1780 * Could not decompress the metadata resource for @a image in @a wim.
1781 * @retval ::WIMLIB_ERR_FUSE
1782 * A non-zero status was returned by @c fuse_main().
1783 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1784 * A directory entry in the metadata resource for @a image in @a wim is
1786 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1787 * @a image does not specify an existing, single image in @a wim.
1788 * @retval ::WIMLIB_ERR_INVALID_PARAM
1789 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1790 * wimlib_export_image(), or @a image has been added with
1791 * wimlib_add_image().
1792 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1793 * The metadata resource for @a image in @a wim is invalid.
1794 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1795 * The security data for @a image in @a wim is invalid.
1796 * @retval ::WIMLIB_ERR_MKDIR
1797 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1798 * staging directory could not be created.
1799 * @retval ::WIMLIB_ERR_NOMEM
1800 * Failed to allocate needed memory.
1801 * @retval ::WIMLIB_ERR_NOTDIR
1802 * Could not determine the current working directory.
1803 * @retval ::WIMLIB_ERR_READ
1804 * An unexpected end-of-file or read error occurred when trying to read
1805 * data from the WIM file associated with @a wim.
1806 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1807 * The WIM is a split WIM, but the parts specified do not form a complete
1808 * split WIM because they do not include all the parts of the original WIM,
1809 * there are duplicate parts, or not all the parts have the same GUID and
1811 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1812 * The WIM is a split WIM and a read-write mount was requested. We only
1813 * support mounting a split WIM read-only.
1816 wimlib_mount_image(WIMStruct *wim,
1818 const wimlib_tchar *dir,
1820 WIMStruct **additional_swms,
1821 unsigned num_additional_swms,
1822 const wimlib_tchar *staging_dir);
1825 * Opens a WIM file and creates a ::WIMStruct for it.
1828 * The path to the WIM file to open.
1830 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1831 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1833 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1834 * the WIM, if it exists, is checked, and this function will fail with an
1835 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1836 * digests of the WIM do not exactly match the corresponding message
1837 * digests given in the integrity table.
1839 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1840 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1841 * returned. (This flag may be removed in the future, in which case no
1842 * error will be issued when opening a split WIM.)
1844 * @param progress_func
1845 * If non-NULL, a function that will be called periodically with the
1846 * progress of the current operation.
1849 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1850 * is written to the memory location pointed to by this parameter. The
1851 * ::WIMStruct must be freed using using wimlib_free() when finished with
1854 * @return 0 on success; nonzero on error.
1855 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1856 * The lookup table of @a wim_file is compressed. Support for this can be
1857 * added to wimlib if needed, but it appears to be the case that the lookup
1858 * table is never compressed.
1859 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1860 * The WIM is not the non-first part of a split WIM, and the number of
1861 * metadata resources found in the WIM did not match the image count given
1862 * in the WIM header, or the number of <IMAGE> elements in the XML
1863 * data for the WIM did not match the image count given in the WIM header.
1864 * @retval ::WIMLIB_ERR_INTEGRITY
1865 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1866 * wim_file contains an integrity table, but the SHA1 message digest for a
1867 * chunk of the WIM does not match the corresponding message digest given
1868 * in the integrity table.
1869 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1870 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1871 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1872 * The header of @a wim_file says that resources in the WIM are compressed,
1873 * but the header flag indicating LZX or XPRESS compression is not set.
1874 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1875 * The length field of the WIM header is not 208.
1876 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1877 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1878 * wim_file contains an integrity table, but the integrity table is
1880 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1881 * The lookup table for the WIM contained duplicate entries that are not
1882 * for metadata resources, or it contained an entry with a SHA1 message
1883 * digest of all 0's.
1884 * @retval ::WIMLIB_ERR_NOMEM
1885 * Failed to allocated needed memory.
1886 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1887 * @a wim_file does not begin with the expected magic characters.
1888 * @retval ::WIMLIB_ERR_OPEN
1889 * Failed to open the file @a wim_file for reading.
1890 * @retval ::WIMLIB_ERR_READ
1891 * An unexpected end-of-file or read error occurred when trying to read
1892 * data from @a wim_file.
1893 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1894 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1895 * specified in @a open_flags.
1896 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1897 * A number other than 0x10d00 is written in the version field of the WIM
1898 * header of @a wim_file. (Probably a pre-Vista WIM).
1899 * @retval ::WIMLIB_ERR_XML
1900 * The XML data for @a wim_file is invalid.
1903 wimlib_open_wim(const wimlib_tchar *wim_file,
1905 WIMStruct **wim_ret,
1906 wimlib_progress_func_t progress_func);
1909 * Overwrites the file that the WIM was originally read from, with changes made.
1910 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1911 * rather than wimlib_create_new_wim().
1913 * There are two ways that a WIM may be overwritten. The first is to do a full
1914 * rebuild. In this mode, the new WIM is written to a temporary file and then
1915 * renamed to the original file after it is has been completely written. The
1916 * temporary file is made in the same directory as the original WIM file. A
1917 * full rebuild may take a while, but can be used even if images have been
1918 * modified or deleted, will produce a WIM with no holes, and has little chance
1919 * of unintentional data loss because the temporary WIM is fsync()ed before
1920 * being renamed to the original WIM.
1922 * The second way to overwrite a WIM is by appending to the end of it and
1923 * overwriting the header. This can be much faster than a full rebuild, but it
1924 * only works if the only operations on the WIM have been to change the header
1925 * and/or XML data, or to add new images. Writing a WIM in this mode begins
1926 * with writing any new file resources *after* everything in the old WIM, even
1927 * though this will leave a hole where the old lookup table, XML data, and
1928 * integrity were. This is done so that the WIM remains valid even if the
1929 * operation is aborted mid-write. The WIM header is only overwritten at the
1930 * very last moment, and up until that point the WIM will be seen as the old
1933 * By default, the overwrite mode is determine automatically based on the past
1934 * operations performed on the ::WIMStruct. Use the flag
1935 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
1936 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
1937 * images have been deleted from the WIM.
1939 * In the temporary-file overwrite mode, no changes are made to the WIM on
1940 * failure, and the temporary file is deleted if possible. Abnormal termination
1941 * of the program will result in the temporary file being orphaned. In the
1942 * direct append mode, the WIM is truncated to the original length on failure;
1943 * and while abnormal termination of the program will result in extra data
1944 * appended to the original WIM, it should still be a valid WIM.
1947 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1948 * been in-memory changes made to it, which are then reflected in the
1950 * @param write_flags
1951 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
1952 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
1953 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
1954 * @param num_threads
1955 * Number of threads to use for compression (see wimlib_write()).
1956 * @param progress_func
1957 * If non-NULL, a function that will be called periodically with the
1958 * progress of the current operation.
1960 * @return 0 on success; nonzero on error. This function may return any value
1961 * returned by wimlib_write() as well as the following error codes:
1962 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1963 * The WIM was going to be modifien in-place (with no temporary file), but
1964 * an exclusive advisory lock on the on-disk WIM file could not be acquired
1965 * because another thread or process has mounted an image from the WIM
1966 * read-write or is currently modifying the WIM in-place.
1967 * @retval ::WIMLIB_ERR_NO_FILENAME
1968 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1969 * than a WIM read with wimlib_open_wim().
1970 * @retval ::WIMLIB_ERR_RENAME
1971 * The temporary file that the WIM was written to could not be renamed to
1972 * the original filename of @a wim.
1973 * @retval ::WIMLIB_ERR_REOPEN
1974 * The WIM was overwritten successfully, but it could not be re-opened
1975 * read-only. Therefore, the resources in the WIM can no longer be
1976 * accessed, so this limits the functions that can be called on @a wim
1977 * before calling wimlib_free().
1980 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
1981 wimlib_progress_func_t progress_func);
1984 * Prints information about one image, or all images, contained in a WIM.
1987 * Pointer to the ::WIMStruct for a WIM file.
1989 * The image about which to print information. Can be the number of an
1990 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
1993 * @return This function has no return value. No error checking is done when
1994 * printing the information. If @a image is invalid, an error message is
1998 wimlib_print_available_images(const WIMStruct *wim, int image);
2001 * Prints the full paths to all files contained in an image, or all images, in a
2005 * Pointer to the ::WIMStruct for a WIM file.
2007 * Which image to print files for. Can be the number of an image, or
2008 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2010 * @return 0 on success; nonzero on error.
2011 * @retval ::WIMLIB_ERR_DECOMPRESSION
2012 * The metadata resource for one of the specified images could not be
2014 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2015 * A directory entry in the metadata resource for one of the specified
2016 * images is invaled.
2017 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2018 * @a image does not specify a valid image in @a wim, and is not
2019 * ::WIMLIB_ALL_IMAGES.
2020 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2021 * The metadata resource for one of the specified images is invalid.
2022 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2023 * The security data for one of the specified images is invalid.
2024 * @retval ::WIMLIB_ERR_NOMEM
2025 * Failed to allocate needed memory.
2026 * @retval ::WIMLIB_ERR_READ
2027 * An unexpected read error or end-of-file occurred when reading the
2028 * metadata resource for one of the specified images.
2029 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2030 * @a wim was not a standalone WIM and was not the first part of a split
2034 wimlib_print_files(WIMStruct *wim, int image);
2037 * Prints detailed information from the header of a WIM file.
2040 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2041 * standalone WIM or part of a split WIM.
2043 * @return This function has no return value.
2047 wimlib_print_header(const WIMStruct *wim);
2050 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2051 * digests, as found in the directory entry tree in the WIM file, to file
2052 * resources in the WIM file. This table includes one entry for each unique
2053 * file in the WIM, so it can be quite long. There is only one lookup table per
2054 * WIM file, but each split WIM part has its own lookup table.
2057 * Pointer to the ::WIMStruct for a WIM file.
2059 * @return This function has no return value.
2062 wimlib_print_lookup_table(WIMStruct *wim);
2065 * Prints the metadata of the specified image in a WIM file. The metadata
2066 * consists of the security data as well as the directory entry tree. Each
2067 * image has its own metadata.
2070 * Pointer to the ::WIMStruct for a WIM file.
2072 * Which image to print the metadata for. Can be the number of an image,
2073 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2075 * @return 0 on success; nonzero on error.
2076 * @retval ::WIMLIB_ERR_DECOMPRESSION
2077 * The metadata resource for one of the specified images could not be
2079 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2080 * A directory entry in the metadata resource for one of the specified
2081 * images is invaled.
2082 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2083 * @a image does not specify a valid image in @a wim, and is not
2084 * ::WIMLIB_ALL_IMAGES.
2085 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2086 * The metadata resource for one of the specified images is invalid.
2087 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2088 * The security data for one of the specified images is invalid.
2089 * @retval ::WIMLIB_ERR_NOMEM
2090 * Failed to allocate needed memory.
2091 * @retval ::WIMLIB_ERR_READ
2092 * An unexpected read error or end-of-file occurred when reading the
2093 * metadata resource for one of the specified images.
2094 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2095 * @a wim was not a standalone WIM and was not the first part of a split
2099 wimlib_print_metadata(WIMStruct *wim, int image);
2102 * Prints some basic information about a WIM file. All information printed by
2103 * this function is also printed by wimlib_print_header(), but
2104 * wimlib_print_wim_information() prints some of this information more concisely
2105 * and in a more readable form.
2108 * Pointer to the ::WIMStruct for a WIM file.
2110 * @return This function has no return value.
2113 wimlib_print_wim_information(const WIMStruct *wim);
2116 * Translates a string specifying the name or number of an image in the WIM into
2117 * the number of the image. The images are numbered starting at 1.
2120 * Pointer to the ::WIMStruct for a WIM file.
2121 * @param image_name_or_num
2122 * A string specifying the name or number of an image in the WIM. If it
2123 * parses to a positive integer, this integer is taken to specify the
2124 * number of the image, indexed starting at 1. Otherwise, it is taken to
2125 * be the name of an image, as given in the XML data for the WIM file. It
2126 * also may be the keyword "all" or the string "*", both of which will
2127 * resolve to ::WIMLIB_ALL_IMAGES.
2129 * There is no way to search for an image actually named "all", "*", or an
2130 * integer number, or an image that has no name. However, you can use
2131 * wimlib_get_image_name() to get the name of any image.
2134 * If the string resolved to a single existing image, the number of that
2135 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2136 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2137 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2138 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2139 * images in @a wim has no name.
2142 wimlib_resolve_image(WIMStruct *wim,
2143 const wimlib_tchar *image_name_or_num);
2146 * Sets which image in the WIM is marked as bootable.
2149 * Pointer to the ::WIMStruct for a WIM file.
2151 * The number of the image to mark as bootable, or 0 to mark no image as
2153 * @return 0 on success; nonzero on error.
2154 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2155 * @a boot_idx does not specify an existing image in @a wim, and it was not
2157 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2158 * @a wim is part of a split WIM. We do not support changing the boot
2159 * index of a split WIM.
2162 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2165 * Changes the description of an image in the WIM.
2168 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2169 * standalone WIM or part of a split WIM; however, you should set the same
2170 * description on all parts of a split WIM.
2172 * The number of the image for which to change the description.
2173 * @param description
2174 * The new description to give the image. It may be @c NULL, which
2175 * indicates that the image is to be given no description.
2177 * @return 0 on success; nonzero on error.
2178 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2179 * @a image does not specify a single existing image in @a wim.
2180 * @retval ::WIMLIB_ERR_NOMEM
2181 * Failed to allocate the memory needed to duplicate the @a description
2185 wimlib_set_image_descripton(WIMStruct *wim, int image,
2186 const wimlib_tchar *description);
2189 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2190 * (something like "Core" or "Ultimate")
2193 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2194 * standalone WIM or part of a split WIM; however, you should set the same
2195 * \<FLAGS\> element on all parts of a split WIM.
2197 * The number of the image for which to change the description.
2199 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2200 * indicates that the image is to be given no \<FLAGS\> element.
2202 * @return 0 on success; nonzero on error.
2203 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2204 * @a image does not specify a single existing image in @a wim.
2205 * @retval ::WIMLIB_ERR_NOMEM
2206 * Failed to allocate the memory needed to duplicate the @a flags string.
2208 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2209 const wimlib_tchar *flags);
2212 * Changes the name of an image in the WIM.
2215 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2216 * standalone WIM or part of a split WIM; however, you should set the same
2217 * name on all parts of a split WIM.
2219 * The number of the image for which to change the name.
2221 * The new name to give the image. It must be a nonempty string.
2223 * @return 0 on success; nonzero on error.
2224 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2225 * There is already an image named @a name in @a wim.
2226 * @retval ::WIMLIB_ERR_INVALID_PARAM
2227 * @a name was @c NULL or the empty string.
2228 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2229 * @a image does not specify a single existing image in @a wim.
2230 * @retval ::WIMLIB_ERR_NOMEM
2231 * Failed to allocate the memory needed to duplicate the @a name string.
2233 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2234 const wimlib_tchar *name);
2237 * Set the functions that wimlib uses to allocate and free memory.
2239 * These settings are global and not per-WIM.
2241 * The default is to use the default @c malloc() and @c free() from the C
2244 * Please note that some external functions, such as those in @c libntfs-3g, may
2245 * use the standard memory allocation functions.
2247 * @param malloc_func
2248 * A function equivalent to @c malloc() that wimlib will use to allocate
2249 * memory. If @c NULL, the allocator function is set back to the default
2250 * @c malloc() from the C library.
2252 * A function equivalent to @c free() that wimlib will use to free memory.
2253 * If @c NULL, the free function is set back to the default @c free() from
2255 * @param realloc_func
2256 * A function equivalent to @c realloc() that wimlib will use to reallocate
2257 * memory. If @c NULL, the free function is set back to the default @c
2258 * realloc() from the C library.
2259 * @return 0 on success; nonzero on error.
2260 * @retval ::WIMLIB_ERR_UNSUPPORTED
2261 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2262 * so custom memory allocators are unsupported.
2265 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2266 void (*free_func)(void *),
2267 void *(*realloc_func)(void *, size_t));
2270 * Sets whether wimlib is to print error messages to @c stderr when a function
2271 * fails. These error messages may provide information that cannot be
2272 * determined only from the error code that is returned. Not every error will
2273 * result in an error message being printed.
2275 * This setting is global and not per-WIM.
2277 * By default, error messages are not printed.
2279 * @param show_messages
2280 * @c true if error messages are to be printed; @c false if error messages
2281 * are not to be printed.
2283 * @return 0 on success; nonzero on error.
2284 * @retval ::WIMLIB_ERR_UNSUPPORTED
2285 * @a show_messages was @c true, but wimlib was compiled with the @c
2286 * --without-error-messages option. Therefore, error messages cannot be
2290 wimlib_set_print_errors(bool show_messages);
2293 * Splits a WIM into multiple parts.
2296 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2299 * Name of the SWM file to create. This will be the name of the first
2300 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2301 * appended before the suffix.
2303 * The maximum size per part, in bytes. It is not guaranteed that this
2304 * will really be the maximum size per part, because some file resources in
2305 * the WIM may be larger than this size, and the WIM file format provides
2306 * no way to split up file resources among multiple WIMs.
2307 * @param write_flags
2308 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2309 * included in the split WIM parts.
2310 * @param progress_func
2311 * If non-NULL, a function that will be called periodically with the
2312 * progress of the current operation.
2314 * @return 0 on success; nonzero on error. This function may return any value
2315 * returned by wimlib_write() as well as the following error codes:
2317 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2318 * @a wim is not part 1 of a stand-alone WIM.
2319 * @retval ::WIMLIB_ERR_INVALID_PARAM
2320 * @a swm_name was @c NULL, or @a part_size was 0.
2322 * Note: the WIM's uncompressed and compressed resources are not checksummed
2323 * when they are copied from the joined WIM to the split WIM parts, nor are
2324 * compressed resources re-compressed.
2327 wimlib_split(WIMStruct *wim,
2328 const wimlib_tchar *swm_name,
2331 wimlib_progress_func_t progress_func);
2334 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2336 * The image to unmount is specified by the path to the mountpoint, not the
2337 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2338 * touched and also may have been allocated in a different process.
2340 * To unmount the image, the thread calling this function communicates with the
2341 * thread that is managing the mounted WIM image. This function blocks until it
2342 * is known whether the unmount succeeded or failed. In the case of a
2343 * read-write mounted WIM, the unmount is not considered to have succeeded until
2344 * all changes have been saved to the underlying WIM file.
2347 * The directory that the WIM image was mounted on.
2348 * @param unmount_flags
2349 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2350 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2351 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2353 * @param progress_func
2354 * If non-NULL, a function that will be called periodically with the
2355 * progress of the current operation.
2357 * @return 0 on success; nonzero on error.
2359 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2360 * The filesystem daemon was unable to remove the staging directory and the
2361 * temporary files that it contains.
2362 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2363 * The filesystem daemon appears to have terminated before sending an exit
2365 * @retval ::WIMLIB_ERR_FORK
2366 * Could not @c fork() the process.
2367 * @retval ::WIMLIB_ERR_FUSERMOUNT
2368 * The @b fusermount program could not be executed or exited with a failure
2370 * @retval ::WIMLIB_ERR_MQUEUE
2371 * Could not open a POSIX message queue to communicate with the filesystem
2372 * daemon servicing the mounted filesystem, could not send a message
2373 * through the queue, or could not receive a message through the queue.
2374 * @retval ::WIMLIB_ERR_NOMEM
2375 * Failed to allocate needed memory.
2376 * @retval ::WIMLIB_ERR_OPEN
2377 * The filesystem daemon could not open a temporary file for writing the
2379 * @retval ::WIMLIB_ERR_READ
2380 * A read error occurred when the filesystem daemon tried to a file from
2381 * the staging directory
2382 * @retval ::WIMLIB_ERR_RENAME
2383 * The filesystem daemon failed to rename the newly written WIM file to the
2384 * original WIM file.
2385 * @retval ::WIMLIB_ERR_WRITE
2386 * A write error occurred when the filesystem daemon was writing to the new
2387 * WIM file, or the filesystem daemon was unable to flush changes that had
2388 * been made to files in the staging directory.
2391 wimlib_unmount_image(const wimlib_tchar *dir,
2393 wimlib_progress_func_t progress_func);
2396 * Writes a standalone WIM to a file.
2398 * This brings in resources from any external locations, such as directory trees
2399 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2400 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2403 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2404 * changes made to it, which are then reflected in the output file.
2406 * The path to the file to write the WIM to.
2408 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2410 * @param write_flags
2411 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2412 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2413 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2414 * @param num_threads
2415 * Number of threads to use for compressing data. If 0, the number of
2416 * threads is taken to be the number of online processors. Note: if no
2417 * data compression needs to be done, no additional threads will be created
2418 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2419 * exporting an image from a compressed WIM to another WIM of the same
2420 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2422 * @param progress_func
2423 * If non-NULL, a function that will be called periodically with the
2424 * progress of the current operation.
2426 * @return 0 on success; nonzero on error.
2427 * @retval ::WIMLIB_ERR_DECOMPRESSION
2428 * Failed to decompress a metadata or file resource in @a wim.
2429 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2430 * A directory entry in the metadata resource for @a image in @a wim is
2432 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2433 * @a image does not specify a single existing image in @a wim, and is not
2434 * ::WIMLIB_ALL_IMAGES.
2435 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2436 * A file that had previously been scanned for inclusion in the WIM by
2437 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2438 * message digest check.
2439 * @retval ::WIMLIB_ERR_INVALID_PARAM
2440 * @a path was @c NULL.
2441 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2442 * The metadata resource for @a image in @a wim is invalid.
2443 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2444 * The security data for @a image in @a wim is invalid.
2445 * @retval ::WIMLIB_ERR_NOMEM
2446 * Failed to allocate needed memory.
2447 * @retval ::WIMLIB_ERR_OPEN
2448 * Failed to open @a path for writing, or some file resources in @a
2449 * wim refer to files in the outside filesystem, and one of these files
2450 * could not be opened for reading.
2451 * @retval ::WIMLIB_ERR_READ
2452 * An error occurred when trying to read data from the WIM file associated
2453 * with @a wim, or some file resources in @a wim refer to files in the
2454 * outside filesystem, and a read error occurred when reading one of these
2456 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2457 * @a wim is part of a split WIM. You may not call this function on a
2459 * @retval ::WIMLIB_ERR_WRITE
2460 * An error occurred when trying to write data to the new WIM file at @a
2464 wimlib_write(WIMStruct *wim,
2465 const wimlib_tchar *path,
2468 unsigned num_threads,
2469 wimlib_progress_func_t progress_func);
2472 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2473 * the data using "XPRESS" compression.
2476 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2479 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2480 * the data is compressed using "XPRESS" compression.
2483 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2484 void *uncompressed_data, unsigned uncompressed_len);
2486 #endif /* _WIMLIB_H */