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 Lesser General Public License as published by the Free
14 * Software Foundation; either version 2.1 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 Lesser General Public License for more
22 * You should have received a copy of the GNU Lesser 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 * The main intended use of wimlib is to create customized images of Windows PE,
38 * the Windows Preinstallation Environment, without having to rely on Windows.
39 * Windows PE, which is the operating system that runs when you boot from the
40 * Windows Vista or Windows 7 DVD, is a lightweight version of Windows that can
41 * run entirely from memory. It can be used to install Windows from local media
42 * or a network drive or perform maintenance.
44 * You can find Windows PE on the installation media for Windows Vista, Windows
45 * 7, and Windows 8. The Windows PE image itself is a WIM file, @c
46 * sources/boot.wim, on the ISO filesystem. Windows PE can also be found in the
47 * Windows Automated Installation Kit (WAIK) inside the @c WinPE.cab file, which
48 * you can extract if you install the @c cabextract program.
50 * \section format WIM files
52 * A <b>Windows Imaging (WIM)</b> file is an archive. Like some other archive
53 * formats such as ZIP, files in WIM archives may be compressed. WIM archives
54 * support two Microsoft-specific compression formats: @b LZX and @b XPRESS.
55 * Both are based on LZ77 and Huffman encoding, and both are supported by
58 * Unlike ZIP files, WIM files can contain multiple independent toplevel
59 * directory trees known as @a images. While each image has its own metadata,
60 * files are not duplicated for each image; instead, each file is included only
61 * once in the entire WIM. Microsoft did this so that in one WIM file, they
62 * could do things like have 5 different versions of Windows that are almost
65 * WIM files may contain a integrity table. The integrity table, if it exists,
66 * is located at the end of the WIM file and contains SHA1 message digests of
67 * 10MB chunks of the WIM.
69 * Microsoft provides documentation for the WIM file format, XPRESS compression
70 * format, and LZX compression format. However, there are errors and omissions
71 * in some places in their documentation.
73 * \section starting Getting Started
75 * wimlib uses the GNU autotools, so it should be easy to install with
76 * <code>configure && make && sudo make install</code>, provided that you have
77 * @c libxml2 and @c libfuse installed. To use wimlib in a program after
78 * installing it, include @c wimlib.h and link your program with @c -lwim.
80 * wimlib wraps up a WIM file in an opaque ::WIMStruct structure.
82 * All functions in wimlib's public API are prefixed with @c wimlib. Most
83 * return an integer error code on failure. Use wimlib_get_error_string() to
84 * get a string that describes an error code. wimlib also can print error
85 * messages itself when an error happens, and these may be more informative than
86 * the error code; to enable this, call wimlib_set_print_errors().
88 * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
89 * following exceptions: wimlib_set_print_errors() and
90 * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
91 * used by one ::WIMStruct at a time.
93 * To open an existing WIM, use wimlib_open_wim().
95 * To create a new WIM that initially contains no images, use
96 * wimlib_create_new_wim().
98 * To add an image to a WIM file from a directory tree on your filesystem, call
99 * wimlib_add_image(). This can be done with a ::WIMStruct gotten from
100 * wimlib_open_wim() or from wimlib_create_new_wim().
102 * To extract an image from a WIM file, call wimlib_set_output_dir() to set the
103 * output directory, then call wimlib_extract_image().
105 * wimlib supports mounting WIM files either read-only or read-write. Mounting
106 * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
107 * Mounting can be done without root privileges because it is implemented using
108 * FUSE (Filesystem in Userspace). If wimlib is compiled with the
109 * <code>--without-fuse</code> flag, these functions will be available but will
112 * After creating or modifying a WIM file, you can write it to a file using
113 * wimlib_write(). Alternatively, if the WIM was originally read from a file,
114 * you can use wimlib_overwrite() to overwrite the original file. In some
115 * cases, wimlib_overwrite_xml_and_header() can be used instead.
117 * After you are done with the WIM file, use wimlib_free() to free all memory
118 * associated with a ::WIMStruct and close all files associated with it.
120 * To see an example of how to use wimlib, see the file
121 * @c programs/imagex.c in wimlib's source tree.
123 * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
126 * \section imagex imagex
128 * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
130 * \section mkwinpeimg mkwinpeimg
132 * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
135 * \section Limitations
137 * While wimlib supports the main features of WIM files, wimlib currently has
138 * the following limitations:
139 * - wimlib does not support modifying or creating "security data", which
140 * describes the access rights of the files in the WIM. This data is very
141 * Windows-specific, and it would be difficult to do anything with it.
142 * Microsoft's software can still read a WIM without security data, including
143 * a boot.wim for Windows PE, but <b>do not expect to be able to use wimlib to
144 * image a Windows installation and preserve file attributes</b>. However, by
145 * default, wimlib will preserve security data for existing WIMs.
146 * - There is no way to directly extract or mount split WIMs.
147 * - There is not yet any code to verify that there are no collisions between
148 * different files that happen to have the same SHA1 message digest.
149 * This is extremely unlikely, but could result in something bad such as a
150 * file going missing.
151 * - Alternate stream entries for directory entries are ignored.
152 * - Different versions of the WIM file format, if they even exist, are
153 * unsupported. Let me know if you notice WIM files with a different version.
154 * - Chunk sizes other than 32768 are unsupported (except for uncompressed WIMs,
155 * for which the chunk size field is ignored). As far as I can tell, other
156 * chunk sizes are not used in compressed WIMs. Let me know if you find a WIM
157 * file with a different chunk size.
158 * - wimlib does not provide a clone of the @b PEImg tool that allows you to
159 * make certain Windows-specific modifications to a Windows PE image, such as
160 * adding a driver or Windows component. Such a tool could conceivably be
161 * implemented on top of wimlib, although it likely would be hard to implement
162 * because it would have to do very Windows-specific things such as
163 * manipulating the driver store. wimlib does provide the @b mkwinpeimg
164 * script for a similar purpose, however. With regards to adding drivers to
165 * Windows PE, you have the option of putting them anywhere in the Windows PE
166 * image, then loading them after boot using @b drvload.exe.
167 * - There is not yet a way to extract specific files or directories from a WIM
168 * file without mounting it, or to add, remove, or modify files in a WIM
169 * without mounting it, other than by adding or removing an entire image. I
170 * can implement this if requested, but I intend the FUSE mount feature to be
171 * used for this purpose, as it is easy to do these things in whatever way you
172 * want after the image is mounted.
174 * Currently, Microsoft's @a image.exe can create slightly smaller WIM files
175 * than wimlib when using maximum (LZX) compression because it knows how to
176 * split up LZX compressed blocks, which is not yet implemented in wimlib.
178 * wimlib is experimental and likely contains bugs; use Microsoft's @a
179 * imagex.exe if you want to make sure your WIM files are made "correctly".
181 * \section legal License
183 * The wimlib library is licensed under the GNU Lesser General Public License
184 * version 2.1 or later.
186 * @b imagex and @b mkwinpeiso are licensed under the GNU General Public License
187 * version 3 or later.
197 #ifndef _WIMLIB_INTERNAL_H
199 * Opaque structure that represents a WIM file.
201 typedef struct WIMStruct WIMStruct;
205 * Specifies the way in which identical files are linked when extracting
206 * image(s) from the WIM.
209 /** Hard link identical files when extracting files from the WIM. */
210 WIM_LINK_TYPE_HARD = 0,
211 /** Symbolic link identical files when extracting files from the WIM. */
212 WIM_LINK_TYPE_SYMBOLIC = 1,
213 /** Do not create links when extracting identical files from the WIM (default).
215 WIM_LINK_TYPE_NONE = 2,
219 * Specifies the compression type of a WIM file.
222 enum wim_compression_type {
223 /** An invalid compression type. */
224 WIM_COMPRESSION_TYPE_INVALID = -1,
226 /** The WIM does not include any compressed resources. */
227 WIM_COMPRESSION_TYPE_NONE = 0,
229 /** Compressed resources in the WIM use LZX compression. */
230 WIM_COMPRESSION_TYPE_LZX = 1,
232 /** Compressed resources in the WIM use XPRESS compression. */
233 WIM_COMPRESSION_TYPE_XPRESS = 2,
236 /** Mount the WIM read-write. */
237 #define WIMLIB_MOUNT_FLAG_READWRITE 0x00000001
239 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
240 #define WIMLIB_MOUNT_FLAG_DEBUG 0x00000002
242 /** Do not allow accessing alternate data streams. */
243 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE 0x00000010
245 /** Access alternate data streams through extended file attributes. This is the
247 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR 0x00000020
249 /** Access alternate data streams by specifying the file name, a colon, then the
250 * alternate file stream name. */
251 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000040
253 /** Include an integrity table in the new WIM being written during the unmount.
254 * Ignored for read-only mounts. */
255 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY 0x00000001
257 /** Unless this flag is given, changes to a mounted WIM are discarded. Ignored
258 * for read-only mounts. */
259 #define WIMLIB_UNMOUNT_FLAG_COMMIT 0x00000002
261 /** Include an integrity table in the new WIM file. */
262 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY 0x00000001
264 /** Print progress information when writing the integrity table. */
265 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS 0x00000002
267 /** Mark the image being added as the bootable image of the WIM. */
268 #define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000001
270 /** Print the name of each file or directory as it is scanned to be included in
272 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000002
274 /** Apply NTFS-specific information to the captured WIM image. This flag can
275 * only be specified if the directory being captured is on a NTFS filesystem
276 * mounted with NTFS-3g, and wimlib was compiled with support for NTFS-3g */
277 #define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000004
279 /** See documentation for wimlib_export_image(). */
280 #define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
282 /** Verify the integrity of the WIM if an integrity table is present. */
283 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY 0x00000001
285 /** Print progress information when verifying integrity table. */
286 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS 0x00000002
288 /** If this flag is not given, an error is issued if the WIM is part of a split
290 #define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000004
293 /** When identical files are extracted from the WIM, hard link them together. */
294 #define WIMLIB_EXTRACT_FLAG_HARDLINK 0x00000001
296 /** When identical files are extracted from the WIM, symlink them together. */
297 #define WIMLIB_EXTRACT_FLAG_SYMLINK 0x00000002
299 /** Apply NTFS-specific information when applying the WIM image. This flag can
300 * only be specified if the output directory is on a NTFS filesystem mounted
301 * with NTFS-3g, and wimlib was compiled with support for NTFS-3g */
302 #define WIMLIB_EXTRACT_FLAG_NTFS 0x00000004
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_CHUNK_SIZE,
325 WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
326 WIMLIB_ERR_INVALID_DENTRY,
327 WIMLIB_ERR_INVALID_HEADER_SIZE,
328 WIMLIB_ERR_INVALID_IMAGE,
329 WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
330 WIMLIB_ERR_INVALID_PARAM,
331 WIMLIB_ERR_INVALID_RESOURCE_SIZE,
332 WIMLIB_ERR_INVALID_SECURITY_DATA,
338 WIMLIB_ERR_NOT_A_WIM_FILE,
339 WIMLIB_ERR_NO_FILENAME,
345 WIMLIB_ERR_SPLIT_INVALID,
346 WIMLIB_ERR_SPLIT_UNSUPPORTED,
349 WIMLIB_ERR_UNKNOWN_VERSION,
350 WIMLIB_ERR_UNSUPPORTED,
356 /** Used to indicate that no WIM image is currently selected. */
357 #define WIM_NO_IMAGE 0
359 /** Used to specify all images in the WIM. */
360 #define WIM_ALL_IMAGES (-1)
364 * Adds an image to a WIM file from a directory tree on disk.
366 * The directory tree is read immediately for the purpose of constructing a
367 * directory entry tree in-memory. Also, all files are read to calculate their
368 * SHA1 message digests. However, because the directory tree may contain a very
369 * large amount of data, the files themselves are not read into memory
370 * permanently, and instead references to their paths saved. This means that
371 * the directory tree must not be modified, other than by adding entirely new
372 * files or directories, before executing a call to wimlib_write() or
373 * wimlib_overwrite(). Otherwise, wimlib_write() may fail or incorrect files may
374 * be included in the WIM written by wimlib_write().
377 * Pointer to the ::WIMStruct for a WIM file to which the image will be
380 * A path to a directory in the outside filesystem. It will become the
381 * root directory for the WIM image.
383 * The name to give the image. This must be non-@c NULL.
385 * The description to give the image. This parameter may be left @c
386 * NULL, in which case no description is given to the image.
387 * @param flags_element
388 * What to put in the <FLAGS> element for the image's XML data. This
389 * parameter may be left @c NULL, in which case no <FLAGS> element is
390 * given to the image.
392 * If set to ::WIMLIB_ADD_IMAGE_FLAG_BOOT, change the image in @a wim
393 * marked as bootable to the one being added. Otherwise, leave the boot
396 * @return 0 on success; nonzero on error. On error, changes to @a wim are
397 * discarded so that it appears to be in the same state as when this function
400 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
401 * There is already an image named @a name in @a w.
402 * @retval ::WIMLIB_ERR_INVALID_PARAM
403 * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
404 * @retval ::WIMLIB_ERR_NOMEM
405 * Failed to allocate needed memory.
406 * @retval ::WIMLIB_ERR_NOTDIR
407 * @a dir is not a directory.
408 * @retval ::WIMLIB_ERR_OPEN
409 * Failed to open a file or directory in the directory tree rooted at @a
411 * @retval ::WIMLIB_ERR_READ
412 * Failed to read a file in the directory tree rooted at @a dir.
413 * @retval ::WIMLIB_ERR_STAT
414 * Failed obtain the metadata for a file or directory in the directory tree
418 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
419 const char *name, const char *description,
420 const char *flags_element, int flags);
423 * Creates a WIMStruct for a new WIM file.
426 * The type of compression to be used in the new WIM file. Must be
427 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
428 * ::WIM_COMPRESSION_TYPE_XPRESS.
430 * On success, a pointer to an opaque ::WIMStruct for the new WIM file is
431 * written to the memory location pointed to by this paramater. The
432 * ::WIMStruct must be freed using using wimlib_free() when finished with
434 * @return 0 on success; nonzero on error.
435 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
436 * @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
437 * ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
438 * @retval ::WIMLIB_ERR_NOMEM
439 * Failed to allocate needed memory.
441 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
444 * Deletes an image, or all images, from a WIM file.
446 * All file resources referenced by the image(s) being deleted are removed from
447 * the WIM if they are not referenced by any other images in the WIM.
450 * Pointer to the ::WIMStruct for the WIM file that contains the image(s)
453 * The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
455 * @return 0 on success; nonzero on error. On error, @a wim is left in an
456 * indeterminate state and should be freed with wimlib_free().
457 * @retval ::WIMLIB_ERR_DECOMPRESSION
458 * Could not decompress the metadata resource for @a image.
459 * @retval ::WIMLIB_ERR_INVALID_DENTRY
460 * A directory entry in the metadata resource for @a image in the WIM is
462 * @retval ::WIMLIB_ERR_INVALID_IMAGE
463 * @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
464 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
465 * The metadata resource for @a image in the WIM is invalid.
466 * @retval ::WIMLIB_ERR_NOMEM Failed to allocate needed memory.
467 * @retval ::WIMLIB_ERR_READ
468 * Could not read the metadata resource for @a image from the WIM.
470 extern int wimlib_delete_image(WIMStruct *wim, int image);
473 * Copies an image, or all the images, from a WIM file, into another WIM file.
476 * Pointer to the ::WIMStruct for a WIM file that contains the image(s)
479 * The image to export from @a src_wim. Can be the number of an image, or
480 * ::WIM_ALL_IMAGES to export all images.
482 * Pointer to the ::WIMStruct for a WIM filethat will receive the images being
485 * The name to give the exported image in the new WIM file. If left @c NULL,
486 * the name from @a src_wim is used. This parameter must be left @c NULL
487 * if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
488 * image; in that case, the names are all taken from the @a src_wim.
489 * @param dest_description
490 * The description to give the exported image in the new WIM file. If left
491 * @c NULL, the description from the @a src_wim is used. This parameter must
492 * be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
493 * more than one image; in that case, the descriptions are all taken from
496 * ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
497 * bootable, or 0 if which image is marked as bootable in the destination
498 * WIM is to be left unchanged. If @a src_image is ::WIM_ALL_IMAGES and
499 * there are multiple images in @a src_wim, specifying
500 * ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
501 * currently marked as bootable in @a src_wim; if that is the case, then
502 * that image is marked as bootable in the destination WIM.
504 * @return 0 on success; nonzero on error. On error, @dest_wim is left in an
505 * indeterminate state and should be freed with wimlib_free().
506 * @retval ::WIMLIB_ERR_DECOMPRESSION
507 * Could not decompress the metadata resource for @a src_image
509 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
510 * One or more of the names being given to an exported image was already in
511 * use in the destination WIM.
512 * @retval ::WIMLIB_ERR_INVALID_DENTRY
513 * A directory entry in the metadata resource for @a src_image in @a
514 * src_wim is invalid.
515 * @retval ::WIMLIB_ERR_INVALID_IMAGE
516 * @a src_image does not exist in @a src_wim.
517 * @retval ::WIMLIB_ERR_INVALID_PARAM
518 * ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
519 * ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
520 * @a src_wim are marked as bootable; or @a dest_name and/or @a
521 * dest_description were non-<code>NULL</code>, @a src_image was
522 * ::WIM_ALL_IMAGES, and @a src_wim contains multiple images.
523 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
524 * The metadata resource for @a src_image in @a src_wim is invalid.
525 * @retval ::WIMLIB_ERR_NOMEM
526 * Failed to allocate needed memory.
527 * @retval ::WIMLIB_ERR_READ
528 * Could not read the metadata resource for @a src_image from @a src_wim.
530 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
531 WIMStruct *dest_wim, const char *dest_name,
532 const char *dest_description, int flags);
535 * Extracts an image, or all images, from a WIM file.
537 * The output directory must have been previously set with
538 * wimlib_set_output_dir().
540 * The link type used for extracted files is that specified by a previous call
541 * to wimlib_set_link_type(), or ::WIM_LINK_TYPE_NONE by default.
544 * Pointer to the ::WIMStruct for a WIM file.
546 * The image to extract. Can be the number of an image, or ::WIM_ALL_IMAGES
547 * to specify that all images are to be extracted.
549 * @return 0 on success; nonzero on error.
550 * @retval ::WIMLIB_ERR_DECOMPRESSION
551 * Could not decompress a resource (file or metadata) for @a image in @a
553 * @retval ::WIMLIB_ERR_INVALID_DENTRY
554 * A directory entry in the metadata resource for @a image in @a wim is
556 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
557 * A resource (file or metadata) for @a image in @a wim is invalid.
558 * @retval ::WIMLIB_ERR_LINK
559 * Failed to create a symbolic link or a hard link.
560 * @retval ::WIMLIB_ERR_MKDIR
561 * Failed create a needed directory.
562 * @retval ::WIMLIB_ERR_NOMEM
563 * Failed to allocate needed memory.
564 * @retval ::WIMLIB_ERR_NOTDIR
565 * wimlib_set_output_dir() has not been successfully called on @a wim.
566 * @retval ::WIMLIB_ERR_OPEN
567 * Could not open one of the files being extracted for writing.
568 * @retval ::WIMLIB_ERR_READ
569 * A unexpected end-of-file or read error occurred when trying to read data
570 * from the WIM file associated with @a wim.
571 * @retval ::WIMLIB_ERR_WRITE
572 * Failed to write a file being extracted.
574 extern int wimlib_extract_image(WIMStruct *wim, int image,
575 const char *output_dir, int flags);
578 * Extracts the XML data for a WIM file to a file stream. Every WIM file
579 * includes a string of XML that describes the images contained in the WIM.
582 * Pointer to the ::WIMStruct for a WIM file.
584 * @c stdout, or a FILE* opened for writing, to extract the data to.
586 * @return 0 on success; nonzero on error.
587 * @retval ::WIMLIB_ERR_WRITE
588 * Failed to completely write the XML data to @a fp.
590 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
593 * Frees all memory allocated for a WIMStruct and closes all files associated
597 * Pointer to the ::WIMStruct for a WIM file.
599 * @return This function has no return value.
601 extern void wimlib_free(WIMStruct *wim);
604 * Finds which image in a WIM is bootable.
607 * Pointer to the ::WIMStruct for a WIM file.
610 * 0 if no image is marked as bootable, or the number of the image marked
611 * as bootable (numbered starting at 1).
613 extern int wimlib_get_boot_idx(const WIMStruct *wim);
616 * Gets the compression type used in the WIM.
619 * Pointer to the ::WIMStruct for a WIM file
622 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
623 * ::WIM_COMPRESSION_TYPE_XPRESS.
625 extern int wimlib_get_compression_type(const WIMStruct *wim);
628 * Converts a compression type enumeration value into a string.
631 * ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
632 * ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
635 * A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
638 extern const char *wimlib_get_compression_type_string(int ctype);
641 * Converts an error code into a string describing it.
644 * The error code returned by one of wimlib's functions.
647 * Pointer to a statically allocated string describing the error code,
648 * or @c NULL if the error code is not valid.
650 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
653 * Returns the description of the specified image.
656 * Pointer to the ::WIMStruct for a WIM file.
658 * The number of the image, numbered starting at 1.
661 * The description of the image, or @c NULL if there is no such image, or @c NULL
662 * if the specified image has no description.
664 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
667 * Returns the name of the specified image.
670 * Pointer to the ::WIMStruct for a WIM file.
672 * The number of the image, numbered starting at 1.
675 * The name of the image, or @c NULL if there is no such image.
677 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
681 * Gets the number of images contained in the WIM.
684 * Pointer to the ::WIMStruct for a WIM file.
687 * The number of images contained in the WIM file.
689 extern int wimlib_get_num_images(const WIMStruct *wim);
692 * Gets the part number of the wim (in a split WIM).
695 * Pointer to the ::WIMStruct for a WIM file.
696 * @param total_parts_ret
697 * If non-@c NULL, the total number of parts in the split WIM (1 for
698 * non-split WIMs) is written to this location.
701 * The part number of the WIM (1 for non-split WIMs)
703 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
706 * Returns true if the WIM has an integrity table.
709 * Pointer to the ::WIMStruct for a WIM file.
711 * @c true if the WIM has an integrity table; false otherwise.
713 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
717 * Determines if an image name is already used by some image in the WIM.
720 * Pointer to the ::WIMStruct for a WIM file.
725 * @c true if there is already an image in @a wim named @a name; @c
726 * false if there is no image named @a name in @a wim.
728 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
731 * Joins a set of split WIMs into a one-part WIM.
734 * An array of strings that give the filenames of all parts of the split
737 * Number of filenames in @a swms.
739 * The path to write the one-part WIM to.
741 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
742 * tables (if present) when opening them, and include an integrity table in
745 * @return 0 on success; nonzero on error. This function may return any value
746 * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
747 * as the following error codes:
749 * @retval ::WIMLIB_ERR_SPLIT_INVALID
750 * The split WIMs do not form a valid WIM because they do not include all
751 * the parts of the original WIM, there are duplicate parts, or not all the
752 * parts have the same GUID and compression type.
753 * @retval ::WIMLIB_ERR_WRITE
754 * An error occurred when trying to write data to the new WIM at @a output_path.
756 * Note that this function merely copies the resources, so it will not check to
757 * see if the resources, including the metadata resource, are valid or not.
759 extern int wimlib_join(const char **swms, int num_swms,
760 const char *output_path, int flags);
763 * Mounts an image in a WIM file on a directory read-only or read-write.
765 * A daemon will be forked to service the filesystem.
767 * If the mount is read-write, modifications to the WIM are staged in a staging
770 * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
771 * intervening wimlib_unmount()s. If there was a way to have libfuse pass a
772 * pointer to user data to each FUSE callback, then this would be possible, but
773 * there doesn't seem to be a way to do this currently.
776 * Pointer to the ::WIMStruct for the WIM file to be mounted.
778 * The number of the image to mount, numbered from 1. It must be an
779 * existing, single image.
781 * The path to an existing directory to mount the image on.
783 * Bitwise OR of the flags ::WIMLIB_MOUNT_FLAG_READWRITE or
784 * ::WIMLIB_MOUNT_FLAG_DEBUG. If ::WIMLIB_MOUNT_FLAG_READWRITE is not
785 * given, the WIM is mounted read-only.
787 * @return 0 on success; nonzero on error.
788 * @retval ::WIMLIB_ERR_DECOMPRESSION
789 * Could not decompress the metadata resource for @a image in @a wim.
790 * @retval ::WIMLIB_ERR_FUSE
791 * A non-zero status was returned by @c fuse_main().
792 * @retval ::WIMLIB_ERR_INVALID_DENTRY
793 * A directory entry in the metadata resource for @a image in @a wim is
795 * @retval ::WIMLIB_ERR_INVALID_IMAGE
796 * @a image does not specify an existing, single image in @a wim.
797 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
798 * The metadata resource for @a image in @a wim is invalid.
799 * @retval ::WIMLIB_ERR_MKDIR
800 * ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
801 * directory could not be created.
802 * @retval ::WIMLIB_ERR_NOMEM
803 * Failed to allocate needed memory.
804 * @retval ::WIMLIB_ERR_NOTDIR
805 * Could not determine the current working directory.
806 * @retval ::WIMLIB_ERR_READ
807 * An unexpected end-of-file or read error occurred when trying to read
808 * data from the WIM file associated with @a wim.
811 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags);
814 * Opens a WIM file and creates a ::WIMStruct for it.
817 * The path to the WIM file to open.
819 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
820 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
821 * If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
822 * of the WIM, if it exists, is checked, and the function will fail with an
823 * ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
824 * digests of the WIM do not exactly match the corresponding message
825 * digests given in the integrity table.
826 * If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
827 * be shown if the integrity of the WIM is checked.
828 * If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
829 * WIM is part of a split WIM. However, wimlib does not fully support
830 * split WIMs, so not all functions will work correctly after opening a
831 * split WIM. For example, you cannot use wimlib_mount() or
832 * wimlib_extract_image() on a split WIM.
835 * On success, a pointer to an opaque ::WIMStruct for the opened WIM file
836 * is written to the memory location pointed to by this parameter. The
837 * ::WIMStruct must be freed using using wimlib_free() when finished with
840 * @return 0 on success; nonzero on error.
841 * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
842 * The lookup table of @a wim_file is compressed. Support for this can be
843 * added to wimlib if needed, but it appears to be the case that the lookup
844 * table is never compressed.
845 * @retval ::WIMLIB_ERR_IMAGE_COUNT
846 * The WIM is not the non-first part of a split WIM, and the number of
847 * metadata resources found in the WIM did not match the image count given
848 * in the WIM header, or the number of <IMAGE> elements in the XML
849 * data for the WIM did not match the image count given in the WIM header.
850 * @retval ::WIMLIB_ERR_INTEGRITY
851 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
852 * wim_file contains an integrity table, but the SHA1 message digest for a
853 * chunk of the WIM does not match the corresponding message digest given
854 * in the integrity table.
855 * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
856 * Resources in @a wim_file are compressed, but the chunk size is not 32768.
857 * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
858 * The header of @a wim_file says that resources in the WIM are compressed,
859 * but the header flag indicating LZX or XPRESS compression is not set.
860 * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
861 * The length field of the WIM header is not 208.
862 * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
863 * ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
864 * wim_file contains an integrity table, but the integrity table is
866 * @retval ::WIMLIB_ERR_NOMEM
867 * Failed to allocated needed memory.
868 * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
869 * @a wim_file does not begin with the expected magic characters.
870 * @retval ::WIMLIB_ERR_OPEN
871 * Failed to open the file @a wim_file for reading.
872 * @retval ::WIMLIB_ERR_READ
873 * An unexpected end-of-file or read error occurred when trying to read
874 * data from @a wim_file.
875 * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
876 * @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
878 * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
879 * A number other than 0x10d00 is written in the version field of the WIM
880 * header of @a wim_file.
881 * @retval ::WIMLIB_ERR_XML
882 * The XML data for @a wim_file is invalid.
884 extern int wimlib_open_wim(const char *wim_file, int flags,
885 WIMStruct **wim_ret);
888 * Overwrites the file that the WIM was originally read from, with changes made.
890 * The new WIM is written to a temporary file and then renamed to the original
891 * file after it is has been completely written. The temporary file currently
892 * is made in the same directory as the original WIM file.
894 * Note that it is not possible for this function to delete the original file
895 * before having written the new file because it is very likely that file
896 * resources in the new WIM file need to be retrieved from the old WIM file.
898 * After this function returns, @a wim must be freed using wimlib_free(). Any
899 * further actions on @a wim before doing this are undefined.
902 * Pointer to the ::WIMStruct for the WIM file to write. There may have
903 * been in-memory changes made to it, which are then reflected in the
906 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
907 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
909 * @return 0 on success; nonzero on error. This function may return any value
910 * returned by wimlib_write() as well as the following error codes:
911 * @retval ::WIMLIB_ERR_NO_FILENAME
912 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
913 * than a WIM read with wimlib_open_wim().
914 * @retval ::WIMLIB_ERR_RENAME
915 * The temporary file that the WIM was written to could not be renamed to
916 * the original filename of @a wim.
918 extern int wimlib_overwrite(WIMStruct *wim, int flags);
921 * Updates the header and XML data of the WIM file, without the need to write
922 * out the entire WIM to a temporary file as in wimlib_write().
924 * This function must only be used if no files, directories, or images have been
925 * added, removed, or changed in the WIM. It must be used when only the boot
926 * index or the name or description of image(s) has been changed.
928 * After this function returns, @a wim must be freed using wimlib_free(). Any
929 * further actions on @a wim before doing this are undefined.
932 * Pointer to the ::WIMStruct for the WIM file to overwrite.
934 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
935 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
937 * @return 0 on success; nonzero on error.
939 * @retval ::WIMLIB_ERR_NO_FILENAME
940 * @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
941 * than a WIM read with wimlib_open_wim().
942 * @retval ::WIMLIB_ERR_NOMEM
943 * Failed to allocate needed memory.
944 * @retval ::WIMLIB_ERR_OPEN
945 * The WIM file associated with @a wim could not be re-opened read-write.
946 * @retval ::WIMLIB_ERR_READ
947 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
948 * from the WIM file associated with @a wim could not be read to compute
949 * the SHA1 message digests, or the old integrity table (if it existed)
951 * @retval ::WIMLIB_ERR_WRITE
952 * Failed to write the WIM header, the XML data, or the integrity table to
953 * the WIM file associated with @a wim.
955 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
958 * Prints information about one image, or all images, contained in a WIM.
961 * Pointer to the ::WIMStruct for a WIM file.
963 * The image about which to print information. Can be the number of an
964 * image, or ::WIM_ALL_IMAGES to print information about all images in the
967 * @return This function has no return value.
969 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
972 * Prints the full paths to all files contained in an image, or all images, in a
976 * Pointer to the ::WIMStruct for a WIM file.
978 * Which image to print files for. Can be the number of an image, or
979 * ::WIM_ALL_IMAGES to print the files contained in all images.
981 * @return 0 on success; nonzero on error.
982 * @retval ::WIMLIB_ERR_DECOMPRESSION
983 * The metadata resource for one of the specified images could not be
985 * @retval ::WIMLIB_ERR_INVALID_DENTRY
986 * A directory entry in the metadata resource for one of the specified
988 * @retval ::WIMLIB_ERR_INVALID_IMAGE
989 * @a image does not specify a valid image in @a wim, and is not
991 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
992 * The metadata resource for one of the specified images is invalid.
993 * @retval ::WIMLIB_ERR_NOMEM
994 * Failed to allocate needed memory.
995 * @retval ::WIMLIB_ERR_READ
996 * An unexpected read error or end-of-file occurred when reading the
997 * metadata resource for one of the specified images.
999 extern int wimlib_print_files(WIMStruct *wim, int image);
1002 * Prints detailed information from the header of a WIM file.
1005 * Pointer to the ::WIMStruct for a WIM file.
1007 * @return This function has no return value.
1010 extern void wimlib_print_header(const WIMStruct *wim);
1013 * Prints the lookup table of a WIM file. The lookup table maps SHA1 message
1014 * digests, as found in the directory entry tree in the WIM file, to file
1015 * resources in the WIM file. This table includes one entry for each unique
1016 * file in the WIM, so it can be quite long. There is only one lookup table per
1020 * Pointer to the ::WIMStruct for a WIM file.
1022 * @return This function has no return value.
1024 extern void wimlib_print_lookup_table(WIMStruct *wim);
1027 * Prints the metadata of the specified image in a WIM file. The metadata
1028 * consists of the security data as well as the directory entry tree, and each
1029 * image has its own metadata.
1032 * Pointer to the ::WIMStruct for a WIM file.
1034 * Which image to print the metadata for. Can be the number of an image,
1035 * or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1037 * @return 0 on success; nonzero on error.
1038 * @retval ::WIMLIB_ERR_DECOMPRESSION
1039 * The metadata resource for one of the specified images could not be
1041 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1042 * A directory entry in the metadata resource for one of the specified
1043 * images is invaled.
1044 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1045 * @a image does not specify a valid image in @a wim, and is not
1047 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1048 * The metadata resource for one of the specified images is invalid.
1049 * @retval ::WIMLIB_ERR_NOMEM
1050 * Failed to allocate needed memory.
1051 * @retval ::WIMLIB_ERR_READ
1052 * An unexpected read error or end-of-file occurred when reading the
1053 * metadata resource for one of the specified images.
1055 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1058 * Prints some basic information about a WIM file. All information printed by
1059 * this function is also printed by wimlib_print_header(), but
1060 * wimlib_print_wim_information() prints some of this information more concisely
1061 * and in a more readable form.
1064 * Pointer to the ::WIMStruct for a WIM file.
1066 * @return This function has no return value.
1068 extern void wimlib_print_wim_information(const WIMStruct *wim);
1071 * Translates a string specifying the name or number of an image in the WIM into
1072 * the number of the image. The images are numbered starting at 1.
1075 * Pointer to the ::WIMStruct for a WIM file.
1076 * @param image_name_or_num
1077 * A string specifying which image. If it begins with a number, it is
1078 * taken to be a string specifying the image number. Otherwise, it is
1079 * taken to be the name of an image, as specified in the XML data for the
1080 * WIM file. It also may be the keyword "all", which will resolve to
1084 * If the string resolved to a single existing image, the number of that
1085 * image, counting starting at 1, is returned. If the keyword "all" was
1086 * specified, ::WIM_ALL_IMAGES is returned. Otherwise, ::WIM_NO_IMAGE is
1089 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1092 * Sets which image in the WIM is marked as bootable.
1095 * Pointer to the ::WIMStruct for a WIM file.
1097 * The number of the image to mark as bootable, or 0 to mark no image as
1099 * @return 0 on success; nonzero on error.
1100 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1101 * @a boot_idx does not specify an existing image in @a wim, and it was not
1104 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1107 * Changes the description of an image in the WIM.
1110 * Pointer to the ::WIMStruct for a WIM file.
1112 * The number of the image for which to change the description.
1113 * @param description
1114 * The new description to give the image. It may be @c NULL, which
1115 * indicates that the image is to be given no description.
1117 * @return 0 on success; nonzero on error.
1118 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1119 * @a image does not specify a single existing image in @a wim.
1120 * @retval ::WIMLIB_ERR_NOMEM
1121 * Failed to allocate the memory needed to duplicate the @a description
1124 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1125 const char *description);
1128 * Changes the name of an image in the WIM.
1131 * Pointer to the ::WIMStruct for a WIM file.
1133 * The number of the image for which to change the name.
1135 * The new name to give the image. It must not be @c NULL.
1137 * @return 0 on success; nonzero on error.
1138 * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1139 * There is already an image named @a name in @a wim.
1140 * @retval ::WIMLIB_ERR_INVALID_PARAM
1141 * @a name was @c NULL or the empty string.
1142 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1143 * @a image does not specify a single existing image in @a wim.
1144 * @retval ::WIMLIB_ERR_NOMEM
1145 * Failed to allocate the memory needed to duplicate the @a name string.
1147 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1150 * Sets the link type to use when extracting files from a WIM. This applies
1151 * when extracting one image as well as when extracting all images. Cross-image
1152 * links may save a lot of space because it is common for files to be referenced
1153 * multiple times in WIM files. By default, the link type used for extraction
1154 * is ::WIM_LINK_TYPE_NONE, meaning that links are not created.
1157 * Pointer to the ::WIMStruct for a WIM file
1159 * ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC, or ::WIM_LINK_TYPE_HARD.
1161 * @return 0 on success; nonzero on error.
1162 * @retval ::WIMLIB_ERR_INVALID_PARAM
1163 * @a link_type was not ::WIM_LINK_TYPE_NONE, ::WIM_LINK_TYPE_SYMBOLIC,
1164 * or ::WIM_LINK_TYPE_HARD.
1166 extern int wimlib_set_link_type(WIMStruct *wim, int link_type);
1169 * Set the functions that wimlib uses to allocate and free memory.
1171 * These settings are global and not per-WIM.
1173 * The default is to use the default @c malloc() and @c free() from the C
1176 * @param malloc_func
1177 * A function equivalent to @c malloc() that wimlib will use to allocate
1178 * memory. If @c NULL, the allocator function is set back to the default
1179 * @c malloc() from the C library.
1181 * A function equivalent to @c free() that wimlib will use to free memory.
1182 * If @c NULL, the free function is set back to the default @c free() from
1184 * @param realloc_func
1185 * A function equivalent to @c realloc() that wimlib will use to reallocate
1186 * memory. If @c NULL, the free function is set back to the default @c
1187 * realloc() from the C library.
1188 * @return 0 on success; nonzero on error.
1189 * @retval ::WIMLIB_ERR_UNSUPPORTED
1190 * wimlib was compiled with the @c --without-custom-memory-allocator flag,
1191 * so custom memory allocators are unsupported.
1193 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1194 void (*free_func)(void *),
1195 void *(*realloc_func)(void *, size_t));
1198 * Sets whether wimlib is to print error messages to @c stderr when a function
1199 * fails or not. These error messages may provide information that cannot be
1200 * determined only from the error code that is returned.
1202 * This setting is global and not per-WIM.
1204 * By default, error messages are not printed.
1206 * @param show_messages
1207 * @c true if error messages are to be printed; @c false if error messages
1208 * are not to be printed.
1210 * @return 0 on success; nonzero on error.
1211 * @retval ::WIMLIB_ERR_UNSUPPORTED
1212 * @a show_messages was @c true, but wimlib was compiled with the @c
1213 * --without-error-messages option. Therefore, error messages cannot be
1216 extern int wimlib_set_print_errors(bool show_messages);
1219 * Splits a WIM into multiple parts.
1222 * Name of the WIM file to split. It must be a standalone, one-part WIM.
1224 * Name of the SWM file to create. This will be the name of the first
1225 * part. The other parts will have the same name with 2, 3, 4, ..., etc.
1228 * The maximum size per part. It is not guaranteed that this will really
1229 * be the maximum size per part, because some file resources in the WIM may
1230 * be larger than this size, and the WIM file format provides no way to
1231 * split up file resources among multiple WIMs.
1233 * Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1234 * ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1236 * @return 0 on success; nonzero on error. This function may return any value
1237 * returned by wimlib_open_wim() as well as the following error codes:
1239 * @retval ::WIMLIB_ERR_WRITE
1240 * An error occurred when trying to write data to one of the split WIMs.
1243 extern int wimlib_split(const char *wimfile, const char *swm_name,
1244 size_t part_size, int flags);
1247 * Unmounts a WIM image that was mounted using wimlib_mount().
1249 * Blocks until it is known whether the mount succeeded or failed.
1251 * To perform this operation, the process calling wimlib_unmount() communicates
1252 * with the process that had called wimlib_mount().
1254 * There is currently a design problem with this function because it is hard to
1255 * know whether the filesystem daemon is still working or whether it has
1256 * crashed, has been killed, or has reached an infinite loop. However, ideally
1257 * there should be no infinite loops or crashes in the code, so this wouldn't be
1258 * much of a problem. Currently, a timeout of 600 seconds (so long because WIMs
1259 * can be very large) is implemented so that this function will not wait forever
1260 * before returning failure.
1263 * The directory that the WIM image was mounted on.
1265 * Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1266 * ::WIMLIB_UNMOUNT_FLAG_COMMIT. Neither of these flags affect read-only
1269 * @return 0 on success; nonzero on error.
1270 * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1271 * The filesystem daemon was unable to remove the staging directory and the
1272 * temporary files that it contains.
1273 * @retval ::WIMLIB_ERR_FORK
1274 * Could not @c fork() the process.
1275 * @retval ::WIMLIB_ERR_FUSERMOUNT
1276 * The @b fusermount program could not be executed or exited with a failure
1278 * @retval ::WIMLIB_ERR_MQUEUE
1279 * Could not open a POSIX message queue to communicate with the filesystem
1280 * daemon servicing the mounted filesystem, could not send a message
1281 * through the queue, or could not receive a message through the queue.
1282 * @retval ::WIMLIB_ERR_NOMEM
1283 * Failed to allocate needed memory.
1284 * @retval ::WIMLIB_ERR_OPEN
1285 * The filesystem daemon could not open a temporary file for writing the
1287 * @retval ::WIMLIB_ERR_TIMEOUT
1288 * 600 seconds elapsed while waiting for the filesystem daemon to notify
1289 * the process of its exit status, so the WIM file probably was not written
1291 * @retval ::WIMLIB_ERR_READ
1292 * A read error occurred when the filesystem daemon tried to a file from
1293 * the staging directory
1294 * @retval ::WIMLIB_ERR_RENAME
1295 * The filesystem daemon failed to rename the newly written WIM file to the
1296 * original WIM file.
1297 * @retval ::WIMLIB_ERR_WRITE
1298 * A write error occurred when the filesystem daemon was writing to the new
1299 * WIM file, or the filesystem daemon was unable to flush changes that had
1300 * been made to files in the staging directory.
1302 extern int wimlib_unmount(const char *dir, int flags);
1305 * Writes the WIM to a file.
1308 * Pointer to the ::WIMStruct for a WIM file. There may have been
1309 * in-memory changes made to it, which are then reflected in the output
1312 * The path to the file to write the WIM to.
1314 * The image inside the WIM to write. Use ::WIM_ALL_IMAGES to include all
1317 * Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1318 * ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS. If
1319 * ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1320 * included in the WIM being written. If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1321 * is given, the progress of the calculation of the integrity table is
1324 * @return 0 on success; nonzero on error.
1325 * @retval ::WIMLIB_ERR_DECOMPRESSION
1326 * Failed to decompress a metadata or file resource in @a wim.
1327 * @retval ::WIMLIB_ERR_INVALID_DENTRY
1328 * A directory entry in the metadata resource for @a image in @a wim is
1330 * @retval ::WIMLIB_ERR_INVALID_IMAGE
1331 * @a image does not specify a single existing image in @a wim, and is not
1333 * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1334 * The metadata resource for @a image in @a wim is invalid.
1335 * @retval ::WIMLIB_ERR_NOMEM
1336 * Failed to allocate needed memory.
1337 * @retval ::WIMLIB_ERR_OPEN
1338 * Failed to open @a path for writing, or some file resources in @a
1339 * wim refer to files in the outside filesystem, and one of these files
1340 * could not be opened for reading.
1341 * @retval ::WIMLIB_ERR_READ
1342 * An error occurred when trying to read data from the WIM file associated
1343 * with @a wim, or some file resources in @a wim refer to files in the
1344 * outside filesystem, and a read error occurred when reading one of these
1346 * @retval ::WIMLIB_ERR_WRITE
1347 * An error occurred when trying to write data to the new WIM file at @a
1350 extern int wimlib_write(WIMStruct *wim, const char *path, int image, int flags);
1354 #endif /* _WIMLIB_H */