4 * External header for wimlib.
8 * Copyright (C) 2012 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
28 * \section intro Introduction
30 * wimlib is a C library to read, write, and mount archive files in the Windows
31 * Imaging Format (WIM files). These files are normally created using the @c
32 * imagex.exe utility on Windows, but this library provides a free
33 * implementetion of @c imagex for UNIX-based systems and an API to allow other
34 * programs to read, write, and mount WIM files. wimlib is comparable to
35 * Microsoft's WIMGAPI, but was designed independently and is not a clone of it.
37 * \section format WIM files
39 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
40 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
41 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
42 * Both are based on LZ77 and Huffman encoding, and both are supported by
45 * Unlike ZIP files, WIM files can contain multiple independent toplevel
46 * directory trees known as @a images. While each image has its own metadata,
47 * files are not duplicated for each image; instead, each file is included only
48 * once in the entire WIM. Microsoft did this so that in one WIM file, they
49 * could do things like have 5 different versions of Windows that are almost
52 * Microsoft provides documentation for the WIM file format, XPRESS compression
53 * format, and LZX compression format. The XPRESS documentation is acceptable,
54 * but the LZX documentation is not entirely correct, and the WIM documentation
55 * itself is very incomplete and is of unacceptable quality.
57 * A WIM file may be either stand-alone or split into multiple parts.
59 * \section winpe Windows PE
61 * A major use for this library is to create customized images of Windows PE, the
62 * Windows Preinstallation Environment, without having to rely on Windows. Windows
63 * PE is a lightweight version of Windows that can run entirely from memory and can
64 * be used to install Windows from local media or a network drive or perform
65 * maintenance. Windows PE is the operating system that runs when you boot from
66 * the Windows installation media.
68 * You can find Windows PE on the installation DVD for Windows Vista, Windows 7,
69 * or Windows 8, in the file @c sources/boot.wim. Windows PE can also be found
70 * in the Windows Automated Installation Kit (WAIK), which is free to download
71 * from Microsoft, inside the @c WinPE.cab file, which you can extract if you
72 * install either the @c cabextract or @c p7zip programs.
74 * In addition, Windows installations and recovery partitions frequently contain a
75 * WIM containing an image of the Windows Recovery Environment, which is similar to
78 * \section ntfs NTFS support
80 * As of version 1.0.0, wimlib supports capturing and applying images directly
81 * to NTFS volumes. This was made possible with the help of libntfs-3g from the
82 * NTFS-3g project. This feature supports capturing and restoring NTFS-specific
83 * data such as security descriptors, alternate data streams, and reparse point
86 * The code for NTFS image capture and image application is complete enough that
87 * it is possible to apply an image from the "install.wim" contained in recent
88 * Windows installation media (Vista, Windows 7, or Windows 8) directly to a
89 * NTFS volume, and then boot Windows from it after preparing the Boot
90 * Configuration Data. In addition, a Windows installation can be captured (or
91 * backed up) into a WIM file, and then re-applied later.
93 * \section starting Getting Started
95 * wimlib uses the GNU autotools, so it should be easy to install with
96 * <code>configure && make && sudo make install</code>; however, please see the
97 * README for more information about installing it. To use wimlib in a program
98 * after installing it, include @c wimlib.h and link your program with @c -lwim.
100 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure. A ::WIMStruct
101 * may represent either a stand-alone WIM or one part of a split WIM.
103 * All functions in wimlib's public API are prefixed with @c wimlib. Most
104 * return an integer error code on failure. Use wimlib_get_error_string() to
105 * get a string that describes an error code. wimlib also can print error
106 * messages itself when an error happens, and these may be more informative than
107 * the error code; to enable this, call wimlib_set_print_errors(). Please note
108 * that this is for convenience only, and some errors can occur without a
109 * message being printed.
111 * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
112 * following exceptions: wimlib_set_print_errors() and
113 * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
114 * used by one ::WIMStruct at a time.
116 * To open an existing WIM, use wimlib_open_wim().
118 * To create a new WIM that initially contains no images, use
119 * wimlib_create_new_wim().
121 * To add an image to a WIM file from a directory tree on your filesystem, call
122 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
123 * wimlib_open_wim() or from wimlib_create_new_wim(). Alternatively, if you
124 * want to capture a WIM image directly from a NTFS volume while preserving
125 * NTFS-specific data such as security descriptors, call
126 * wimlib_add_image_from_ntfs_volume() instead.
128 * To extract an image from a WIM file, call wimlib_extract_image().
129 * Alternatively, if you want to apply a WIM image directly to a NTFS volume
130 * while setting NTFS-specific data such as security descriptors, call
131 * wimlib_apply_image_to_ntfs_volume().
133 * The NTFS functions will fail if wimlib was compiled with the
134 * <code>--without-ntfs-3g</code> flag.
136 * wimlib supports mounting WIM files either read-only or read-write. Mounting
137 * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
138 * Mounting can be done without root privileges because it is implemented using
139 * FUSE (Filesystem in Userspace). If wimlib is compiled with the
140 * <code>--without-fuse</code> flag, these functions will be available but will
143 * After creating or modifying a WIM file, you can write it to a file using
144 * wimlib_write(). Alternatively, if the WIM was originally read from a file,
145 * you can use wimlib_overwrite() to overwrite the original file. In some
146 * cases, wimlib_overwrite_xml_and_header() can be used instead.
148 * After you are done with the WIM file, use wimlib_free() to free all memory
149 * associated with a ::WIMStruct and close all files associated with it.
151 * To see an example of how to use wimlib, see the file
152 * @c programs/imagex.c in wimlib's source tree.
154 * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
155 * for this. However, if wimlib calls into @c libntfs-3g, the custom memory
156 * allocator may not be used.
158 * \section imagex imagex
160 * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
162 * \section mkwinpeimg mkwinpeimg
164 * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
167 * \section Limitations
169 * While wimlib supports the main features of WIM files, wimlib currently has
170 * the following limitations:
171 * - Different versions of the WIM file format are unsupported. There is one
172 * different version of the format from development versions of Windows Vista,
173 * but I'm not planning to support it.
174 * - Compressed resource chunk sizes other than 32768 are unsupported (except for
175 * uncompressed WIMs, for which the chunk size field is ignored). As far as I
176 * can tell, other chunk sizes are not used in compressed WIMs. Let me know
177 * if you find a WIM file with a different chunk size.
178 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
179 * make certain Windows-specific modifications to a Windows PE image, such as
180 * adding a driver or Windows component. Such a tool could conceivably be
181 * implemented on top of wimlib, although it likely would be hard to implement
182 * because it would have to do very Windows-specific things such as
183 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
184 * script for a similar purpose, however. With regards to adding drivers to
185 * Windows PE, you have the option of putting them anywhere in the Windows PE
186 * image, then loading them after boot using @b drvload.exe.
187 * - There is not yet a way to extract specific files or directories from a WIM
188 * file without mounting it, or to add, remove, or modify files in a WIM
189 * without mounting it, other than by adding or removing an entire image. I
190 * can implement this if requested, but I intend the FUSE mount feature to be
191 * used for this purpose, as it is easy to do these things in whatever way you
192 * want after the image is mounted.
193 * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
194 * than wimlib when using maximum (LZX) compression because it knows how to
195 * split up LZX compressed blocks, which is not yet implemented in wimlib.
196 * - wimlib is experimental and likely contains bugs; use Microsoft's @a
197 * imagex.exe if you want to make sure your WIM files are made "correctly".
199 * \section legal License
201 * The wimlib library, as well as the programs and scripts distributed with it
202 * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
203 * License version 3 or later.
213 #ifndef _WIMLIB_INTERNAL_H
215 * Opaque structure that represents a WIM file.
217 typedef struct WIMStruct WIMStruct;
221 * Specifies the compression type of a WIM file.
224 enum wim_compression_type {
225 /** An invalid compression type. */
226 WIM_COMPRESSION_TYPE_INVALID = -1,
228 /** The WIM does not include any compressed resources. */
229 WIM_COMPRESSION_TYPE_NONE = 0,
231 /** Compressed resources in the WIM use LZX compression. */
232 WIM_COMPRESSION_TYPE_LZX = 1,
234 /** Compressed resources in the WIM use XPRESS compression. */
235 WIM_COMPRESSION_TYPE_XPRESS = 2,
238 /** Mount the WIM read-write. */
239 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
241 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
242 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
244 /** Do not allow accessing alternate data streams. */
245 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000010
247 /** Access alternate data streams through extended file attributes. This is the
249 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000020
251 /** Access alternate data streams by specifying the file name, a colon, then the
252 * alternate file stream name. */
253 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
255 /** Include an integrity table in the new WIM being written during the unmount.
256 * Ignored for read-only mounts. */
257 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
259 /** Unless this flag is given, changes to a mounted WIM are discarded. Ignored
260 * for read-only mounts. */
261 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
263 /** Include an integrity table in the new WIM file. */
264 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
266 /** Print progress information when writing the integrity table. */
267 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS 0x00000002
269 /** Print file paths as we write then */
270 #define WIMLIB_WRITE_FLAG_VERBOSE 0x00000004
272 /** Mark the image being added as the bootable image of the WIM. */
273 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
275 /** Print the name of each file or directory as it is scanned to be included in
277 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
279 /** Follow symlinks; archive and dump the files they point to. */
280 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000004
282 /** See documentation for wimlib_export_image(). */
283 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
285 /** Verify the integrity of the WIM if an integrity table is present. */
286 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
288 /** Print progress information when verifying integrity table. */
289 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
291 /** If this flag is not given, an error is issued if the WIM is part of a split
293 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
296 /** When identical files are extracted from the WIM, always hard link them
298 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
300 /** When identical files are extracted from the WIM, always symlink them
302 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
304 /** Print the name of each file as it is extracted from the WIM image. */
305 #define WIMLIB_EXTRACT_FLAG_VERBOSE 0x00000008
308 * Possible values of the error code returned by many functions in wimlib.
310 * See the documentation for each wimlib function to see specifically what error
311 * codes can be returned by a given function, and what they mean.
313 enum wimlib_error_code {
314 WIMLIB_ERR_SUCCESS = 0,
315 WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
316 WIMLIB_ERR_DECOMPRESSION,
317 WIMLIB_ERR_DELETE_STAGING_DIR,
320 WIMLIB_ERR_FUSERMOUNT,
321 WIMLIB_ERR_IMAGE_COUNT,
322 WIMLIB_ERR_IMAGE_NAME_COLLISION,
323 WIMLIB_ERR_INTEGRITY,
324 WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
325 WIMLIB_ERR_INVALID_CHUNK_SIZE,
326 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
327 WIMLIB_ERR_INVALID_DENTRY,
328 WIMLIB_ERR_INVALID_HEADER_SIZE,
329 WIMLIB_ERR_INVALID_IMAGE,
330 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
331 WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
332 WIMLIB_ERR_INVALID_PARAM,
333 WIMLIB_ERR_INVALID_RESOURCE_HASH,
334 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
335 WIMLIB_ERR_INVALID_SECURITY_DATA,
341 WIMLIB_ERR_NOT_A_WIM_FILE,
342 WIMLIB_ERR_NO_FILENAME,
349 WIMLIB_ERR_SPECIAL_FILE,
350 WIMLIB_ERR_SPLIT_INVALID,
351 WIMLIB_ERR_SPLIT_UNSUPPORTED,
354 WIMLIB_ERR_UNKNOWN_VERSION,
355 WIMLIB_ERR_UNSUPPORTED,
361 /** Used to indicate that no WIM image is currently selected. */
362 #define WIM_NO_IMAGE 0
364 /** Used to specify all images in the WIM. */
365 #define WIM_ALL_IMAGES (-1)
369 * Adds an image to a WIM file from a directory tree on disk.
371 * The directory tree is read immediately for the purpose of constructing a
372 * directory entry tree in-memory. Also, all files are read to calculate their
373 * SHA1 message digests. However, because the directory tree may contain a very
374 * large amount of data, the files themselves are not read into memory
375 * permanently, and instead references to their paths saved. The files are then
376 * read on-demand if wimlib_write() or wimlib_overwrite() is called.
379 * Pointer to the ::WIMStruct for a WIM file to which the image will be
382 * A path to a directory in the outside filesystem. It will become the
383 * root directory for the WIM image.
385 * The name to give the image. This must be non-@c NULL.
387 * Pointer to the contents of an image capture configuration file. If @c
388 * NULL, a default string is used. Please see the manual page for
389 * <b>imagex capture</b> for more information.
391 * Length of the string @a config in bytes. Ignored if @a config is @c
395 * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG. If
396 * ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
397 * marked as bootable is changed to the one being added. If
398 * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
399 * printed as it is scanned or captured. If
400 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
401 * directories pointed to by symbolic links are archived rather than the
402 * symbolic links themselves.
404 * @return 0 on success; nonzero on error. On error, changes to @a wim are
405 * discarded so that it appears to be in the same state as when this function
408 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
409 * There is already an image named @a name in @a w.
410 * @retval ::WIMLIB_ERR_INVALID_PARAM
411 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
412 * @retval ::WIMLIB_ERR_NOMEM
413 * Failed to allocate needed memory.
414 * @retval ::WIMLIB_ERR_NOTDIR
415 * @a dir is not a directory.
416 * @retval ::WIMLIB_ERR_OPEN
417 * Failed to open a file or directory in the directory tree rooted at @a
419 * @retval ::WIMLIB_ERR_READ
420 * Failed to read a file in the directory tree rooted at @a dir.
421 * @retval ::WIMLIB_ERR_STAT
422 * Failed obtain the metadata for a file or directory in the directory tree
424 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
425 * @a wim is part of a split WIM. Adding an image to a split WIM is
428 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
429 const char *name, const char *config,
430 size_t config_len, int flags);
433 * This function is similar to wimlib_add_image(), except instead of capturing
434 * the WIM image from a directory, it is captured from a NTFS volume specified
435 * by @a device. NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
436 * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
437 * the reparse points exactly as they are.
439 extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
446 * This function is similar to wimlib_extract_image(), except that @a image may
447 * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
448 * device containing a NTFS volume to apply the image to. NTFS-3g errors are
449 * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
450 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
451 * apply mode we apply the reparse points and hard links exactly as they are in
454 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
455 const char *device, int flags,
456 WIMStruct **additional_swms,
457 unsigned num_additional_swms);
460 * Creates a WIMStruct for a new WIM file.
463 * The type of compression to be used in the new WIM file. Must be
464 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
465 * ::WIM_COMPRESSION_TYPE_XPRESS.
467 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
468 * written to the memory location pointed to by this paramater. The
469 * ::WIMStruct must be freed using using wimlib_free() when finished with
471 * @return 0 on success; nonzero on error.
472 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
473 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
474 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
475 * @retval ::WIMLIB_ERR_NOMEM
476 * Failed to allocate needed memory.
478 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
481 * Deletes an image, or all images, from a WIM file.
483 * All file resources referenced by the image(s) being deleted are removed from
484 * the WIM if they are not referenced by any other images in the WIM.
487 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
490 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
492 * @return 0 on success; nonzero on error. On error, @a wim is left in an
493 * indeterminate state and should be freed with wimlib_free().
494 * @retval ::WIMLIB_ERR_DECOMPRESSION
495 * Could not decompress the metadata resource for @a image.
496 * @retval ::WIMLIB_ERR_INVALID_DENTRY
497 * A directory entry in the metadata resource for @a image in the WIM is
499 * @retval ::WIMLIB_ERR_INVALID_IMAGE
500 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
501 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
502 * The metadata resource for @a image in the WIM is invalid.
503 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
504 * The security data for @a image in the WIM is invalid.
505 * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
506 * @retval ::WIMLIB_ERR_READ
507 * Could not read the metadata resource for @a image from the WIM.
508 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
509 * @a wim is part of a split WIM. Deleting an image from a split WIM is
512 extern int wimlib_delete_image(WIMStruct *wim, int image);
515 * Exports an image, or all the images, from a WIM file, into another WIM file.
517 * The destination image is made to share the same dentry tree and security data
518 * structure as the source image. This places some restrictions on additional
519 * functions that may be called. wimlib_mount() may not be called on either the
520 * source image or the destination image without an intervening call to a
521 * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
522 * wimlib_delete_image() on either the source or destination image.
523 * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
524 * src_wim before any calls to functions such as wimlib_write() on @a dest_wim
525 * because @a dest_wim will have references back to @a src_wim.
527 * Previous versions of this function left @a dest_wim in an indeterminate state
528 * on failure. This is no longer the case; all changes to @a dest_wim made by
529 * this function are rolled back on failure.
531 * Previous versions of this function did not allow exporting an image that had
532 * been added by wimlib_add_image(). This is no longer the case; you may now
533 * export an image regardless of how it was added.
535 * Regardless of whether this function succeeds or fails, no user-visible
536 * changes are made to @a src_wim.
539 * Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
540 * WIM that contains the image(s) being exported.
542 * The image to export from @a src_wim. Can be the number of an image, or
543 * ::WIM_ALL_IMAGES to export all images.
545 * Pointer to the ::WIMStruct for a WIM file that will receive the images
548 * The name to give the exported image in the new WIM file. If left @c NULL,
549 * the name from @a src_wim is used. This parameter must be left @c NULL
550 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
551 * image; in that case, the names are all taken from the @a src_wim.
552 * @param dest_description
553 * The description to give the exported image in the new WIM file. If left
554 * @c NULL, the description from the @a src_wim is used. This parameter must
555 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
556 * more than one image; in that case, the descriptions are all taken from
559 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
560 * bootable, or 0 if which image is marked as bootable in the destination
561 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
562 * there are multiple images in @a src_wim, specifying
563 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
564 * currently marked as bootable in @a src_wim; if that is the case, then
565 * that image is marked as bootable in the destination WIM.
566 * @param additional_swms
567 * Array of pointers to the ::WIMStruct for each additional part in the
568 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
569 * need to be in any particular order, but they must include all parts of
570 * the split WIM other than the first part, which must be provided in the
572 * @param num_additional_swms
573 * Number of additional WIM parts provided in the @a additional_swms array.
574 * This number should be one less than the total number of parts in the
575 * split WIM. Set to 0 if the WIM is a standalone WIM.
577 * @return 0 on success; nonzero on error.
578 * @retval ::WIMLIB_ERR_DECOMPRESSION
579 * Could not decompress the metadata resource for @a src_image
581 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
582 * One or more of the names being given to an exported image was already in
583 * use in the destination WIM.
584 * @retval ::WIMLIB_ERR_INVALID_DENTRY
585 * A directory entry in the metadata resource for @a src_image in @a
586 * src_wim is invalid.
587 * @retval ::WIMLIB_ERR_INVALID_IMAGE
588 * @a src_image does not exist in @a src_wim.
589 * @retval ::WIMLIB_ERR_INVALID_PARAM
590 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
591 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
592 * @a src_wim are marked as bootable; or @a dest_name and/or @a
593 * dest_description were non-<code>NULL</code>, @a src_image was
594 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
595 * or @a dest_wim was @c NULL.
596 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
597 * The metadata resource for @a src_image in @a src_wim is invalid.
598 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
599 * The security data for @a src_image in @a src_wim is invalid.
600 * @retval ::WIMLIB_ERR_NOMEM
601 * Failed to allocate needed memory.
602 * @retval ::WIMLIB_ERR_READ
603 * Could not read the metadata resource for @a src_image from @a src_wim.
604 * @retval ::WIMLIB_ERR_SPLIT_INVALID
605 * The source WIM is a split WIM, but the parts specified do not form a
606 * complete split WIM because they do not include all the parts of the
607 * original WIM, there are duplicate parts, or not all the parts have the
608 * same GUID and compression type.
609 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
610 * @a dest_wim is part of a split WIM. Exporting an image to a split WIM
613 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
614 WIMStruct *dest_wim, const char *dest_name,
615 const char *dest_description, int flags,
616 WIMStruct **additional_swms,
617 unsigned num_additional_swms);
620 * Extracts an image, or all images, from a standalone or split WIM file.
623 * Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
626 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
627 * to specify that all images are to be extracted.
629 * Directory to extract the WIM image(s) to. It is created if it does not
632 * Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
634 * One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
635 * ::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified. These flags cause
636 * extracted files that are identical to be hardlinked or symlinked
637 * together, depending on the flag. These flags override the hard link
638 * groups that are specified in the WIM file itself. If ::WIM_ALL_IMAGES
639 * is provided as the @a image parameter, files may be hardlinked or
640 * symlinked across images if a file is found to occur in more than one
643 * You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
644 * informational messages to be printed during the extraction, including
645 * the name of each extracted file or directory.
646 * @param additional_swms
647 * Array of pointers to the ::WIMStruct for each additional part in the
648 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
649 * need to be in any particular order, but they must include all parts of
650 * the split WIM other than the first part, which must be provided in the
652 * @param num_additional_swms
653 * Number of additional WIM parts provided in the @a additional_swms array.
654 * This number should be one less than the total number of parts in the
655 * split WIM. Set to 0 if the WIM is a standalone WIM.
657 * @return 0 on success; nonzero on error.
658 * @retval ::WIMLIB_ERR_DECOMPRESSION
659 * Could not decompress a resource (file or metadata) for @a image in @a
661 * @retval ::WIMLIB_ERR_INVALID_DENTRY
662 * A directory entry in the metadata resource for @a image in @a wim is
664 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
665 * The SHA1 message digest of an extracted stream did not match the SHA1
666 * message digest given in the WIM file.
667 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
668 * A resource (file or metadata) for @a image in @a wim is invalid.
669 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
670 * The security data for @a image in @a wim is invalid.
671 * @retval ::WIMLIB_ERR_LINK
672 * Failed to create a symbolic link or a hard link.
673 * @retval ::WIMLIB_ERR_MKDIR
674 * Failed create a needed directory.
675 * @retval ::WIMLIB_ERR_NOMEM
676 * Failed to allocate needed memory.
677 * @retval ::WIMLIB_ERR_OPEN
678 * Could not open one of the files being extracted for writing.
679 * @retval ::WIMLIB_ERR_READ
680 * A unexpected end-of-file or read error occurred when trying to read data
681 * from the WIM file associated with @a wim.
682 * @retval ::WIMLIB_ERR_SPLIT_INVALID
683 * The WIM is a split WIM, but the parts specified do not form a complete
684 * split WIM because they do not include all the parts of the original WIM,
685 * there are duplicate parts, or not all the parts have the same GUID and
687 * @retval ::WIMLIB_ERR_WRITE
688 * Failed to write a file being extracted.
690 extern int wimlib_extract_image(WIMStruct *wim, int image,
691 const char *output_dir, int flags,
692 WIMStruct **additional_swms,
693 unsigned num_additional_swms);
696 * Extracts the XML data for a WIM file to a file stream. Every WIM file
697 * includes a string of XML that describes the images contained in the WIM.
698 * This function works on standalone WIMs as well as split WIM parts.
701 * Pointer to the ::WIMStruct for a WIM file.
703 * @c stdout, or a FILE* opened for writing, to extract the data to.
705 * @return 0 on success; nonzero on error.
706 * @retval ::WIMLIB_ERR_WRITE
707 * Failed to completely write the XML data to @a fp.
709 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
712 * Frees all memory allocated for a WIMStruct and closes all files associated
716 * Pointer to the ::WIMStruct for a WIM file.
718 * @return This function has no return value.
720 extern void wimlib_free(WIMStruct *wim);
723 * Finds which image in a WIM is bootable.
726 * Pointer to the ::WIMStruct for a WIM file.
729 * 0 if no image is marked as bootable, or the number of the image marked
730 * as bootable (numbered starting at 1).
732 extern int wimlib_get_boot_idx(const WIMStruct *wim);
735 * Gets the compression type used in the WIM.
738 * Pointer to the ::WIMStruct for a WIM file
741 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
742 * ::WIM_COMPRESSION_TYPE_XPRESS.
744 extern int wimlib_get_compression_type(const WIMStruct *wim);
747 * Converts a compression type enumeration value into a string.
750 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
751 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
754 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
757 extern const char *wimlib_get_compression_type_string(int ctype);
760 * Converts an error code into a string describing it.
763 * The error code returned by one of wimlib's functions.
766 * Pointer to a statically allocated string describing the error code,
767 * or @c NULL if the error code is not valid.
769 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
772 * Returns the description of the specified image.
775 * Pointer to the ::WIMStruct for a WIM file. It may be either a
776 * standalone WIM or a split WIM part.
778 * The number of the image, numbered starting at 1.
781 * The description of the image, or @c NULL if there is no such image, or
782 * @c NULL if the specified image has no description. The description
783 * string is in library-internal memory and may not be modified or freed;
784 * in addition, the string will become invalid if the description of the
785 * image is changed, the image is deleted, or the ::WIMStruct is destroyed.
787 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
790 * Returns the name of the specified image.
793 * Pointer to the ::WIMStruct for a WIM file. It may be either a
794 * standalone WIM or a split WIM part.
796 * The number of the image, numbered starting at 1.
799 * The name of the image, or @c NULL if there is no such image. The name
800 * string is in library-internal memory and may not be modified or freed;
801 * in addition, the string will become invalid if the name of the image is
802 * changed, the image is deleted, or the ::WIMStruct is destroyed.
804 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
808 * Gets the number of images contained in the WIM.
811 * Pointer to the ::WIMStruct for a WIM file. It may be either a
812 * standalone WIM or a split WIM part.
815 * The number of images contained in the WIM file.
817 extern int wimlib_get_num_images(const WIMStruct *wim);
820 * Gets the part number of part of a split WIM.
823 * Pointer to the ::WIMStruct for a WIM file.
824 * @param total_parts_ret
825 * If non-@c NULL, the total number of parts in the split WIM (1 for
826 * non-split WIMs) is written to this location.
829 * The part number of the WIM (1 for non-split WIMs)
831 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
834 * Returns true if the WIM has an integrity table.
837 * Pointer to the ::WIMStruct for a WIM file.
839 * @c true if the WIM has an integrity table; @c false otherwise.
841 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
845 * Determines if an image name is already used by some image in the WIM.
848 * Pointer to the ::WIMStruct for a WIM file.
853 * @c true if there is already an image in @a wim named @a name; @c false
854 * if there is no image named @a name in @a wim. (If @a name is @c NULL,
855 * @c false is returned.)
857 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
860 * Joins a set of split WIMs into a one-part WIM.
863 * An array of strings that give the filenames of all parts of the split
866 * Number of filenames in @a swms.
868 * The path to write the one-part WIM to.
870 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
871 * tables (if present) when opening them, and include an integrity table in
874 * @return 0 on success; nonzero on error. This function may return any value
875 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
876 * as the following error codes:
878 * @retval ::WIMLIB_ERR_SPLIT_INVALID
879 * The split WIMs do not form a valid WIM because they do not include all
880 * the parts of the original WIM, there are duplicate parts, or not all the
881 * parts have the same GUID and compression type.
882 * @retval ::WIMLIB_ERR_WRITE
883 * An error occurred when trying to write data to the new WIM at @a output_path.
885 * Note that this function merely copies the resources, so it will not check to
886 * see if the resources, including the metadata resource, are valid or not.
888 extern int wimlib_join(const char **swms, unsigned num_swms,
889 const char *output_path, int flags);
892 * Mounts an image in a WIM file on a directory read-only or read-write.
894 * A daemon will be forked to service the filesystem.
896 * If the mount is read-write, modifications to the WIM are staged in a staging
899 * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
900 * intervening wimlib_unmount()s.
902 * wimlib_mount() cannot be used on an image that was exported with
903 * wimlib_export() while the dentry trees for both images are still in memory.
906 * Pointer to the ::WIMStruct for the WIM file to be mounted.
908 * The number of the image to mount, numbered from 1. It must be an
909 * existing, single image.
911 * The path to an existing directory to mount the image on.
913 * Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG. If
914 * ::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
915 * read-only. The interface to the WIM named data streams is specified by
916 * exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
917 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
918 * ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS. The default interface is
919 * the XATTR interface.
920 * @param additional_swms
921 * Array of pointers to the ::WIMStruct for each additional part in the
922 * split WIM. Ignored if @a num_additional_swms is 0. The pointers do not
923 * need to be in any particular order, but they must include all parts of
924 * the split WIM other than the first part, which must be provided in the
926 * @param num_additional_swms
927 * Number of additional WIM parts provided in the @a additional_swms array.
928 * This number should be one less than the total number of parts in the
929 * split WIM. Set to 0 if the WIM is a standalone WIM.
931 * @return 0 on success; nonzero on error.
932 * @retval ::WIMLIB_ERR_DECOMPRESSION
933 * Could not decompress the metadata resource for @a image in @a wim.
934 * @retval ::WIMLIB_ERR_FUSE
935 * A non-zero status was returned by @c fuse_main().
936 * @retval ::WIMLIB_ERR_INVALID_DENTRY
937 * A directory entry in the metadata resource for @a image in @a wim is
939 * @retval ::WIMLIB_ERR_INVALID_IMAGE
940 * @a image does not specify an existing, single image in @a wim.
941 * @retval ::WIMLIB_ERR_INVALID_PARAM
942 * @a image is shared among multiple ::WIMStruct's as a result of a call to
944 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
945 * The metadata resource for @a image in @a wim is invalid.
946 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
947 * The security data for @a image in @a wim is invalid.
948 * @retval ::WIMLIB_ERR_MKDIR
949 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
950 * directory could not be created.
951 * @retval ::WIMLIB_ERR_NOMEM
952 * Failed to allocate needed memory.
953 * @retval ::WIMLIB_ERR_NOTDIR
954 * Could not determine the current working directory.
955 * @retval ::WIMLIB_ERR_READ
956 * An unexpected end-of-file or read error occurred when trying to read
957 * data from the WIM file associated with @a wim.
958 * @retval ::WIMLIB_ERR_SPLIT_INVALID
959 * The WIM is a split WIM, but the parts specified do not form a complete
960 * split WIM because they do not include all the parts of the original WIM,
961 * there are duplicate parts, or not all the parts have the same GUID and
963 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
964 * The WIM is a split WIM and a read-write mount was requested. We only
965 * support mounting a split WIM read-only.
967 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
968 WIMStruct **additional_swms,
969 unsigned num_additional_swms);
972 * Opens a WIM file and creates a ::WIMStruct for it.
975 * The path to the WIM file to open.
977 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
978 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
979 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
980 * of the WIM, if it exists, is checked, and the function will fail with an
981 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
982 * digests of the WIM do not exactly match the corresponding message
983 * digests given in the integrity table.
984 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
985 * be shown if the integrity of the WIM is checked.
986 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
987 * WIM is part of a split WIM; otherwise WIMLIB_ERR_SPLIT_UNSUPPORTED is
988 * returned. (This flag may be removed in the future, in which case no
989 * error will be issued when opening a split WIM.)
992 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
993 * is written to the memory location pointed to by this parameter. The
994 * ::WIMStruct must be freed using using wimlib_free() when finished with
997 * @return 0 on success; nonzero on error.
998 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
999 * The lookup table of @a wim_file is compressed. Support for this can be
1000 * added to wimlib if needed, but it appears to be the case that the lookup
1001 * table is never compressed.
1002 * @retval ::WIMLIB_ERR_IMAGE_COUNT
1003 * The WIM is not the non-first part of a split WIM, and the number of
1004 * metadata resources found in the WIM did not match the image count given
1005 * in the WIM header, or the number of <IMAGE> elements in the XML
1006 * data for the WIM did not match the image count given in the WIM header.
1007 * @retval ::WIMLIB_ERR_INTEGRITY
1008 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1009 * wim_file contains an integrity table, but the SHA1 message digest for a
1010 * chunk of the WIM does not match the corresponding message digest given
1011 * in the integrity table.
1012 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1013 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
1014 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1015 * The header of @a wim_file says that resources in the WIM are compressed,
1016 * but the header flag indicating LZX or XPRESS compression is not set.
1017 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1018 * The length field of the WIM header is not 208.
1019 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1020 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1021 * wim_file contains an integrity table, but the integrity table is
1023 * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1024 * The lookup table for the WIM contained duplicate entries, or it
1025 * contained an entry with a SHA1 message digest of all 0's.
1026 * @retval ::WIMLIB_ERR_NOMEM
1027 * Failed to allocated needed memory.
1028 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1029 * @a wim_file does not begin with the expected magic characters.
1030 * @retval ::WIMLIB_ERR_OPEN
1031 * Failed to open the file @a wim_file for reading.
1032 * @retval ::WIMLIB_ERR_READ
1033 * An unexpected end-of-file or read error occurred when trying to read
1034 * data from @a wim_file.
1035 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1036 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1037 * givin in @a flags.
1038 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1039 * A number other than 0x10d00 is written in the version field of the WIM
1040 * header of @a wim_file.
1041 * @retval ::WIMLIB_ERR_XML
1042 * The XML data for @a wim_file is invalid.
1044 extern int wimlib_open_wim(const char *wim_file, int flags,
1045 WIMStruct **wim_ret);
1048 * Overwrites the file that the WIM was originally read from, with changes made.
1050 * The new WIM is written to a temporary file and then renamed to the original
1051 * file after it is has been completely written. The temporary file currently
1052 * is made in the same directory as the original WIM file.
1054 * After this function returns, @a wim must be freed using wimlib_free(). Any
1055 * further actions on @a wim before doing this are undefined.
1058 * Pointer to the ::WIMStruct for the WIM file to write. There may have
1059 * been in-memory changes made to it, which are then reflected in the
1062 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1063 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1065 * @return 0 on success; nonzero on error. This function may return any value
1066 * returned by wimlib_write() as well as the following error codes:
1067 * @retval ::WIMLIB_ERR_NO_FILENAME
1068 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1069 * than a WIM read with wimlib_open_wim().
1070 * @retval ::WIMLIB_ERR_RENAME
1071 * The temporary file that the WIM was written to could not be renamed to
1072 * the original filename of @a wim.
1074 extern int wimlib_overwrite(WIMStruct *wim, int flags);
1077 * Updates the header and XML data of the WIM file, without the need to write
1078 * out the entire WIM to a temporary file as in wimlib_write().
1080 * This function must only be used if no files, directories, or images have been
1081 * added, removed, or changed in the WIM. It must be used when only the boot
1082 * index or the name or description of image(s) has been changed.
1084 * After this function returns, @a wim must be freed using wimlib_free(). Any
1085 * further actions on @a wim before doing this are undefined.
1088 * Pointer to the ::WIMStruct for the WIM file to overwrite.
1090 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1091 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1093 * @return 0 on success; nonzero on error.
1095 * @retval ::WIMLIB_ERR_NO_FILENAME
1096 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1097 * than a WIM read with wimlib_open_wim().
1098 * @retval ::WIMLIB_ERR_NOMEM
1099 * Failed to allocate needed memory.
1100 * @retval ::WIMLIB_ERR_OPEN
1101 * The WIM file associated with @a wim could not be re-opened read-write.
1102 * @retval ::WIMLIB_ERR_READ
1103 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
1104 * from the WIM file associated with @a wim could not be read to compute
1105 * the SHA1 message digests, or the old integrity table (if it existed)
1106 * could not be read.
1107 * @retval ::WIMLIB_ERR_WRITE
1108 * Failed to write the WIM header, the XML data, or the integrity table to
1109 * the WIM file associated with @a wim.
1111 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
1114 * Prints information about one image, or all images, contained in a WIM.
1117 * Pointer to the ::WIMStruct for a WIM file.
1119 * The image about which to print information. Can be the number of an
1120 * image, or ::WIM_ALL_IMAGES to print information about all images in the
1123 * @return This function has no return value.
1125 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1128 * Prints the full paths to all files contained in an image, or all images, in a
1132 * Pointer to the ::WIMStruct for a WIM file.
1134 * Which image to print files for. Can be the number of an image, or
1135 * ::WIM_ALL_IMAGES to print the files contained in all images.
1137 * @return 0 on success; nonzero on error.
1138 * @retval ::WIMLIB_ERR_DECOMPRESSION
1139 * The metadata resource for one of the specified images could not be
1141 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1142 * A directory entry in the metadata resource for one of the specified
1143 * images is invaled.
1144 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1145 * @a image does not specify a valid image in @a wim, and is not
1147 * @retval ::WIMLIB_ERR_INVALID_PARAM
1148 * @a wim was @c NULL.
1149 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1150 * The metadata resource for one of the specified images is invalid.
1151 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1152 * The security data for one of the specified images is invalid.
1153 * @retval ::WIMLIB_ERR_NOMEM
1154 * Failed to allocate needed memory.
1155 * @retval ::WIMLIB_ERR_READ
1156 * An unexpected read error or end-of-file occurred when reading the
1157 * metadata resource for one of the specified images.
1158 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1159 * @a wim was not a standalone WIM and was not the first part of a split
1162 extern int wimlib_print_files(WIMStruct *wim, int image);
1165 * Prints detailed information from the header of a WIM file.
1168 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1169 * standalone WIM or part of a split WIM.
1171 * @return This function has no return value.
1174 extern void wimlib_print_header(const WIMStruct *wim);
1177 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1178 * digests, as found in the directory entry tree in the WIM file, to file
1179 * resources in the WIM file. This table includes one entry for each unique
1180 * file in the WIM, so it can be quite long. There is only one lookup table per
1184 * Pointer to the ::WIMStruct for a WIM file.
1186 * @return This function has no return value.
1188 extern void wimlib_print_lookup_table(WIMStruct *wim);
1191 * Prints the metadata of the specified image in a WIM file. The metadata
1192 * consists of the security data as well as the directory entry tree, and each
1193 * image has its own metadata.
1196 * Pointer to the ::WIMStruct for a WIM file.
1198 * Which image to print the metadata for. Can be the number of an image,
1199 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1201 * @return 0 on success; nonzero on error.
1202 * @retval ::WIMLIB_ERR_DECOMPRESSION
1203 * The metadata resource for one of the specified images could not be
1205 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1206 * A directory entry in the metadata resource for one of the specified
1207 * images is invaled.
1208 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1209 * @a image does not specify a valid image in @a wim, and is not
1211 * @retval ::WIMLIB_ERR_INVALID_PARAM
1212 * @a wim was @c NULL.
1213 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1214 * The metadata resource for one of the specified images is invalid.
1215 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1216 * The security data for one of the specified images is invalid.
1217 * @retval ::WIMLIB_ERR_NOMEM
1218 * Failed to allocate needed memory.
1219 * @retval ::WIMLIB_ERR_READ
1220 * An unexpected read error or end-of-file occurred when reading the
1221 * metadata resource for one of the specified images.
1222 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1223 * @a wim was not a standalone WIM and was not the first part of a split
1226 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1229 * Prints some basic information about a WIM file. All information printed by
1230 * this function is also printed by wimlib_print_header(), but
1231 * wimlib_print_wim_information() prints some of this information more concisely
1232 * and in a more readable form.
1235 * Pointer to the ::WIMStruct for a WIM file.
1237 * @return This function has no return value.
1239 extern void wimlib_print_wim_information(const WIMStruct *wim);
1242 * Translates a string specifying the name or number of an image in the WIM into
1243 * the number of the image. The images are numbered starting at 1.
1246 * Pointer to the ::WIMStruct for a WIM file.
1247 * @param image_name_or_num
1248 * A string specifying which image. If it begins with a number, it is
1249 * taken to be a string specifying the image number. Otherwise, it is
1250 * taken to be the name of an image, as specified in the XML data for the
1251 * WIM file. It also may be the keyword "all" or the string "*", both of
1252 * which will resolve to ::WIM_ALL_IMAGES.
1255 * If the string resolved to a single existing image, the number of that
1256 * image, counting starting at 1, is returned. If the keyword "all" was
1257 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1260 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1263 * Sets which image in the WIM is marked as bootable.
1266 * Pointer to the ::WIMStruct for a WIM file.
1268 * The number of the image to mark as bootable, or 0 to mark no image as
1270 * @return 0 on success; nonzero on error.
1271 * @retval ::WIMLIB_ERR_INVALID_PARAM
1272 * @a wim was @c NULL.
1273 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1274 * @a boot_idx does not specify an existing image in @a wim, and it was not
1276 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1277 * @a wim is part of a split WIM. We do not support changing the boot
1278 * index of a split WIM.
1280 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1283 * Changes the description of an image in the WIM.
1286 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1287 * standalone WIM or part of a split WIM; however, you should set the same
1288 * description on all parts of a split WIM.
1290 * The number of the image for which to change the description.
1291 * @param description
1292 * The new description to give the image. It may be @c NULL, which
1293 * indicates that the image is to be given no description.
1295 * @return 0 on success; nonzero on error.
1296 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1297 * @a image does not specify a single existing image in @a wim.
1298 * @retval ::WIMLIB_ERR_INVALID_PARAM
1299 * @a wim was @c NULL.
1300 * @retval ::WIMLIB_ERR_NOMEM
1301 * Failed to allocate the memory needed to duplicate the @a description
1304 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1305 const char *description);
1308 * Changes what is written in the \<FLAGS\> element in the WIM XML data
1309 * (something like "Core" or "Ultimate")
1312 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1313 * standalone WIM or part of a split WIM; however, you should set the same
1314 * \<FLAGS\> element on all parts of a split WIM.
1316 * The number of the image for which to change the description.
1318 * The new \<FLAGS\> element to give the image. It may be @c NULL, which
1319 * indicates that the image is to be given no \<FLAGS\> element.
1321 * @return 0 on success; nonzero on error.
1322 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1323 * @a image does not specify a single existing image in @a wim.
1324 * @retval ::WIMLIB_ERR_INVALID_PARAM
1325 * @a wim was @c NULL.
1326 * @retval ::WIMLIB_ERR_NOMEM
1327 * Failed to allocate the memory needed to duplicate the @a flags string.
1329 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1332 * Changes the name of an image in the WIM.
1335 * Pointer to the ::WIMStruct for a WIM file. It may be either a
1336 * standalone WIM or part of a split WIM; however, you should set the same
1337 * name on all parts of a split WIM.
1339 * The number of the image for which to change the name.
1341 * The new name to give the image. It must not a nonempty string.
1343 * @return 0 on success; nonzero on error.
1344 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1345 * There is already an image named @a name in @a wim.
1346 * @retval ::WIMLIB_ERR_INVALID_PARAM
1347 * @a name was @c NULL or the empty string, or @a wim was @c NULL.
1348 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1349 * @a image does not specify a single existing image in @a wim.
1350 * @retval ::WIMLIB_ERR_NOMEM
1351 * Failed to allocate the memory needed to duplicate the @a name string.
1353 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1356 * Set the functions that wimlib uses to allocate and free memory.
1358 * These settings are global and not per-WIM.
1360 * The default is to use the default @c malloc() and @c free() from the C
1363 * Please note that some external functions we call still may use the standard
1364 * memory allocation functions.
1366 * @param malloc_func
1367 * A function equivalent to @c malloc() that wimlib will use to allocate
1368 * memory. If @c NULL, the allocator function is set back to the default
1369 * @c malloc() from the C library.
1371 * A function equivalent to @c free() that wimlib will use to free memory.
1372 * If @c NULL, the free function is set back to the default @c free() from
1374 * @param realloc_func
1375 * A function equivalent to @c realloc() that wimlib will use to reallocate
1376 * memory. If @c NULL, the free function is set back to the default @c
1377 * realloc() from the C library.
1378 * @return 0 on success; nonzero on error.
1379 * @retval ::WIMLIB_ERR_UNSUPPORTED
1380 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1381 * so custom memory allocators are unsupported.
1383 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1384 void (*free_func)(void *),
1385 void *(*realloc_func)(void *, size_t));
1388 * Sets whether wimlib is to print error messages to @c stderr when a function
1389 * fails. These error messages may provide information that cannot be
1390 * determined only from the error code that is returned. Not every error will
1391 * result in an error message being printed.
1393 * This setting is global and not per-WIM.
1395 * By default, error messages are not printed.
1397 * @param show_messages
1398 * @c true if error messages are to be printed; @c false if error messages
1399 * are not to be printed.
1401 * @return 0 on success; nonzero on error.
1402 * @retval ::WIMLIB_ERR_UNSUPPORTED
1403 * @a show_messages was @c true, but wimlib was compiled with the @c
1404 * --without-error-messages option. Therefore, error messages cannot be
1407 extern int wimlib_set_print_errors(bool show_messages);
1410 * Splits a WIM into multiple parts.
1413 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1415 * Name of the SWM file to create. This will be the name of the first
1416 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1419 * The maximum size per part, in bytes. It is not guaranteed that this
1420 * will really be the maximum size per part, because some file resources in
1421 * the WIM may be larger than this size, and the WIM file format provides
1422 * no way to split up file resources among multiple WIMs.
1424 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1425 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1427 * @return 0 on success; nonzero on error. This function may return any value
1428 * returned by wimlib_open_wim() as well as the following error codes:
1430 * @retval ::WIMLIB_ERR_WRITE
1431 * An error occurred when trying to write data to one of the split WIMs.
1434 extern int wimlib_split(const char *wimfile, const char *swm_name,
1435 size_t part_size, int flags);
1438 * Unmounts a WIM image that was mounted using wimlib_mount().
1440 * Blocks until it is known whether the mount succeeded or failed.
1442 * To perform this operation, the process calling wimlib_unmount() communicates
1443 * with the process that had called wimlib_mount().
1445 * There is currently a design problem with this function because it is hard to
1446 * know whether the filesystem daemon is still working or whether it has
1447 * crashed, has been killed, or has reached an infinite loop. However, ideally
1448 * there should be no infinite loops or crashes in the code, so this wouldn't be
1449 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1450 * can be very large) is implemented so that this function will not wait forever
1451 * before returning failure.
1454 * The directory that the WIM image was mounted on.
1456 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1457 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1460 * @return 0 on success; nonzero on error.
1461 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1462 * The filesystem daemon was unable to remove the staging directory and the
1463 * temporary files that it contains.
1464 * @retval ::WIMLIB_ERR_FORK
1465 * Could not @c fork() the process.
1466 * @retval ::WIMLIB_ERR_FUSERMOUNT
1467 * The @b fusermount program could not be executed or exited with a failure
1469 * @retval ::WIMLIB_ERR_MQUEUE
1470 * Could not open a POSIX message queue to communicate with the filesystem
1471 * daemon servicing the mounted filesystem, could not send a message
1472 * through the queue, or could not receive a message through the queue.
1473 * @retval ::WIMLIB_ERR_NOMEM
1474 * Failed to allocate needed memory.
1475 * @retval ::WIMLIB_ERR_OPEN
1476 * The filesystem daemon could not open a temporary file for writing the
1478 * @retval ::WIMLIB_ERR_TIMEOUT
1479 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1480 * the process of its exit status, so the WIM file probably was not written
1482 * @retval ::WIMLIB_ERR_READ
1483 * A read error occurred when the filesystem daemon tried to a file from
1484 * the staging directory
1485 * @retval ::WIMLIB_ERR_RENAME
1486 * The filesystem daemon failed to rename the newly written WIM file to the
1487 * original WIM file.
1488 * @retval ::WIMLIB_ERR_WRITE
1489 * A write error occurred when the filesystem daemon was writing to the new
1490 * WIM file, or the filesystem daemon was unable to flush changes that had
1491 * been made to files in the staging directory.
1493 extern int wimlib_unmount(const char *dir, int flags);
1496 * Writes the WIM to a file.
1499 * Pointer to the ::WIMStruct for a WIM file. There may have been
1500 * in-memory changes made to it, which are then reflected in the output
1503 * The path to the file to write the WIM to.
1505 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1508 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1509 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1510 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1511 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1512 * is given, the progress of the calculation of the integrity table is
1515 * @return 0 on success; nonzero on error.
1516 * @retval ::WIMLIB_ERR_DECOMPRESSION
1517 * Failed to decompress a metadata or file resource in @a wim.
1518 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1519 * A directory entry in the metadata resource for @a image in @a wim is
1521 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1522 * @a image does not specify a single existing image in @a wim, and is not
1524 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1525 * A file that had previously been scanned for inclusion in the WIM by the
1526 * wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
1527 * concurrently modified, so it failed the SHA1 message digest check.
1528 * @retval ::WIMLIB_ERR_INVALID_PARAM
1529 * @a wim or @a path was @c NULL.
1530 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1531 * The metadata resource for @a image in @a wim is invalid.
1532 * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1533 * The security data for @a image in @a wim is invalid.
1534 * @retval ::WIMLIB_ERR_NOMEM
1535 * Failed to allocate needed memory.
1536 * @retval ::WIMLIB_ERR_OPEN
1537 * Failed to open @a path for writing, or some file resources in @a
1538 * wim refer to files in the outside filesystem, and one of these files
1539 * could not be opened for reading.
1540 * @retval ::WIMLIB_ERR_READ
1541 * An error occurred when trying to read data from the WIM file associated
1542 * with @a wim, or some file resources in @a wim refer to files in the
1543 * outside filesystem, and a read error occurred when reading one of these
1545 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1546 * @a wim is part of a split WIM. You may not call this function on a
1548 * @retval ::WIMLIB_ERR_WRITE
1549 * An error occurred when trying to write data to the new WIM file at @a
1552 extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
1556 #endif /* _WIMLIB_H */