4 * External header for wimlib.
6 * This file contains extensive comments for generating documentation with
7 * Doxygen. The built HTML documentation can be viewed at
8 * http://wimlib.sourceforge.net.
12 * Copyright (C) 2012, 2013 Eric Biggers
14 * This file is part of wimlib, a library for working with WIM files.
16 * wimlib is free software; you can redistribute it and/or modify it under the
17 * terms of the GNU General Public License as published by the Free
18 * Software Foundation; either version 3 of the License, or (at your option)
21 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
22 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23 * A PARTICULAR PURPOSE. See the GNU General Public License for more
26 * You should have received a copy of the GNU General Public License
27 * along with wimlib; if not, see http://www.gnu.org/licenses/.
32 * \section intro Introduction
34 * This is the documentation for the library interface of wimlib 1.4.0, a C
35 * library for creating, modifying, extracting, and mounting files in the
36 * Windows Imaging Format. This documentation is intended for developers only.
37 * If you have installed wimlib and want to know how to use the @b wimlib-imagex
38 * program, please see the README file.
40 * \section starting Getting Started
42 * wimlib uses the GNU autotools, so, on UNIX systems, it should be easy to
43 * install with <code>configure && make && sudo make install</code>; however,
44 * please see the README for more information about installing it. To use
45 * wimlib in a program after installing it, include @c wimlib.h and link your
46 * program with @c -lwim.
48 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
49 * may represent either a stand-alone WIM or one part of a split WIM.
51 * All functions in wimlib's public API are prefixed with @c wimlib. Most
52 * return 0 on success and a positive error code on failure. Use
53 * wimlib_get_error_string() to get a string that describes an error code.
54 * wimlib also can print error messages itself when an error happens, and these
55 * may be more informative than the error code; to enable this, call
56 * wimlib_set_print_errors(). Please note that this is for convenience only,
57 * and some errors can occur without a message being printed.
59 * First before calling any other functions, you should call
60 * wimlib_global_init() to initialize the library.
62 * To open an existing WIM, use wimlib_open_wim().
64 * To create a new WIM that initially contains no images, use
65 * wimlib_create_new_wim().
67 * To add an image to a WIM file from a directory tree on your filesystem, call
68 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
69 * wimlib_open_wim() or from wimlib_create_new_wim(). On UNIX,
70 * wimlib_add_image() can also capture a WIM image directly from a block device
71 * containing a NTFS filesystem.
73 * To extract an image from a WIM file, call wimlib_extract_image(). This can
74 * be done either to a directory, or, on UNIX, directly to a block device
75 * containing a NTFS filesystem.
77 * To extract individual files or directories from a WIM image, rather than a
78 * full image, call wimlib_extract_files().
80 * To programatically make changes to a WIM image without mounting it, call
81 * wimlib_update_image().
83 * On UNIX, wimlib supports mounting WIM files either read-only or read-write.
84 * Mounting is done using wimlib_mount_image() and unmounting is done using
85 * wimlib_unmount_image(). Mounting can be done without root privileges because
86 * it is implemented using FUSE (Filesystem in Userspace). If wimlib is
87 * compiled with the <code>--without-fuse</code> flag, these functions will be
88 * available but will fail with ::WIMLIB_ERR_UNSUPPORTED.
90 * After creating or modifying a WIM file, you can write it to a file using
91 * wimlib_write(). Alternatively, if the WIM was originally read from a file
92 * (using wimlib_open_wim() rather than wimlib_create_new_wim()), you can use
93 * wimlib_overwrite() to overwrite the original file.
95 * Please note: merely by calling wimlib_add_image() or many of the other
96 * functions in this library that operate on ::WIMStruct's, you are @b not
97 * modifying the WIM file on disk. Changes are not saved until you explicitly
98 * call wimlib_write() or wimlib_overwrite().
100 * After you are done with the WIM file, use wimlib_free() to free all memory
101 * associated with a ::WIMStruct and close all files associated with it.
103 * When you are completely done with using wimlib in your program, you should
104 * call wimlib_global_cleanup().
106 * A number of functions take a pointer to a progress function of type
107 * ::wimlib_progress_func_t. This function will be called periodically during
108 * the WIM operation(s) to report on the progress of the operation (for example,
109 * how many bytes have been written so far).
111 * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112 * the following exceptions:
113 * - You must call wimlib_global_init() in one thread before calling any other
115 * - wimlib_set_print_errors() and wimlib_set_memory_allocator() both apply globally.
116 * race conditions with one-time allocations of memory.
117 * - wimlib_mount_image(), while it can be used to mount multiple WIMs
118 * concurrently in the same process, will daemonize the entire process when it
119 * does so for the first time. This includes changing the working directory
120 * to the root directory.
122 * \section encodings Locales and character encodings
124 * To support Windows as well as UNIX, wimlib's API typically takes and returns
125 * strings of ::wimlib_tchar, which are in a platform-dependent encoding.
127 * On Windows, each ::wimlib_tchar is 2 bytes and is the same as a "wchar_t",
128 * and the encoding is UTF-16LE.
130 * On UNIX, each ::wimlib_tchar is 1 byte and is simply a "char", and the
131 * encoding is the locale-dependent multibyte encoding. I recommend you set
132 * your locale to a UTF-8 capable locale to avoid any issues. Also, by default,
133 * wimlib on UNIX will assume the locale is UTF-8 capable unless you call
134 * wimlib_global_init() after having set your desired locale.
136 * \section Limitations
138 * This section documents some technical limitations of wimlib not already
139 * documented in the man page for @b wimlib-imagex.
141 * - The old WIM format from Vista pre-releases is not supported.
142 * - Compressed resource chunk sizes other than 32768 are not supported. This
143 * doesn't seem to be a real problem because the chunk size always seems to be
145 * - wimlib does not provide a clone of the @b PEImg tool, or the @b Dism
146 * functionality other than that already present in @b ImageX, that allows you
147 * to make certain Windows-specific modifications to a Windows PE image, such
148 * as adding a driver or Windows component. Such a tool possibly could be
149 * implemented on top of wimlib.
158 #include <inttypes.h>
160 /** Major version of the library (for example, the 1 in 1.2.5). */
161 #define WIMLIB_MAJOR_VERSION 1
163 /** Minor version of the library (for example, the 2 in 1.2.5). */
164 #define WIMLIB_MINOR_VERSION 4
166 /** Patch version of the library (for example, the 5 in 1.2.5). */
167 #define WIMLIB_PATCH_VERSION 0
170 * Opaque structure that represents a WIM file. This is an in-memory structure
171 * and need not correspond to a specific on-disk file. However, a ::WIMStruct
172 * obtained from wimlib_open_wim() depends on the underlying on-disk WIM file
173 * continuing to exist so that data can be read from it as needed.
175 * Most functions in this library will work the same way regardless of whether a
176 * given ::WIMStruct was obtained through wimlib_open_wim() or
177 * wimlib_create_new_wim(). Exceptions are documented.
179 * Use wimlib_write() or wimlib_overwrite() to actually write an on-disk WIM
180 * file from a ::WIMStruct.
182 #ifndef WIMLIB_WIMSTRUCT_DECLARED
183 typedef struct WIMStruct WIMStruct;
184 #define WIMLIB_WIMSTRUCT_DECLARED
188 typedef wchar_t wimlib_tchar;
190 /** See \ref encodings */
191 typedef char wimlib_tchar;
195 * Specifies the compression type of a WIM file.
197 enum wimlib_compression_type {
198 /** An invalid compression type. */
199 WIMLIB_COMPRESSION_TYPE_INVALID = -1,
201 /** The WIM does not include any compressed resources. */
202 WIMLIB_COMPRESSION_TYPE_NONE = 0,
204 /** Compressed resources in the WIM use LZX compression. */
205 WIMLIB_COMPRESSION_TYPE_LZX = 1,
207 /** Compressed resources in the WIM use XPRESS compression. */
208 WIMLIB_COMPRESSION_TYPE_XPRESS = 2,
211 /** Possible values of the first parameter to the user-supplied
212 * ::wimlib_progress_func_t progress function */
213 enum wimlib_progress_msg {
215 /** A WIM image is about to be extracted. @a info will point to
216 * ::wimlib_progress_info.extract. */
217 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
219 /** A file or directory tree within a WIM image (not the full image) is
220 * about to be extracted. @a info will point to
221 * ::wimlib_progress_info.extract. */
222 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_BEGIN,
224 /** The directory structure of the WIM image is about to be extracted.
225 * @a info will point to ::wimlib_progress_info.extract. */
226 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
228 /** The directory structure of the WIM image has been successfully
229 * extracted. @a info will point to ::wimlib_progress_info.extract. */
230 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
232 /** The WIM image's files resources are currently being extracted. @a
233 * info will point to ::wimlib_progress_info.extract. */
234 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS,
236 /** A file or directory is being extracted. @a info will point to
237 * ::wimlib_progress_info.extract, and the @a cur_path member will be
239 WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY,
241 /** All the WIM files and directories have been extracted, and
242 * timestamps are about to be applied. @a info will point to
243 * ::wimlib_progress_info.extract. */
244 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
246 /** A WIM image has been successfully extracted. @a info will point to
247 * ::wimlib_progress_info.extract. */
248 WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END,
250 /** A file or directory tree within a WIM image (not the full image) has
251 * been successfully extracted. @a info will point to
252 * ::wimlib_progress_info.extract. */
253 WIMLIB_PROGRESS_MSG_EXTRACT_TREE_END,
255 /** The directory or NTFS volume is about to be scanned to build a tree
256 * of WIM dentries in-memory. @a info will point to
257 * ::wimlib_progress_info.scan. */
258 WIMLIB_PROGRESS_MSG_SCAN_BEGIN,
260 /** A directory or file is being scanned. @a info will point to
261 * ::wimlib_progress_info.scan, and its @a cur_path member will be
262 * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
263 * is passed to wimlib_add_image(). */
264 WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
266 /** The directory or NTFS volume has been successfully scanned, and a
267 * tree of WIM dentries has been built in-memory. @a info will point to
268 * ::wimlib_progress_info.scan. */
269 WIMLIB_PROGRESS_MSG_SCAN_END,
272 * File resources are currently being written to the WIM.
273 * @a info will point to ::wimlib_progress_info.write_streams. */
274 WIMLIB_PROGRESS_MSG_WRITE_STREAMS,
277 * The metadata resource for each image is about to be written to the
278 * WIM. @a info will not be valid. */
279 WIMLIB_PROGRESS_MSG_WRITE_METADATA_BEGIN,
282 * The metadata resource for each image has successfully been writen to
283 * the WIM. @a info will not be valid. */
284 WIMLIB_PROGRESS_MSG_WRITE_METADATA_END,
287 * The temporary file has successfully been renamed to the original WIM
288 * file. Only happens when wimlib_overwrite() is called and the
289 * overwrite is not done in-place.
290 * @a info will point to ::wimlib_progress_info.rename. */
291 WIMLIB_PROGRESS_MSG_RENAME,
293 /** The contents of the WIM are being checked against the integrity
294 * table. Only happens when wimlib_open_wim() is called with the
295 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY flag. @a info will point to
296 * ::wimlib_progress_info.integrity. */
297 WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
299 /** An integrity table is being calculated for the WIM being written.
300 * Only happens when wimlib_write() or wimlib_overwrite() is called with
301 * the ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY flag. @a info will point to
302 * ::wimlib_progress_info.integrity. */
303 WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
305 /** A wimlib_join() operation is in progress. @a info will point to
306 * ::wimlib_progress_info.join. */
307 WIMLIB_PROGRESS_MSG_JOIN_STREAMS,
309 /** A wimlib_split() operation is in progress, and a new split part is
310 * about to be started. @a info will point to
311 * ::wimlib_progress_info.split. */
312 WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART,
314 /** A wimlib_split() operation is in progress, and a split part has been
315 * finished. @a info will point to ::wimlib_progress_info.split. */
316 WIMLIB_PROGRESS_MSG_SPLIT_END_PART,
319 /** A pointer to this union is passed to the user-supplied
320 * ::wimlib_progress_func_t progress function. One (or none) of the structures
321 * contained in this union will be applicable for the operation
322 * (::wimlib_progress_msg) indicated in the first argument to the progress
324 union wimlib_progress_info {
326 /* N.B. I wanted these to be anonymous structs, but Doxygen won't
327 * document them if they aren't given a name... */
329 /** Valid on messages ::WIMLIB_PROGRESS_MSG_WRITE_STREAMS. */
330 struct wimlib_progress_info_write_streams {
331 /** Number of bytes that are going to be written for all the
332 * streams combined. This is the amount in uncompressed data.
333 * (The actual number of bytes will be less if the data is being
334 * written compressed.) */
335 uint64_t total_bytes;
336 /** Number of streams that are going to be written. */
337 uint64_t total_streams;
339 /** Number of uncompressed bytes that have been written so far.
340 * Will be 0 initially, and equal to @a total_bytes at the end.
342 uint64_t completed_bytes;
344 /** Number of streams that have been written. Will be 0
345 * initially, and equal to @a total_streams at the end. */
346 uint64_t completed_streams;
348 /** Number of threads that are being used to compress resources
349 * (if applicable). */
350 unsigned num_threads;
352 /** The compression type being used to write the streams; either
353 * ::WIMLIB_COMPRESSION_TYPE_NONE,
354 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or
355 * ::WIMLIB_COMPRESSION_TYPE_LZX. */
356 int compression_type;
358 /** Library internal use only. */
362 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
363 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
364 struct wimlib_progress_info_scan {
365 /** Directory or NTFS volume that is being scanned. */
366 const wimlib_tchar *source;
368 /** Path to the file or directory that is about to be scanned,
369 * relative to the root of the image capture or the NTFS volume.
371 const wimlib_tchar *cur_path;
373 /** True iff @a cur_path is being excluded from the image
374 * capture due to the capture configuration file. */
377 /** Target path in the WIM. Only valid on messages
378 * ::WIMLIB_PROGRESS_MSG_SCAN_BEGIN and
379 * ::WIMLIB_PROGRESS_MSG_SCAN_END. */
380 const wimlib_tchar *wim_target_path;
383 /** Valid on messages ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_BEGIN,
384 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
385 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END,
386 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS, and
387 * ::WIMLIB_PROGRESS_MSG_EXTRACT_IMAGE_END. */
388 struct wimlib_progress_info_extract {
389 /** Number of the image being extracted (1-based). */
392 /** Flags passed to to wimlib_extract_image() */
395 /** Full path to the WIM file being extracted. */
396 const wimlib_tchar *wimfile_name;
398 /** Name of the image being extracted. */
399 const wimlib_tchar *image_name;
401 /** Directory or NTFS volume to which the image is being
403 const wimlib_tchar *target;
405 /** Current dentry being extracted. (Valid only if message is
406 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY.) */
407 const wimlib_tchar *cur_path;
409 /** Number of bytes of uncompressed data that will be extracted.
410 * Takes into account hard links (they are not counted for each
413 uint64_t total_bytes;
415 /** Number of bytes that have been written so far. Will be 0
416 * initially, and equal to @a total_bytes at the end. */
417 uint64_t completed_bytes;
419 /** Number of streams that will be extracted. This may more or
420 * less than the number of "files" to be extracted due to
421 * special cases (hard links, symbolic links, and alternate data
423 uint64_t num_streams;
425 /** Path to the root dentry within the WIM for the tree that is
426 * being extracted. Will be the empty string when extracting a
428 const wimlib_tchar *extract_root_wim_source_path;
431 /** Valid on messages ::WIMLIB_PROGRESS_MSG_RENAME. */
432 struct wimlib_progress_info_rename {
433 /** Name of the temporary file that the WIM was written to. */
434 const wimlib_tchar *from;
436 /** Name of the original WIM file to which the temporary file is
438 const wimlib_tchar *to;
441 /** Valid on messages ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY and
442 * ::WIMLIB_PROGRESS_MSG_CALC_INTEGRITY. */
443 struct wimlib_progress_info_integrity {
444 /** Number of bytes from the end of the WIM header to the end of
445 * the lookup table (the area that is covered by the SHA1
446 * integrity checks.) */
447 uint64_t total_bytes;
449 /** Number of bytes that have been SHA1-summed so far. Will be
450 * 0 initially, and equal @a total_bytes at the end. */
451 uint64_t completed_bytes;
453 /** Number of chunks that the checksummed region is divided
455 uint32_t total_chunks;
457 /** Number of chunks that have been SHA1-summed so far. Will
458 * be 0 initially, and equal to @a total_chunks at the end. */
459 uint32_t completed_chunks;
461 /** Size of the chunks used for the integrity calculation. */
464 /** Filename of the WIM (only valid if the message is
465 * ::WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY). */
466 const wimlib_tchar *filename;
469 /** Valid on messages ::WIMLIB_PROGRESS_MSG_JOIN_STREAMS. */
470 struct wimlib_progress_info_join {
471 /** Total number of bytes of compressed data contained in all
472 * the split WIM part's file and metadata resources. */
473 uint64_t total_bytes;
475 /** Number of bytes that have been copied to the joined WIM so
476 * far. Will be 0 initially, and equal to @a total_bytes at the
478 uint64_t completed_bytes;
480 /** Number of split WIM parts that have had all their file and
481 * metadata resources copied over to the joined WIM so far. */
482 unsigned completed_parts;
484 /** Number of split WIM parts. */
485 unsigned total_parts;
488 /** Valid on messages ::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART and
489 * ::WIMLIB_PROGRESS_MSG_SPLIT_END_PART. */
490 struct wimlib_progress_info_split {
491 /** Total size of the original WIM's file and metadata resources
493 uint64_t total_bytes;
495 /** Number of bytes of file and metadata resources that have
496 * been copied out of the original WIM so far. Will be 0
497 * initially, and equal to @a total_bytes at the end. */
498 uint64_t completed_bytes;
500 /** Number of the split WIM part that is about to be started
501 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
502 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
503 unsigned cur_part_number;
505 /** Name of the split WIM part that is about to be started
506 * (::WIMLIB_PROGRESS_MSG_SPLIT_BEGIN_PART) or has just been
507 * finished (::WIMLIB_PROGRESS_MSG_SPLIT_END_PART). */
508 const wimlib_tchar *part_name;
512 /** A user-supplied function that will be called periodically during certain WIM
513 * operations. The first argument will be the type of operation that is being
514 * performed or is about to be started or has been completed. The second
515 * argument will be a pointer to one of a number of structures depending on the
516 * first argument. It may be @c NULL for some message types.
518 * The return value of the progress function is currently ignored, but it may do
519 * something in the future. (Set it to 0 for now.)
521 typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
522 const union wimlib_progress_info *info);
524 /** An array of these structures is passed to wimlib_add_image_multisource() to
525 * specify the sources from which to create a WIM image. */
526 struct wimlib_capture_source {
527 /** Absolute or relative path to a file or directory on the external
528 * filesystem to be included in the WIM image. */
529 wimlib_tchar *fs_source_path;
531 /** Destination path in the WIM image. Leading and trailing slashes are
532 * ignored. The empty string or @c NULL means the root directory of the
534 wimlib_tchar *wim_target_path;
536 /** Reserved; set to 0. */
540 /** Structure that specifies a list of path patterns. */
541 struct wimlib_pattern_list {
542 /** Array of patterns. The patterns may be modified by library code,
543 * but the @a pats pointer itself will not. See the man page for
544 * <b>wimlib-imagex capture</b> for more information about allowed
548 /** Number of patterns in the @a pats array. */
551 /** Ignored; may be used by the calling code. */
552 size_t num_allocated_pats;
555 /** A structure that contains lists of wildcards that match paths to treat
556 * specially when capturing a WIM image. */
557 struct wimlib_capture_config {
558 /** Paths matching any pattern this list are excluded from being
559 * captured, except if the same path appears in @a
560 * exclusion_exception_pats. */
561 struct wimlib_pattern_list exclusion_pats;
563 /** Paths matching any pattern in this list are never excluded from
565 struct wimlib_pattern_list exclusion_exception_pats;
567 /** Reserved for future capture configuration options. */
568 struct wimlib_pattern_list reserved1;
570 /** Reserved for future capture configuration options. */
571 struct wimlib_pattern_list reserved2;
573 /** Library internal use only. */
574 const wimlib_tchar *_prefix;
576 /** Library internal use only. */
577 size_t _prefix_num_tchars;
581 /*****************************
583 *****************************/
585 /** Directly capture a NTFS volume rather than a generic directory. This flag
586 * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
587 * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
588 #define WIMLIB_ADD_FLAG_NTFS 0x00000001
590 /** Follow symlinks; archive and dump the files they point to. Cannot be used
591 * with ::WIMLIB_ADD_FLAG_NTFS. */
592 #define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
594 /** Call the progress function with the message
595 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
597 #define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
599 /** Mark the image being added as the bootable image of the WIM. */
600 #define WIMLIB_ADD_FLAG_BOOT 0x00000008
602 /** Store the UNIX owner, group, and mode. This is done by adding a special
603 * alternate data stream to each regular file, symbolic link, and directory to
604 * contain this information. Please note that this flag is for convenience
605 * only; Microsoft's @a imagex.exe will not understand this special information.
606 * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
607 #define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
609 /** Do not capture security descriptors. Only has an effect in NTFS capture
610 * mode, or in Win32 native builds. */
611 #define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
613 /** Fail immediately if the full security descriptor of any file or directory
614 * cannot be accessed. Only has an effect in Win32 native builds. The default
615 * behavior without this flag is to first try omitting the SACL from the
616 * security descriptor, then to try omitting the security descriptor entirely.
618 #define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
620 /** Call the progress function with the message
621 * ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
622 * capture. This is a subset of the messages provided by
623 * ::WIMLIB_ADD_FLAG_VERBOSE. */
624 #define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
626 /** Reparse-point fixups: Modify absolute symbolic links (or junction points,
627 * in the case of Windows) that point inside the directory being captured to
628 * instead be absolute relative to the directory being captured, rather than the
629 * current root; also exclude absolute symbolic links that point outside the
630 * directory tree being captured.
632 * Without this flag, the default is to do this if WIM_HDR_FLAG_RP_FIX is set in
633 * the WIM header or if this is the first image being added.
634 * WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
635 * reparse point fixups enabled and currently cannot be unset. */
636 #define WIMLIB_ADD_FLAG_RPFIX 0x00000100
638 /** Don't do reparse point fixups. The default behavior is described in the
639 * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
640 #define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
642 #define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
643 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
644 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
645 #define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
646 #define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
647 #define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
648 #define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
649 #define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
650 #define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
651 #define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
653 /******************************
654 * WIMLIB_DELETE_FLAG_*
655 ******************************/
657 /** Do not issue an error if the path to delete does not exist. */
658 #define WIMLIB_DELETE_FLAG_FORCE 0x00000001
660 /** Delete the file or directory tree recursively; if not specified, an error is
661 * issued if the path to delete is a directory. */
662 #define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
664 /******************************
665 * WIMLIB_EXPORT_FLAG_*
666 ******************************/
668 /** See documentation for wimlib_export_image(). */
669 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
671 /******************************
672 * WIMLIB_EXTRACT_FLAG_*
673 ******************************/
675 /** Extract the image directly to a NTFS volume rather than a generic directory.
677 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000001
679 /** When identical files are extracted from the WIM, always hard link them
680 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
681 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000002
683 /** When identical files are extracted from the WIM, always symlink them
684 * together. Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
685 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000004
687 /** Call the progress function with the argument
688 * ::WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY each time a file or directory is
689 * extracted. Note: these calls will be interspersed with calls for the message
690 * ::WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS. */
691 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
693 /** Read the WIM file sequentially while extracting the image. */
694 #define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
696 /** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
697 * Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
698 #define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
700 /** Do not extract security descriptors. Only has an effect in NTFS apply mode,
701 * or in Win32 native builds. */
702 #define WIMLIB_EXTRACT_FLAG_NO_ACLS 0x00000040
704 /** Fail immediately if the full security descriptor of any file or directory
705 * cannot be set exactly as specified in the WIM file. The default behavior
706 * without this flag is to fall back to setting the security descriptor with the
707 * SACL omitted, then only the default inherited security descriptor, if we do
708 * not have permission to set the desired one. */
709 #define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
711 /* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
712 * fixups on, so absolute symbolic links or junction points will be fixed to be
713 * absolute relative to the actual extraction root. Done by default if
714 * WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
715 * specified when extracting a full image. */
716 #define WIMLIB_EXTRACT_FLAG_RPFIX 0x00000100
718 /** Force reparse-point fixups on extraction off, regardless of the state of the
719 * WIM_HDR_FLAG_RP_FIX flag in the WIM header. */
720 #define WIMLIB_EXTRACT_FLAG_NORPFIX 0x00000200
722 /** Extract files to standard output rather than to the filesystem. */
723 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
725 /** Instead of ignoring files and directories with names that cannot be
726 * represented on the current platform (note: Windows has more restrictions on
727 * filenames than UNIX), try to replace characters or append junk to the names
728 * so that they can be extracted in some form. */
729 #define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES 0x00000800
731 /** On Windows, when there exist two or more files with the same case
732 * insensitive name (but different case sensitive names), try to extract them
733 * all by appending junk to the end of them, rather than extracting an
734 * arbitrarily only one. */
735 #define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS 0x00001000
737 /******************************
738 * WIMLIB_MOUNT_FLAG_*
739 ******************************/
741 /** Mount the WIM image read-write rather than the default of read-only. */
742 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
744 /** Enable FUSE debugging by passing the @c -d flag to @c fuse_main().*/
745 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
747 /** Do not allow accessing alternate data streams in the mounted WIM image. */
748 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000004
750 /** Access alternate data streams in the mounted WIM image through extended file
751 * attributes. This is the default mode. */
752 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000008
754 /** Access alternate data streams in the mounted WIM image by specifying the
755 * file name, a colon, then the alternate file stream name. */
756 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
758 /** Use UNIX file owners, groups, and modes if available in the WIM (see
759 * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
760 #define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
762 /** Allow other users to see the mounted filesystem. (this passes the @c
763 * allow_other option to FUSE mount) */
764 #define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
766 /******************************
768 ******************************/
770 /** Verify the WIM contents against the WIM's integrity table, if present. */
771 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
773 /** Do not issue an error if the WIM is part of a split WIM. */
774 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
776 /******************************
777 * WIMLIB_UNMOUNT_FLAG_*
778 ******************************/
780 /** Include an integrity table in the WIM after it's been unmounted. Ignored
781 * for read-only mounts. */
782 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
784 /** Unless this flag is given, changes to a read-write mounted WIM are
785 * discarded. Ignored for read-only mounts. */
786 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
788 /** See ::WIMLIB_WRITE_FLAG_REBUILD */
789 #define WIMLIB_UNMOUNT_FLAG_REBUILD 0x00000004
791 /** See ::WIMLIB_WRITE_FLAG_RECOMPRESS */
792 #define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
794 /** Do a "lazy" unmount (detach filesystem immediately, even if busy) */
795 #define WIMLIB_UNMOUNT_FLAG_LAZY 0x00000010
797 /******************************
798 * WIMLIB_WRITE_FLAG_*
799 ******************************/
801 /** Include an integrity table in the new WIM file. */
802 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
804 /** Re-build the entire WIM file rather than appending data to it, if possible.
805 * (Applies to wimlib_overwrite(), not wimlib_write()). */
806 #define WIMLIB_WRITE_FLAG_REBUILD 0x00000002
808 /** Recompress all resources, even if they could otherwise be copied from a
809 * different WIM with the same compression type (in the case of
810 * wimlib_export_image() being called previously). */
811 #define WIMLIB_WRITE_FLAG_RECOMPRESS 0x00000004
813 /** Call fsync() when the WIM file is closed */
814 #define WIMLIB_WRITE_FLAG_FSYNC 0x00000008
816 /* Specifying this flag overrides the default behavior of wimlib_overwrite()
817 * after one or more calls to wimlib_delete_image(), which is to rebuild the
820 * If you specifiy this flag to wimlib_overwrite(), only minimal changes to
821 * correctly remove the image from the WIM will be taken. In particular, all
822 * streams will be left alone, even if they are no longer referenced. This is
823 * probably not what you want, because almost no space will be spaced by
824 * deleting an image in this way. */
825 #define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
827 /******************************
829 ******************************/
831 /** Assume that strings are represented in UTF-8, even if this is not the
832 * locale's character encoding. */
833 #define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
835 /** Specification of an update to perform on a WIM image. */
836 struct wimlib_update_command {
838 /** The specific type of update to perform. */
839 enum wimlib_update_op {
840 /** Add a new file or directory tree to the WIM image in a
841 * certain location. */
842 WIMLIB_UPDATE_OP_ADD = 0,
844 /** Delete a file or directory tree from the WIM image. */
845 WIMLIB_UPDATE_OP_DELETE,
847 /** Rename a file or directory tree in the WIM image. */
848 WIMLIB_UPDATE_OP_RENAME,
851 /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
852 struct wimlib_add_command {
853 /** Filesystem path to the file or directory tree to
855 wimlib_tchar *fs_source_path;
856 /** Path, specified from the root of the WIM image, at
857 * which to add the file or directory tree within the
859 wimlib_tchar *wim_target_path;
861 /** Configuration for excluded files. @c NULL means
862 * exclude no files. */
863 struct wimlib_capture_config *config;
865 /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
868 /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
869 struct wimlib_delete_command {
870 /** Path, specified from the root of the WIM image, for
871 * the file or directory tree within the WIM image to be
873 wimlib_tchar *wim_path;
874 /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
877 /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
878 struct wimlib_rename_command {
879 /** Path, specified from the root of the WIM image, for
880 * the source file or directory tree within the WIM
882 wimlib_tchar *wim_source_path;
883 /** Path, specified from the root of the WIM image, for
884 * the destination file or directory tree within the WIM
886 wimlib_tchar *wim_target_path;
887 /** Reserved; set to 0. */
893 /** Specification of a file or directory tree to extract from a WIM image. */
894 struct wimlib_extract_command {
895 /** Path to file or directory tree within the WIM image to extract. It
896 * must be provided as an absolute path from the root of the WIM image.
897 * The path separators may be either forward slashes or backslashes. */
898 wimlib_tchar *wim_source_path;
900 /** Filesystem path to extract the file or directory tree to. */
901 wimlib_tchar *fs_dest_path;
903 /** Bitwise or of zero or more of the WIMLIB_EXTRACT_FLAG_* flags. */
908 * Possible values of the error code returned by many functions in wimlib.
910 * See the documentation for each wimlib function to see specifically what error
911 * codes can be returned by a given function, and what they mean.
913 enum wimlib_error_code {
914 WIMLIB_ERR_SUCCESS = 0,
915 WIMLIB_ERR_ALREADY_LOCKED,
916 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
917 WIMLIB_ERR_DECOMPRESSION,
918 WIMLIB_ERR_DELETE_STAGING_DIR,
919 WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED,
922 WIMLIB_ERR_FUSERMOUNT,
923 WIMLIB_ERR_ICONV_NOT_AVAILABLE,
924 WIMLIB_ERR_IMAGE_COUNT,
925 WIMLIB_ERR_IMAGE_NAME_COLLISION,
926 WIMLIB_ERR_INSUFFICIENT_PRIVILEGES_TO_EXTRACT,
927 WIMLIB_ERR_INTEGRITY,
928 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
929 WIMLIB_ERR_INVALID_CHUNK_SIZE,
930 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
931 WIMLIB_ERR_INVALID_DENTRY,
932 WIMLIB_ERR_INVALID_HEADER_SIZE,
933 WIMLIB_ERR_INVALID_IMAGE,
934 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
935 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
936 WIMLIB_ERR_INVALID_MULTIBYTE_STRING,
937 WIMLIB_ERR_INVALID_OVERLAY,
938 WIMLIB_ERR_INVALID_PARAM,
939 WIMLIB_ERR_INVALID_PART_NUMBER,
940 WIMLIB_ERR_INVALID_REPARSE_DATA,
941 WIMLIB_ERR_INVALID_RESOURCE_HASH,
942 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
943 WIMLIB_ERR_INVALID_SECURITY_DATA,
944 WIMLIB_ERR_INVALID_UNMOUNT_MESSAGE,
945 WIMLIB_ERR_INVALID_UTF16_STRING,
946 WIMLIB_ERR_INVALID_UTF8_STRING,
947 WIMLIB_ERR_IS_DIRECTORY,
948 WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE,
955 WIMLIB_ERR_NOT_A_REGULAR_FILE,
956 WIMLIB_ERR_NOT_A_WIM_FILE,
957 WIMLIB_ERR_NO_FILENAME,
961 WIMLIB_ERR_PATH_DOES_NOT_EXIST,
966 WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED,
967 WIMLIB_ERR_RESOURCE_ORDER,
968 WIMLIB_ERR_SPECIAL_FILE,
969 WIMLIB_ERR_SPLIT_INVALID,
970 WIMLIB_ERR_SPLIT_UNSUPPORTED,
973 WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
974 WIMLIB_ERR_UNKNOWN_VERSION,
975 WIMLIB_ERR_UNSUPPORTED,
976 WIMLIB_ERR_VOLUME_LACKS_FEATURES,
982 /** Used to indicate no WIM image or an invalid WIM image. */
983 #define WIMLIB_NO_IMAGE 0
985 /** Used to specify all images in the WIM. */
986 #define WIMLIB_ALL_IMAGES (-1)
989 * Appends an empty image to a WIM file. This empty image will initially
990 * contain no files or directories, although if written without further
991 * modifications, a root directory will be created automatically for it.
994 * Pointer to the ::WIMStruct for the WIM file to which the image is to be
997 * Name to give the new image.
999 * If non-<code>NULL</code>, the index of the newly added image is returned
1002 * @return 0 on success; nonzero on failure. The possible error codes are:
1004 * @retval ::WIMLIB_ERR_INVALID_PARAM
1005 * @a name was @c NULL or an empty string.
1006 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1007 * @a wim is part of a split WIM.
1008 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1009 * There is already an image in @a wim named @a name.
1010 * @retval ::WIMLIB_ERR_NOMEM
1011 * Failed to allocate the memory needed to add the new image.
1014 wimlib_add_empty_image(WIMStruct *wim,
1015 const wimlib_tchar *name,
1019 * Adds an image to a WIM file from an on-disk directory tree or NTFS volume.
1021 * The directory tree or NTFS volume is scanned immediately to load the dentry
1022 * tree into memory, and file attributes and symbolic links are read. However,
1023 * actual file data is not read until wimlib_write() or wimlib_overwrite() is
1026 * See the manual page for the @b wimlib-imagex program for more information
1027 * about the "normal" capture mode versus the NTFS capture mode (entered by
1028 * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
1030 * Note that @b no changes are committed to the underlying WIM file (if
1031 * any) until wimlib_write() or wimlib_overwrite() is called.
1034 * Pointer to the ::WIMStruct for a WIM file to which the image will be
1037 * A path to a directory or unmounted NTFS volume that will be captured as
1040 * The name to give the image. It must be nonempty and must specify a name
1041 * that does not yet exist in @a wim.
1043 * Capture configuration that specifies files, directories, or path globs
1044 * to exclude from being captured. If @c NULL, a dummy configuration where
1045 * no paths are treated specially is used.
1047 * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
1048 * @param progress_func
1049 * If non-NULL, a function that will be called periodically with the
1050 * progress of the current operation.
1052 * @return 0 on success; nonzero on error. On error, changes to @a wim are
1053 * discarded so that it appears to be in the same state as when this function
1056 * This function is implemented by calling wimlib_add_empty_image(), then
1057 * calling wimlib_update_image() with a single "add" command, so any error code
1058 * returned by wimlib_add_empty_image() may be returned, as well as any error
1059 * codes returned by wimlib_update_image() other than ones documented as only
1060 * being returned specifically by an update involving delete or rename commands.
1063 wimlib_add_image(WIMStruct *wim,
1064 const wimlib_tchar *source,
1065 const wimlib_tchar *name,
1066 const struct wimlib_capture_config *config,
1068 wimlib_progress_func_t progress_func);
1070 /** This function is equivalent to wimlib_add_image() except it allows for
1071 * multiple sources to be combined into a single WIM image. This is done by
1072 * specifying the @a sources and @a num_sources parameters instead of the @a
1073 * source parameter of wimlib_add_image(). The rest of the parameters are the
1074 * same as wimlib_add_image(). See the documentation for <b>wimlib-imagex
1075 * capture</b> for full details on how this mode works.
1077 * In addition to the error codes that wimlib_add_image() can return,
1078 * wimlib_add_image_multisource() can return ::WIMLIB_ERR_INVALID_OVERLAY
1079 * when trying to overlay a non-directory on a directory or when otherwise
1080 * trying to overlay multiple conflicting files to the same location in the WIM
1081 * image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
1082 * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
1083 * was not exactly one capture source with the target being the root directory.
1084 * (In this respect, there is no advantage to using
1085 * wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
1088 wimlib_add_image_multisource(WIMStruct *wim,
1089 const struct wimlib_capture_source *sources,
1091 const wimlib_tchar *name,
1092 const struct wimlib_capture_config *config,
1094 wimlib_progress_func_t progress_func);
1097 * Creates a ::WIMStruct for a new WIM file.
1099 * This only creates an in-memory structure for a WIM that initially contains no
1100 * images. No on-disk file is created until wimlib_write() is called.
1103 * The type of compression to be used in the new WIM file. Must be
1104 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1105 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1107 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
1108 * written to the memory location pointed to by this paramater. The
1109 * ::WIMStruct must be freed using using wimlib_free() when finished with
1111 * @return 0 on success; nonzero on error.
1112 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1113 * @a ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
1114 * ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1115 * @retval ::WIMLIB_ERR_NOMEM
1116 * Failed to allocate needed memory.
1119 wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
1122 * Deletes an image, or all images, from a WIM file.
1124 * All streams referenced by the image(s) being deleted are removed from the
1125 * lookup table of the WIM if they are not referenced by any other images in the
1128 * Please note that @b no changes are committed to the underlying WIM file (if
1129 * any) until wimlib_write() or wimlib_overwrite() is called.
1132 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
1135 * The number of the image to delete, or ::WIMLIB_ALL_IMAGES to delete all
1137 * @return 0 on success; nonzero on failure. On failure, @a wim is guaranteed
1138 * to be left unmodified only if @a image specified a single image. If instead
1139 * @a image was ::WIMLIB_ALL_IMAGES and @a wim contained more than one image, it's
1140 * possible for some but not all of the images to have been deleted when a
1141 * failure status is returned.
1143 * @retval ::WIMLIB_ERR_DECOMPRESSION
1144 * Could not decompress the metadata resource for @a image.
1145 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1146 * A directory entry in the metadata resource for @a image in the WIM is
1148 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1149 * @a image does not exist in the WIM and is not ::WIMLIB_ALL_IMAGES.
1150 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1151 * The metadata resource for @a image in the WIM is invalid.
1152 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1153 * The security data for @a image in the WIM is invalid.
1154 * @retval ::WIMLIB_ERR_NOMEM
1155 * Failed to allocate needed memory.
1156 * @retval ::WIMLIB_ERR_READ
1157 * Could not read the metadata resource for @a image from the WIM.
1158 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1159 * @a wim is part of a split WIM. Deleting an image from a split WIM is
1163 wimlib_delete_image(WIMStruct *wim, int image);
1166 * Exports an image, or all the images, from a WIM file, into another WIM file.
1168 * The destination image is made to share the same dentry tree and security data
1169 * structure as the source image. This places some restrictions on additional
1170 * functions that may be called. wimlib_mount_image() may not be called on
1171 * either the source image or the destination image without an intervening call
1172 * to a function that un-shares the images, such as wimlib_free() on @a
1173 * dest_wim, or wimlib_delete_image() on either the source or destination image.
1174 * Furthermore, you may not call wimlib_free() on @a src_wim before calling
1175 * wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
1176 * have references back to @a src_wim.
1178 * If this function fails, all changes to @a dest_wim are rolled back.
1180 * No changes shall be made to @a src_wim by this function.
1182 * Please note that no changes are committed to the underlying WIM file of @a
1183 * dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
1186 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
1187 * WIM that contains the image(s) being exported.
1189 * The image to export from @a src_wim. Can be the number of an image, or
1190 * ::WIMLIB_ALL_IMAGES to export all images.
1192 * Pointer to the ::WIMStruct for a WIM file that will receive the images
1195 * The name to give the exported image in the new WIM file. If left @c
1196 * NULL, the name from @a src_wim is used. This parameter must be left @c
1197 * NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains more
1198 * than one image; in that case, the names are all taken from the @a
1199 * src_wim. (This is allowed even if one or more images being exported has
1201 * @param dest_description
1202 * The description to give the exported image in the new WIM file. If left
1203 * @c NULL, the description from the @a src_wim is used. This parameter must
1204 * be left @c NULL if @a src_image is ::WIMLIB_ALL_IMAGES and @a src_wim contains
1205 * more than one image; in that case, the descriptions are all taken from
1206 * @a src_wim. (This is allowed even if one or more images being exported
1207 * has no description.)
1208 * @param export_flags
1209 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
1210 * bootable, or 0 if which image is marked as bootable in the destination
1211 * WIM is to be left unchanged. If @a src_image is ::WIMLIB_ALL_IMAGES and
1212 * there are multiple images in @a src_wim, specifying
1213 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
1214 * currently marked as bootable in @a src_wim; if that is the case, then
1215 * that image is marked as bootable in the destination WIM.
1216 * @param additional_swms
1217 * Array of pointers to the ::WIMStruct for each additional part in the
1218 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1219 * need to be in any particular order, but they must include all parts of
1220 * the split WIM other than the first part, which must be provided in the
1222 * @param num_additional_swms
1223 * Number of additional WIM parts provided in the @a additional_swms array.
1224 * This number should be one less than the total number of parts in the
1225 * split WIM. Set to 0 if the WIM is a standalone WIM.
1226 * @param progress_func
1227 * If non-NULL, a function that will be called periodically with the
1228 * progress of the current operation.
1230 * @return 0 on success; nonzero on error.
1231 * @retval ::WIMLIB_ERR_DECOMPRESSION
1232 * Could not decompress the metadata resource for @a src_image
1234 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1235 * One or more of the names being given to an exported image was already in
1236 * use in the destination WIM.
1237 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1238 * A directory entry in the metadata resource for @a src_image in @a
1239 * src_wim is invalid.
1240 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1241 * @a src_image does not exist in @a src_wim.
1242 * @retval ::WIMLIB_ERR_INVALID_PARAM
1243 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
1244 * ::WIMLIB_ALL_IMAGES, @a src_wim contains multiple images, and no images in
1245 * @a src_wim are marked as bootable; or @a dest_name and/or @a
1246 * dest_description were non-<code>NULL</code>, @a src_image was
1247 * ::WIMLIB_ALL_IMAGES, and @a src_wim contains multiple images.
1248 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1249 * The metadata resource for @a src_image in @a src_wim is invalid.
1250 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1251 * The security data for @a src_image in @a src_wim is invalid.
1252 * @retval ::WIMLIB_ERR_NOMEM
1253 * Failed to allocate needed memory.
1254 * @retval ::WIMLIB_ERR_READ
1255 * Could not read the metadata resource for @a src_image from @a src_wim.
1256 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1257 * The source WIM is a split WIM, but the parts specified do not form a
1258 * complete split WIM because they do not include all the parts of the
1259 * original WIM, there are duplicate parts, or not all the parts have the
1260 * same GUID and compression type.
1261 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1262 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
1266 wimlib_export_image(WIMStruct *src_wim, int src_image,
1267 WIMStruct *dest_wim,
1268 const wimlib_tchar *dest_name,
1269 const wimlib_tchar *dest_description,
1271 WIMStruct **additional_swms,
1272 unsigned num_additional_swms,
1273 wimlib_progress_func_t progress_func);
1276 * Extract zero or more files or directory trees from a WIM image.
1278 * This generalizes the single-image extraction functionality of
1279 * wimlib_extract_image() to allow extracting only the specified subsets of the
1283 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1287 * The 1-based number of the image in @a wim from which the files or
1288 * directory trees are to be extracted. It cannot be ::WIMLIB_ALL_IMAGES.
1291 * An array of ::wimlib_extract_command structures that specifies the
1292 * extractions to perform.
1295 * Number of commands in the @a cmds array.
1297 * @param default_extract_flags
1298 * Default extraction flags; the behavior shall be as if these flags had
1299 * been specified in the ::wimlib_extract_command.extract_flags member in
1300 * each extraction command, in combination with any flags already present.
1302 * @param additional_swms
1303 * Array of pointers to the ::WIMStruct for each additional part in the
1304 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1305 * need to be in any particular order, but they must include all parts of
1306 * the split WIM other than the first part, which must be provided in the
1309 * @param num_additional_swms
1310 * Number of additional WIM parts provided in the @a additional_swms array.
1311 * This number should be one less than the total number of parts in the
1312 * split WIM. Set to 0 if the WIM is a standalone WIM.
1314 * @param progress_func
1315 * If non-NULL, a function that will be called periodically with the
1316 * progress of the current operation.
1318 * @return 0 on success; nonzero on error. The possible error codes include
1319 * those documented as returned by wimlib_extract_image() as well as the
1320 * following additional error codes:
1322 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
1323 * The ::wimlib_extract_command.wim_source_path member in one of the
1324 * extract commands did not exist in the WIM.
1325 * @retval ::WIMLIB_ERR_NOT_A_REGULAR_FILE
1326 * ::WIMLIB_EXTRACT_FLAG_TO_STDOUT was specified for an extraction command
1327 * in which ::wimlib_extract_command.wim_source_path existed but was not a
1328 * regular file or directory.
1329 * @retval ::WIMLIB_ERR_INVALID_PARAM
1330 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK was
1331 * specified for some commands but not all; or
1332 * ::wimlib_extract_command.fs_dest_path was @c NULL or the empty string
1333 * for one or more commands; or ::WIMLIB_EXTRACT_FLAG_RPFIX was specified
1334 * for a command in which ::wimlib_extract_command.wim_source_path did not
1335 * specify the root directory of the WIM image.
1338 wimlib_extract_files(WIMStruct *wim,
1340 const struct wimlib_extract_command *cmds,
1342 int default_extract_flags,
1343 WIMStruct **additional_swms,
1344 unsigned num_additional_swms,
1345 wimlib_progress_func_t progress_func);
1348 * Extracts an image, or all images, from a standalone or split WIM file to a
1349 * directory or a NTFS volume.
1351 * Please see the manual page for the @c wimlib-imagex program for more
1352 * information about the "normal" extraction mode versus the NTFS extraction
1353 * mode (entered by providing flag ::WIMLIB_EXTRACT_FLAG_NTFS).
1355 * Extraction is done with one thread.
1357 * All extracted data is SHA1-summed, and ::WIMLIB_ERR_INVALID_RESOURCE_HASH is
1358 * returned if any resulting SHA1 message digests do not match the values
1359 * provided in the WIM file. Therefore, if this function is successful, you can
1360 * be fairly sure that any compressed data in the WIM was uncompressed
1364 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
1367 * The image to extract. Can be the number of an image, or ::WIMLIB_ALL_IMAGES
1368 * to specify that all images are to be extracted. ::WIMLIB_ALL_IMAGES cannot
1369 * be used if ::WIMLIB_EXTRACT_FLAG_NTFS is specified in @a extract_flags.
1371 * Directory to extract the WIM image(s) to (created if it does not already
1372 * exist); or, with ::WIMLIB_EXTRACT_FLAG_NTFS in @a extract_flags, the
1373 * path to the unmounted NTFS volume to extract the image to.
1374 * @param extract_flags
1375 * Bitwise OR of the flags prefixed with WIMLIB_EXTRACT_FLAG.
1377 * If ::WIMLIB_EXTRACT_FLAG_NTFS is specified, @a target is interpreted as
1378 * a NTFS volume to extract the image to. The volume will be opened using
1379 * NTFS-3g and the image will be extracted to the root of the NTFS volume.
1380 * Otherwise, @a target is interpreted as a directory to extract the
1383 * If ::WIMLIB_EXTRACT_FLAG_NTFS is not specified, one or none of
1384 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK may be
1385 * specified. These flags cause extracted files that are identical to be
1386 * hardlinked or symlinked together, depending on the flag. These flags
1387 * override the hard link groups that are specified in the WIM file itself.
1388 * If ::WIMLIB_ALL_IMAGES is provided as the @a image parameter, files may be
1389 * hardlinked or symlinked across images if a file is found to occur in
1390 * more than one image.
1392 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to print the
1393 * name of each file or directory as it is extracted.
1395 * If ::WIMLIB_EXTRACT_FLAG_SEQUENTIAL is specified, data is read from the
1396 * WIM sequentially, if possible. If ::WIMLIB_ALL_IMAGES is specified,
1397 * each image is considered separately with regards to the sequential
1398 * order. It is also possible for alternate data streams to break the
1399 * sequential order (this only applies if ::WIMLIB_EXTRACT_FLAG_NTFS is
1401 * @param additional_swms
1402 * Array of pointers to the ::WIMStruct for each additional part in the
1403 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1404 * need to be in any particular order, but they must include all parts of
1405 * the split WIM other than the first part, which must be provided in the
1407 * @param num_additional_swms
1408 * Number of additional WIM parts provided in the @a additional_swms array.
1409 * This number should be one less than the total number of parts in the
1410 * split WIM. Set to 0 if the WIM is a standalone WIM.
1412 * @param progress_func
1413 * If non-NULL, a function that will be called periodically with the
1414 * progress of the current operation.
1416 * @return 0 on success; nonzero on error.
1417 * @retval ::WIMLIB_ERR_DECOMPRESSION
1418 * Could not decompress a resource (file or metadata) for @a image in @a
1420 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1421 * A directory entry in the metadata resource for @a image in @a wim is
1423 * @retval ::WIMLIB_ERR_INVALID_PARAM
1424 * @a target was @c NULL, or both ::WIMLIB_EXTRACT_FLAG_HARDLINK and
1425 * ::WIMLIB_EXTRACT_FLAG_SYMLINK were specified in @a extract_flags; or
1426 * both ::WIMLIB_EXTRACT_FLAG_NTFS and either
1427 * ::WIMLIB_EXTRACT_FLAG_HARDLINK or ::WIMLIB_EXTRACT_FLAG_SYMLINK were
1428 * specified in @a extract_flags; or ::WIMLIB_EXTRACT_FLAG_NTFS was
1429 * specified in @a extract_flags and @a image was ::WIMLIB_ALL_IMAGES; or
1430 * both ::WIMLIB_EXTRACT_FLAG_NTFS and ::WIMLIB_EXTRACT_FLAG_UNIX_DATA were
1431 * specified in @a extract_flag.
1432 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1433 * The SHA1 message digest of an extracted stream did not match the SHA1
1434 * message digest given in the WIM file.
1435 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1436 * A resource (file or metadata) for @a image in @a wim is invalid.
1437 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1438 * The security data for @a image in @a wim is invalid.
1439 * @retval ::WIMLIB_ERR_LINK
1440 * Failed to create a symbolic link or a hard link (only if
1441 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1442 * @retval ::WIMLIB_ERR_MKDIR
1443 * Failed create a needed directory (only if ::WIMLIB_EXTRACT_FLAG_NTFS was
1444 * not specified in @a extract_flags).
1445 * @retval ::WIMLIB_ERR_NOMEM
1446 * Failed to allocate needed memory.
1447 * @retval ::WIMLIB_ERR_NTFS_3G
1448 * An error was returned from a libntfs-3g function while the WIM image was
1449 * being extracted to the NTFS volume (only if ::WIMLIB_EXTRACT_FLAG_NTFS
1450 * was specified in @a extract_flags).
1451 * @retval ::WIMLIB_ERR_OPEN
1452 * Could not open one of the files being extracted for writing (only if
1453 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1454 * @retval ::WIMLIB_ERR_READ
1455 * A unexpected end-of-file or read error occurred when trying to read data
1456 * from the WIM file associated with @a wim.
1457 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1458 * The WIM is a split WIM, but the parts specified do not form a complete
1459 * split WIM because they do not include all the parts of the original WIM,
1460 * there are duplicate parts, or not all the parts have the same GUID and
1462 * @retval ::WIMLIB_ERR_UNSUPPORTED
1463 * ::WIMLIB_EXTRACT_FLAG_NTFS was specified in @a extract_flags, but wimlib
1464 * was configured with the @c --without-ntfs-3g flag.
1465 * @retval ::WIMLIB_ERR_WRITE
1466 * Failed to write a file being extracted (only if
1467 * ::WIMLIB_EXTRACT_FLAG_NTFS was not specified in @a extract_flags).
1470 wimlib_extract_image(WIMStruct *wim, int image,
1471 const wimlib_tchar *target,
1473 WIMStruct **additional_swms,
1474 unsigned num_additional_swms,
1475 wimlib_progress_func_t progress_func);
1478 * Extracts the XML data of a WIM file to a file stream. Every WIM file
1479 * includes a string of XML that describes the images contained in the WIM.
1480 * This function works on standalone WIMs as well as split WIM parts.
1483 * Pointer to the ::WIMStruct for a WIM file.
1485 * @c stdout, or a FILE* opened for writing, to extract the data to.
1487 * @return 0 on success; nonzero on error.
1488 * @retval ::WIMLIB_ERR_INVALID_PARAM
1489 * @a wim is not a ::WIMStruct that was created by wimlib_open_wim().
1490 * @retval ::WIMLIB_ERR_NOMEM
1491 * Failed to allocate needed memory.
1492 * @retval ::WIMLIB_ERR_READ
1493 * Failed to read the XML data from the WIM.
1494 * @retval ::WIMLIB_ERR_WRITE
1495 * Failed to completely write the XML data to @a fp.
1498 wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
1501 * Frees all memory allocated for a WIMStruct and closes all files associated
1505 * Pointer to the ::WIMStruct for a WIM file.
1507 * @return This function has no return value.
1510 wimlib_free(WIMStruct *wim);
1513 * Returns the index of the bootable image of the WIM.
1516 * Pointer to the ::WIMStruct for a WIM file.
1519 * 0 if no image is marked as bootable, or the number of the image marked
1520 * as bootable (numbered starting at 1).
1523 wimlib_get_boot_idx(const WIMStruct *wim);
1526 * Returns the compression type used in the WIM.
1529 * Pointer to the ::WIMStruct for a WIM file
1532 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
1533 * ::WIMLIB_COMPRESSION_TYPE_XPRESS.
1536 wimlib_get_compression_type(const WIMStruct *wim);
1539 * Converts a ::wimlib_compression_type value into a string.
1542 * ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
1543 * ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
1546 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
1549 extern const wimlib_tchar *
1550 wimlib_get_compression_type_string(int ctype);
1553 * Converts an error code into a string describing it.
1556 * The error code returned by one of wimlib's functions.
1559 * Pointer to a statically allocated string describing the error code,
1560 * or @c NULL if the error code is not valid.
1562 extern const wimlib_tchar *
1563 wimlib_get_error_string(enum wimlib_error_code code);
1566 * Returns the description of the specified image.
1569 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1570 * standalone WIM or a split WIM part.
1572 * The number of the image, numbered starting at 1.
1575 * The description of the image, or @c NULL if there is no such image, or
1576 * @c NULL if the specified image has no description. The description
1577 * string is in library-internal memory and may not be modified or freed;
1578 * in addition, the string will become invalid if the description of the
1579 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
1581 extern const wimlib_tchar *
1582 wimlib_get_image_description(const WIMStruct *wim, int image);
1585 * Returns the name of the specified image.
1588 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1589 * standalone WIM or a split WIM part.
1591 * The number of the image, numbered starting at 1.
1594 * The name of the image, or @c NULL if there is no such image. The name
1595 * string is in library-internal memory and may not be modified or freed;
1596 * in addition, the string will become invalid if the name of the image is
1597 * changed, the image is deleted, or the ::WIMStruct is destroyed.
1599 * If @a wim was read with wimlib_open_wim(), it is allowed for image(s) in
1600 * the WIM to be unnamed, in which case an empty string will be returned
1601 * when the corresponding name is requested.
1603 extern const wimlib_tchar *
1604 wimlib_get_image_name(const WIMStruct *wim, int image);
1608 * Returns the number of images contained in a WIM.
1611 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1612 * standalone WIM or a split WIM part.
1615 * The number of images contained in the WIM file.
1618 wimlib_get_num_images(const WIMStruct *wim);
1621 * Returns the part number of a WIM in a split WIM and the total number of parts
1625 * Pointer to the ::WIMStruct for a WIM file.
1626 * @param total_parts_ret
1627 * If non-@c NULL, the total number of parts in the split WIM (1 for
1628 * non-split WIMs) is written to this location.
1631 * The part number of the WIM (1 for non-split WIMs)
1634 wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
1637 * Initialization function for wimlib. Call before using any other wimlib
1641 * On UNIX, specify ::WIMLIB_INIT_FLAG_ASSUME_UTF8 if wimlib should assume
1642 * that all input data, including filenames, are in UTF-8 rather than the
1643 * locale-dependent character encoding which may or may not be UTF-8, and
1644 * that UTF-8 data can be directly printed to the console. On Windows, use
1645 * 0 for this parameter.
1647 * @return 0; other error codes may be returned in future releases.
1650 wimlib_global_init(int init_flags);
1653 * Since wimlib 1.2.6: Cleanup function for wimlib. This is not re-entrant.
1654 * You are not required to call this function, but it will release any global
1655 * memory allocated by the library.
1658 wimlib_global_cleanup(void);
1661 * Returns true if the WIM has an integrity table.
1664 * Pointer to the ::WIMStruct for a WIM file.
1666 * @c true if the WIM has an integrity table; @c false otherwise. If @a
1667 * wim is a ::WIMStruct created with wimlib_create_new_wim() rather than
1668 * wimlib_open_wim(), @c false will be returned, even if wimlib_write() has
1669 * been called on @a wim with ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY set.
1672 wimlib_has_integrity_table(const WIMStruct *wim);
1675 * Determines if an image name is already used by some image in the WIM.
1678 * Pointer to the ::WIMStruct for a WIM file.
1680 * The name to check.
1683 * @c true if there is already an image in @a wim named @a name; @c false
1684 * if there is no image named @a name in @a wim. If @a name is @c NULL or
1685 * the empty string, @c false is returned.
1688 wimlib_image_name_in_use(const WIMStruct *wim, const wimlib_tchar *name);
1691 * Joins a split WIM into a stand-alone one-part WIM.
1694 * An array of strings that gives the filenames of all parts of the split
1695 * WIM. No specific order is required, but all parts must be included with
1698 * Number of filenames in @a swms.
1699 * @param swm_open_flags
1700 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY if the integrity of each split WIM
1701 * part should be verified, if integrity tables are present. Otherwise,
1703 * @param wim_write_flags
1704 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY, and/or ::WIMLIB_WRITE_FLAG_FSYNC.
1705 * @param output_path
1706 * The path to write the one-part WIM to.
1707 * @param progress_func
1708 * If non-NULL, a function that will be called periodically with the
1709 * progress of the current operation.
1711 * @return 0 on success; nonzero on error. This function may return any value
1712 * returned by wimlib_open_wim() and wimlib_write() except
1713 * ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well as the following error code:
1715 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1716 * The split WIMs do not form a valid WIM because they do not include all
1717 * the parts of the original WIM, there are duplicate parts, or not all the
1718 * parts have the same GUID and compression type.
1720 * Note: the WIM's uncompressed and compressed resources are not checksummed
1721 * when they are copied from the split WIM parts to the joined WIM, nor are
1722 * compressed resources re-compressed.
1724 * Note: wimlib_export_image() can provide similar functionality to
1725 * wimlib_join(), since it is possible to export all images from a split WIM.
1728 wimlib_join(const wimlib_tchar * const *swms,
1730 const wimlib_tchar *output_path,
1732 int wim_write_flags,
1733 wimlib_progress_func_t progress_func);
1736 * Compress a chunk of a WIM resource using LZX compression.
1738 * This function is exported for convenience only and need not be used.
1741 * Uncompressed data of the chunk.
1743 * Size of the uncompressed chunk, in bytes.
1745 * Pointer to output buffer of size at least (@a chunk_size - 1) bytes.
1748 * The size of the compressed data written to @a out in bytes, or 0 if the
1749 * data could not be compressed to (@a chunk_size - 1) bytes or fewer.
1751 * As a special requirement, the compression code is optimized for the WIM
1752 * format and therefore requires (@a chunk_size <= 32768).
1755 wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);
1758 * Decompresses a block of LZX-compressed data as used in the WIM file format.
1760 * Note that this will NOT work unmodified for LZX as used in the cabinet
1761 * format, which is not the same as in the WIM format!
1763 * This function is exported for convenience only and need not be used.
1765 * @param compressed_data
1766 * Pointer to the compressed data.
1768 * @param compressed_len
1769 * Length of the compressed data, in bytes.
1771 * @param uncompressed_data
1772 * Pointer to the buffer into which to write the uncompressed data.
1774 * @param uncompressed_len
1775 * Length of the uncompressed data. It must be 32768 bytes or less.
1778 * 0 on success; non-zero on failure.
1781 wimlib_lzx_decompress(const void *compressed_data, unsigned compressed_len,
1782 void *uncompressed_data, unsigned uncompressed_len);
1786 * Mounts an image in a WIM file on a directory read-only or read-write.
1788 * This is not supported on Windows.
1790 * Unless ::WIMLIB_MOUNT_FLAG_DEBUG is specified or an early error occurs, the
1791 * process will be daemonized.
1793 * If the mount is read-write (::WIMLIB_MOUNT_FLAG_READWRITE specified),
1794 * modifications to the WIM are staged in a temporary directory.
1796 * It is safe to mount multiple images from the same WIM file read-only at the
1797 * same time, but only if different ::WIMStruct's are used. It is @b not safe
1798 * to mount multiple images from the same WIM file read-write at the same time.
1800 * wimlib_mount_image() cannot be used on an image that was exported with
1801 * wimlib_export_image() while the dentry trees for both images are still in
1802 * memory. In addition, wimlib_mount_image() may not be used to mount an image
1803 * that has just been added with wimlib_add_image(), unless the WIM has been
1804 * written and read into a new ::WIMStruct.
1807 * Pointer to the ::WIMStruct containing the image to be mounted.
1809 * The number of the image to mount, indexed starting from it. It must be
1810 * an existing, single image.
1812 * The path to an existing empty directory to mount the image on.
1813 * @param mount_flags
1814 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.
1816 * If ::WIMLIB_MOUNT_FLAG_READWRITE is given, the WIM is mounted read-write
1817 * rather than the default of read-only.
1819 * WIMs may contain named (alternate) data streams, which are a somewhat
1820 * obscure NTFS feature. They can be read and written on a mounted WIM
1821 * through one of several interfaces. The interface to use if specified by
1822 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
1823 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
1824 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
1825 * the XATTR interface.
1826 * @param additional_swms
1827 * Array of pointers to the ::WIMStruct for each additional part in the
1828 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
1829 * need to be in any particular order, but they must include all parts of
1830 * the split WIM other than the first part, which must be provided in the
1832 * @param num_additional_swms
1833 * Number of additional WIM parts provided in the @a additional_swms array.
1834 * This number should be one less than the total number of parts in the
1835 * split WIM. Set to 0 if the WIM is a standalone WIM.
1836 * @param staging_dir
1837 * If non-NULL, the name of a directory in which the staging directory will
1838 * be created. Ignored if ::WIMLIB_MOUNT_FLAG_READWRITE is not specified
1839 * in @a mount_flags. If left @c NULL, the staging directory is created in
1840 * the same directory as the WIM file that @a wim was originally read from.
1842 * @return 0 on success; nonzero on error.
1844 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
1845 * A read-write mount was requested, but an an exclusive advisory lock on
1846 * the on-disk WIM file could not be acquired because another thread or
1847 * process has mounted an image from the WIM read-write or is currently
1848 * modifying the WIM in-place.
1849 * @retval ::WIMLIB_ERR_DECOMPRESSION
1850 * Could not decompress the metadata resource for @a image in @a wim.
1851 * @retval ::WIMLIB_ERR_FUSE
1852 * A non-zero status was returned by @c fuse_main().
1853 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1854 * A directory entry in the metadata resource for @a image in @a wim is
1856 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1857 * @a image does not specify an existing, single image in @a wim.
1858 * @retval ::WIMLIB_ERR_INVALID_PARAM
1859 * @a image is shared among multiple ::WIMStruct's as a result of a call to
1860 * wimlib_export_image(), or @a image has been added with
1861 * wimlib_add_image().
1862 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1863 * The metadata resource for @a image in @a wim is invalid.
1864 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1865 * The security data for @a image in @a wim is invalid.
1866 * @retval ::WIMLIB_ERR_MKDIR
1867 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a mount_flags, but the
1868 * staging directory could not be created.
1869 * @retval ::WIMLIB_ERR_NOMEM
1870 * Failed to allocate needed memory.
1871 * @retval ::WIMLIB_ERR_NOTDIR
1872 * Could not determine the current working directory.
1873 * @retval ::WIMLIB_ERR_READ
1874 * An unexpected end-of-file or read error occurred when trying to read
1875 * data from the WIM file associated with @a wim.
1876 * @retval ::WIMLIB_ERR_SPLIT_INVALID
1877 * The WIM is a split WIM, but the parts specified do not form a complete
1878 * split WIM because they do not include all the parts of the original WIM,
1879 * there are duplicate parts, or not all the parts have the same GUID and
1881 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1882 * The WIM is a split WIM and a read-write mount was requested. We only
1883 * support mounting a split WIM read-only.
1884 * @retval ::WIMLIB_ERR_UNSUPPORTED
1885 * Mounting is not supported, either because the platform is Windows, or
1886 * because the platform is UNIX and wimlib was compiled with @c
1890 wimlib_mount_image(WIMStruct *wim,
1892 const wimlib_tchar *dir,
1894 WIMStruct **additional_swms,
1895 unsigned num_additional_swms,
1896 const wimlib_tchar *staging_dir);
1899 * Opens a WIM file and creates a ::WIMStruct for it.
1902 * The path to the WIM file to open.
1904 * Bitwise OR of flags ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1905 * ::WIMLIB_OPEN_FLAG_SPLIT_OK.
1907 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table of
1908 * the WIM, if it exists, is checked, and this function will fail with an
1909 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1910 * digests of the WIM do not exactly match the corresponding message
1911 * digests given in the integrity table.
1913 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1914 * WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1915 * returned. (This flag may be removed in the future, in which case no
1916 * error will be issued when opening a split WIM.)
1918 * @param progress_func
1919 * If non-NULL, a function that will be called periodically with the
1920 * progress of the current operation.
1923 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1924 * is written to the memory location pointed to by this parameter. The
1925 * ::WIMStruct must be freed using using wimlib_free() when finished with
1928 * @return 0 on success; nonzero on error.
1929 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1930 * The lookup table of @a wim_file is compressed. Support for this can be
1931 * added to wimlib if needed, but it appears to be the case that the lookup
1932 * table is never compressed.
1933 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1934 * The WIM is not the non-first part of a split WIM, and the number of
1935 * metadata resources found in the WIM did not match the image count given
1936 * in the WIM header, or the number of <IMAGE> elements in the XML
1937 * data for the WIM did not match the image count given in the WIM header.
1938 * @retval ::WIMLIB_ERR_INTEGRITY
1939 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1940 * wim_file contains an integrity table, but the SHA1 message digest for a
1941 * chunk of the WIM does not match the corresponding message digest given
1942 * in the integrity table.
1943 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1944 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1945 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1946 * The header of @a wim_file says that resources in the WIM are compressed,
1947 * but the header flag indicating LZX or XPRESS compression is not set.
1948 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1949 * The length field of the WIM header is not 208.
1950 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1951 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a open_flags and @a
1952 * wim_file contains an integrity table, but the integrity table is
1954 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1955 * The lookup table for the WIM contained duplicate entries that are not
1956 * for metadata resources, or it contained an entry with a SHA1 message
1957 * digest of all 0's.
1958 * @retval ::WIMLIB_ERR_NOMEM
1959 * Failed to allocated needed memory.
1960 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1961 * @a wim_file does not begin with the expected magic characters.
1962 * @retval ::WIMLIB_ERR_OPEN
1963 * Failed to open the file @a wim_file for reading.
1964 * @retval ::WIMLIB_ERR_READ
1965 * An unexpected end-of-file or read error occurred when trying to read
1966 * data from @a wim_file.
1967 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1968 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1969 * specified in @a open_flags.
1970 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1971 * A number other than 0x10d00 is written in the version field of the WIM
1972 * header of @a wim_file. (Probably a pre-Vista WIM).
1973 * @retval ::WIMLIB_ERR_XML
1974 * The XML data for @a wim_file is invalid.
1977 wimlib_open_wim(const wimlib_tchar *wim_file,
1979 WIMStruct **wim_ret,
1980 wimlib_progress_func_t progress_func);
1983 * Overwrites the file that the WIM was originally read from, with changes made.
1984 * This only makes sense for ::WIMStruct's obtained from wimlib_open_wim()
1985 * rather than wimlib_create_new_wim().
1987 * There are two ways that a WIM may be overwritten. The first is to do a full
1988 * rebuild. In this mode, the new WIM is written to a temporary file and then
1989 * renamed to the original file after it is has been completely written. The
1990 * temporary file is made in the same directory as the original WIM file. A
1991 * full rebuild may take a while, but can be used even if images have been
1992 * modified or deleted, will produce a WIM with no holes, and has little chance
1993 * of unintentional data loss because the temporary WIM is fsync()ed before
1994 * being renamed to the original WIM.
1996 * The second way to overwrite a WIM is by appending to the end of it and
1997 * overwriting the header. This can be much faster than a full rebuild, but the
1998 * disadvantage is that some space will be wasted. Writing a WIM in this mode
1999 * begins with writing any new file resources *after* everything in the old WIM,
2000 * even though this will leave a hole where the old lookup table, XML data, and
2001 * integrity were. This is done so that the WIM remains valid even if the
2002 * operation is aborted mid-write. The WIM header is only overwritten at the
2003 * very last moment, and up until that point the WIM will be seen as the old
2006 * By default, wimlib_overwrite() does the append-style overwrite described
2007 * above, unless resources in the WIM are arranged in an unusual way or if
2008 * images have been deleted from the WIM. Use the flag
2009 * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
2010 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
2011 * images have been deleted from the WIM.
2013 * In the temporary-file overwrite mode, no changes are made to the WIM on
2014 * failure, and the temporary file is deleted if possible. Abnormal termination
2015 * of the program will result in the temporary file being orphaned. In the
2016 * direct append mode, the WIM is truncated to the original length on failure;
2017 * and while abnormal termination of the program will result in extra data
2018 * appended to the original WIM, it should still be a valid WIM.
2020 * If this function completes successfully, no more functions should be called
2021 * on @a wim other than wimlib_free(). You must use wimlib_open_wim() to read
2022 * the WIM file anew.
2025 * Pointer to the ::WIMStruct for the WIM file to write. There may have
2026 * been in-memory changes made to it, which are then reflected in the
2028 * @param write_flags
2029 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2030 * ::WIMLIB_WRITE_FLAG_REBUILD, ::WIMLIB_WRITE_FLAG_RECOMPRESS, and/or
2031 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2032 * @param num_threads
2033 * Number of threads to use for compression (see wimlib_write()).
2034 * @param progress_func
2035 * If non-NULL, a function that will be called periodically with the
2036 * progress of the current operation.
2038 * @return 0 on success; nonzero on error. This function may return any value
2039 * returned by wimlib_write() as well as the following error codes:
2040 * @retval ::WIMLIB_ERR_ALREADY_LOCKED
2041 * The WIM was going to be modifien in-place (with no temporary file), but
2042 * an exclusive advisory lock on the on-disk WIM file could not be acquired
2043 * because another thread or process has mounted an image from the WIM
2044 * read-write or is currently modifying the WIM in-place.
2045 * @retval ::WIMLIB_ERR_NO_FILENAME
2046 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
2047 * than a WIM read with wimlib_open_wim().
2048 * @retval ::WIMLIB_ERR_RENAME
2049 * The temporary file that the WIM was written to could not be renamed to
2050 * the original filename of @a wim.
2053 wimlib_overwrite(WIMStruct *wim, int write_flags, unsigned num_threads,
2054 wimlib_progress_func_t progress_func);
2057 * Prints information about one image, or all images, contained in a WIM.
2060 * Pointer to the ::WIMStruct for a WIM file.
2062 * The image about which to print information. Can be the number of an
2063 * image, or ::WIMLIB_ALL_IMAGES to print information about all images in the
2066 * @return This function has no return value. No error checking is done when
2067 * printing the information. If @a image is invalid, an error message is
2071 wimlib_print_available_images(const WIMStruct *wim, int image);
2074 * Prints the full paths to all files contained in an image, or all images, in a
2078 * Pointer to the ::WIMStruct for a WIM file.
2080 * Which image to print files for. Can be the number of an image, or
2081 * ::WIMLIB_ALL_IMAGES to print the files contained in all images.
2083 * @return 0 on success; nonzero on error.
2084 * @retval ::WIMLIB_ERR_DECOMPRESSION
2085 * The metadata resource for one of the specified images could not be
2087 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2088 * A directory entry in the metadata resource for one of the specified
2089 * images is invaled.
2090 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2091 * @a image does not specify a valid image in @a wim, and is not
2092 * ::WIMLIB_ALL_IMAGES.
2093 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2094 * The metadata resource for one of the specified images is invalid.
2095 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2096 * The security data for one of the specified images is invalid.
2097 * @retval ::WIMLIB_ERR_NOMEM
2098 * Failed to allocate needed memory.
2099 * @retval ::WIMLIB_ERR_READ
2100 * An unexpected read error or end-of-file occurred when reading the
2101 * metadata resource for one of the specified images.
2102 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2103 * @a wim was not a standalone WIM and was not the first part of a split
2107 wimlib_print_files(WIMStruct *wim, int image);
2110 * Prints detailed information from the header of a WIM file.
2113 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2114 * standalone WIM or part of a split WIM.
2116 * @return This function has no return value.
2120 wimlib_print_header(const WIMStruct *wim);
2123 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
2124 * digests, as found in the directory entry tree in the WIM file, to file
2125 * resources in the WIM file. This table includes one entry for each unique
2126 * file in the WIM, so it can be quite long. There is only one lookup table per
2127 * WIM file, but each split WIM part has its own lookup table.
2130 * Pointer to the ::WIMStruct for a WIM file.
2132 * @return This function has no return value.
2135 wimlib_print_lookup_table(WIMStruct *wim);
2138 * Prints the metadata of the specified image in a WIM file. The metadata
2139 * consists of the security data as well as the directory entry tree. Each
2140 * image has its own metadata.
2143 * Pointer to the ::WIMStruct for a WIM file.
2145 * Which image to print the metadata for. Can be the number of an image,
2146 * or ::WIMLIB_ALL_IMAGES to print the metadata for all images in the WIM.
2148 * @return 0 on success; nonzero on error.
2149 * @retval ::WIMLIB_ERR_DECOMPRESSION
2150 * The metadata resource for one of the specified images could not be
2152 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2153 * A directory entry in the metadata resource for one of the specified
2154 * images is invaled.
2155 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2156 * @a image does not specify a valid image in @a wim, and is not
2157 * ::WIMLIB_ALL_IMAGES.
2158 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2159 * The metadata resource for one of the specified images is invalid.
2160 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2161 * The security data for one of the specified images is invalid.
2162 * @retval ::WIMLIB_ERR_NOMEM
2163 * Failed to allocate needed memory.
2164 * @retval ::WIMLIB_ERR_READ
2165 * An unexpected read error or end-of-file occurred when reading the
2166 * metadata resource for one of the specified images.
2167 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2168 * @a wim was not a standalone WIM and was not the first part of a split
2172 wimlib_print_metadata(WIMStruct *wim, int image);
2175 * Prints some basic information about a WIM file. All information printed by
2176 * this function is also printed by wimlib_print_header(), but
2177 * wimlib_print_wim_information() prints some of this information more concisely
2178 * and in a more readable form.
2181 * Pointer to the ::WIMStruct for a WIM file.
2183 * @return This function has no return value.
2186 wimlib_print_wim_information(const WIMStruct *wim);
2189 * Translates a string specifying the name or number of an image in the WIM into
2190 * the number of the image. The images are numbered starting at 1.
2193 * Pointer to the ::WIMStruct for a WIM file.
2194 * @param image_name_or_num
2195 * A string specifying the name or number of an image in the WIM. If it
2196 * parses to a positive integer, this integer is taken to specify the
2197 * number of the image, indexed starting at 1. Otherwise, it is taken to
2198 * be the name of an image, as given in the XML data for the WIM file. It
2199 * also may be the keyword "all" or the string "*", both of which will
2200 * resolve to ::WIMLIB_ALL_IMAGES.
2202 * There is no way to search for an image actually named "all", "*", or an
2203 * integer number, or an image that has no name. However, you can use
2204 * wimlib_get_image_name() to get the name of any image.
2207 * If the string resolved to a single existing image, the number of that
2208 * image, indexed starting at 1, is returned. If the keyword "all" or "*"
2209 * was specified, ::WIMLIB_ALL_IMAGES is returned. Otherwise,
2210 * ::WIMLIB_NO_IMAGE is returned. If @a image_name_or_num was @c NULL or
2211 * the empty string, ::WIMLIB_NO_IMAGE is returned, even if one or more
2212 * images in @a wim has no name.
2215 wimlib_resolve_image(WIMStruct *wim,
2216 const wimlib_tchar *image_name_or_num);
2219 * Sets which image in the WIM is marked as bootable.
2222 * Pointer to the ::WIMStruct for a WIM file.
2224 * The number of the image to mark as bootable, or 0 to mark no image as
2226 * @return 0 on success; nonzero on error.
2227 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2228 * @a boot_idx does not specify an existing image in @a wim, and it was not
2230 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2231 * @a wim is part of a split WIM. We do not support changing the boot
2232 * index of a split WIM.
2235 wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
2238 * Changes the description of an image in the WIM.
2241 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2242 * standalone WIM or part of a split WIM; however, you should set the same
2243 * description on all parts of a split WIM.
2245 * The number of the image for which to change the description.
2246 * @param description
2247 * The new description to give the image. It may be @c NULL, which
2248 * indicates that the image is to be given no description.
2250 * @return 0 on success; nonzero on error.
2251 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2252 * @a image does not specify a single existing image in @a wim.
2253 * @retval ::WIMLIB_ERR_NOMEM
2254 * Failed to allocate the memory needed to duplicate the @a description
2258 wimlib_set_image_descripton(WIMStruct *wim, int image,
2259 const wimlib_tchar *description);
2262 * Changes what is written in the \<FLAGS\> element in the WIM XML data
2263 * (something like "Core" or "Ultimate")
2266 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2267 * standalone WIM or part of a split WIM; however, you should set the same
2268 * \<FLAGS\> element on all parts of a split WIM.
2270 * The number of the image for which to change the description.
2272 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
2273 * indicates that the image is to be given no \<FLAGS\> element.
2275 * @return 0 on success; nonzero on error.
2276 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2277 * @a image does not specify a single existing image in @a wim.
2278 * @retval ::WIMLIB_ERR_NOMEM
2279 * Failed to allocate the memory needed to duplicate the @a flags string.
2281 extern int wimlib_set_image_flags(WIMStruct *wim, int image,
2282 const wimlib_tchar *flags);
2285 * Changes the name of an image in the WIM.
2288 * Pointer to the ::WIMStruct for a WIM file. It may be either a
2289 * standalone WIM or part of a split WIM; however, you should set the same
2290 * name on all parts of a split WIM.
2292 * The number of the image for which to change the name.
2294 * The new name to give the image. It must be a nonempty string.
2296 * @return 0 on success; nonzero on error.
2297 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
2298 * There is already an image named @a name in @a wim.
2299 * @retval ::WIMLIB_ERR_INVALID_PARAM
2300 * @a name was @c NULL or the empty string.
2301 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2302 * @a image does not specify a single existing image in @a wim.
2303 * @retval ::WIMLIB_ERR_NOMEM
2304 * Failed to allocate the memory needed to duplicate the @a name string.
2306 extern int wimlib_set_image_name(WIMStruct *wim, int image,
2307 const wimlib_tchar *name);
2310 * Set the functions that wimlib uses to allocate and free memory.
2312 * These settings are global and not per-WIM.
2314 * The default is to use the default @c malloc() and @c free() from the C
2317 * Please note that some external functions, such as those in @c libntfs-3g, may
2318 * use the standard memory allocation functions.
2320 * @param malloc_func
2321 * A function equivalent to @c malloc() that wimlib will use to allocate
2322 * memory. If @c NULL, the allocator function is set back to the default
2323 * @c malloc() from the C library.
2325 * A function equivalent to @c free() that wimlib will use to free memory.
2326 * If @c NULL, the free function is set back to the default @c free() from
2328 * @param realloc_func
2329 * A function equivalent to @c realloc() that wimlib will use to reallocate
2330 * memory. If @c NULL, the free function is set back to the default @c
2331 * realloc() from the C library.
2332 * @return 0 on success; nonzero on error.
2333 * @retval ::WIMLIB_ERR_UNSUPPORTED
2334 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
2335 * so custom memory allocators are unsupported.
2338 wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
2339 void (*free_func)(void *),
2340 void *(*realloc_func)(void *, size_t));
2343 * Sets whether wimlib is to print error messages to @c stderr when a function
2344 * fails. These error messages may provide information that cannot be
2345 * determined only from the error code that is returned. Not every error will
2346 * result in an error message being printed.
2348 * This setting is global and not per-WIM.
2350 * By default, error messages are not printed.
2352 * @param show_messages
2353 * @c true if error messages are to be printed; @c false if error messages
2354 * are not to be printed.
2356 * @return 0 on success; nonzero on error.
2357 * @retval ::WIMLIB_ERR_UNSUPPORTED
2358 * @a show_messages was @c true, but wimlib was compiled with the @c
2359 * --without-error-messages option. Therefore, error messages cannot be
2363 wimlib_set_print_errors(bool show_messages);
2366 * Splits a WIM into multiple parts.
2369 * The ::WIMStruct for the WIM to split. It must be a standalone, one-part
2372 * Name of the SWM file to create. This will be the name of the first
2373 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
2374 * appended before the suffix.
2376 * The maximum size per part, in bytes. It is not guaranteed that this
2377 * will really be the maximum size per part, because some file resources in
2378 * the WIM may be larger than this size, and the WIM file format provides
2379 * no way to split up file resources among multiple WIMs.
2380 * @param write_flags
2381 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY if integrity tables are to be
2382 * included in the split WIM parts.
2383 * @param progress_func
2384 * If non-NULL, a function that will be called periodically with the
2385 * progress of the current operation.
2387 * @return 0 on success; nonzero on error. This function may return any value
2388 * returned by wimlib_write() as well as the following error codes:
2390 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2391 * @a wim is not part 1 of a stand-alone WIM.
2392 * @retval ::WIMLIB_ERR_INVALID_PARAM
2393 * @a swm_name was @c NULL, or @a part_size was 0.
2395 * Note: the WIM's uncompressed and compressed resources are not checksummed
2396 * when they are copied from the joined WIM to the split WIM parts, nor are
2397 * compressed resources re-compressed.
2400 wimlib_split(WIMStruct *wim,
2401 const wimlib_tchar *swm_name,
2404 wimlib_progress_func_t progress_func);
2407 * Unmounts a WIM image that was mounted using wimlib_mount_image().
2409 * The image to unmount is specified by the path to the mountpoint, not the
2410 * original ::WIMStruct passed to wimlib_mount_image(), which should not be
2411 * touched and also may have been allocated in a different process.
2413 * To unmount the image, the thread calling this function communicates with the
2414 * thread that is managing the mounted WIM image. This function blocks until it
2415 * is known whether the unmount succeeded or failed. In the case of a
2416 * read-write mounted WIM, the unmount is not considered to have succeeded until
2417 * all changes have been saved to the underlying WIM file.
2420 * The directory that the WIM image was mounted on.
2421 * @param unmount_flags
2422 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY,
2423 * ::WIMLIB_UNMOUNT_FLAG_COMMIT, ::WIMLIB_UNMOUNT_FLAG_REBUILD, and/or
2424 * ::WIMLIB_UNMOUNT_FLAG_RECOMPRESS. None of these flags affect read-only
2426 * @param progress_func
2427 * If non-NULL, a function that will be called periodically with the
2428 * progress of the current operation.
2430 * @return 0 on success; nonzero on error.
2432 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
2433 * The filesystem daemon was unable to remove the staging directory and the
2434 * temporary files that it contains.
2435 * @retval ::WIMLIB_ERR_FILESYSTEM_DAEMON_CRASHED
2436 * The filesystem daemon appears to have terminated before sending an exit
2438 * @retval ::WIMLIB_ERR_FORK
2439 * Could not @c fork() the process.
2440 * @retval ::WIMLIB_ERR_FUSERMOUNT
2441 * The @b fusermount program could not be executed or exited with a failure
2443 * @retval ::WIMLIB_ERR_MQUEUE
2444 * Could not open a POSIX message queue to communicate with the filesystem
2445 * daemon servicing the mounted filesystem, could not send a message
2446 * through the queue, or could not receive a message through the queue.
2447 * @retval ::WIMLIB_ERR_NOMEM
2448 * Failed to allocate needed memory.
2449 * @retval ::WIMLIB_ERR_OPEN
2450 * The filesystem daemon could not open a temporary file for writing the
2452 * @retval ::WIMLIB_ERR_READ
2453 * A read error occurred when the filesystem daemon tried to a file from
2454 * the staging directory
2455 * @retval ::WIMLIB_ERR_RENAME
2456 * The filesystem daemon failed to rename the newly written WIM file to the
2457 * original WIM file.
2458 * @retval ::WIMLIB_ERR_UNSUPPORTED
2459 * Mounting is not supported, either because the platform is Windows, or
2460 * because the platform is UNIX and wimlib was compiled with @c
2462 * @retval ::WIMLIB_ERR_WRITE
2463 * A write error occurred when the filesystem daemon was writing to the new
2464 * WIM file, or the filesystem daemon was unable to flush changes that had
2465 * been made to files in the staging directory.
2468 wimlib_unmount_image(const wimlib_tchar *dir,
2470 wimlib_progress_func_t progress_func);
2473 * Update a WIM image by adding, deleting, and/or renaming files or directories.
2476 * Pointer to the ::WIMStruct for the WIM file to update.
2478 * The 1-based index of the image in the WIM to update. It cannot be
2479 * ::WIMLIB_ALL_IMAGES.
2481 * An array of ::wimlib_update_command's that specify the update operations
2484 * Number of commands in @a cmds.
2485 * @param update_flags
2486 * Reserved; must be 0.
2487 * @param progress_func
2488 * If non-NULL, a function that will be called periodically with the
2489 * progress of the current operation.
2491 * @return 0 on success; nonzero on error. On failure, some but not all of the
2492 * update commands may have been executed. No individual update command will
2493 * have been partially executed. Possible error codes include:
2495 * @retval ::WIMLIB_ERR_DECOMPRESSION
2496 * Failed to decompress the metadata resource from @a image in @a wim.
2497 * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
2498 * The capture configuration structure specified for an add command was
2500 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2501 * A directory entry for @a image in @a wim is invalid.
2502 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2503 * @a image did not specify a single, existing image in @a wim.
2504 * @retval ::WIMLIB_ERR_INVALID_OVERLAY
2505 * Attempted to perform an add command that conflicted with previously
2506 * existing files in the WIM when an overlay was attempted.
2507 * @retval ::WIMLIB_ERR_INVALID_PARAM
2508 * An unknown operation type was specified in the update commands; or,
2509 * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
2510 * in the @a add_flags, but the same image had previously already been
2511 * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
2512 * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
2513 * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
2514 * specified in the @a add_flags for an add command in which @a
2515 * wim_target_path was not the root directory of the WIM image.
2516 * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
2517 * (Windows only): While executing an add command, tried to capture a
2518 * reparse point with invalid data.
2519 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2520 * The metadata resource for @a image in @a wim is invalid.
2521 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2522 * The security data for image @a image in @a wim is invalid.
2523 * @retval ::WIMLIB_ERR_IS_DIRECTORY
2524 * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
2525 * for a WIM path that corresponded to a directory; or, a rename command
2526 * attempted to rename a directory to a non-directory.
2527 * @retval ::WIMLIB_ERR_NOMEM
2528 * Failed to allocate needed memory.
2529 * @retval ::WIMLIB_ERR_NOTDIR
2530 * A rename command attempted to rename a directory to a non-directory; or,
2531 * an add command was executed that attempted to set the root of the WIM
2532 * image as a non-directory; or, a path component used as a directory in a
2533 * rename command was not, in fact, a directory.
2534 * @retval ::WIMLIB_ERR_NOTEMPTY
2535 * A rename command attempted to rename a directory to a non-empty
2537 * @retval ::WIMLIB_ERR_NTFS_3G
2538 * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
2539 * error occurred while reading data from the NTFS volume using libntfs-3g.
2540 * @retval ::WIMLIB_ERR_OPEN
2541 * Failed to open a file to be captured while executing an add command.
2542 * @retval ::WIMLIB_ERR_OPENDIR
2543 * Failed to open a directory to be captured while executing an add command.
2544 * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
2545 * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
2546 * WIM path that did not exist; or, a rename command attempted to rename a
2547 * file that does not exist.
2548 * @retval ::WIMLIB_ERR_READ
2549 * Failed to read the metadata resource for @a image in @a wim; or, while
2550 * executing an add command, failed to read data from a file or directory
2552 * @retval ::WIMLIB_ERR_READLINK
2553 * While executing an add command, failed to read the target of a symbolic
2554 * link or junction point.
2555 * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
2556 * (Windows only) Failed to perform a reparse point fixup because of
2557 * problems with the data of a reparse point.
2558 * @retval ::WIMLIB_ERR_SPECIAL_FILE
2559 * While executing an add command, attempted to capture a file that was not
2560 * a supported file type, such as a regular file, directory, symbolic link,
2561 * or (on Windows) a reparse point.
2562 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2563 * @a wim is part of a split WIM. Updating a split WIM is unsupported.
2564 * @retval ::WIMLIB_ERR_STAT
2565 * While executing an add command, failed to get attributes for a file or
2567 * @retval ::WIMLIB_ERR_UNSUPPORTED
2568 * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
2569 * command, but wimlib was configured with the @c --without-ntfs-3g flag;
2570 * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
2571 * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
2572 * add_flags for an update command.
2575 wimlib_update_image(WIMStruct *wim,
2577 const struct wimlib_update_command *cmds,
2580 wimlib_progress_func_t progress_func);
2583 * Writes a standalone WIM to a file.
2585 * This brings in resources from any external locations, such as directory trees
2586 * or NTFS volumes scanned with wimlib_add_image(), or other WIM files via
2587 * wimlib_export_image(), and incorporates them into a new on-disk WIM file.
2590 * Pointer to the ::WIMStruct for a WIM. There may have been in-memory
2591 * changes made to it, which are then reflected in the output file.
2593 * The path to the file to write the WIM to.
2595 * The image inside the WIM to write. Use ::WIMLIB_ALL_IMAGES to include all
2597 * @param write_flags
2598 * Bitwise OR of the flags ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY,
2599 * ::WIMLIB_WRITE_FLAG_RECOMPRESS, ::WIMLIB_WRITE_FLAG_FSYNC, and/or
2600 * ::WIMLIB_WRITE_FLAG_SOFT_DELETE.
2601 * @param num_threads
2602 * Number of threads to use for compressing data. If 0, the number of
2603 * threads is taken to be the number of online processors. Note: if no
2604 * data compression needs to be done, no additional threads will be created
2605 * regardless of this parameter (e.g. if writing an uncompressed WIM, or
2606 * exporting an image from a compressed WIM to another WIM of the same
2607 * compression type without ::WIMLIB_WRITE_FLAG_RECOMPRESS specified in @a
2609 * @param progress_func
2610 * If non-NULL, a function that will be called periodically with the
2611 * progress of the current operation.
2613 * @return 0 on success; nonzero on error.
2614 * @retval ::WIMLIB_ERR_DECOMPRESSION
2615 * Failed to decompress a metadata or file resource in @a wim.
2616 * @retval ::WIMLIB_ERR_INVALID_DENTRY
2617 * A directory entry in the metadata resource for @a image in @a wim is
2619 * @retval ::WIMLIB_ERR_INVALID_IMAGE
2620 * @a image does not specify a single existing image in @a wim, and is not
2621 * ::WIMLIB_ALL_IMAGES.
2622 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
2623 * A file that had previously been scanned for inclusion in the WIM by
2624 * wimlib_add_image() was concurrently modified, so it failed the SHA1
2625 * message digest check.
2626 * @retval ::WIMLIB_ERR_INVALID_PARAM
2627 * @a path was @c NULL.
2628 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
2629 * The metadata resource for @a image in @a wim is invalid.
2630 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
2631 * The security data for @a image in @a wim is invalid.
2632 * @retval ::WIMLIB_ERR_NOMEM
2633 * Failed to allocate needed memory.
2634 * @retval ::WIMLIB_ERR_OPEN
2635 * Failed to open @a path for writing, or some file resources in @a
2636 * wim refer to files in the outside filesystem, and one of these files
2637 * could not be opened for reading.
2638 * @retval ::WIMLIB_ERR_READ
2639 * An error occurred when trying to read data from the WIM file associated
2640 * with @a wim, or some file resources in @a wim refer to files in the
2641 * outside filesystem, and a read error occurred when reading one of these
2643 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
2644 * @a wim is part of a split WIM. You may not call this function on a
2646 * @retval ::WIMLIB_ERR_WRITE
2647 * An error occurred when trying to write data to the new WIM file at @a
2651 wimlib_write(WIMStruct *wim,
2652 const wimlib_tchar *path,
2655 unsigned num_threads,
2656 wimlib_progress_func_t progress_func);
2659 * This function is equivalent to wimlib_lzx_compress(), but instead compresses
2660 * the data using "XPRESS" compression.
2663 wimlib_xpress_compress(const void *chunk, unsigned chunk_size, void *out);
2666 * This function is equivalent to wimlib_lzx_decompress(), but instead assumes
2667 * the data is compressed using "XPRESS" compression.
2670 wimlib_xpress_decompress(const void *compressed_data, unsigned compressed_len,
2671 void *uncompressed_data, unsigned uncompressed_len);
2673 #endif /* _WIMLIB_H */