*
* \section intro Introduction
*
- * This is the documentation for the library interface of wimlib 1.3.2. If you
+ * This is the documentation for the library interface of wimlib 1.3.3. If you
* have installed wimlib and want to know how to use the @b wimlib-imagex
* program, please see the man pages instead. Also: the actual project page
* where you can download the source code for the library is at <a
#define WIMLIB_MINOR_VERSION 3
/** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 2
+#define WIMLIB_PATCH_VERSION 3
/**
* Opaque structure that represents a WIM file. This is an in-memory structure
* ::WIMLIB_COMPRESSION_TYPE_LZX. */
int compression_type;
+ /** Library internal use only. */
uint64_t _private;
} write_streams;
* added at the end to maintain a compatible ABI, except when it's being broken
* anyway. */
enum wimlib_error_code {
- WIMLIB_ERR_ALREADY_LOCKED = 1,
+ WIMLIB_ERR_SUCCESS = 0,
+ WIMLIB_ERR_ALREADY_LOCKED,
WIMLIB_ERR_COMPRESSED_LOOKUP_TABLE,
WIMLIB_ERR_DECOMPRESSION,
WIMLIB_ERR_DELETE_STAGING_DIR,
WIMLIB_ERR_SPLIT_INVALID,
WIMLIB_ERR_SPLIT_UNSUPPORTED,
WIMLIB_ERR_STAT,
- WIMLIB_ERR_SUCCESS = 0,
WIMLIB_ERR_TIMEOUT,
WIMLIB_ERR_UNICODE_STRING_NOT_REPRESENTABLE,
WIMLIB_ERR_UNKNOWN_VERSION,
*
* As a special requirement, the compression code is optimized for the WIM
* format and therefore requires (@a chunk_size <= 32768).
- *
- * As another special requirement, the compression code will read up to 8 bytes
- * off the end of the @a chunk array for performance reasons. The values of
- * these bytes will not affect the output of the compression, but the calling
- * code must make sure that the buffer holding the uncompressed chunk is
- * actually at least (@a chunk_size + 8) bytes, or at least that these extra
- * bytes are in mapped memory that will not cause a memory access violation if
- * accessed.
*/
extern unsigned
wimlib_lzx_compress(const void *chunk, unsigned chunk_size, void *out);