Mark system compression support non-experimental

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index c95e7635db4f014062caf338ceac69ae9be6c431..bdb2c33ea88e4be8fd6401d7f4929481d34426fc 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -1942,28 +1942,25 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour
 #define WIMLIB_EXTRACT_FLAG_WIMBOOT                    0x00400000
 
 /**
 #define WIMLIB_EXTRACT_FLAG_WIMBOOT                    0x00400000
 
 /**

- * EXPERIMENTAL, Windows-only: compress the extracted files using System
- * Compression, when possible.  This only works on either Windows 10 or later,
- * or on an older Windows to which Microsoft's wofadk.sys driver has been added.
- * Several different compression formats may be used with System Compression;
- * this particular flag selects the XPRESS compression format with 4096 byte
- * chunks.  <b>This flag is currently experimental and may be changed or removed
- * in future releases of wimlib.</b>  */
+ * Since wimlib v1.8.2 and Windows-only: compress the extracted files using
+ * System Compression, when possible.  This only works on either Windows 10 or
+ * later, or on an older Windows to which Microsoft's wofadk.sys driver has been
+ * added.  Several different compression formats may be used with System
+ * Compression; this particular flag selects the XPRESS compression format with
+ * 4096 byte chunks.
+ */

 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K           0x01000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K           0x01000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with

- * 8192 byte chunks.  <b>This flag is currently experimental and may be changed
- * or removed in future releases of wimlib.</b>  */
+ * 8192 byte chunks.  */

 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K           0x02000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with
 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS8K           0x02000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with

- * 16384 byte chunks.  <b>This flag is currently experimental and may be changed
- * or removed in future releases of wimlib.</b>  */
+ * 16384 byte chunks.  */

 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K          0x04000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use LZX compression with
 #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS16K          0x04000000
 
 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use LZX compression with

- * 32768 byte chunks.  <b>This flag is currently experimental and may be changed
- * or removed in future releases of wimlib.</b>  */
+ * 32768 byte chunks.  */

 #define WIMLIB_EXTRACT_FLAG_COMPACT_LZX                        0x08000000
 
 /** @} */
 #define WIMLIB_EXTRACT_FLAG_COMPACT_LZX                        0x08000000
 
 /** @} */


@@ -2433,7 +2430,6 @@ enum wimlib_error_code {
        WIMLIB_ERR_INVALID_UTF8_STRING                = 31,
        WIMLIB_ERR_IS_DIRECTORY                       = 32,
        WIMLIB_ERR_IS_SPLIT_WIM                       = 33,
        WIMLIB_ERR_INVALID_UTF8_STRING                = 31,
        WIMLIB_ERR_IS_DIRECTORY                       = 32,
        WIMLIB_ERR_IS_SPLIT_WIM                       = 33,

-       WIMLIB_ERR_LIBXML_UTF16_HANDLER_NOT_AVAILABLE = 34,

        WIMLIB_ERR_LINK                               = 35,
        WIMLIB_ERR_METADATA_NOT_FOUND                 = 36,
        WIMLIB_ERR_MKDIR                              = 37,
        WIMLIB_ERR_LINK                               = 35,
        WIMLIB_ERR_METADATA_NOT_FOUND                 = 36,
        WIMLIB_ERR_MKDIR                              = 37,


@@ -2480,6 +2476,7 @@ enum wimlib_error_code {
        WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT           = 81,
        WIMLIB_ERR_FVE_LOCKED_VOLUME                  = 82,
        WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG      = 83,
        WIMLIB_ERR_NOT_PERMITTED_TO_UNMOUNT           = 81,
        WIMLIB_ERR_FVE_LOCKED_VOLUME                  = 82,
        WIMLIB_ERR_UNABLE_TO_READ_CAPTURE_CONFIG      = 83,

+       WIMLIB_ERR_WIM_IS_INCOMPLETE                  = 84,

 };
 
 
 };
 
 


@@ -3137,9 +3134,10 @@ wimlib_get_image_name(const WIMStruct *wim, int image);
 /**
  * @ingroup G_wim_information
  *
 /**
  * @ingroup G_wim_information
  *

- * Get a per-image property from the WIM's XML document.  This is an alternative
- * to wimlib_get_image_name() and wimlib_get_image_descripton() which allows
- * getting any simple string property.
+ * Since wimlib v1.8.3: get a per-image property from the WIM's XML document.
+ * This is an alternative to wimlib_get_image_name() and
+ * wimlib_get_image_description() which allows getting any simple string
+ * property.

  *
  * @param wim
  *     Pointer to the ::WIMStruct for the WIM.
  *
  * @param wim
  *     Pointer to the ::WIMStruct for the WIM.


@@ -3153,8 +3151,8 @@ wimlib_get_image_name(const WIMStruct *wim, int image);
  *     element.  The <tt>[</tt> character is reserved for future use.
  *
  * @return
  *     element.  The <tt>[</tt> character is reserved for future use.
  *
  * @return

- *     The property's value as a wimlib_tchar string, or @c NULL if there is no
- *     such property.  The string may not remain valid after later library
+ *     The property's value as a ::wimlib_tchar string, or @c NULL if there is
+ *     no such property.  The string may not remain valid after later library

  *     calls, so the caller should duplicate it if needed.
  */
 extern const wimlib_tchar *
  *     calls, so the caller should duplicate it if needed.
  */
 extern const wimlib_tchar *


@@ -3554,6 +3552,9 @@ wimlib_mount_image(WIMStruct *wim,
  * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
  *     The WIM cannot be opened because it contains encrypted segments.  (It
  *     may be a Windows 8 "ESD" file.)
  * @retval ::WIMLIB_ERR_WIM_IS_ENCRYPTED
  *     The WIM cannot be opened because it contains encrypted segments.  (It
  *     may be a Windows 8 "ESD" file.)

+ * @retval ::WIMLIB_ERR_WIM_IS_INCOMPLETE
+ *     The WIM file is not complete (e.g. the program which wrote it was
+ *     terminated before it finished)

  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
  *     ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
  *     considered read-only because of any of the reasons mentioned in the
  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
  *     ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
  *     considered read-only because of any of the reasons mentioned in the


@@ -3991,8 +3992,8 @@ wimlib_set_image_name(WIMStruct *wim, int image, const wimlib_tchar *name);
 /**
  * @ingroup G_modifying_wims
  *
 /**
  * @ingroup G_modifying_wims
  *

- * Add, modify, or remove a per-image property from the WIM's XML document.
- * This is an alternative to wimlib_set_image_name(),
+ * Since wimlib v1.8.3: add, modify, or remove a per-image property from the
+ * WIM's XML document.  This is an alternative to wimlib_set_image_name(),

  * wimlib_set_image_descripton(), and wimlib_set_image_flags() which allows
  * manipulating any simple string property.
  *
  * wimlib_set_image_descripton(), and wimlib_set_image_flags() which allows
  * manipulating any simple string property.
  *