Allow adding an unnamed image

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index 906a15c796cc78a8c2ed062da0e11d419adec3fb..e021906106e75465e2465db482693a50770fdc3c 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -31,7 +31,7 @@
  *
  * \section intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.4.0, a C
+ * This is the documentation for the library interface of wimlib 1.4.1, a C
  * library for creating, modifying, extracting, and mounting files in the
  * Windows Imaging Format.  This documentation is intended for developers only.
  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
@@ -164,7 +164,7 @@
 #define WIMLIB_MINOR_VERSION 4
 
 /** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 0
+#define WIMLIB_PATCH_VERSION 1
 
 /**
  * Opaque structure that represents a WIM file.  This is an in-memory structure
@@ -722,6 +722,18 @@ struct wimlib_capture_config {
 /** Extract files to standard output rather than to the filesystem. */
 #define WIMLIB_EXTRACT_FLAG_TO_STDOUT                  0x00000400
 
+/** Instead of ignoring files and directories with names that cannot be
+ * represented on the current platform (note: Windows has more restrictions on
+ * filenames than UNIX), try to replace characters or append junk to the names
+ * so that they can be extracted in some form. */
+#define WIMLIB_EXTRACT_FLAG_REPLACE_INVALID_FILENAMES  0x00000800
+
+/** On Windows, when there exist two or more files with the same case
+ * insensitive name but different case sensitive names, try to extract them all
+ * by appending junk to the end of them, rather than arbitrarily extracting only
+ * one. */
+#define WIMLIB_EXTRACT_FLAG_ALL_CASE_CONFLICTS         0x00001000
+
 /******************************
  * WIMLIB_MOUNT_FLAG_*
  ******************************/
@@ -982,15 +994,15 @@ enum wimlib_error_code {
  *     Pointer to the ::WIMStruct for the WIM file to which the image is to be
  *     added.
  * @param name
- *     Name to give the new image.
+ *     Name to give the new image.  If @c NULL or empty, the new image is given
+ *     no name.  If nonempty, it must specify a name that does not already
+ *     exist in @a wim.
  * @param new_idx_ret
  *     If non-<code>NULL</code>, the index of the newly added image is returned
  *     in this location.
  *
  * @return 0 on success; nonzero on failure.  The possible error codes are:
  *
- * @retval ::WIMLIB_ERR_INVALID_PARAM
- *     @a name was @c NULL or an empty string.
  * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
  *     @a wim is part of a split WIM.
  * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
@@ -1025,8 +1037,9 @@ wimlib_add_empty_image(WIMStruct *wim,
  *     A path to a directory or unmounted NTFS volume that will be captured as
  *     a WIM image.
  * @param name
- *     The name to give the image.  It must be nonempty and must specify a name
- *     that does not yet exist in @a wim.
+ *     Name to give the new image.  If @c NULL or empty, the new image is given
+ *     no name.  If nonempty, it must specify a name that does not already
+ *     exist in @a wim.
  * @param config
  *     Capture configuration that specifies files, directories, or path globs
  *     to exclude from being captured.  If @c NULL, a dummy configuration where