wimlib.h doc fix
[wimlib] / src / wimlib.h
1 /*
2  * wimlib.h
3  *
4  * External header for wimlib.
5  */
6
7 /*
8  * Copyright (C) 2012 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
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)
15  * any later version.
16  *
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
20  * details.
21  *
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/.
24  */
25
26 /** \mainpage
27  *
28  * \section intro Introduction
29  *
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.
36  *
37  * \section format WIM files
38  *
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
43  * wimlib.
44  *
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
50  * exactly the same.
51  *
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.
56  *
57  * A WIM file may be either stand-alone or split into multiple parts.
58  *
59  * \section winpe Windows PE
60  *
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.
67  *
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.
73  *
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
76  * Windows PE.
77  *
78  * \section ntfs NTFS support
79  *
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
84  * data.
85
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.
92  *
93  * \section starting Getting Started
94  *
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.
99  *
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.
102  *
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.
110  *
111  * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
112  * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
113  * both apply globally.
114  *
115  * To open an existing WIM, use wimlib_open_wim().
116  *
117  * To create a new WIM that initially contains no images, use
118  * wimlib_create_new_wim().
119  *
120  * To add an image to a WIM file from a directory tree on your filesystem, call
121  * wimlib_add_image().  This can be done with a ::WIMStruct gotten from
122  * wimlib_open_wim() or from wimlib_create_new_wim().  Alternatively, if you
123  * want to capture a WIM image directly from a NTFS volume while preserving
124  * NTFS-specific data such as security descriptors, call
125  * wimlib_add_image_from_ntfs_volume() instead.
126  *
127  * To extract an image from a WIM file, call wimlib_extract_image().
128  * Alternatively, if you want to apply a WIM image directly to a NTFS volume
129  * while setting NTFS-specific data such as security descriptors, call
130  * wimlib_apply_image_to_ntfs_volume().
131  *
132  * The NTFS functions will fail if wimlib was compiled with the
133  * <code>--without-ntfs-3g</code> flag.
134  *
135  * wimlib supports mounting WIM files either read-only or read-write.  Mounting
136  * is done using wimlib_mount() and unmounting is done using wimlib_unmount().
137  * Mounting can be done without root privileges because it is implemented using
138  * FUSE (Filesystem in Userspace).  If wimlib is compiled with the
139  * <code>--without-fuse</code> flag, these functions will be available but will
140  * fail.
141  *
142  * After creating or modifying a WIM file, you can write it to a file using
143  * wimlib_write().  Alternatively,  if the WIM was originally read from a file,
144  * you can use wimlib_overwrite() to overwrite the original file.  In some
145  * cases, wimlib_overwrite_xml_and_header() can be used instead.
146  *
147  * After you are done with the WIM file, use wimlib_free() to free all memory
148  * associated with a ::WIMStruct and close all files associated with it.
149  *
150  * To see an example of how to use wimlib, see the file
151  * @c programs/imagex.c in wimlib's source tree.
152  *
153  * wimlib supports custom memory allocators; use wimlib_set_memory_allocator()
154  * for this.  However, if wimlib calls into @c libntfs-3g, the custom memory
155  * allocator may not be used.
156  *
157  * \section imagex imagex
158  *
159  * wimlib comes with the <b>imagex</b> program, which is documented in man pages.
160  *
161  * \section mkwinpeimg mkwinpeimg
162  *
163  * wimlib comes with the <b>mkwinpeimg</b> script, which is documented in a man
164  * page.
165  *
166  * \section Limitations
167  *
168  * While wimlib supports the main features of WIM files, wimlib currently has
169  * the following limitations:
170  * - Different versions of the WIM file format are unsupported.  There is one
171  *   different version of the format from development versions of Windows Vista,
172  *   but I'm not planning to support it.
173  * - Compressed resource chunk sizes other than 32768 are unsupported (except for
174  *   uncompressed WIMs, for which the chunk size field is ignored).  As far as I
175  *   can tell, other chunk sizes are not used in compressed WIMs.  Let me know
176  *   if you find a WIM file with a different chunk size.
177  * - wimlib does not provide a clone of the @b PEImg tool that allows you to
178  *   make certain Windows-specific modifications to a Windows PE image, such as
179  *   adding a driver or Windows component.  Such a tool could conceivably be
180  *   implemented on top of wimlib, although it likely would be hard to implement
181  *   because it would have to do very Windows-specific things such as
182  *   manipulating the driver store.  wimlib does provide the @b mkwinpeimg
183  *   script for a similar purpose, however.  With regards to adding drivers to
184  *   Windows PE, you have the option of putting them anywhere in the Windows PE
185  *   image, then loading them after boot using @b drvload.exe.
186  * - There is not yet a way to extract specific files or directories from a WIM
187  *   file without mounting it, or to add, remove, or modify files in a WIM
188  *   without mounting it, other than by adding or removing an entire image.  I
189  *   can implement this if requested, but I intend the FUSE mount feature to be
190  *   used for this purpose, as it is easy to do these things in whatever way you
191  *   want after the image is mounted.
192  * - Currently, Microsoft's @a image.exe can create slightly smaller WIM files
193  *   than wimlib when using maximum (LZX) compression because it knows how to
194  *   split up LZX compressed blocks, which is not yet implemented in wimlib.
195  * - wimlib is experimental and likely contains bugs; use Microsoft's @a
196  *   imagex.exe if you want to make sure your WIM files are made "correctly".
197  *
198  * \section legal License
199  *
200  * The wimlib library, as well as the programs and scripts distributed with it
201  * (@b imagex and @b mkwinpeimg), is licensed under the GNU General Public
202  * License version 3 or later.
203  */
204
205 #ifndef _WIMLIB_H
206 #define _WIMLIB_H
207
208 #include <stdio.h>
209 #include <stddef.h>
210 #include <stdbool.h>
211
212 #ifndef _WIMLIB_INTERNAL_H
213 /**
214  * Opaque structure that represents a WIM file.
215  */
216 typedef struct WIMStruct WIMStruct;
217 #endif
218
219 /**
220  * Specifies the compression type of a WIM file.
221  */
222
223 enum wim_compression_type {
224         /** An invalid compression type. */
225         WIM_COMPRESSION_TYPE_INVALID = -1,
226
227         /** The WIM does not include any compressed resources. */
228         WIM_COMPRESSION_TYPE_NONE = 0,
229
230         /** Compressed resources in the WIM use LZX compression. */
231         WIM_COMPRESSION_TYPE_LZX = 1,
232
233         /** Compressed resources in the WIM use XPRESS compression. */
234         WIM_COMPRESSION_TYPE_XPRESS = 2,
235 };
236
237 /** Mount the WIM read-write. */
238 #define WIMLIB_MOUNT_FLAG_READWRITE             0x00000001
239
240 /** For debugging only. (This passes the @c -d flag to @c fuse_main()).*/
241 #define WIMLIB_MOUNT_FLAG_DEBUG                 0x00000002
242
243 /** Do not allow accessing alternate data streams. */
244 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE         0x00000010
245
246 /** Access alternate data streams through extended file attributes.  This is the
247  * default mode. */
248 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR        0x00000020
249
250 /** Access alternate data streams by specifying the file name, a colon, then the
251  * alternate file stream name. */
252 #define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS      0x00000040
253
254 /** Include an integrity table in the new WIM being written during the unmount.
255  * Ignored for read-only mounts. */
256 #define WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY     0x00000001
257
258 /** Unless this flag is given, changes to a mounted WIM are discarded.  Ignored
259  * for read-only mounts. */
260 #define WIMLIB_UNMOUNT_FLAG_COMMIT              0x00000002
261
262 /** Include an integrity table in the new WIM file. */
263 #define WIMLIB_WRITE_FLAG_CHECK_INTEGRITY       0x00000001
264
265 /** Print progress information when writing streams and when writing the
266  * integrity table. */
267 #define WIMLIB_WRITE_FLAG_SHOW_PROGRESS         0x00000002
268
269 /** Print file paths as we write then */
270 #define WIMLIB_WRITE_FLAG_VERBOSE               0x00000004
271
272 /** Mark the image being added as the bootable image of the WIM. */
273 #define WIMLIB_ADD_IMAGE_FLAG_BOOT              0x00000001
274
275 /** Print the name of each file or directory as it is scanned to be included in
276  * the WIM image. */
277 #define WIMLIB_ADD_IMAGE_FLAG_VERBOSE           0x00000002
278
279 /** Follow symlinks; archive and dump the files they point to. */
280 #define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE       0x00000004
281
282 /** Show progress information when scanning a directory tree */
283 #define WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS     0x00000008
284
285 /** See documentation for wimlib_export_image(). */
286 #define WIMLIB_EXPORT_FLAG_BOOT                 0x00000001
287
288 /** Verify the integrity of the WIM if an integrity table is present. */
289 #define WIMLIB_OPEN_FLAG_CHECK_INTEGRITY        0x00000001
290
291 /** Print progress information when verifying integrity table. */
292 #define WIMLIB_OPEN_FLAG_SHOW_PROGRESS          0x00000002
293
294 /** If this flag is not given, an error is issued if the WIM is part of a split
295  * WIM.  */
296 #define WIMLIB_OPEN_FLAG_SPLIT_OK               0x00000004
297
298
299 /** When identical files are extracted from the WIM, always hard link them
300  * together. */
301 #define WIMLIB_EXTRACT_FLAG_HARDLINK            0x00000001
302
303 /** When identical files are extracted from the WIM, always symlink them
304  * together. */
305 #define WIMLIB_EXTRACT_FLAG_SYMLINK             0x00000002
306
307 /** Print the name of each file as it is extracted from the WIM image. */
308 #define WIMLIB_EXTRACT_FLAG_VERBOSE             0x00000008
309
310 /**
311  * Possible values of the error code returned by many functions in wimlib.
312  *
313  * See the documentation for each wimlib function to see specifically what error
314  * codes can be returned by a given function, and what they mean.
315  */
316 enum wimlib_error_code {
317         WIMLIB_ERR_SUCCESS = 0,
318         WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
319         WIMLIB_ERR_DECOMPRESSION,
320         WIMLIB_ERR_DELETE_STAGING_DIR,
321         WIMLIB_ERR_FORK,
322         WIMLIB_ERR_FUSE,
323         WIMLIB_ERR_FUSERMOUNT,
324         WIMLIB_ERR_IMAGE_COUNT,
325         WIMLIB_ERR_IMAGE_NAME_COLLISION,
326         WIMLIB_ERR_INTEGRITY,
327         WIMLIB_ERR_INVALID_CAPTURE_CONFIG,
328         WIMLIB_ERR_INVALID_CHUNK_SIZE,
329         WIMLIB_ERR_INVALID_COMPRESSION_TYPE,
330         WIMLIB_ERR_INVALID_DENTRY,
331         WIMLIB_ERR_INVALID_HEADER_SIZE,
332         WIMLIB_ERR_INVALID_IMAGE,
333         WIMLIB_ERR_INVALID_INTEGRITY_TABLE,
334         WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY,
335         WIMLIB_ERR_INVALID_PARAM,
336         WIMLIB_ERR_INVALID_RESOURCE_HASH,
337         WIMLIB_ERR_INVALID_RESOURCE_SIZE,
338         WIMLIB_ERR_INVALID_SECURITY_DATA,
339         WIMLIB_ERR_LINK,
340         WIMLIB_ERR_MKDIR,
341         WIMLIB_ERR_MQUEUE,
342         WIMLIB_ERR_NOMEM,
343         WIMLIB_ERR_NOTDIR,
344         WIMLIB_ERR_NOT_A_WIM_FILE,
345         WIMLIB_ERR_NO_FILENAME,
346         WIMLIB_ERR_NTFS_3G,
347         WIMLIB_ERR_OPEN,
348         WIMLIB_ERR_OPENDIR,
349         WIMLIB_ERR_READLINK,
350         WIMLIB_ERR_READ,
351         WIMLIB_ERR_RENAME,
352         WIMLIB_ERR_RESOURCE_ORDER,
353         WIMLIB_ERR_SPECIAL_FILE,
354         WIMLIB_ERR_SPLIT_INVALID,
355         WIMLIB_ERR_SPLIT_UNSUPPORTED,
356         WIMLIB_ERR_STAT,
357         WIMLIB_ERR_TIMEOUT,
358         WIMLIB_ERR_UNKNOWN_VERSION,
359         WIMLIB_ERR_UNSUPPORTED,
360         WIMLIB_ERR_WRITE,
361         WIMLIB_ERR_XML,
362 };
363
364
365 /** Used to indicate that no WIM image is currently selected. */
366 #define WIM_NO_IMAGE    0
367
368 /** Used to specify all images in the WIM. */
369 #define WIM_ALL_IMAGES  (-1)
370
371
372 /**
373  * Adds an image to a WIM file from a directory tree on disk.
374  *
375  * The directory tree is read immediately for the purpose of constructing a
376  * directory entry tree in-memory.  Also, all files are read to calculate their
377  * SHA1 message digests.  However, because the directory tree may contain a very
378  * large amount of data, the files themselves are not read into memory
379  * permanently, and instead references to their paths saved.  The files are then
380  * read on-demand if wimlib_write() or wimlib_overwrite() is called.
381  *
382  * @param wim
383  *      Pointer to the ::WIMStruct for a WIM file to which the image will be
384  *      added.
385  * @param dir
386  *      A path to a directory in the outside filesystem.  It will become the
387  *      root directory for the WIM image.
388  * @param name
389  *      The name to give the image.  This must be non-@c NULL.
390  * @param config
391  *      Pointer to the contents of an image capture configuration file.  If @c
392  *      NULL, a default string is used.  Please see the manual page for
393  *      <b>imagex capture</b> for more information.
394  * @param config_len
395  *      Length of the string @a config in bytes.  Ignored if @a config is @c
396  *      NULL.
397  *
398  * @param flags
399  *      Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.  If
400  *      ::WIMLIB_ADD_IMAGE_FLAG_BOOT is specified, the image in @a wim that is
401  *      marked as bootable is changed to the one being added.  If
402  *      ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE is specified, the name of each file is
403  *      printed as it is scanned or captured.  If
404  *      ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE is specified, the files or
405  *      directories pointed to by symbolic links are archived rather than the
406  *      symbolic links themselves.  If ::WIMLIB_ADD_IMAGE_FLAG_SHOW_PROGRESS is
407  *      specified, progress information will be printed (distinct from the
408  *      verbose information).
409  *
410  * @return 0 on success; nonzero on error.  On error, changes to @a wim are
411  * discarded so that it appears to be in the same state as when this function
412  * was called.
413  *
414  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
415  *      There is already an image named @a name in @a w.
416  * @retval ::WIMLIB_ERR_INVALID_PARAM
417  *      @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
418  * @retval ::WIMLIB_ERR_NOMEM
419  *      Failed to allocate needed memory.
420  * @retval ::WIMLIB_ERR_NOTDIR
421  *      @a dir is not a directory.
422  * @retval ::WIMLIB_ERR_OPEN
423  *      Failed to open a file or directory in the directory tree rooted at @a
424  *      dir.
425  * @retval ::WIMLIB_ERR_READ
426  *      Failed to read a file in the directory tree rooted at @a dir.
427  * @retval ::WIMLIB_ERR_SPECIAL_FILE
428  *      The directory tree rooted at @dir contains a special file that is not a
429  *      directory, regular file, or symbolic link.
430  * @retval ::WIMLIB_ERR_STAT
431  *      Failed obtain the metadata for a file or directory in the directory tree
432  *      rooted at @a dir.
433  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
434  *      @a wim is part of a split WIM.  Adding an image to a split WIM is
435  *      unsupported.
436  */
437 extern int wimlib_add_image(WIMStruct *wim, const char *dir,
438                             const char *name, const char *config,
439                             size_t config_len, int flags);
440
441 /**
442  * This function is similar to wimlib_add_image(), except instead of capturing
443  * the WIM image from a directory, it is captured from a NTFS volume specified
444  * by @a device.  NTFS-3g errors are reported as ::WIMLIB_ERR_NTFS_3G.
445  * ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE may not be specified because we capture
446  * the reparse points exactly as they are.
447  */
448 extern int wimlib_add_image_from_ntfs_volume(WIMStruct *wim, const char *device,
449                                              const char *name,
450                                              const char *config,
451                                              size_t config_len,
452                                              int flags);
453
454 /**
455  * This function is similar to wimlib_extract_image(), except that @a image may
456  * not be ::WIM_ALL_IMAGES, and @a device specifies the name of a file or block
457  * device containing a NTFS volume to apply the image to.  NTFS-3g errors are
458  * reported as ::WIMLIB_ERR_NTFS_3G, and ::WIMLIB_EXTRACT_FLAG_HARDLINK or
459  * ::WIMLIB_EXTRACT_FLAG_SYMLINK may not be specified because in the NTFS
460  * apply mode we apply the reparse points and hard links exactly as they are in
461  * the WIM.
462  */
463 extern int wimlib_apply_image_to_ntfs_volume(WIMStruct *wim, int image,
464                                              const char *device, int flags,
465                                              WIMStruct **additional_swms,
466                                              unsigned num_additional_swms);
467
468 /**
469  * Creates a WIMStruct for a new WIM file.
470  *
471  * @param ctype
472  *      The type of compression to be used in the new WIM file.  Must be
473  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
474  *      ::WIM_COMPRESSION_TYPE_XPRESS.
475  * @param wim_ret
476  *      On success, a pointer to an opaque ::WIMStruct for the new WIM file is
477  *      written to the memory location pointed to by this paramater.  The
478  *      ::WIMStruct must be freed using using wimlib_free() when finished with
479  *      it.
480  * @return 0 on success; nonzero on error.
481  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
482  *      @a ctype was not ::WIM_COMPRESSION_TYPE_NONE,
483  *      ::WIM_COMPRESSION_TYPE_LZX, or ::WIM_COMPRESSION_TYPE_XPRESS.
484  * @retval ::WIMLIB_ERR_NOMEM
485  *      Failed to allocate needed memory.
486  */
487 extern int wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
488
489 /**
490  * Deletes an image, or all images, from a WIM file.
491  *
492  * All streams referenced by the image(s) being deleted are removed from the
493  * lookup table of the WIM if they are not referenced by any other images in the
494  * WIM.
495  *
496  * @param wim
497  *      Pointer to the ::WIMStruct for the WIM file that contains the image(s)
498  *      being deleted.
499  * @param image
500  *      The number of the image to delete, or ::WIM_ALL_IMAGES to delete all
501  *      images.
502  * @return 0 on success; nonzero on failure.  On failure, @a wim is guaranteed
503  * to be left unmodified only if @a image specified a single image.  If instead
504  * @a image was ::WIM_ALL_IMAGES and @a wim contained more than one image, it's
505  * possible for some but not all of the images to have been deleted when a
506  * failure status is returned.
507  *
508  * @retval ::WIMLIB_ERR_DECOMPRESSION
509  *      Could not decompress the metadata resource for @a image.
510  * @retval ::WIMLIB_ERR_INVALID_DENTRY
511  *      A directory entry in the metadata resource for @a image in the WIM is
512  *      invalid.
513  * @retval ::WIMLIB_ERR_INVALID_IMAGE
514  *      @a image does not exist in the WIM and is not ::WIM_ALL_IMAGES.
515  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
516  *      The metadata resource for @a image in the WIM is invalid.
517  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
518  *      The security data for @a image in the WIM is invalid.
519  * @retval ::WIMLIB_ERR_NOMEM
520  *      Failed to allocate needed memory.
521  * @retval ::WIMLIB_ERR_READ
522  *      Could not read the metadata resource for @a image from the WIM.
523  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
524  *      @a wim is part of a split WIM.  Deleting an image from a split WIM is
525  *      unsupported.
526  */
527 extern int wimlib_delete_image(WIMStruct *wim, int image);
528
529 /**
530  * Exports an image, or all the images, from a WIM file, into another WIM file.
531  *
532  * The destination image is made to share the same dentry tree and security data
533  * structure as the source image.  This places some restrictions on additional
534  * functions that may be called.  wimlib_mount() may not be called on either the
535  * source image or the destination image without an intervening call to a
536  * function that un-shares the images, such as wimlib_free() on @a dest_wim, or
537  * wimlib_delete_image() on either the source or destination image.
538  * Furthermore, you may not call wimlib_free() or wimlib_overwrite() on @a
539  * src_wim before any calls to functions such as wimlib_write() on @a dest_wim
540  * because @a dest_wim will have references back to @a src_wim.
541  *
542  * Previous versions of this function left @a dest_wim in an indeterminate state
543  * on failure.  This is no longer the case; all changes to @a dest_wim made by
544  * this function are rolled back on failure.
545  *
546  * Previous versions of this function did not allow exporting an image that had
547  * been added by wimlib_add_image().  This is no longer the case; you may now
548  * export an image regardless of how it was added.
549  *
550  * Regardless of whether this function succeeds or fails, no user-visible
551  * changes are made to @a src_wim.
552  *
553  * @param src_wim
554  *      Pointer to the ::WIMStruct for a stand-alone WIM or part 1 of a split
555  *      WIM that contains the image(s) being exported.
556  * @param src_image
557  *      The image to export from @a src_wim.  Can be the number of an image, or
558  *      ::WIM_ALL_IMAGES to export all images.
559  * @param dest_wim
560  *      Pointer to the ::WIMStruct for a WIM file that will receive the images
561  *      being exported.
562  * @param dest_name
563  *      The name to give the exported image in the new WIM file.  If left @c NULL,
564  *      the name from @a src_wim is used.  This parameter must be left @c NULL
565  *      if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains more than one
566  *      image; in that case, the names are all taken from the @a src_wim.
567  * @param dest_description
568  *      The description to give the exported image in the new WIM file.  If left
569  *      @c NULL, the description from the @a src_wim is used.  This parameter must
570  *      be left @c NULL if @a src_image is ::WIM_ALL_IMAGES and @a src_wim contains
571  *      more than one image; in that case, the descriptions are all taken from
572  *      @a src_wim.
573  * @param flags
574  *      ::WIMLIB_EXPORT_FLAG_BOOT if the image being exported is to be made
575  *      bootable, or 0 if which image is marked as bootable in the destination
576  *      WIM is to be left unchanged.  If @a src_image is ::WIM_ALL_IMAGES and
577  *      there are multiple images in @a src_wim, specifying
578  *      ::WIMLIB_EXPORT_FLAG_BOOT is valid only if one of the exported images is
579  *      currently marked as bootable in @a src_wim; if that is the case, then
580  *      that image is marked as bootable in the destination WIM.
581  * @param additional_swms
582  *      Array of pointers to the ::WIMStruct for each additional part in the
583  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
584  *      need to be in any particular order, but they must include all parts of
585  *      the split WIM other than the first part, which must be provided in the
586  *      @a wim parameter.
587  * @param num_additional_swms
588  *      Number of additional WIM parts provided in the @a additional_swms array.
589  *      This number should be one less than the total number of parts in the
590  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
591  *
592  * @return 0 on success; nonzero on error.
593  * @retval ::WIMLIB_ERR_DECOMPRESSION
594  *      Could not decompress the metadata resource for @a src_image
595  *      in @a src_wim
596  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
597  *      One or more of the names being given to an exported image was already in
598  *      use in the destination WIM.
599  * @retval ::WIMLIB_ERR_INVALID_DENTRY
600  *      A directory entry in the metadata resource for @a src_image in @a
601  *      src_wim is invalid.
602  * @retval ::WIMLIB_ERR_INVALID_IMAGE
603  *      @a src_image does not exist in @a src_wim.
604  * @retval ::WIMLIB_ERR_INVALID_PARAM
605  *      ::WIMLIB_EXPORT_FLAG_BOOT was specified in @a flags, @a src_image was
606  *      ::WIM_ALL_IMAGES, @a src_wim contains multiple images, and no images in
607  *      @a src_wim are marked as bootable; or @a dest_name and/or @a
608  *      dest_description were non-<code>NULL</code>, @a src_image was
609  *      ::WIM_ALL_IMAGES, and @a src_wim contains multiple images; or @a src_wim
610  *      or @a dest_wim was @c NULL.
611  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
612  *      The metadata resource for @a src_image in @a src_wim is invalid.
613  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
614  *      The security data for @a src_image in @a src_wim is invalid.
615  * @retval ::WIMLIB_ERR_NOMEM
616  *      Failed to allocate needed memory.
617  * @retval ::WIMLIB_ERR_READ
618  *      Could not read the metadata resource for @a src_image from @a src_wim.
619  * @retval ::WIMLIB_ERR_SPLIT_INVALID
620  *      The source WIM is a split WIM, but the parts specified do not form a
621  *      complete split WIM because they do not include all the parts of the
622  *      original WIM, there are duplicate parts, or not all the parts have the
623  *      same GUID and compression type.
624  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
625  *      @a dest_wim is part of a split WIM.  Exporting an image to a split WIM
626  *      is unsupported.
627  */
628 extern int wimlib_export_image(WIMStruct *src_wim, int src_image,
629                                WIMStruct *dest_wim, const char *dest_name,
630                                const char *dest_description, int flags,
631                                WIMStruct **additional_swms,
632                                unsigned num_additional_swms);
633
634 /**
635  * Extracts an image, or all images, from a standalone or split WIM file.
636  *
637  * @param wim
638  *      Pointer to the ::WIMStruct for a standalone WIM file, or part 1 of a
639  *      split WIM.
640  * @param image
641  *      The image to extract.  Can be the number of an image, or ::WIM_ALL_IMAGES
642  *      to specify that all images are to be extracted.
643  * @param output_dir
644  *      Directory to extract the WIM image(s) to.  It is created if it does not
645  *      already exist.
646  * @param flags
647  *      Bitwise or of the flags prefixed with WIMLIB_EXTRACT_FLAG.
648  *
649  *      One or none of ::WIMLIB_EXTRACT_FLAG_HARDLINK or
650  *      ::WIMLIB_EXTRACT_FLAG_SYMLINK may be specified.  These flags cause
651  *      extracted files that are identical to be hardlinked or symlinked
652  *      together, depending on the flag.  These flags override the hard link
653  *      groups that are specified in the WIM file itself.  If ::WIM_ALL_IMAGES
654  *      is provided as the @a image parameter, files may be hardlinked or
655  *      symlinked across images if a file is found to occur in more than one
656  *      image.
657  *
658  *      You may also specify the flag ::WIMLIB_EXTRACT_FLAG_VERBOSE to cause
659  *      informational messages to be printed during the extraction, including
660  *      the name of each extracted file or directory.
661  * @param additional_swms
662  *      Array of pointers to the ::WIMStruct for each additional part in the
663  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
664  *      need to be in any particular order, but they must include all parts of
665  *      the split WIM other than the first part, which must be provided in the
666  *      @a wim parameter.
667  * @param num_additional_swms
668  *      Number of additional WIM parts provided in the @a additional_swms array.
669  *      This number should be one less than the total number of parts in the
670  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
671  *
672  * @return 0 on success; nonzero on error.
673  * @retval ::WIMLIB_ERR_DECOMPRESSION
674  *      Could not decompress a resource (file or metadata) for @a image in @a
675  *      wim.
676  * @retval ::WIMLIB_ERR_INVALID_DENTRY
677  *      A directory entry in the metadata resource for @a image in @a wim is
678  *      invalid.
679  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
680  *      The SHA1 message digest of an extracted stream did not match the SHA1
681  *      message digest given in the WIM file.
682  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
683  *      A resource (file or metadata) for @a image in @a wim is invalid.
684  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
685  *      The security data for @a image in @a wim is invalid.
686  * @retval ::WIMLIB_ERR_LINK
687  *      Failed to create a symbolic link or a hard link.
688  * @retval ::WIMLIB_ERR_MKDIR
689  *      Failed create a needed directory.
690  * @retval ::WIMLIB_ERR_NOMEM
691  *      Failed to allocate needed memory.
692  * @retval ::WIMLIB_ERR_OPEN
693  *      Could not open one of the files being extracted for writing.
694  * @retval ::WIMLIB_ERR_READ
695  *      A unexpected end-of-file or read error occurred when trying to read data
696  *      from the WIM file associated with @a wim.
697  * @retval ::WIMLIB_ERR_SPLIT_INVALID
698  *      The WIM is a split WIM, but the parts specified do not form a complete
699  *      split WIM because they do not include all the parts of the original WIM,
700  *      there are duplicate parts, or not all the parts have the same GUID and
701  *      compression type.
702  * @retval ::WIMLIB_ERR_WRITE
703  *      Failed to write a file being extracted.
704  */
705 extern int wimlib_extract_image(WIMStruct *wim, int image,
706                                 const char *output_dir, int flags,
707                                 WIMStruct **additional_swms,
708                                 unsigned num_additional_swms);
709
710 /**
711  * Extracts the XML data for a WIM file to a file stream.  Every WIM file
712  * includes a string of XML that describes the images contained in the WIM.
713  * This function works on standalone WIMs as well as split WIM parts.
714  *
715  * @param wim
716  *      Pointer to the ::WIMStruct for a WIM file.
717  * @param fp
718  *      @c stdout, or a FILE* opened for writing, to extract the data to.
719  *
720  * @return 0 on success; nonzero on error.
721  * @retval ::WIMLIB_ERR_WRITE
722  *      Failed to completely write the XML data to @a fp.
723  */
724 extern int wimlib_extract_xml_data(WIMStruct *wim, FILE *fp);
725
726 /**
727  * Frees all memory allocated for a WIMStruct and closes all files associated
728  * with it.
729  *
730  * @param wim
731  *      Pointer to the ::WIMStruct for a WIM file.
732  *
733  * @return This function has no return value.
734  */
735 extern void wimlib_free(WIMStruct *wim);
736
737 /**
738  * Finds which image in a WIM is bootable.
739  *
740  * @param wim
741  *      Pointer to the ::WIMStruct for a WIM file.
742  *
743  * @return
744  *      0 if no image is marked as bootable, or the number of the image marked
745  *      as bootable (numbered starting at 1).
746  */
747 extern int wimlib_get_boot_idx(const WIMStruct *wim);
748
749 /**
750  * Gets the compression type used in the WIM.
751  *
752  * @param wim
753  *      Pointer to the ::WIMStruct for a WIM file
754  *
755  * @return
756  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX, or
757  *      ::WIM_COMPRESSION_TYPE_XPRESS.
758  */
759 extern int wimlib_get_compression_type(const WIMStruct *wim);
760
761 /**
762  * Converts a compression type enumeration value into a string.
763  *
764  * @param ctype
765  *      ::WIM_COMPRESSION_TYPE_NONE, ::WIM_COMPRESSION_TYPE_LZX,
766  *      ::WIM_COMPRESSION_TYPE_XPRESS, or another value.
767  *
768  * @return
769  *      A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
770  *      respectively.
771  */
772 extern const char *wimlib_get_compression_type_string(int ctype);
773
774 /**
775  * Converts an error code into a string describing it.
776  *
777  * @param code
778  *      The error code returned by one of wimlib's functions.
779  *
780  * @return
781  *      Pointer to a statically allocated string describing the error code,
782  *      or @c NULL if the error code is not valid.
783  */
784 extern const char *wimlib_get_error_string(enum wimlib_error_code code);
785
786 /**
787  * Returns the description of the specified image.
788  *
789  * @param wim
790  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
791  *      standalone WIM or a split WIM part.
792  * @param image
793  *      The number of the image, numbered starting at 1.
794  *
795  * @return
796  *      The description of the image, or @c NULL if there is no such image, or
797  *      @c NULL if the specified image has no description.  The description
798  *      string is in library-internal memory and may not be modified or freed;
799  *      in addition, the string will become invalid if the description of the
800  *      image is changed, the image is deleted, or the ::WIMStruct is destroyed.
801  */
802 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
803
804 /**
805  * Returns the name of the specified image.
806  *
807  * @param wim
808  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
809  *      standalone WIM or a split WIM part.
810  * @param image
811  *      The number of the image, numbered starting at 1.
812  *
813  * @return
814  *      The name of the image, or @c NULL if there is no such image.  The name
815  *      string is in library-internal memory and may not be modified or freed;
816  *      in addition, the string will become invalid if the name of the image is
817  *      changed, the image is deleted, or the ::WIMStruct is destroyed.
818  */
819 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
820
821
822 /**
823  * Gets the number of images contained in the WIM.
824  *
825  * @param wim
826  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
827  *      standalone WIM or a split WIM part.
828  *
829  * @return
830  *      The number of images contained in the WIM file.
831  */
832 extern int wimlib_get_num_images(const WIMStruct *wim);
833
834 /**
835  * Gets the part number of part of a split WIM.
836  *
837  * @param wim
838  *      Pointer to the ::WIMStruct for a WIM file.
839  * @param total_parts_ret
840  *      If non-@c NULL, the total number of parts in the split WIM (1 for
841  *      non-split WIMs) is written to this location.
842  *
843  * @return
844  *      The part number of the WIM (1 for non-split WIMs)
845  */
846 extern int wimlib_get_part_number(const WIMStruct *wim, int *total_parts_ret);
847
848 /**
849  * Returns true if the WIM has an integrity table.
850  *
851  * @param wim
852  *      Pointer to the ::WIMStruct for a WIM file.
853  * @return
854  *      @c true if the WIM has an integrity table; @c false otherwise.
855  */
856 extern bool wimlib_has_integrity_table(const WIMStruct *wim);
857
858
859 /**
860  * Determines if an image name is already used by some image in the WIM.
861  *
862  * @param wim
863  *      Pointer to the ::WIMStruct for a WIM file.
864  * @param name
865  *      The name to check.
866  *
867  * @return
868  *      @c true if there is already an image in @a wim named @a name; @c false
869  *      if there is no image named @a name in @a wim.  (If @a name is @c NULL,
870  *      @c false is returned.)
871  */
872 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
873
874 /**
875  * Joins a set of split WIMs into a one-part WIM.
876  *
877  * @param swms
878  *      An array of strings that give the filenames of all parts of the split
879  *      WIM.
880  * @param num_swms
881  *      Number of filenames in @a swms.
882  * @param output_path
883  *      The path to write the one-part WIM to.
884  * @param flags
885  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY to check the split WIMs' integrity
886  *      tables (if present) when opening them, and include an integrity table in
887  *      the output WIM.
888  *
889  * @return 0 on success; nonzero on error.  This function may return any value
890  * returned by wimlib_open_wim() except ::WIMLIB_ERR_SPLIT_UNSUPPORTED, as well
891  * as the following error codes:
892  *
893  * @retval ::WIMLIB_ERR_SPLIT_INVALID
894  *      The split WIMs do not form a valid WIM because they do not include all
895  *      the parts of the original WIM, there are duplicate parts, or not all the
896  *      parts have the same GUID and compression type.
897  * @retval ::WIMLIB_ERR_WRITE
898  *      An error occurred when trying to write data to the new WIM at @a output_path.
899  *
900  * Note that this function merely copies the resources, so it will not check to
901  * see if the resources, including the metadata resources, are valid or not.
902  *
903  * Also, after this function is called, the only function that may be called on
904  * the ::WIMStruct's in the @a swms array is wimlib_free().
905  */
906 extern int wimlib_join(const char **swms, unsigned num_swms,
907                        const char *output_path, int flags);
908
909 /**
910  * Mounts an image in a WIM file on a directory read-only or read-write.
911  *
912  * A daemon will be forked to service the filesystem.
913  *
914  * If the mount is read-write, modifications to the WIM are staged in a staging
915  * directory.
916  *
917  * wimlib_mount() may be called from multiple threads without intervening calls
918  * to wimlib_unmount(), provided that different ::WIMStruct's are used.  (This
919  * was not the case for versions of this library 1.0.3 and earlier.)
920  *
921  * wimlib_mount() cannot be used on an image that was exported with
922  * wimlib_export_image() while the dentry trees for both images are still in
923  * memory.  In addition, wimlib_mount() may not be used to mount an image that
924  * has just been added with wimlib_add_image() or
925  * wimlib_add_image_from_ntfs_volume(), unless the WIM has been written and read
926  * into a new ::WIMStruct.
927  *
928  * @param wim
929  *      Pointer to the ::WIMStruct for the WIM file to be mounted.
930  * @param image
931  *      The number of the image to mount, numbered from 1.  It must be an
932  *      existing, single image.
933  * @param dir
934  *      The path to an existing directory to mount the image on.
935  * @param flags
936  *      Bitwise OR of the flags prefixed with WIMLIB_MOUNT_FLAG.  If
937  *      ::WIMLIB_MOUNT_FLAG_READWRITE is not given, the WIM is mounted
938  *      read-only.  The interface to the WIM named data streams is specified by
939  *      exactly one of ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_NONE,
940  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_XATTR, or
941  *      ::WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS.  The default interface is
942  *      the XATTR interface.
943  * @param additional_swms
944  *      Array of pointers to the ::WIMStruct for each additional part in the
945  *      split WIM.  Ignored if @a num_additional_swms is 0.  The pointers do not
946  *      need to be in any particular order, but they must include all parts of
947  *      the split WIM other than the first part, which must be provided in the
948  *      @a wim parameter.
949  * @param num_additional_swms
950  *      Number of additional WIM parts provided in the @a additional_swms array.
951  *      This number should be one less than the total number of parts in the
952  *      split WIM.  Set to 0 if the WIM is a standalone WIM.
953  *
954  * @return 0 on success; nonzero on error.
955  * @retval ::WIMLIB_ERR_DECOMPRESSION
956  *      Could not decompress the metadata resource for @a image in @a wim.
957  * @retval ::WIMLIB_ERR_FUSE
958  *      A non-zero status was returned by @c fuse_main().
959  * @retval ::WIMLIB_ERR_INVALID_DENTRY
960  *      A directory entry in the metadata resource for @a image in @a wim is
961  *      invalid.
962  * @retval ::WIMLIB_ERR_INVALID_IMAGE
963  *      @a image does not specify an existing, single image in @a wim.
964  * @retval ::WIMLIB_ERR_INVALID_PARAM
965  *      @a image is shared among multiple ::WIMStruct's as a result of a call to
966  *      wimlib_export_image(), or @a image has been added with
967  *      wimlib_add_image() or wimlib_add_image_from_ntfs_volume().
968  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
969  *      The metadata resource for @a image in @a wim is invalid.
970  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
971  *      The security data for @a image in @a wim is invalid.
972  * @retval ::WIMLIB_ERR_MKDIR
973  *      ::WIMLIB_MOUNT_FLAG_READWRITE was specified in @a flags, but the staging
974  *      directory could not be created.
975  * @retval ::WIMLIB_ERR_NOMEM
976  *      Failed to allocate needed memory.
977  * @retval ::WIMLIB_ERR_NOTDIR
978  *      Could not determine the current working directory.
979  * @retval ::WIMLIB_ERR_READ
980  *      An unexpected end-of-file or read error occurred when trying to read
981  *      data from the WIM file associated with @a wim.
982  * @retval ::WIMLIB_ERR_SPLIT_INVALID
983  *      The WIM is a split WIM, but the parts specified do not form a complete
984  *      split WIM because they do not include all the parts of the original WIM,
985  *      there are duplicate parts, or not all the parts have the same GUID and
986  *      compression type.
987  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
988  *      The WIM is a split WIM and a read-write mount was requested.  We only
989  *      support mounting a split WIM read-only.
990  */
991 extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
992                         WIMStruct **additional_swms,
993                         unsigned num_additional_swms);
994
995 /**
996  * Opens a WIM file and creates a ::WIMStruct for it.
997  *
998  * @param wim_file
999  *      The path to the WIM file to open.
1000  * @param flags
1001  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1002  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1003  *      If ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY is given, the integrity table
1004  *      of the WIM, if it exists, is checked, and the function will fail with an
1005  *      ::WIMLIB_ERR_INTEGRITY status if any of the computed SHA1 message
1006  *      digests of the WIM do not exactly match the corresponding message
1007  *      digests given in the integrity table.
1008  *      If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
1009  *      be shown if the integrity of the WIM is checked.
1010  *      If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
1011  *      WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
1012  *      returned.  (This flag may be removed in the future, in which case no
1013  *      error will be issued when opening a split WIM.)
1014  *
1015  * @param wim_ret
1016  *      On success, a pointer to an opaque ::WIMStruct for the opened WIM file
1017  *      is written to the memory location pointed to by this parameter.  The
1018  *      ::WIMStruct must be freed using using wimlib_free() when finished with
1019  *      it.
1020  *
1021  * @return 0 on success; nonzero on error.
1022  * @retval ::WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE
1023  *      The lookup table of @a wim_file is compressed.  Support for this can be
1024  *      added to wimlib if needed, but it appears to be the case that the lookup
1025  *      table is never compressed.
1026  * @retval ::WIMLIB_ERR_IMAGE_COUNT
1027  *      The WIM is not the non-first part of a split WIM, and the number of
1028  *      metadata resources found in the WIM did not match the image count given
1029  *      in the WIM header, or the number of &lt;IMAGE&gt; elements in the XML
1030  *      data for the WIM did not match the image count given in the WIM header.
1031  * @retval ::WIMLIB_ERR_INTEGRITY
1032  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1033  *      wim_file contains an integrity table, but the SHA1 message digest for a
1034  *      chunk of the WIM does not match the corresponding message digest given
1035  *      in the integrity table.
1036  * @retval ::WIMLIB_ERR_INVALID_CHUNK_SIZE
1037  *      Resources in @a wim_file are compressed, but the chunk size is not 32768.
1038  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
1039  *      The header of @a wim_file says that resources in the WIM are compressed,
1040  *      but the header flag indicating LZX or XPRESS compression is not set.
1041  * @retval ::WIMLIB_ERR_INVALID_HEADER_SIZE
1042  *      The length field of the WIM header is not 208.
1043  * @retval ::WIMLIB_ERR_INVALID_INTEGRITY_TABLE
1044  *      ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY was specified in @a flags and @a
1045  *      wim_file contains an integrity table, but the integrity table is
1046  *      invalid.
1047  * @retval ::WIMLIB_ERR_INVALID_LOOKUP_TABLE_ENTRY
1048  *      The lookup table for the WIM contained duplicate entries, or it
1049  *      contained an entry with a SHA1 message digest of all 0's.
1050  * @retval ::WIMLIB_ERR_NOMEM
1051  *      Failed to allocated needed memory.
1052  * @retval ::WIMLIB_ERR_NOT_A_WIM_FILE
1053  *      @a wim_file does not begin with the expected magic characters.
1054  * @retval ::WIMLIB_ERR_OPEN
1055  *      Failed to open the file @a wim_file for reading.
1056  * @retval ::WIMLIB_ERR_READ
1057  *      An unexpected end-of-file or read error occurred when trying to read
1058  *      data from @a wim_file.
1059  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1060  *      @a wim_file is a split WIM, but ::WIMLIB_OPEN_FLAG_SPLIT_OK was not
1061  *      givin in @a flags.
1062  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
1063  *      A number other than 0x10d00 is written in the version field of the WIM
1064  *      header of @a wim_file.
1065  * @retval ::WIMLIB_ERR_XML
1066  *      The XML data for @a wim_file is invalid.
1067  */
1068 extern int wimlib_open_wim(const char *wim_file, int flags,
1069                            WIMStruct **wim_ret);
1070
1071 /**
1072  * Overwrites the file that the WIM was originally read from, with changes made.
1073  *
1074  * The new WIM is written to a temporary file and then renamed to the original
1075  * file after it is has been completely written.  The temporary file currently
1076  * is made in the same directory as the original WIM file.
1077  *
1078  * After this function returns, @a wim must be freed using wimlib_free().  Any
1079  * further actions on @a wim before doing this are undefined.
1080  *
1081  * @param wim
1082  *      Pointer to the ::WIMStruct for the WIM file to write.  There may have
1083  *      been in-memory changes made to it, which are then reflected in the
1084  *      output file.
1085  * @param write_flags
1086  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1087  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1088  * @param num_threads
1089  *      Number of threads to use for compression (see wimlib_write()).
1090  *
1091  * @return 0 on success; nonzero on error.  This function may return any value
1092  * returned by wimlib_write() as well as the following error codes:
1093  * @retval ::WIMLIB_ERR_NO_FILENAME
1094  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1095  *      than a WIM read with wimlib_open_wim().
1096  * @retval ::WIMLIB_ERR_RENAME
1097  *      The temporary file that the WIM was written to could not be renamed to
1098  *      the original filename of @a wim.
1099  */
1100 extern int wimlib_overwrite(WIMStruct *wim, int write_flags,
1101                             unsigned num_threads);
1102
1103 /**
1104  * Updates the header and XML data of the WIM file, without the need to write
1105  * out the entire WIM to a temporary file as in wimlib_write().
1106  *
1107  * This function must only be used if no files, directories, or images have been
1108  * added, removed, or changed in the WIM.  It must be used when only the boot
1109  * index or the name or description of image(s) has been changed.
1110  *
1111  * After this function returns, @a wim must be freed using wimlib_free().  Any
1112  * further actions on @a wim before doing this are undefined.
1113  *
1114  * @param wim
1115  *      Pointer to the ::WIMStruct for the WIM file to overwrite.
1116  * @param write_flags
1117  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1118  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.
1119  *
1120  * @return 0 on success; nonzero on error.
1121  *
1122  * @retval ::WIMLIB_ERR_NO_FILENAME
1123  *      @a wim corresponds to a WIM created with wimlib_create_new_wim() rather
1124  *      than a WIM read with wimlib_open_wim().
1125  * @retval ::WIMLIB_ERR_NOMEM
1126  *      Failed to allocate needed memory.
1127  * @retval ::WIMLIB_ERR_OPEN
1128  *      The WIM file associated with @a wim could not be re-opened read-write.
1129  * @retval ::WIMLIB_ERR_READ
1130  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY was specified in @a flags, but data
1131  *      from the WIM file associated with @a wim could not be read to compute
1132  *      the SHA1 message digests, or the old integrity table (if it existed)
1133  *      could not be read.
1134  * @retval ::WIMLIB_ERR_RESOURCE_ORDER
1135  *      Stream resources appeared in the WIM after the XML data or integrity
1136  *      table, so we could not safely overwrite the XML data and integrity
1137  *      table.  Note: this error should never be received from WIMs that were
1138  *      written by this library.
1139  * @retval ::WIMLIB_ERR_WRITE
1140  *      Failed to write the WIM header, the XML data, or the integrity table to
1141  *      the WIM file associated with @a wim.
1142  */
1143 extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int write_flags);
1144
1145 /**
1146  * Prints information about one image, or all images, contained in a WIM.
1147  *
1148  * @param wim
1149  *      Pointer to the ::WIMStruct for a WIM file.
1150  * @param image
1151  *      The image about which to print information.  Can be the number of an
1152  *      image, or ::WIM_ALL_IMAGES to print information about all images in the
1153  *      WIM.
1154  *
1155  * @return This function has no return value.  No error checking is done when
1156  * printing the information.  If @a image is invalid, an error message is
1157  * printed.
1158  */
1159 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
1160
1161 /**
1162  * Prints the full paths to all files contained in an image, or all images, in a
1163  * WIM file.
1164  *
1165  * @param wim
1166  *      Pointer to the ::WIMStruct for a WIM file.
1167  * @param image
1168  *      Which image to print files for.  Can be the number of an image, or
1169  *      ::WIM_ALL_IMAGES to print the files contained in all images.
1170  *
1171  * @return 0 on success; nonzero on error.
1172  * @retval ::WIMLIB_ERR_DECOMPRESSION
1173  *      The metadata resource for one of the specified images could not be
1174  *      decompressed.
1175  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1176  *      A directory entry in the metadata resource for one of the specified
1177  *      images is invaled.
1178  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1179  *      @a image does not specify a valid image in @a wim, and is not
1180  *      ::WIM_ALL_IMAGES.
1181  * @retval ::WIMLIB_ERR_INVALID_PARAM
1182  *      @a wim was @c NULL.
1183  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1184  *      The metadata resource for one of the specified images is invalid.
1185  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1186  *      The security data for one of the specified images is invalid.
1187  * @retval ::WIMLIB_ERR_NOMEM
1188  *      Failed to allocate needed memory.
1189  * @retval ::WIMLIB_ERR_READ
1190  *      An unexpected read error or end-of-file occurred when reading the
1191  *      metadata resource for one of the specified images.
1192  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1193  *      @a wim was not a standalone WIM and was not the first part of a split
1194  *      WIM.
1195  */
1196 extern int wimlib_print_files(WIMStruct *wim, int image);
1197
1198 /**
1199  * Prints detailed information from the header of a WIM file.
1200  *
1201  * @param wim
1202  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1203  *      standalone WIM or part of a split WIM.
1204  *
1205  * @return This function has no return value.
1206  *
1207  */
1208 extern void wimlib_print_header(const WIMStruct *wim);
1209
1210 /**
1211  * Prints the lookup table of a WIM file.  The lookup table maps SHA1 message
1212  * digests, as found in the directory entry tree in the WIM file, to file
1213  * resources in the WIM file.  This table includes one entry for each unique
1214  * file in the WIM, so it can be quite long.  There is only one lookup table per
1215  * WIM.
1216  *
1217  * @param wim
1218  *      Pointer to the ::WIMStruct for a WIM file.
1219  *
1220  * @return This function has no return value.
1221  */
1222 extern void wimlib_print_lookup_table(WIMStruct *wim);
1223
1224 /**
1225  * Prints the metadata of the specified image in a WIM file.  The metadata
1226  * consists of the security data as well as the directory entry tree, and each
1227  * image has its own metadata.
1228  *
1229  * @param wim
1230  *      Pointer to the ::WIMStruct for a WIM file.
1231  * @param image
1232  *      Which image to print the metadata for.  Can be the number of an image,
1233  *      or ::WIM_ALL_IMAGES to print the metadata for all images in the WIM.
1234  *
1235  * @return 0 on success; nonzero on error.
1236  * @retval ::WIMLIB_ERR_DECOMPRESSION
1237  *      The metadata resource for one of the specified images could not be
1238  *      decompressed.
1239  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1240  *      A directory entry in the metadata resource for one of the specified
1241  *      images is invaled.
1242  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1243  *      @a image does not specify a valid image in @a wim, and is not
1244  *      ::WIM_ALL_IMAGES.
1245  * @retval ::WIMLIB_ERR_INVALID_PARAM
1246  *      @a wim was @c NULL.
1247  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1248  *      The metadata resource for one of the specified images is invalid.
1249  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1250  *      The security data for one of the specified images is invalid.
1251  * @retval ::WIMLIB_ERR_NOMEM
1252  *      Failed to allocate needed memory.
1253  * @retval ::WIMLIB_ERR_READ
1254  *      An unexpected read error or end-of-file occurred when reading the
1255  *      metadata resource for one of the specified images.
1256  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1257  *      @a wim was not a standalone WIM and was not the first part of a split
1258  *      WIM.
1259  */
1260 extern int wimlib_print_metadata(WIMStruct *wim, int image);
1261
1262 /**
1263  * Prints some basic information about a WIM file.  All information printed by
1264  * this function is also printed by wimlib_print_header(), but
1265  * wimlib_print_wim_information() prints some of this information more concisely
1266  * and in a more readable form.
1267  *
1268  * @param wim
1269  *      Pointer to the ::WIMStruct for a WIM file.
1270  *
1271  * @return This function has no return value.
1272  */
1273 extern void wimlib_print_wim_information(const WIMStruct *wim);
1274
1275 /**
1276  * Translates a string specifying the name or number of an image in the WIM into
1277  * the number of the image.  The images are numbered starting at 1.
1278  *
1279  * @param wim
1280  *      Pointer to the ::WIMStruct for a WIM file.
1281  * @param image_name_or_num
1282  *      A string specifying which image.  If it begins with a number, it is
1283  *      taken to be a string specifying the image number.  Otherwise, it is
1284  *      taken to be the name of an image, as specified in the XML data for the
1285  *      WIM file.  It also may be the keyword "all" or the string "*", both of
1286  *      which will resolve to ::WIM_ALL_IMAGES.
1287  *
1288  * @return
1289  *      If the string resolved to a single existing image, the number of that
1290  *      image, counting starting at 1, is returned.  If the keyword "all" was
1291  *      specified, ::WIM_ALL_IMAGES is returned.  Otherwise, ::WIM_NO_IMAGE is
1292  *      returned.
1293  */
1294 extern int wimlib_resolve_image(WIMStruct *wim, const char *image_name_or_num);
1295
1296 /**
1297  * Sets which image in the WIM is marked as bootable.
1298  *
1299  * @param wim
1300  *      Pointer to the ::WIMStruct for a WIM file.
1301  * @param boot_idx
1302  *      The number of the image to mark as bootable, or 0 to mark no image as
1303  *      bootable.
1304  * @return 0 on success; nonzero on error.
1305  * @retval ::WIMLIB_ERR_INVALID_PARAM
1306  *      @a wim was @c NULL.
1307  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1308  *      @a boot_idx does not specify an existing image in @a wim, and it was not
1309  *      0.
1310  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1311  *      @a wim is part of a split WIM.  We do not support changing the boot
1312  *      index of a split WIM.
1313  */
1314 extern int wimlib_set_boot_idx(WIMStruct *wim, int boot_idx);
1315
1316 /**
1317  * Changes the description of an image in the WIM.
1318  *
1319  * @param wim
1320  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1321  *      standalone WIM or part of a split WIM; however, you should set the same
1322  *      description on all parts of a split WIM.
1323  * @param image
1324  *      The number of the image for which to change the description.
1325  * @param description
1326  *      The new description to give the image.  It may be @c NULL, which
1327  *      indicates that the image is to be given no description.
1328  *
1329  * @return 0 on success; nonzero on error.
1330  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1331  *      @a image does not specify a single existing image in @a wim.
1332  * @retval ::WIMLIB_ERR_INVALID_PARAM
1333  *      @a wim was @c NULL.
1334  * @retval ::WIMLIB_ERR_NOMEM
1335  *      Failed to allocate the memory needed to duplicate the @a description
1336  *      string.
1337  */
1338 extern int wimlib_set_image_descripton(WIMStruct *wim, int image,
1339                                        const char *description);
1340
1341 /**
1342  * Changes what is written in the \<FLAGS\> element in the WIM XML data
1343  * (something like "Core" or "Ultimate")
1344  *
1345  * @param wim
1346  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1347  *      standalone WIM or part of a split WIM; however, you should set the same
1348  *      \<FLAGS\> element on all parts of a split WIM.
1349  * @param image
1350  *      The number of the image for which to change the description.
1351  * @param flags
1352  *      The new \<FLAGS\> element to give the image.  It may be @c NULL, which
1353  *      indicates that the image is to be given no \<FLAGS\> element.
1354  *
1355  * @return 0 on success; nonzero on error.
1356  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1357  *      @a image does not specify a single existing image in @a wim.
1358  * @retval ::WIMLIB_ERR_INVALID_PARAM
1359  *      @a wim was @c NULL.
1360  * @retval ::WIMLIB_ERR_NOMEM
1361  *      Failed to allocate the memory needed to duplicate the @a flags string.
1362  */
1363 extern int wimlib_set_image_flags(WIMStruct *wim, int image, const char *flags);
1364
1365 /**
1366  * Changes the name of an image in the WIM.
1367  *
1368  * @param wim
1369  *      Pointer to the ::WIMStruct for a WIM file.  It may be either a
1370  *      standalone WIM or part of a split WIM; however, you should set the same
1371  *      name on all parts of a split WIM.
1372  * @param image
1373  *      The number of the image for which to change the name.
1374  * @param name
1375  *      The new name to give the image.  It must not a nonempty string.
1376  *
1377  * @return 0 on success; nonzero on error.
1378  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
1379  *      There is already an image named @a name in @a wim.
1380  * @retval ::WIMLIB_ERR_INVALID_PARAM
1381  *      @a name was @c NULL or the empty string, or @a wim was @c NULL.
1382  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1383  *      @a image does not specify a single existing image in @a wim.
1384  * @retval ::WIMLIB_ERR_NOMEM
1385  *      Failed to allocate the memory needed to duplicate the @a name string.
1386  */
1387 extern int wimlib_set_image_name(WIMStruct *wim, int image, const char *name);
1388
1389 /**
1390  * Set the functions that wimlib uses to allocate and free memory.
1391  *
1392  * These settings are global and not per-WIM.
1393  *
1394  * The default is to use the default @c malloc() and @c free() from the C
1395  * library.
1396  *
1397  * Please note that some external functions we call still may use the standard
1398  * memory allocation functions.
1399  *
1400  * @param malloc_func
1401  *      A function equivalent to @c malloc() that wimlib will use to allocate
1402  *      memory.  If @c NULL, the allocator function is set back to the default
1403  *      @c malloc() from the C library.
1404  * @param free_func
1405  *      A function equivalent to @c free() that wimlib will use to free memory.
1406  *      If @c NULL, the free function is set back to the default @c free() from
1407  *      the C library.
1408  * @param realloc_func
1409  *      A function equivalent to @c realloc() that wimlib will use to reallocate
1410  *      memory.  If @c NULL, the free function is set back to the default @c
1411  *      realloc() from the C library.
1412  * @return 0 on success; nonzero on error.
1413  * @retval ::WIMLIB_ERR_UNSUPPORTED
1414  *      wimlib was compiled with the @c --without-custom-memory-allocator flag,
1415  *      so custom memory allocators are unsupported.
1416  */
1417 int wimlib_set_memory_allocator(void *(*malloc_func)(size_t),
1418                                  void (*free_func)(void *),
1419                                  void *(*realloc_func)(void *, size_t));
1420
1421 /**
1422  * Sets whether wimlib is to print error messages to @c stderr when a function
1423  * fails.  These error messages may provide information that cannot be
1424  * determined only from the error code that is returned.  Not every error will
1425  * result in an error message being printed.
1426  *
1427  * This setting is global and not per-WIM.
1428  *
1429  * By default, error messages are not printed.
1430  *
1431  * @param show_messages
1432  *      @c true if error messages are to be printed; @c false if error messages
1433  *      are not to be printed.
1434  *
1435  * @return 0 on success; nonzero on error.
1436  * @retval ::WIMLIB_ERR_UNSUPPORTED
1437  *      @a show_messages was @c true, but wimlib was compiled with the @c
1438  *      --without-error-messages option.   Therefore, error messages cannot be
1439  *      shown.
1440  */
1441 extern int wimlib_set_print_errors(bool show_messages);
1442
1443 /**
1444  * Splits a WIM into multiple parts.
1445  *
1446  * @param wimfile
1447  *      Name of the WIM file to split.  It must be a standalone, one-part WIM.
1448  * @param swm_name
1449  *      Name of the SWM file to create.  This will be the name of the first
1450  *      part.  The other parts will have the same name with 2, 3, 4, ..., etc.
1451  *      appended.
1452  * @param part_size
1453  *      The maximum size per part, in bytes.  It is not guaranteed that this
1454  *      will really be the maximum size per part, because some file resources in
1455  *      the WIM may be larger than this size, and the WIM file format provides
1456  *      no way to split up file resources among multiple WIMs.
1457  * @param flags
1458  *      Bitwise OR of ::WIMLIB_OPEN_FLAG_CHECK_INTEGRITY and/or
1459  *      ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS.
1460  *
1461  * @return 0 on success; nonzero on error.  This function may return any value
1462  * returned by wimlib_open_wim() as well as the following error codes:
1463  *
1464  * @retval ::WIMLIB_ERR_WRITE
1465  *      An error occurred when trying to write data to one of the split WIMs.
1466  *
1467  */
1468 extern int wimlib_split(const char *wimfile, const char *swm_name,
1469                         size_t part_size, int flags);
1470
1471 /**
1472  * Unmounts a WIM image that was mounted using wimlib_mount().
1473  *
1474  * Blocks until it is known whether the mount succeeded or failed.
1475  *
1476  * To perform this operation, the process calling wimlib_unmount() communicates
1477  * with the process that had called wimlib_mount().
1478  *
1479  * There is currently a design problem with this function because it is hard to
1480  * know whether the filesystem daemon is still working or whether it has
1481  * crashed, has been killed, or has reached an infinite loop. However, ideally
1482  * there should be no infinite loops or crashes in the code, so this wouldn't be
1483  * much of a problem.  Currently, a timeout of 600 seconds (so long because WIMs
1484  * can be very large) is implemented so that this function will not wait forever
1485  * before returning failure.
1486  *
1487  * @param dir
1488  *      The directory that the WIM image was mounted on.
1489  * @param flags
1490  *      Bitwise OR of the flags ::WIMLIB_UNMOUNT_FLAG_CHECK_INTEGRITY or
1491  *      ::WIMLIB_UNMOUNT_FLAG_COMMIT.  Neither of these flags affect read-only
1492  *      mounts.
1493  *
1494  * @return 0 on success; nonzero on error.
1495  * @retval ::WIMLIB_ERR_DELETE_STAGING_DIR
1496  *      The filesystem daemon was unable to remove the staging directory and the
1497  *      temporary files that it contains.
1498  * @retval ::WIMLIB_ERR_FORK
1499  *      Could not @c fork() the process.
1500  * @retval ::WIMLIB_ERR_FUSERMOUNT
1501  *      The @b fusermount program could not be executed or exited with a failure
1502  *      status.
1503  * @retval ::WIMLIB_ERR_MQUEUE
1504  *      Could not open a POSIX message queue to communicate with the filesystem
1505  *      daemon servicing the mounted filesystem, could not send a message
1506  *      through the queue, or could not receive a message through the queue.
1507  * @retval ::WIMLIB_ERR_NOMEM
1508  *      Failed to allocate needed memory.
1509  * @retval ::WIMLIB_ERR_OPEN
1510  *      The filesystem daemon could not open a temporary file for writing the
1511  *      new WIM.
1512  * @retval ::WIMLIB_ERR_TIMEOUT
1513  *      600 seconds elapsed while waiting for the filesystem daemon to notify
1514  *      the process of its exit status, so the WIM file probably was not written
1515  *      successfully.
1516  * @retval ::WIMLIB_ERR_READ
1517  *      A read error occurred when the filesystem daemon tried to a file from
1518  *      the staging directory
1519  * @retval ::WIMLIB_ERR_RENAME
1520  *      The filesystem daemon failed to rename the newly written WIM file to the
1521  *      original WIM file.
1522  * @retval ::WIMLIB_ERR_WRITE
1523  *      A write error occurred when the filesystem daemon was writing to the new
1524  *      WIM file, or the filesystem daemon was unable to flush changes that had
1525  *      been made to files in the staging directory.
1526  */
1527 extern int wimlib_unmount(const char *dir, int flags);
1528
1529 /**
1530  * Writes the WIM to a file.
1531  *
1532  * @param wim
1533  *      Pointer to the ::WIMStruct for a WIM file.  There may have been
1534  *      in-memory changes made to it, which are then reflected in the output
1535  *      file.
1536  * @param path
1537  *      The path to the file to write the WIM to.
1538  * @param image
1539  *      The image inside the WIM to write.  Use ::WIM_ALL_IMAGES to include all
1540  *      images.
1541  * @param write_flags
1542  *      Bitwise OR of ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY and/or
1543  *      ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS.  If
1544  *      ::WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is given, an integrity table is
1545  *      included in the WIM being written.  If ::WIMLIB_WRITE_FLAG_SHOW_PROGRESS
1546  *      is given, the progress of the calculation of the integrity table is
1547  *      shown.
1548  * @param num_threads
1549  *      Number of threads to use for compressing data.  Autodetected if set to
1550  *      0.  Note: if no data compression needs to be done, no threads will be
1551  *      created regardless of this parameter (e.g. if writing an uncompressed
1552  *      WIM, or exporting an image from a compressed WIM to another WIM of the
1553  *      same compression type).
1554  *
1555  * @return 0 on success; nonzero on error.
1556  * @retval ::WIMLIB_ERR_DECOMPRESSION
1557  *      Failed to decompress a metadata or file resource in @a wim.
1558  * @retval ::WIMLIB_ERR_INVALID_DENTRY
1559  *      A directory entry in the metadata resource for @a image in @a wim is
1560  *      invalid.
1561  * @retval ::WIMLIB_ERR_INVALID_IMAGE
1562  *      @a image does not specify a single existing image in @a wim, and is not
1563  *      ::WIM_ALL_IMAGES.
1564  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_HASH
1565  *      A file that had previously been scanned for inclusion in the WIM by the
1566  *      wimlib_add_image() or wimlib_add_image_from_ntfs_volume() functions was
1567  *      concurrently modified, so it failed the SHA1 message digest check.
1568  * @retval ::WIMLIB_ERR_INVALID_PARAM
1569  *      @a wim or @a path was @c NULL.
1570  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
1571  *      The metadata resource for @a image in @a wim is invalid.
1572  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
1573  *      The security data for @a image in @a wim is invalid.
1574  * @retval ::WIMLIB_ERR_NOMEM
1575  *      Failed to allocate needed memory.
1576  * @retval ::WIMLIB_ERR_OPEN
1577  *      Failed to open @a path for writing, or some file resources in @a
1578  *      wim refer to files in the outside filesystem, and one of these files
1579  *      could not be opened for reading.
1580  * @retval ::WIMLIB_ERR_READ
1581  *      An error occurred when trying to read data from the WIM file associated
1582  *      with @a wim, or some file resources in @a wim refer to files in the
1583  *      outside filesystem, and a read error occurred when reading one of these
1584  *      files.
1585  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
1586  *      @a wim is part of a split WIM.  You may not call this function on a
1587  *      split WIM.
1588  * @retval ::WIMLIB_ERR_WRITE
1589  *      An error occurred when trying to write data to the new WIM file at @a
1590  *      path.
1591  */
1592 extern int wimlib_write(WIMStruct *wim, const char *path, int image,
1593                         int write_flags, unsigned num_threads);
1594
1595
1596
1597 #endif /* _WIMLIB_H */
1598