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.3. 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_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 3
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 /** A file or directory tree within a WIM image (not the full image) is
306 * about to be extracted. @a info will point to
307 * ::wimlib_progress_info.extract. */
308 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
310 /** The directory structure of the WIM image is about to be extracted.
311 * @a info will point to ::wimlib_progress_info.extract. */
312 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
314 /** The directory structure of the WIM image has been successfully
315 * extracted. @a info will point to ::wimlib_progress_info.extract. */
316 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
318 /** The WIM image's files resources are currently being extracted. @a
319 * info will point to ::wimlib_progress_info.extract. */
320 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
322 /** A file or directory is being extracted. @a info will point to
323 * ::wimlib_progress_info.extract, and the @a cur_path member will be
325 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
327 /** All the WIM files and directories have been extracted, and
328 * timestamps are about to be applied. @a info will point to
329 * ::wimlib_progress_info.extract. */
330 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
332 /** A WIM image has been successfully extracted. @a info will point to
333 * ::wimlib_progress_info.extract. */
334 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
336 /** A file or directory tree within a WIM image (not the full image) has
337 * been successfully extracted. @a info will point to
338 * ::wimlib_progress_info.extract. */
339 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
341 /** The directory or NTFS volume is about to be scanned to build a tree
342 * of WIM dentries in-memory. @a info will point to
343 * ::wimlib_progress_info.scan. */
344 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
346 /** A directory or file is being scanned. @a info will point to
347 * ::wimlib_progress_info.scan, and its @a cur_path member will be
348 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
349 * is passed to wimlib_add_image(). */
350 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
352 /** The directory or NTFS volume has been successfully scanned, and a
353 * tree of WIM dentries has been built in-memory. @a info will point to
354 * ::wimlib_progress_info.scan. */
355 WIMLIB_PROGRESS_MSG_SCAN_END,
358 * File resources are currently being written to the WIM.
359 * @a info will point to ::wimlib_progress_info.write_streams. */
360 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
363 * The metadata resource for each image is about to be written to the
364 * WIM. @a info will not be valid. */
365 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
368 * The metadata resource for each image has successfully been writen to
369 * the WIM. @a info will not be valid. */
370 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
373 * The temporary file has successfully been renamed to the original WIM
374 * file. Only happens when wimlib_overwrite() is called and the
375 * overwrite is not done in-place.
376 * @a info will point to ::wimlib_progress_info.rename. */
377 WIMLIB_PROGRESS_MSG_RENAME,
379 /** The contents of the WIM are being checked against the integrity
380 * table. Only happens when wimlib_open_wim() is called with the
381 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
382 * ::wimlib_progress_info.integrity. */
383 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
385 /** An integrity table is being calculated for the WIM being written.
386 * Only happens when wimlib_write() or wimlib_overwrite() is called with
387 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
388 * ::wimlib_progress_info.integrity. */
389 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
391 /** A wimlib_join() operation is in progress. @a info will point to
392 * ::wimlib_progress_info.join. */
393 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
395 /** A wimlib_split() operation is in progress, and a new split part is
396 * about to be started. @a info will point to
397 * ::wimlib_progress_info.split. */
398 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
400 /** A wimlib_split() operation is in progress, and a split part has been
401 * finished. @a info will point to ::wimlib_progress_info.split. */
402 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
405 /** A pointer to this union is passed to the user-supplied
406 * ::wimlib_progress_func_t progress function. One (or none) of the structures
407 * contained in this union will be applicable for the operation
408 * (::wimlib_progress_msg) indicated in the first argument to the progress
410 union wimlib_progress_info {
412 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
413 * document them if they aren't given a name... */
415 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
416 struct wimlib_progress_info_write_streams {
417 /** Number of bytes that are going to be written for all the
418 * streams combined. This is the amount in uncompressed data.
419 * (The actual number of bytes will be less if the data is being
420 * written compressed.) */
421 uint64_t total_bytes;
422 /** Number of streams that are going to be written. */
423 uint64_t total_streams;
425 /** Number of uncompressed bytes that have been written so far.
426 * Will be 0 initially, and equal to @a total_bytes at the end.
428 uint64_t completed_bytes;
430 /** Number of streams that have been written. Will be 0
431 * initially, and equal to @a total_streams at the end. */
432 uint64_t completed_streams;
434 /** Number of threads that are being used to compress resources
435 * (if applicable). */
436 unsigned num_threads;
438 /** The compression type being used to write the streams; either
439 * ::WIMLIB_COMPRESSION_TYPE_NONE,
440 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
441 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
442 int compression_type;
444 /** Library internal use only. */
448 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
449 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
450 struct wimlib_progress_info_scan {
451 /** Directory or NTFS volume that is being scanned. */
452 const wimlib_tchar *source;
454 /** Path to the file or directory that is about to be scanned,
455 * relative to the root of the image capture or the NTFS volume.
457 const wimlib_tchar *cur_path;
459 /** True iff @a cur_path is being excluded from the image
460 * capture due to the capture configuration file. */
463 /** Target path in the WIM. Only valid on messages
464 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
465 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
466 const wimlib_tchar *wim_target_path;
469 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
470 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
471 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
472 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
473 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
474 struct wimlib_progress_info_extract {
475 /** Number of the image being extracted (1-based). */
478 /** Flags passed to to wimlib_extract_image() */
481 /** Full path to the WIM file being extracted. */
482 const wimlib_tchar *wimfile_name;
484 /** Name of the image being extracted. */
485 const wimlib_tchar *image_name;
487 /** Directory or NTFS volume to which the image is being
489 const wimlib_tchar *target;
491 /** Current dentry being extracted. (Valid only if message is
492 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
493 const wimlib_tchar *cur_path;
495 /** Number of bytes of uncompressed data that will be extracted.
496 * Takes into account hard links (they are not counted for each
499 uint64_t total_bytes;
501 /** Number of bytes that have been written so far. Will be 0
502 * initially, and equal to @a total_bytes at the end. */
503 uint64_t completed_bytes;
505 /** Number of streams that will be extracted. This may more or
506 * less than the number of "files" to be extracted due to
507 * special cases (hard links, symbolic links, and alternate data
509 uint64_t num_streams;
511 /** Path to the root dentry within the WIM for the tree that is
512 * being extracted. Will be the empty string when extracting a
514 const wimlib_tchar *extract_root_wim_source_path;
517 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
518 struct wimlib_progress_info_rename {
519 /** Name of the temporary file that the WIM was written to. */
520 const wimlib_tchar *from;
522 /** Name of the original WIM file to which the temporary file is
524 const wimlib_tchar *to;
527 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
528 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
529 struct wimlib_progress_info_integrity {
530 /** Number of bytes from the end of the WIM header to the end of
531 * the lookup table (the area that is covered by the SHA1
532 * integrity checks.) */
533 uint64_t total_bytes;
535 /** Number of bytes that have been SHA1-summed so far. Will be
536 * 0 initially, and equal @a total_bytes at the end. */
537 uint64_t completed_bytes;
539 /** Number of chunks that the checksummed region is divided
541 uint32_t total_chunks;
543 /** Number of chunks that have been SHA1-summed so far. Will
544 * be 0 initially, and equal to @a total_chunks at the end. */
545 uint32_t completed_chunks;
547 /** Size of the chunks used for the integrity calculation. */
550 /** Filename of the WIM (only valid if the message is
551 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
552 const wimlib_tchar *filename;
555 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
556 struct wimlib_progress_info_join {
557 /** Total number of bytes of compressed data contained in all
558 * the split WIM part's file and metadata resources. */
559 uint64_t total_bytes;
561 /** Number of bytes that have been copied to the joined WIM so
562 * far. Will be 0 initially, and equal to @a total_bytes at the
564 uint64_t completed_bytes;
566 /** Number of split WIM parts that have had all their file and
567 * metadata resources copied over to the joined WIM so far. */
568 unsigned completed_parts;
570 /** Number of split WIM parts. */
571 unsigned total_parts;
574 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
575 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
576 struct wimlib_progress_info_split {
577 /** Total size of the original WIM's file and metadata resources
579 uint64_t total_bytes;
581 /** Number of bytes of file and metadata resources that have
582 * been copied out of the original WIM so far. Will be 0
583 * initially, and equal to @a total_bytes at the end. */
584 uint64_t completed_bytes;
586 /** Number of the split WIM part that is about to be started
587 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
588 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
589 unsigned cur_part_number;
591 /** Name of the split WIM part that is about to be started
592 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
593 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
594 const wimlib_tchar *part_name;
598 /** A user-supplied function that will be called periodically during certain WIM
599 * operations. The first argument will be the type of operation that is being
600 * performed or is about to be started or has been completed. The second
601 * argument will be a pointer to one of a number of structures depending on the
602 * first argument. It may be @c NULL for some message types.
604 * The return value of the progress function is currently ignored, but it may do
605 * something in the future. (Set it to 0 for now.)
607 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
608 const union wimlib_progress_info *info);
610 /** An array of these structures is passed to wimlib_add_image_multisource() to
611 * specify the sources from which to create a WIM image. */
612 struct wimlib_capture_source {
613 /** Absolute or relative path to a file or directory on the external
614 * filesystem to be included in the WIM image. */
615 wimlib_tchar *fs_source_path;
617 /** Destination path in the WIM image. Leading and trailing slashes are
618 * ignored. The empty string or @c NULL means the root directory of the
620 wimlib_tchar *wim_target_path;
622 /** Reserved; set to 0. */
626 /** Structure that specifies a list of path patterns. */
627 struct wimlib_pattern_list {
628 /** Array of patterns. The patterns may be modified by library code,
629 * but the @a pats pointer itself will not. See the man page for
630 * <b>wimlib-imagex capture</b> for more information about allowed
634 /** Number of patterns in the @a pats array. */
637 /** Ignored; may be used by the calling code. */
638 size_t num_allocated_pats;
641 /** A structure that contains lists of wildcards that match paths to treat
642 * specially when capturing a WIM image. */
643 struct wimlib_capture_config {
644 /** Paths matching any pattern this list are excluded from being
645 * captured, except if the same path appears in @a
646 * exclusion_exception_pats. */
647 struct wimlib_pattern_list exclusion_pats;
649 /** Paths matching any pattern in this list are never excluded from
651 struct wimlib_pattern_list exclusion_exception_pats;
653 /** Reserved for future capture configuration options. */
654 struct wimlib_pattern_list reserved1;
656 /** Reserved for future capture configuration options. */
657 struct wimlib_pattern_list reserved2;
659 /** Library internal use only. */
660 const wimlib_tchar *_prefix;
662 /** Library internal use only. */
663 size_t _prefix_num_tchars;
667 /*****************************
669 *****************************/
671 /** Directly capture a NTFS volume rather than a generic directory. This flag
672 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
673 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
674 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
676 /** Follow symlinks; archive and dump the files they point to. Cannot be used
677 * with ::WIMLIB_ADD_FLAG_NTFS. */
678 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
680 /** Call the progress function with the message
681 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
683 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
685 /** Mark the image being added as the bootable image of the WIM. */
686 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
688 /** Store the UNIX owner, group, and mode. This is done by adding a special
689 * alternate data stream to each regular file, symbolic link, and directory to
690 * contain this information. Please note that this flag is for convenience
691 * only; Microsoft's @a imagex.exe will not understand this special information.
692 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
693 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
695 /** Do not capture security descriptors. Only has an effect in NTFS capture
696 * mode, or in Win32 native builds. */
697 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
699 /** Fail immediately if the full security descriptor of any file or directory
700 * cannot be accessed. Only has an effect in Win32 native builds. The default
701 * behavior without this flag is to first try omitting the SACL from the
702 * security descriptor, then to try omitting the security descriptor entirely.
704 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
706 /** Call the progress function with the message
707 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
708 * capture. This is a subset of the messages provided by
709 * ::WIMLIB_ADD_FLAG_VERBOSE. */
710 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
712 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
713 * in the case of Windows) that point inside the directory being captured to
714 * instead be absolute relative to the directory being captured, rather than the
715 * current root; also exclude absolute symbolic links that point outside the
716 * directory tree being captured.
718 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
719 * the WIM header or if this is the first image being added.
720 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
721 * reparse point fixups enabled and currently cannot be unset. */
722 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
724 /** Don't do reparse point fixups. The default behavior is described in the
725 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
726 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
728 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
729 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
730 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
731 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
732 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
733 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
734 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
735 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
736 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
737 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
739 /******************************
740 * WIMLIB_DELETE_FLAG_*
741 ******************************/
743 /** Do not issue an error if the path to delete does not exist. */
744 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
746 /** Delete the file or directory tree recursively; if not specified, an error is
747 * issued if the path to delete is a directory. */
748 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
750 /******************************
751 * WIMLIB_EXPORT_FLAG_*
752 ******************************/
754 /** See documentation for wimlib_export_image(). */
755 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
757 /******************************
758 * WIMLIB_EXTRACT_FLAG_*
759 ******************************/
761 /** Extract the image directly to a NTFS volume rather than a generic directory.
763 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
765 /** When identical files are extracted from the WIM, always hard link them
766 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
767 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
769 /** When identical files are extracted from the WIM, always symlink them
770 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
771 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
773 /** Call the progress function with the argument
774 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
775 * extracted. Note: these calls will be interspersed with calls for the message
776 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
777 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
779 /** Read the WIM file sequentially while extracting the image. */
780 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
782 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
783 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
784 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
786 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
787 * or in Win32 native builds. */
788 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
790 /** Fail immediately if the full security descriptor of any file or directory
791 * cannot be set exactly as specified in the WIM file. The default behavior
792 * without this flag is to fall back to setting the security descriptor with the
793 * SACL omitted, then only the default inherited security descriptor, if we do
794 * not have permission to set the desired one. */
795 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
797 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
798 * fixups on, so absolute symbolic links or junction points will be fixed to be
799 * absolute relative to the actual extraction root. Done by default if
800 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
801 * specified when extracting a full image. */
802 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
804 /** Force reparse-point fixups on extraction off, regardless of the state of the
805 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
806 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
808 /** Extract files to standard output rather than to the filesystem. */
809 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
811 /******************************
812 * WIMLIB_MOUNT_FLAG_*
813 ******************************/
815 /** Mount the WIM image read-write rather than the default of read-only. */
816 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
818 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
819 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
821 /** Do not allow accessing alternate data streams in the mounted WIM image. */
822 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
824 /** Access alternate data streams in the mounted WIM image through extended file
825 * attributes. This is the default mode. */
826 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
828 /** Access alternate data streams in the mounted WIM image by specifying the
829 * file name, a colon, then the alternate file stream name. */
830 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
832 /** Use UNIX file owners, groups, and modes if available in the WIM (see
833 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
834 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
836 /** Allow other users to see the mounted filesystem. (this passes the @c
837 * allow_other option to FUSE mount) */
838 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
840 /******************************
842 ******************************/
844 /** Verify the WIM contents against the WIM's integrity table, if present. */
845 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
847 /** Do not issue an error if the WIM is part of a split WIM. */
848 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
850 /******************************
851 * WIMLIB_UNMOUNT_FLAG_*
852 ******************************/
854 /** Include an integrity table in the WIM after it's been unmounted. Ignored
855 * for read-only mounts. */
856 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
858 /** Unless this flag is given, changes to a read-write mounted WIM are
859 * discarded. Ignored for read-only mounts. */
860 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
862 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
863 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
865 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
866 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
868 /******************************
869 * WIMLIB_WRITE_FLAG_*
870 ******************************/
872 /** Include an integrity table in the new WIM file. */
873 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
875 /** Re-build the entire WIM file rather than appending data to it, if possible.
876 * (Applies to wimlib_overwrite(), not wimlib_write()). */
877 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
879 /** Recompress all resources, even if they could otherwise be copied from a
880 * different WIM with the same compression type (in the case of
881 * wimlib_export_image() being called previously). */
882 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
884 /** Call fsync() when the WIM file is closed */
885 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
887 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
888 * after one or more calls to wimlib_delete_image(), which is to rebuild the
891 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
892 * correctly remove the image from the WIM will be taken. In particular, all
893 * streams will be left alone, even if they are no longer referenced. This is
894 * probably not what you want, because almost no space will be spaced by
895 * deleting an image in this way. */
896 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
898 /******************************
900 ******************************/
902 /** Assume that strings are represented in UTF-8, even if this is not the
903 * locale's character encoding. */
904 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
906 /** Specification of an update to perform on a WIM image. */
907 struct wimlib_update_command {
909 /** The specific type of update to perform. */
910 enum wimlib_update_op {
911 /** Add a new file or directory tree to the WIM image in a
912 * certain location. */
913 WIMLIB_UPDATE_OP_ADD = 0,
915 /** Delete a file or directory tree from the WIM image. */
916 WIMLIB_UPDATE_OP_DELETE,
918 /** Rename a file or directory tree in the WIM image. */
919 WIMLIB_UPDATE_OP_RENAME,
922 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
923 struct wimlib_add_command {
924 /** Filesystem path to the file or directory tree to
926 wimlib_tchar *fs_source_path;
927 /** Path, specified from the root of the WIM image, at
928 * which to add the file or directory tree within the
930 wimlib_tchar *wim_target_path;
932 /** Configuration for excluded files. @c NULL means
933 * exclude no files. */
934 struct wimlib_capture_config *config;
936 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
939 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
940 struct wimlib_delete_command {
941 /** Path, specified from the root of the WIM image, for
942 * the file or directory tree within the WIM image to be
944 wimlib_tchar *wim_path;
945 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
948 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
949 struct wimlib_rename_command {
950 /** Path, specified from the root of the WIM image, for
951 * the source file or directory tree within the WIM
953 wimlib_tchar *wim_source_path;
954 /** Path, specified from the root of the WIM image, for
955 * the destination file or directory tree within the WIM
957 wimlib_tchar *wim_target_path;
958 /** Reserved; set to 0. */
964 /** Specification of a file or directory tree to extract from a WIM image. */
965 struct wimlib_extract_command {
966 /** Path to file or directory tree within the WIM image to extract. It
967 * must be provided as an absolute path from the root of the WIM image.
968 * The path separators may be either forward slashes or backslashes. */
969 wimlib_tchar *wim_source_path;
971 /** Filesystem path to extract the file or directory tree to. */
972 wimlib_tchar *fs_dest_path;
974 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
979 * Possible values of the error code returned by many functions in wimlib.
981 * See the documentation for each wimlib function to see specifically what error
982 * codes can be returned by a given function, and what they mean.
984 enum wimlib_error_code {
985 WIMLIB_ERR_SUCCESS = 0,
986 WIMLIB_ERR_ALREADY_LOCKED,
987 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
988 WIMLIB_ERR_DECOMPRESSION,
989 WIMLIB_ERR_DELETE_STAGING_DIR,
990 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
993 WIMLIB_ERR_FUSERMOUNT,
994 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
995 WIMLIB_ERR_IMAGE_COUNT,
996 WIMLIB_ERR_IMAGE_NAME_COLLISION,
997 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
998 WIMLIB_ERR_INTEGRITY,
999 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
1000 WIMLIB_ERR_INVALID_CHUNK_SIZE,
1001 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
1002 WIMLIB_ERR_INVALID_DENTRY,
1003 WIMLIB_ERR_INVALID_HEADER_SIZE,
1004 WIMLIB_ERR_INVALID_IMAGE,
1005 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
1006 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
1007 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
1008 WIMLIB_ERR_INVALID_OVERLAY,
1009 WIMLIB_ERR_INVALID_PARAM,
1010 WIMLIB_ERR_INVALID_PART_NUMBER,
1011 WIMLIB_ERR_INVALID_REPARSE_DATA,
1012 WIMLIB_ERR_INVALID_RESOURCE_HASH,
1013 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
1014 WIMLIB_ERR_INVALID_SECURITY_DATA,
1015 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
1016 WIMLIB_ERR_INVALID_UTF16_STRING,
1017 WIMLIB_ERR_INVALID_UTF8_STRING,
1018 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
1024 WIMLIB_ERR_NOT_A_WIM_FILE,
1025 WIMLIB_ERR_NO_FILENAME,
1030 WIMLIB_ERR_READLINK,
1033 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
1034 WIMLIB_ERR_RESOURCE_ORDER,
1035 WIMLIB_ERR_SPECIAL_FILE,
1036 WIMLIB_ERR_SPLIT_INVALID,
1037 WIMLIB_ERR_SPLIT_UNSUPPORTED,
1040 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
1041 WIMLIB_ERR_UNKNOWN_VERSION,
1042 WIMLIB_ERR_UNSUPPORTED,
1043 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
1046 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
1047 WIMLIB_ERR_NOT_A_REGULAR_FILE,
1048 WIMLIB_ERR_IS_DIRECTORY,
1049 WIMLIB_ERR_NOTEMPTY,
1053 /** Used to indicate no WIM image or an invalid WIM image. */
1054 #define WIMLIB_NO_IMAGE 0
1056 /** Used to specify all images in the WIM. */
1057 #define WIMLIB_ALL_IMAGES (-1)
1060 * Appends an empty image to a WIM file. This empty image will initially
1061 * contain no files or directories, although if written without further
1062 * modifications, a root directory will be created automatically for it.
1065 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
1068 * Name to give the new image.
1069 * @param new_idx_ret
1070 * If non-<code>NULL</code>, the index of the newly added image is returned
1073 * @return 0 on success; nonzero on failure. The possible error codes are:
1075 * @retval ::WIMLIB_ERR_INVALID_PARAM
1076 * @a name was @c NULL or an empty string.
1077 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1078 * @a wim is part of a split WIM.
1079 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1080 * There is already an image in @a wim named @a name.
1081 * @retval ::WIMLIB_ERR_NOMEM
1082 * Failed to allocate the memory needed to add the new image.
1085 wimlib_add_empty_image(WIMStruct *wim,
1086 const wimlib_tchar *name,
1090 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1092 * The directory tree or NTFS volume is scanned immediately to load the dentry
1093 * tree into memory, and file attributes and symbolic links are read. However,
1094 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1097 * See the manual page for the @b wimlib-imagex program for more information
1098 * about the "normal" capture mode versus the NTFS capture mode (entered by
1099 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1101 * Note that @b no changes are committed to the underlying WIM file (if
1102 * any) until wimlib_write() or wimlib_overwrite() is called.
1105 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1108 * A path to a directory or unmounted NTFS volume that will be captured as
1111 * The name to give the image. It must be nonempty and must specify a name
1112 * that does not yet exist in @a wim.
1114 * Capture configuration that specifies files, directories, or path globs
1115 * to exclude from being captured. If @c NULL, a dummy configuration where
1116 * no paths are treated specially is used.
1118 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1119 * @param progress_func
1120 * If non-NULL, a function that will be called periodically with the
1121 * progress of the current operation.
1123 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1124 * discarded so that it appears to be in the same state as when this function
1127 * This function is implemented by calling wimlib_add_empty_image(), then
1128 * calling wimlib_update_image() with a single "add" command, so any error code
1129 * returned by wimlib_add_empty_image() may be returned, as well as any error
1130 * codes returned by wimlib_update_image() other than ones documented as only
1131 * being returned specifically by an update involving delete or rename commands.
1134 wimlib_add_image(WIMStruct *wim,
1135 const wimlib_tchar *source,
1136 const wimlib_tchar *name,
1137 const struct wimlib_capture_config *config,
1139 wimlib_progress_func_t progress_func);
1141 /** This function is equivalent to wimlib_add_image() except it allows for
1142 * multiple sources to be combined into a single WIM image. This is done by
1143 * specifying the @a sources and @a num_sources parameters instead of the @a
1144 * source parameter of wimlib_add_image(). The rest of the parameters are the
1145 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1146 * capture</b> for full details on how this mode works.
1148 * In addition to the error codes that wimlib_add_image() can return,
1149 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1150 * when trying to overlay a non-directory on a directory or when otherwise
1151 * trying to overlay multiple conflicting files to the same location in the WIM
1152 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1153 * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1154 * was not exactly one capture source with the target being the root directory.
1155 * (In this respect, there is no advantage to using
1156 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1159 wimlib_add_image_multisource(WIMStruct *wim,
1160 const struct wimlib_capture_source *sources,
1162 const wimlib_tchar *name,
1163 const struct wimlib_capture_config *config,
1165 wimlib_progress_func_t progress_func);
1168 * Creates a ::WIMStruct for a new WIM file.
1170 * This only creates an in-memory structure for a WIM that initially contains no
1171 * images. No on-disk file is created until wimlib_write() is called.
1174 * The type of compression to be used in the new WIM file. Must be
1175 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1176 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1178 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1179 * written to the memory location pointed to by this paramater. The
1180 * ::WIMStruct must be freed using using wimlib_free() when finished with
1182 * @return 0 on success; nonzero on error.
1183 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1184 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1185 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1186 * @retval ::WIMLIB_ERR_NOMEM
1187 * Failed to allocate needed memory.
1190 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1193 * Deletes an image, or all images, from a WIM file.
1195 * All streams referenced by the image(s) being deleted are removed from the
1196 * lookup table of the WIM if they are not referenced by any other images in the
1199 * Please note that @b no changes are committed to the underlying WIM file (if
1200 * any) until wimlib_write() or wimlib_overwrite() is called.
1203 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1206 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1208 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1209 * to be left unmodified only if @a image specified a single image. If instead
1210 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1211 * possible for some but not all of the images to have been deleted when a
1212 * failure status is returned.
1214 * @retval ::WIMLIB_ERR_DECOMPRESSION
1215 * Could not decompress the metadata resource for @a image.
1216 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1217 * A directory entry in the metadata resource for @a image in the WIM is
1219 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1220 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1221 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1222 * The metadata resource for @a image in the WIM is invalid.
1223 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1224 * The security data for @a image in the WIM is invalid.
1225 * @retval ::WIMLIB_ERR_NOMEM
1226 * Failed to allocate needed memory.
1227 * @retval ::WIMLIB_ERR_READ
1228 * Could not read the metadata resource for @a image from the WIM.
1229 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1230 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1234 wimlib_delete_image(WIMStruct *wim, int image);
1237 * Exports an image, or all the images, from a WIM file, into another WIM file.
1239 * The destination image is made to share the same dentry tree and security data
1240 * structure as the source image. This places some restrictions on additional
1241 * functions that may be called. wimlib_mount_image() may not be called on
1242 * either the source image or the destination image without an intervening call
1243 * to a function that un-shares the images, such as wimlib_free() on @a
1244 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1245 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1246 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1247 * have references back to @a src_wim.
1249 * If this function fails, all changes to @a dest_wim are rolled back.
1251 * No changes shall be made to @a src_wim by this function.
1253 * Please note that no changes are committed to the underlying WIM file of @a
1254 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1257 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1258 * WIM that contains the image(s) being exported.
1260 * The image to export from @a src_wim. Can be the number of an image, or
1261 * ::WIMLIB_ALL_IMAGES to export all images.
1263 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1266 * The name to give the exported image in the new WIM file. If left @c
1267 * NULL, the name from @a src_wim is used. This parameter must be left @c
1268 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1269 * than one image; in that case, the names are all taken from the @a
1270 * src_wim. (This is allowed even if one or more images being exported has
1272 * @param dest_description
1273 * The description to give the exported image in the new WIM file. If left
1274 * @c NULL, the description from the @a src_wim is used. This parameter must
1275 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1276 * more than one image; in that case, the descriptions are all taken from
1277 * @a src_wim. (This is allowed even if one or more images being exported
1278 * has no description.)
1279 * @param export_flags
1280 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1281 * bootable, or 0 if which image is marked as bootable in the destination
1282 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1283 * there are multiple images in @a src_wim, specifying
1284 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1285 * currently marked as bootable in @a src_wim; if that is the case, then
1286 * that image is marked as bootable in the destination WIM.
1287 * @param additional_swms
1288 * Array of pointers to the ::WIMStruct for each additional part in the
1289 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1290 * need to be in any particular order, but they must include all parts of
1291 * the split WIM other than the first part, which must be provided in the
1293 * @param num_additional_swms
1294 * Number of additional WIM parts provided in the @a additional_swms array.
1295 * This number should be one less than the total number of parts in the
1296 * split WIM. Set to 0 if the WIM is a standalone WIM.
1297 * @param progress_func
1298 * If non-NULL, a function that will be called periodically with the
1299 * progress of the current operation.
1301 * @return 0 on success; nonzero on error.
1302 * @retval ::WIMLIB_ERR_DECOMPRESSION
1303 * Could not decompress the metadata resource for @a src_image
1305 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1306 * One or more of the names being given to an exported image was already in
1307 * use in the destination WIM.
1308 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1309 * A directory entry in the metadata resource for @a src_image in @a
1310 * src_wim is invalid.
1311 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1312 * @a src_image does not exist in @a src_wim.
1313 * @retval ::WIMLIB_ERR_INVALID_PARAM
1314 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1315 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1316 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1317 * dest_description were non-<code>NULL</code>, @a src_image was
1318 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1319 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1320 * The metadata resource for @a src_image in @a src_wim is invalid.
1321 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1322 * The security data for @a src_image in @a src_wim is invalid.
1323 * @retval ::WIMLIB_ERR_NOMEM
1324 * Failed to allocate needed memory.
1325 * @retval ::WIMLIB_ERR_READ
1326 * Could not read the metadata resource for @a src_image from @a src_wim.
1327 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1328 * The source WIM is a split WIM, but the parts specified do not form a
1329 * complete split WIM because they do not include all the parts of the
1330 * original WIM, there are duplicate parts, or not all the parts have the
1331 * same GUID and compression type.
1332 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1333 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1337 wimlib_export_image(WIMStruct *src_wim, int src_image,
1338 WIMStruct *dest_wim,
1339 const wimlib_tchar *dest_name,
1340 const wimlib_tchar *dest_description,
1342 WIMStruct **additional_swms,
1343 unsigned num_additional_swms,
1344 wimlib_progress_func_t progress_func);
1347 * Extract zero or more files or directory trees from a WIM image.
1349 * This generalizes the single-image extraction functionality of
1350 * wimlib_extract_image() to allow extracting only the specified subsets of the
1354 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1358 * The 1-based number of the image in @a wim from which the files or
1359 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1361 * @param default_extract_flags
1362 * Default extraction flags; the behavior shall be as if these flags had
1363 * been specified in the ::wimlib_extract_command.extract_flags member in
1364 * each extraction command, in combination with any flags already present.
1367 * An array of ::wimlib_extract_command structures that specifies the
1368 * extractions to perform.
1371 * Number of commands in the @a cmds array.
1373 * @param additional_swms
1374 * Array of pointers to the ::WIMStruct for each additional part in the
1375 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1376 * need to be in any particular order, but they must include all parts of
1377 * the split WIM other than the first part, which must be provided in the
1380 * @param num_additional_swms
1381 * Number of additional WIM parts provided in the @a additional_swms array.
1382 * This number should be one less than the total number of parts in the
1383 * split WIM. Set to 0 if the WIM is a standalone WIM.
1385 * @param progress_func
1386 * If non-NULL, a function that will be called periodically with the
1387 * progress of the current operation.
1389 * @return 0 on success; nonzero on error. The possible error codes include
1390 * those documented as returned by wimlib_extract_image() as well as the
1391 * following additional error codes:
1393 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1394 * The ::wimlib_extract_command.wim_source_path member in one of the
1395 * extract commands did not exist in the WIM.
1396 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1397 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1398 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1399 * regular file or directory.
1400 * @retval ::WIMLIB_ERR_INVALID_PARAM
1401 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1402 * specified for some commands but not all; or
1403 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1404 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1405 * for a command in which ::wimlib_extract_command.wim_source_path did not
1406 * specify the root directory of the WIM image.
1409 wimlib_extract_files(WIMStruct *wim,
1411 int default_extract_flags,
1412 const struct wimlib_extract_command *cmds,
1414 WIMStruct **additional_swms,
1415 unsigned num_additional_swms,
1416 wimlib_progress_func_t progress_func);
1419 * Extracts an image, or all images, from a standalone or split WIM file to a
1420 * directory or a NTFS volume.
1422 * Please see the manual page for the @c wimlib-imagex program for more
1423 * information about the "normal" extraction mode versus the NTFS extraction
1424 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1426 * Extraction is done with one thread.
1428 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1429 * returned if any resulting SHA1 message digests do not match the values
1430 * provided in the WIM file. Therefore, if this function is successful, you can
1431 * be fairly sure that any compressed data in the WIM was uncompressed
1435 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1438 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1439 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1440 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1442 * Directory to extract the WIM image(s) to (created if it does not already
1443 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1444 * path to the unmounted NTFS volume to extract the image to.
1445 * @param extract_flags
1446 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1448 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1449 * a NTFS volume to extract the image to. The volume will be opened using
1450 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1451 * Otherwise, @a target is interpreted as a directory to extract the
1454 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1455 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1456 * specified. These flags cause extracted files that are identical to be
1457 * hardlinked or symlinked together, depending on the flag. These flags
1458 * override the hard link groups that are specified in the WIM file itself.
1459 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1460 * hardlinked or symlinked across images if a file is found to occur in
1461 * more than one image.
1463 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1464 * name of each file or directory as it is extracted.
1466 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1467 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1468 * each image is considered separately with regards to the sequential
1469 * order. It is also possible for alternate data streams to break the
1470 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1472 * @param additional_swms
1473 * Array of pointers to the ::WIMStruct for each additional part in the
1474 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1475 * need to be in any particular order, but they must include all parts of
1476 * the split WIM other than the first part, which must be provided in the
1478 * @param num_additional_swms
1479 * Number of additional WIM parts provided in the @a additional_swms array.
1480 * This number should be one less than the total number of parts in the
1481 * split WIM. Set to 0 if the WIM is a standalone WIM.
1483 * @param progress_func
1484 * If non-NULL, a function that will be called periodically with the
1485 * progress of the current operation.
1487 * @return 0 on success; nonzero on error.
1488 * @retval ::WIMLIB_ERR_DECOMPRESSION
1489 * Could not decompress a resource (file or metadata) for @a image in @a
1491 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1492 * A directory entry in the metadata resource for @a image in @a wim is
1494 * @retval ::WIMLIB_ERR_INVALID_PARAM
1495 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1496 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1497 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1498 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1499 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1500 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1501 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1502 * specified in @a extract_flag.
1503 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1504 * The SHA1 message digest of an extracted stream did not match the SHA1
1505 * message digest given in the WIM file.
1506 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1507 * A resource (file or metadata) for @a image in @a wim is invalid.
1508 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1509 * The security data for @a image in @a wim is invalid.
1510 * @retval ::WIMLIB_ERR_LINK
1511 * Failed to create a symbolic link or a hard link (only if
1512 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1513 * @retval ::WIMLIB_ERR_MKDIR
1514 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1515 * not specified in @a extract_flags).
1516 * @retval ::WIMLIB_ERR_NOMEM
1517 * Failed to allocate needed memory.
1518 * @retval ::WIMLIB_ERR_NTFS_3G
1519 * An error was returned from a libntfs-3g function while the WIM image was
1520 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1521 * was specified in @a extract_flags).
1522 * @retval ::WIMLIB_ERR_OPEN
1523 * Could not open one of the files being extracted for writing (only if
1524 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1525 * @retval ::WIMLIB_ERR_READ
1526 * A unexpected end-of-file or read error occurred when trying to read data
1527 * from the WIM file associated with @a wim.
1528 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1529 * The WIM is a split WIM, but the parts specified do not form a complete
1530 * split WIM because they do not include all the parts of the original WIM,
1531 * there are duplicate parts, or not all the parts have the same GUID and
1533 * @retval ::WIMLIB_ERR_UNSUPPORTED
1534 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1535 * was configured with the @c --without-ntfs-3g flag.
1536 * @retval ::WIMLIB_ERR_WRITE
1537 * Failed to write a file being extracted (only if
1538 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1541 wimlib_extract_image(WIMStruct *wim, int image,
1542 const wimlib_tchar *target,
1544 WIMStruct **additional_swms,
1545 unsigned num_additional_swms,
1546 wimlib_progress_func_t progress_func);
1549 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1550 * includes a string of XML that describes the images contained in the WIM.
1551 * This function works on standalone WIMs as well as split WIM parts.
1554 * Pointer to the ::WIMStruct for a WIM file.
1556 * @c stdout, or a FILE* opened for writing, to extract the data to.
1558 * @return 0 on success; nonzero on error.
1559 * @retval ::WIMLIB_ERR_WRITE
1560 * Failed to completely write the XML data to @a fp.
1561 * @retval ::WIMLIB_ERR_INVALID_PARAM
1562 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1565 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1568 * Frees all memory allocated for a WIMStruct and closes all files associated
1572 * Pointer to the ::WIMStruct for a WIM file.
1574 * @return This function has no return value.
1577 wimlib_free(WIMStruct *wim);
1580 * Returns the index of the bootable image of the WIM.
1583 * Pointer to the ::WIMStruct for a WIM file.
1586 * 0 if no image is marked as bootable, or the number of the image marked
1587 * as bootable (numbered starting at 1).
1590 wimlib_get_boot_idx(const WIMStruct *wim);
1593 * Returns the compression type used in the WIM.
1596 * Pointer to the ::WIMStruct for a WIM file
1599 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1600 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1603 wimlib_get_compression_type(const WIMStruct *wim);
1606 * Converts a ::wimlib_compression_type value into a string.
1609 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1610 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1613 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1616 extern const wimlib_tchar *
1617 wimlib_get_compression_type_string(int ctype);
1620 * Converts an error code into a string describing it.
1623 * The error code returned by one of wimlib's functions.
1626 * Pointer to a statically allocated string describing the error code,
1627 * or @c NULL if the error code is not valid.
1629 extern const wimlib_tchar *
1630 wimlib_get_error_string(enum wimlib_error_code code);
1633 * Returns the description of the specified image.
1636 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1637 * standalone WIM or a split WIM part.
1639 * The number of the image, numbered starting at 1.
1642 * The description of the image, or @c NULL if there is no such image, or
1643 * @c NULL if the specified image has no description. The description
1644 * string is in library-internal memory and may not be modified or freed;
1645 * in addition, the string will become invalid if the description of the
1646 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1648 extern const wimlib_tchar *
1649 wimlib_get_image_description(const WIMStruct *wim, int image);
1652 * Returns the name of the specified image.
1655 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1656 * standalone WIM or a split WIM part.
1658 * The number of the image, numbered starting at 1.
1661 * The name of the image, or @c NULL if there is no such image. The name
1662 * string is in library-internal memory and may not be modified or freed;
1663 * in addition, the string will become invalid if the name of the image is
1664 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1666 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1667 * the WIM to be unnamed, in which case an empty string will be returned
1668 * when the corresponding name is requested.
1670 extern const wimlib_tchar *
1671 wimlib_get_image_name(const WIMStruct *wim, int image);
1675 * Returns the number of images contained in a WIM.
1678 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1679 * standalone WIM or a split WIM part.
1682 * The number of images contained in the WIM file.
1685 wimlib_get_num_images(const WIMStruct *wim);
1688 * Returns the part number of a WIM in a split WIM and the total number of parts
1692 * Pointer to the ::WIMStruct for a WIM file.
1693 * @param total_parts_ret
1694 * If non-@c NULL, the total number of parts in the split WIM (1 for
1695 * non-split WIMs) is written to this location.
1698 * The part number of the WIM (1 for non-split WIMs)
1701 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1704 * Since wimlib 1.2.6: Initialization function for wimlib. This is not
1705 * re-entrant. If you are calling wimlib functions concurrently in different
1706 * threads, then you must call this function serially first.
1708 * Since wimlib 1.3.0, you must call this function if the character encoding of
1709 * the current locale is not UTF-8 and you do not want wimlib to assume a UTF-8
1712 * Since wimlib 1.3.2, you must call this function if using the Windows-native
1713 * build of the library so that certain functions can be dynamically loaded from
1716 * Since wimlib 1.3.3, this function takes the @a init_flags parameter.
1719 * ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume that all input
1720 * data, including filenames, are in UTF-8, and that UTF-8 data can be
1721 * directly printed to the console.
1723 * @return 0; other error codes may be returned in future releases.
1726 wimlib_global_init(int init_flags);
1729 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1730 * You are not required to call this function, but it will release any global
1731 * memory allocated by the library.
1734 wimlib_global_cleanup();
1737 * Returns true if the WIM has an integrity table.
1740 * Pointer to the ::WIMStruct for a WIM file.
1742 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1743 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1744 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1745 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1748 wimlib_has_integrity_table(const WIMStruct *wim);
1751 * Determines if an image name is already used by some image in the WIM.
1754 * Pointer to the ::WIMStruct for a WIM file.
1756 * The name to check.
1759 * @c true if there is already an image in @a wim named @a name; @c false
1760 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1761 * the empty string, @c false is returned.
1764 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1767 * Joins a split WIM into a stand-alone one-part WIM.
1770 * An array of strings that gives the filenames of all parts of the split
1771 * WIM. No specific order is required, but all parts must be included with
1774 * Number of filenames in @a swms.
1775 * @param swm_open_flags
1776 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1777 * part should be verified, if integrity tables are present. Otherwise,
1779 * @param wim_write_flags
1780 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1781 * @param output_path
1782 * The path to write the one-part WIM to.
1783 * @param progress_func
1784 * If non-NULL, a function that will be called periodically with the
1785 * progress of the current operation.
1787 * @return 0 on success; nonzero on error. This function may return any value
1788 * returned by wimlib_open_wim() and wimlib_write() except
1789 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1791 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1792 * The split WIMs do not form a valid WIM because they do not include all
1793 * the parts of the original WIM, there are duplicate parts, or not all the
1794 * parts have the same GUID and compression type.
1796 * Note: the WIM's uncompressed and compressed resources are not checksummed
1797 * when they are copied from the split WIM parts to the joined WIM, nor are
1798 * compressed resources re-compressed.
1800 * Note: wimlib_export_image() can provide similar functionality to
1801 * wimlib_join(), since it is possible to export all images from a split WIM.
1804 wimlib_join(const wimlib_tchar * const *swms,
1806 const wimlib_tchar *output_path,
1808 int wim_write_flags,
1809 wimlib_progress_func_t progress_func);
1812 * Compress a chunk of a WIM resource using LZX compression.
1814 * This function is exported for convenience only and need not be used.
1817 * Uncompressed data of the chunk.
1819 * Size of the uncompressed chunk, in bytes.
1821 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1824 * The size of the compressed data written to @a out in bytes, or 0 if the
1825 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1827 * As a special requirement, the compression code is optimized for the WIM
1828 * format and therefore requires (@a chunk_size <= 32768).
1831 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1834 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1836 * Note that this will NOT work unmodified for LZX as used in the cabinet
1837 * format, which is not the same as in the WIM format!
1839 * This function is exported for convenience only and need not be used.
1841 * @param compressed_data
1842 * Pointer to the compressed data.
1844 * @param compressed_len
1845 * Length of the compressed data, in bytes.
1847 * @param uncompressed_data
1848 * Pointer to the buffer into which to write the uncompressed data.
1850 * @param uncompressed_len
1851 * Length of the uncompressed data. It must be 32768 bytes or less.
1854 * 0 on success; non-zero on failure.
1857 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1858 void *uncompressed_data, unsigned uncompressed_len);
1862 * Mounts an image in a WIM file on a directory read-only or read-write.
1864 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1865 * process shall be daemonized.
1867 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1868 * modifications to the WIM are staged in a temporary directory.
1870 * It is safe to mount multiple images from the same WIM file read-only at the
1871 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1872 * to mount multiple images from the same WIM file read-write at the same time.
1874 * wimlib_mount_image() cannot be used on an image that was exported with
1875 * wimlib_export_image() while the dentry trees for both images are still in
1876 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1877 * that has just been added with wimlib_add_image(), unless the WIM has been
1878 * written and read into a new ::WIMStruct.
1881 * Pointer to the ::WIMStruct containing the image to be mounted.
1883 * The number of the image to mount, indexed starting from it. It must be
1884 * an existing, single image.
1886 * The path to an existing empty directory to mount the image on.
1887 * @param mount_flags
1888 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1890 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1891 * rather than the default of read-only.
1893 * WIMs may contain named (alternate) data streams, which are a somewhat
1894 * obscure NTFS feature. They can be read and written on a mounted WIM
1895 * through one of several interfaces. The interface to use if specified by
1896 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1897 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1898 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1899 * the XATTR interface.
1900 * @param additional_swms
1901 * Array of pointers to the ::WIMStruct for each additional part in the
1902 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1903 * need to be in any particular order, but they must include all parts of
1904 * the split WIM other than the first part, which must be provided in the
1906 * @param num_additional_swms
1907 * Number of additional WIM parts provided in the @a additional_swms array.
1908 * This number should be one less than the total number of parts in the
1909 * split WIM. Set to 0 if the WIM is a standalone WIM.
1910 * @param staging_dir
1911 * If non-NULL, the name of a directory in which the staging directory will
1912 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1913 * in @a mount_flags. If left @c NULL, the staging directory is created in
1914 * the same directory as the WIM file that @a wim was originally read from.
1916 * @return 0 on success; nonzero on error.
1918 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1919 * A read-write mount was requested, but an an exclusive advisory lock on
1920 * the on-disk WIM file could not be acquired because another thread or
1921 * process has mounted an image from the WIM read-write or is currently
1922 * modifying the WIM in-place.
1923 * @retval ::WIMLIB_ERR_DECOMPRESSION
1924 * Could not decompress the metadata resource for @a image in @a wim.
1925 * @retval ::WIMLIB_ERR_FUSE
1926 * A non-zero status was returned by @c fuse_main().
1927 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1928 * A directory entry in the metadata resource for @a image in @a wim is
1930 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1931 * @a image does not specify an existing, single image in @a wim.
1932 * @retval ::WIMLIB_ERR_INVALID_PARAM
1933 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1934 * wimlib_export_image(), or @a image has been added with
1935 * wimlib_add_image().
1936 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1937 * The metadata resource for @a image in @a wim is invalid.
1938 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1939 * The security data for @a image in @a wim is invalid.
1940 * @retval ::WIMLIB_ERR_MKDIR
1941 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1942 * staging directory could not be created.
1943 * @retval ::WIMLIB_ERR_NOMEM
1944 * Failed to allocate needed memory.
1945 * @retval ::WIMLIB_ERR_NOTDIR
1946 * Could not determine the current working directory.
1947 * @retval ::WIMLIB_ERR_READ
1948 * An unexpected end-of-file or read error occurred when trying to read
1949 * data from the WIM file associated with @a wim.
1950 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1951 * The WIM is a split WIM, but the parts specified do not form a complete
1952 * split WIM because they do not include all the parts of the original WIM,
1953 * there are duplicate parts, or not all the parts have the same GUID and
1955 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1956 * The WIM is a split WIM and a read-write mount was requested. We only
1957 * support mounting a split WIM read-only.
1960 wimlib_mount_image(WIMStruct *wim,
1962 const wimlib_tchar *dir,
1964 WIMStruct **additional_swms,
1965 unsigned num_additional_swms,
1966 const wimlib_tchar *staging_dir);
1969 * Opens a WIM file and creates a ::WIMStruct for it.
1972 * The path to the WIM file to open.
1974 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1975 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1977 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1978 * the WIM, if it exists, is checked, and this function will fail with an
1979 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1980 * digests of the WIM do not exactly match the corresponding message
1981 * digests given in the integrity table.
1983 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1984 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1985 * returned. (This flag may be removed in the future, in which case no
1986 * error will be issued when opening a split WIM.)
1988 * @param progress_func
1989 * If non-NULL, a function that will be called periodically with the
1990 * progress of the current operation.
1993 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1994 * is written to the memory location pointed to by this parameter. The
1995 * ::WIMStruct must be freed using using wimlib_free() when finished with
1998 * @return 0 on success; nonzero on error.
1999 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
2000 * The lookup table of @a wim_file is compressed. Support for this can be
2001 * added to wimlib if needed, but it appears to be the case that the lookup
2002 * table is never compressed.
2003 * @retval ::WIMLIB_ERR_IMAGE_COUNT
2004 * The WIM is not the non-first part of a split WIM, and the number of
2005 * metadata resources found in the WIM did not match the image count given
2006 * in the WIM header, or the number of <IMAGE> elements in the XML
2007 * data for the WIM did not match the image count given in the WIM header.
2008 * @retval ::WIMLIB_ERR_INTEGRITY
2009 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2010 * wim_file contains an integrity table, but the SHA1 message digest for a
2011 * chunk of the WIM does not match the corresponding message digest given
2012 * in the integrity table.
2013 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
2014 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
2015 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
2016 * The header of @a wim_file says that resources in the WIM are compressed,
2017 * but the header flag indicating LZX or XPRESS compression is not set.
2018 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
2019 * The length field of the WIM header is not 208.
2020 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
2021 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
2022 * wim_file contains an integrity table, but the integrity table is
2024 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
2025 * The lookup table for the WIM contained duplicate entries that are not
2026 * for metadata resources, or it contained an entry with a SHA1 message
2027 * digest of all 0's.
2028 * @retval ::WIMLIB_ERR_NOMEM
2029 * Failed to allocated needed memory.
2030 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
2031 * @a wim_file does not begin with the expected magic characters.
2032 * @retval ::WIMLIB_ERR_OPEN
2033 * Failed to open the file @a wim_file for reading.
2034 * @retval ::WIMLIB_ERR_READ
2035 * An unexpected end-of-file or read error occurred when trying to read
2036 * data from @a wim_file.
2037 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2038 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
2039 * specified in @a open_flags.
2040 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
2041 * A number other than 0x10d00 is written in the version field of the WIM
2042 * header of @a wim_file. (Probably a pre-Vista WIM).
2043 * @retval ::WIMLIB_ERR_XML
2044 * The XML data for @a wim_file is invalid.
2047 wimlib_open_wim(const wimlib_tchar *wim_file,
2049 WIMStruct **wim_ret,
2050 wimlib_progress_func_t progress_func);
2053 * Overwrites the file that the WIM was originally read from, with changes made.
2054 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
2055 * rather than wimlib_create_new_wim().
2057 * There are two ways that a WIM may be overwritten. The first is to do a full
2058 * rebuild. In this mode, the new WIM is written to a temporary file and then
2059 * renamed to the original file after it is has been completely written. The
2060 * temporary file is made in the same directory as the original WIM file. A
2061 * full rebuild may take a while, but can be used even if images have been
2062 * modified or deleted, will produce a WIM with no holes, and has little chance
2063 * of unintentional data loss because the temporary WIM is fsync()ed before
2064 * being renamed to the original WIM.
2066 * The second way to overwrite a WIM is by appending to the end of it and
2067 * overwriting the header. This can be much faster than a full rebuild, but it
2068 * only works if the only operations on the WIM have been to change the header
2069 * and/or XML data, or to add new images. Writing a WIM in this mode begins
2070 * with writing any new file resources *after* everything in the old WIM, even
2071 * though this will leave a hole where the old lookup table, XML data, and
2072 * integrity were. This is done so that the WIM remains valid even if the
2073 * operation is aborted mid-write. The WIM header is only overwritten at the
2074 * very last moment, and up until that point the WIM will be seen as the old
2077 * By default, the overwrite mode is determine automatically based on the past
2078 * operations performed on the ::WIMStruct. Use the flag
2079 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2080 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2081 * images have been deleted from the WIM.
2083 * In the temporary-file overwrite mode, no changes are made to the WIM on
2084 * failure, and the temporary file is deleted if possible. Abnormal termination
2085 * of the program will result in the temporary file being orphaned. In the
2086 * direct append mode, the WIM is truncated to the original length on failure;
2087 * and while abnormal termination of the program will result in extra data
2088 * appended to the original WIM, it should still be a valid WIM.
2090 * If this function completes successfully, no functions should be called on @a
2091 * wim other than wimlib_free(). You must use wimlib_open_wim() to read the WIM
2095 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2096 * been in-memory changes made to it, which are then reflected in the
2098 * @param write_flags
2099 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2100 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2101 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2102 * @param num_threads
2103 * Number of threads to use for compression (see wimlib_write()).
2104 * @param progress_func
2105 * If non-NULL, a function that will be called periodically with the
2106 * progress of the current operation.
2108 * @return 0 on success; nonzero on error. This function may return any value
2109 * returned by wimlib_write() as well as the following error codes:
2110 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2111 * The WIM was going to be modifien in-place (with no temporary file), but
2112 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2113 * because another thread or process has mounted an image from the WIM
2114 * read-write or is currently modifying the WIM in-place.
2115 * @retval ::WIMLIB_ERR_NO_FILENAME
2116 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2117 * than a WIM read with wimlib_open_wim().
2118 * @retval ::WIMLIB_ERR_RENAME
2119 * The temporary file that the WIM was written to could not be renamed to
2120 * the original filename of @a wim.
2123 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2124 wimlib_progress_func_t progress_func);
2127 * Prints information about one image, or all images, contained in a WIM.
2130 * Pointer to the ::WIMStruct for a WIM file.
2132 * The image about which to print information. Can be the number of an
2133 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2136 * @return This function has no return value. No error checking is done when
2137 * printing the information. If @a image is invalid, an error message is
2141 wimlib_print_available_images(const WIMStruct *wim, int image);
2144 * Prints the full paths to all files contained in an image, or all images, in a
2148 * Pointer to the ::WIMStruct for a WIM file.
2150 * Which image to print files for. Can be the number of an image, or
2151 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2153 * @return 0 on success; nonzero on error.
2154 * @retval ::WIMLIB_ERR_DECOMPRESSION
2155 * The metadata resource for one of the specified images could not be
2157 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2158 * A directory entry in the metadata resource for one of the specified
2159 * images is invaled.
2160 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2161 * @a image does not specify a valid image in @a wim, and is not
2162 * ::WIMLIB_ALL_IMAGES.
2163 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2164 * The metadata resource for one of the specified images is invalid.
2165 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2166 * The security data for one of the specified images is invalid.
2167 * @retval ::WIMLIB_ERR_NOMEM
2168 * Failed to allocate needed memory.
2169 * @retval ::WIMLIB_ERR_READ
2170 * An unexpected read error or end-of-file occurred when reading the
2171 * metadata resource for one of the specified images.
2172 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2173 * @a wim was not a standalone WIM and was not the first part of a split
2177 wimlib_print_files(WIMStruct *wim, int image);
2180 * Prints detailed information from the header of a WIM file.
2183 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2184 * standalone WIM or part of a split WIM.
2186 * @return This function has no return value.
2190 wimlib_print_header(const WIMStruct *wim);
2193 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2194 * digests, as found in the directory entry tree in the WIM file, to file
2195 * resources in the WIM file. This table includes one entry for each unique
2196 * file in the WIM, so it can be quite long. There is only one lookup table per
2197 * WIM file, but each split WIM part has its own lookup table.
2200 * Pointer to the ::WIMStruct for a WIM file.
2202 * @return This function has no return value.
2205 wimlib_print_lookup_table(WIMStruct *wim);
2208 * Prints the metadata of the specified image in a WIM file. The metadata
2209 * consists of the security data as well as the directory entry tree. Each
2210 * image has its own metadata.
2213 * Pointer to the ::WIMStruct for a WIM file.
2215 * Which image to print the metadata for. Can be the number of an image,
2216 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2218 * @return 0 on success; nonzero on error.
2219 * @retval ::WIMLIB_ERR_DECOMPRESSION
2220 * The metadata resource for one of the specified images could not be
2222 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2223 * A directory entry in the metadata resource for one of the specified
2224 * images is invaled.
2225 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2226 * @a image does not specify a valid image in @a wim, and is not
2227 * ::WIMLIB_ALL_IMAGES.
2228 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2229 * The metadata resource for one of the specified images is invalid.
2230 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2231 * The security data for one of the specified images is invalid.
2232 * @retval ::WIMLIB_ERR_NOMEM
2233 * Failed to allocate needed memory.
2234 * @retval ::WIMLIB_ERR_READ
2235 * An unexpected read error or end-of-file occurred when reading the
2236 * metadata resource for one of the specified images.
2237 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2238 * @a wim was not a standalone WIM and was not the first part of a split
2242 wimlib_print_metadata(WIMStruct *wim, int image);
2245 * Prints some basic information about a WIM file. All information printed by
2246 * this function is also printed by wimlib_print_header(), but
2247 * wimlib_print_wim_information() prints some of this information more concisely
2248 * and in a more readable form.
2251 * Pointer to the ::WIMStruct for a WIM file.
2253 * @return This function has no return value.
2256 wimlib_print_wim_information(const WIMStruct *wim);
2259 * Translates a string specifying the name or number of an image in the WIM into
2260 * the number of the image. The images are numbered starting at 1.
2263 * Pointer to the ::WIMStruct for a WIM file.
2264 * @param image_name_or_num
2265 * A string specifying the name or number of an image in the WIM. If it
2266 * parses to a positive integer, this integer is taken to specify the
2267 * number of the image, indexed starting at 1. Otherwise, it is taken to
2268 * be the name of an image, as given in the XML data for the WIM file. It
2269 * also may be the keyword "all" or the string "*", both of which will
2270 * resolve to ::WIMLIB_ALL_IMAGES.
2272 * There is no way to search for an image actually named "all", "*", or an
2273 * integer number, or an image that has no name. However, you can use
2274 * wimlib_get_image_name() to get the name of any image.
2277 * If the string resolved to a single existing image, the number of that
2278 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2279 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2280 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2281 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2282 * images in @a wim has no name.
2285 wimlib_resolve_image(WIMStruct *wim,
2286 const wimlib_tchar *image_name_or_num);
2289 * Sets which image in the WIM is marked as bootable.
2292 * Pointer to the ::WIMStruct for a WIM file.
2294 * The number of the image to mark as bootable, or 0 to mark no image as
2296 * @return 0 on success; nonzero on error.
2297 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2298 * @a boot_idx does not specify an existing image in @a wim, and it was not
2300 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2301 * @a wim is part of a split WIM. We do not support changing the boot
2302 * index of a split WIM.
2305 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2308 * Changes the description of an image in the WIM.
2311 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2312 * standalone WIM or part of a split WIM; however, you should set the same
2313 * description on all parts of a split WIM.
2315 * The number of the image for which to change the description.
2316 * @param description
2317 * The new description to give the image. It may be @c NULL, which
2318 * indicates that the image is to be given no description.
2320 * @return 0 on success; nonzero on error.
2321 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2322 * @a image does not specify a single existing image in @a wim.
2323 * @retval ::WIMLIB_ERR_NOMEM
2324 * Failed to allocate the memory needed to duplicate the @a description
2328 wimlib_set_image_descripton(WIMStruct *wim, int image,
2329 const wimlib_tchar *description);
2332 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2333 * (something like "Core" or "Ultimate")
2336 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2337 * standalone WIM or part of a split WIM; however, you should set the same
2338 * \<FLAGS\> element on all parts of a split WIM.
2340 * The number of the image for which to change the description.
2342 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2343 * indicates that the image is to be given no \<FLAGS\> element.
2345 * @return 0 on success; nonzero on error.
2346 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2347 * @a image does not specify a single existing image in @a wim.
2348 * @retval ::WIMLIB_ERR_NOMEM
2349 * Failed to allocate the memory needed to duplicate the @a flags string.
2351 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2352 const wimlib_tchar *flags);
2355 * Changes the name of an image in the WIM.
2358 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2359 * standalone WIM or part of a split WIM; however, you should set the same
2360 * name on all parts of a split WIM.
2362 * The number of the image for which to change the name.
2364 * The new name to give the image. It must be a nonempty string.
2366 * @return 0 on success; nonzero on error.
2367 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2368 * There is already an image named @a name in @a wim.
2369 * @retval ::WIMLIB_ERR_INVALID_PARAM
2370 * @a name was @c NULL or the empty string.
2371 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2372 * @a image does not specify a single existing image in @a wim.
2373 * @retval ::WIMLIB_ERR_NOMEM
2374 * Failed to allocate the memory needed to duplicate the @a name string.
2376 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2377 const wimlib_tchar *name);
2380 * Set the functions that wimlib uses to allocate and free memory.
2382 * These settings are global and not per-WIM.
2384 * The default is to use the default @c malloc() and @c free() from the C
2387 * Please note that some external functions, such as those in @c libntfs-3g, may
2388 * use the standard memory allocation functions.
2390 * @param malloc_func
2391 * A function equivalent to @c malloc() that wimlib will use to allocate
2392 * memory. If @c NULL, the allocator function is set back to the default
2393 * @c malloc() from the C library.
2395 * A function equivalent to @c free() that wimlib will use to free memory.
2396 * If @c NULL, the free function is set back to the default @c free() from
2398 * @param realloc_func
2399 * A function equivalent to @c realloc() that wimlib will use to reallocate
2400 * memory. If @c NULL, the free function is set back to the default @c
2401 * realloc() from the C library.
2402 * @return 0 on success; nonzero on error.
2403 * @retval ::WIMLIB_ERR_UNSUPPORTED
2404 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2405 * so custom memory allocators are unsupported.
2408 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2409 void (*free_func)(void *),
2410 void *(*realloc_func)(void *, size_t));
2413 * Sets whether wimlib is to print error messages to @c stderr when a function
2414 * fails. These error messages may provide information that cannot be
2415 * determined only from the error code that is returned. Not every error will
2416 * result in an error message being printed.
2418 * This setting is global and not per-WIM.
2420 * By default, error messages are not printed.
2422 * @param show_messages
2423 * @c true if error messages are to be printed; @c false if error messages
2424 * are not to be printed.
2426 * @return 0 on success; nonzero on error.
2427 * @retval ::WIMLIB_ERR_UNSUPPORTED
2428 * @a show_messages was @c true, but wimlib was compiled with the @c
2429 * --without-error-messages option. Therefore, error messages cannot be
2433 wimlib_set_print_errors(bool show_messages);
2436 * Splits a WIM into multiple parts.
2439 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2442 * Name of the SWM file to create. This will be the name of the first
2443 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2444 * appended before the suffix.
2446 * The maximum size per part, in bytes. It is not guaranteed that this
2447 * will really be the maximum size per part, because some file resources in
2448 * the WIM may be larger than this size, and the WIM file format provides
2449 * no way to split up file resources among multiple WIMs.
2450 * @param write_flags
2451 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2452 * included in the split WIM parts.
2453 * @param progress_func
2454 * If non-NULL, a function that will be called periodically with the
2455 * progress of the current operation.
2457 * @return 0 on success; nonzero on error. This function may return any value
2458 * returned by wimlib_write() as well as the following error codes:
2460 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2461 * @a wim is not part 1 of a stand-alone WIM.
2462 * @retval ::WIMLIB_ERR_INVALID_PARAM
2463 * @a swm_name was @c NULL, or @a part_size was 0.
2465 * Note: the WIM's uncompressed and compressed resources are not checksummed
2466 * when they are copied from the joined WIM to the split WIM parts, nor are
2467 * compressed resources re-compressed.
2470 wimlib_split(WIMStruct *wim,
2471 const wimlib_tchar *swm_name,
2474 wimlib_progress_func_t progress_func);
2477 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2479 * The image to unmount is specified by the path to the mountpoint, not the
2480 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2481 * touched and also may have been allocated in a different process.
2483 * To unmount the image, the thread calling this function communicates with the
2484 * thread that is managing the mounted WIM image. This function blocks until it
2485 * is known whether the unmount succeeded or failed. In the case of a
2486 * read-write mounted WIM, the unmount is not considered to have succeeded until
2487 * all changes have been saved to the underlying WIM file.
2490 * The directory that the WIM image was mounted on.
2491 * @param unmount_flags
2492 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2493 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2494 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2496 * @param progress_func
2497 * If non-NULL, a function that will be called periodically with the
2498 * progress of the current operation.
2500 * @return 0 on success; nonzero on error.
2502 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2503 * The filesystem daemon was unable to remove the staging directory and the
2504 * temporary files that it contains.
2505 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2506 * The filesystem daemon appears to have terminated before sending an exit
2508 * @retval ::WIMLIB_ERR_FORK
2509 * Could not @c fork() the process.
2510 * @retval ::WIMLIB_ERR_FUSERMOUNT
2511 * The @b fusermount program could not be executed or exited with a failure
2513 * @retval ::WIMLIB_ERR_MQUEUE
2514 * Could not open a POSIX message queue to communicate with the filesystem
2515 * daemon servicing the mounted filesystem, could not send a message
2516 * through the queue, or could not receive a message through the queue.
2517 * @retval ::WIMLIB_ERR_NOMEM
2518 * Failed to allocate needed memory.
2519 * @retval ::WIMLIB_ERR_OPEN
2520 * The filesystem daemon could not open a temporary file for writing the
2522 * @retval ::WIMLIB_ERR_READ
2523 * A read error occurred when the filesystem daemon tried to a file from
2524 * the staging directory
2525 * @retval ::WIMLIB_ERR_RENAME
2526 * The filesystem daemon failed to rename the newly written WIM file to the
2527 * original WIM file.
2528 * @retval ::WIMLIB_ERR_WRITE
2529 * A write error occurred when the filesystem daemon was writing to the new
2530 * WIM file, or the filesystem daemon was unable to flush changes that had
2531 * been made to files in the staging directory.
2534 wimlib_unmount_image(const wimlib_tchar *dir,
2536 wimlib_progress_func_t progress_func);
2539 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2542 * Pointer to the ::WIMStruct for the WIM file to update.
2544 * The 1-based index of the image in the WIM to update. It cannot be
2545 * ::WIMLIB_ALL_IMAGES.
2547 * An array of ::wimlib_update_command's that specify the update operations
2550 * Number of commands in @a cmds.
2551 * @param update_flags
2552 * Reserved; must be 0.
2553 * @param progress_func
2554 * If non-NULL, a function that will be called periodically with the
2555 * progress of the current operation.
2557 * @return 0 on success; nonzero on error. On failure, some but not all of the
2558 * update commands may have been executed. No individual update command will
2559 * have been partially executed. Possible error codes include:
2561 * @retval ::WIMLIB_ERR_DECOMPRESSION
2562 * Failed to decompress the metadata resource from @a image in @a wim.
2563 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2564 * The capture configuration structure specified for an add command was
2566 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2567 * A directory entry for @a image in @a wim is invalid.
2568 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2569 * @a image did not specify a single, existing image in @a wim.
2570 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2571 * Attempted to perform an add command that conflicted with previously
2572 * existing files in the WIM when an overlay was attempted.
2573 * @retval ::WIMLIB_ERR_INVALID_PARAM
2574 * An unknown operation type was specified in the update commands; or,
2575 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2576 * in the @a add_flags, but the same image had previously already been
2577 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2578 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2579 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2580 * specified in the @a add_flags for an add command in which @a
2581 * wim_target_path was not the root directory of the WIM image.
2582 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2583 * (Windows only): While executing an add command, tried to capture a
2584 * reparse point with invalid data.
2585 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2586 * The metadata resource for @a image in @a wim is invalid.
2587 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2588 * The security data for image @a image in @a wim is invalid.
2589 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2590 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2591 * for a WIM path that corresponded to a directory; or, a rename command
2592 * attempted to rename a directory to a non-directory.
2593 * @retval ::WIMLIB_ERR_NOMEM
2594 * Failed to allocate needed memory.
2595 * @retval ::WIMLIB_ERR_NOTDIR
2596 * A rename command attempted to rename a directory to a non-directory; or,
2597 * an add command was executed that attempted to set the root of the WIM
2598 * image as a non-directory.
2599 * @retval ::WIMLIB_ERR_NOTEMPTY
2600 * A rename command attempted to rename a directory to a non-empty
2602 * @retval ::WIMLIB_ERR_NTFS_3G
2603 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2604 * error occurred while reading data from the NTFS volume using libntfs-3g.
2605 * @retval ::WIMLIB_ERR_OPEN
2606 * Failed to open a file to be captured while executing an add command.
2607 * @retval ::WIMLIB_ERR_OPENDIR
2608 * Failed to open a file to be captured while executing an add command.
2609 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2610 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2611 * WIM path that did not exist; or, a component of the path of the source
2612 * or destination of a rename command was used as a directory but was not,
2613 * in fact, a directory.
2614 * @retval ::WIMLIB_ERR_READ
2615 * Failed to read the metadata resource for @a image in @a wim; or, while
2616 * executing an add command, failed to read data from a file or directory
2618 * @retval ::WIMLIB_ERR_READLINK
2619 * While executing an add command, failed to read the target of a symbolic
2620 * link or junction point.
2621 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2622 * (Windows only) Failed to perform a reparse point fixup because of
2623 * problems with the data of a reparse point.
2624 * @retval ::WIMLIB_ERR_SPECIAL_FILE
2625 * While executing an add command, attempted to capture a file that was not
2626 * a supported file type, such as a regular file, directory, symbolic link,
2627 * or (on Windows) a reparse point.
2628 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2629 * @a wim is part of a split WIM. Updating a split WIM is unsupported.
2630 * @retval ::WIMLIB_ERR_STAT
2631 * While executing an add command, failed to get attributes for a file or
2633 * @retval ::WIMLIB_ERR_UNSUPPORTED
2634 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2635 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
2636 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2637 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2638 * add_flags for an update command.
2641 wimlib_update_image(WIMStruct *wim,
2643 const struct wimlib_update_command *cmds,
2646 wimlib_progress_func_t progress_func);
2649 * Writes a standalone WIM to a file.
2651 * This brings in resources from any external locations, such as directory trees
2652 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2653 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2656 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2657 * changes made to it, which are then reflected in the output file.
2659 * The path to the file to write the WIM to.
2661 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2663 * @param write_flags
2664 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2665 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2666 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2667 * @param num_threads
2668 * Number of threads to use for compressing data. If 0, the number of
2669 * threads is taken to be the number of online processors. Note: if no
2670 * data compression needs to be done, no additional threads will be created
2671 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2672 * exporting an image from a compressed WIM to another WIM of the same
2673 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2675 * @param progress_func
2676 * If non-NULL, a function that will be called periodically with the
2677 * progress of the current operation.
2679 * @return 0 on success; nonzero on error.
2680 * @retval ::WIMLIB_ERR_DECOMPRESSION
2681 * Failed to decompress a metadata or file resource in @a wim.
2682 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2683 * A directory entry in the metadata resource for @a image in @a wim is
2685 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2686 * @a image does not specify a single existing image in @a wim, and is not
2687 * ::WIMLIB_ALL_IMAGES.
2688 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2689 * A file that had previously been scanned for inclusion in the WIM by
2690 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2691 * message digest check.
2692 * @retval ::WIMLIB_ERR_INVALID_PARAM
2693 * @a path was @c NULL.
2694 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2695 * The metadata resource for @a image in @a wim is invalid.
2696 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2697 * The security data for @a image in @a wim is invalid.
2698 * @retval ::WIMLIB_ERR_NOMEM
2699 * Failed to allocate needed memory.
2700 * @retval ::WIMLIB_ERR_OPEN
2701 * Failed to open @a path for writing, or some file resources in @a
2702 * wim refer to files in the outside filesystem, and one of these files
2703 * could not be opened for reading.
2704 * @retval ::WIMLIB_ERR_READ
2705 * An error occurred when trying to read data from the WIM file associated
2706 * with @a wim, or some file resources in @a wim refer to files in the
2707 * outside filesystem, and a read error occurred when reading one of these
2709 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2710 * @a wim is part of a split WIM. You may not call this function on a
2712 * @retval ::WIMLIB_ERR_WRITE
2713 * An error occurred when trying to write data to the new WIM file at @a
2717 wimlib_write(WIMStruct *wim,
2718 const wimlib_tchar *path,
2721 unsigned num_threads,
2722 wimlib_progress_func_t progress_func);
2725 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2726 * the data using "XPRESS" compression.
2729 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2732 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2733 * the data is compressed using "XPRESS" compression.
2736 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2737 void *uncompressed_data, unsigned uncompressed_len);
2739 #endif /* _WIMLIB_H */