*
* \section intro Introduction
*
- * This is the documentation for the library interface of wimlib 1.3.3. If you
+ * This is the documentation for the library interface of wimlib 1.4.0. 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
* wimlib_add_image(). This can be done with a ::WIMStruct gotten from
* wimlib_open_wim() or from wimlib_create_new_wim(). wimlib_add_image() can
* also capture a WIM image directly from a NTFS volume if you provide the
- * ::WIMLIB_ADD_IMAGE_FLAG_NTFS flag, provided that wimlib was not compiled with
+ * ::WIMLIB_ADD_FLAG_NTFS flag, provided that wimlib was not compiled with
* the <code>--without-ntfs-3g</code> flag.
*
* To extract an image from a WIM file, call wimlib_extract_image(). You may
#define WIMLIB_MAJOR_VERSION 1
/** Minor version of the library (for example, the 2 in 1.2.5). */
-#define WIMLIB_MINOR_VERSION 3
+#define WIMLIB_MINOR_VERSION 4
/** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 3
+#define WIMLIB_PATCH_VERSION 0
/**
* Opaque structure that represents a WIM file. This is an in-memory structure
/** A directory or file is being scanned. @a info will point to
* ::wimlib_progress_info.scan, and its @a cur_path member will be
- * valid. This message is only sent if ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE
+ * valid. This message is only sent if ::WIMLIB_ADD_FLAG_VERBOSE
* is passed to wimlib_add_image(). */
WIMLIB_PROGRESS_MSG_SCAN_DENTRY,
/*****************************
- * WIMLIB_ADD_IMAGE_FLAG_* *
+ * WIMLIB_ADD_FLAG_*
*****************************/
/** Directly capture a NTFS volume rather than a generic directory. This flag
- * cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE or
- * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA. */
-#define WIMLIB_ADD_IMAGE_FLAG_NTFS 0x00000001
+ * cannot be combined with ::WIMLIB_ADD_FLAG_DEREFERENCE or
+ * ::WIMLIB_ADD_FLAG_UNIX_DATA. */
+#define WIMLIB_ADD_FLAG_NTFS 0x00000001
/** Follow symlinks; archive and dump the files they point to. Cannot be used
- * with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
-#define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE 0x00000002
+ * with ::WIMLIB_ADD_FLAG_NTFS. */
+#define WIMLIB_ADD_FLAG_DEREFERENCE 0x00000002
/** Call the progress function with the message
* ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when each directory or file is starting to
* be scanned. */
-#define WIMLIB_ADD_IMAGE_FLAG_VERBOSE 0x00000004
+#define WIMLIB_ADD_FLAG_VERBOSE 0x00000004
/** Mark the image being added as the bootable image of the WIM. */
-#define WIMLIB_ADD_IMAGE_FLAG_BOOT 0x00000008
+#define WIMLIB_ADD_FLAG_BOOT 0x00000008
/** Store the UNIX owner, group, and mode. This is done by adding a special
* alternate data stream to each regular file, symbolic link, and directory to
* contain this information. Please note that this flag is for convenience
* only; Microsoft's @a imagex.exe will not understand this special information.
- * This flag cannot be combined with ::WIMLIB_ADD_IMAGE_FLAG_NTFS. */
-#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA 0x00000010
+ * This flag cannot be combined with ::WIMLIB_ADD_FLAG_NTFS. */
+#define WIMLIB_ADD_FLAG_UNIX_DATA 0x00000010
/** Do not capture security descriptors. Only has an effect in NTFS capture
* mode, or in Win32 native builds. */
-#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS 0x00000020
+#define WIMLIB_ADD_FLAG_NO_ACLS 0x00000020
/** Fail immediately if the full security descriptor of any file or directory
* cannot be accessed. Only has an effect in Win32 native builds. The default
* behavior without this flag is to first try omitting the SACL from the
* security descriptor, then to try omitting the security descriptor entirely.
* */
-#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS 0x00000040
+#define WIMLIB_ADD_FLAG_STRICT_ACLS 0x00000040
/** Call the progress function with the message
* ::WIMLIB_PROGRESS_MSG_SCAN_DENTRY when a directory or file is excluded from
* capture. This is a subset of the messages provided by
- * ::WIMLIB_ADD_IMAGE_FLAG_VERBOSE. */
-#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE 0x00000080
+ * ::WIMLIB_ADD_FLAG_VERBOSE. */
+#define WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE 0x00000080
/** Reparse-point fixups: Modify absolute symbolic links (or junction points,
* in the case of Windows) that point inside the directory being captured to
* the WIM header or if this is the first image being added.
* WIM_HDR_FLAG_RP_FIX is set if the first image in a WIM is captured with
* reparse point fixups enabled and currently cannot be unset. */
-#define WIMLIB_ADD_IMAGE_FLAG_RPFIX 0x00000100
+#define WIMLIB_ADD_FLAG_RPFIX 0x00000100
/** Don't do reparse point fixups. The default behavior is described in the
- * documentation for ::WIMLIB_ADD_IMAGE_FLAG_RPFIX. */
-#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX 0x00000200
+ * documentation for ::WIMLIB_ADD_FLAG_RPFIX. */
+#define WIMLIB_ADD_FLAG_NORPFIX 0x00000200
+
+#define WIMLIB_ADD_IMAGE_FLAG_NTFS WIMLIB_ADD_FLAG_NTFS
+#define WIMLIB_ADD_IMAGE_FLAG_DEREFERENCE WIMLIB_ADD_FLAG_DEREFERENCE
+#define WIMLIB_ADD_IMAGE_FLAG_VERBOSE WIMLIB_ADD_FLAG_VERBOSE
+#define WIMLIB_ADD_IMAGE_FLAG_BOOT WIMLIB_ADD_FLAG_BOOT
+#define WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA WIMLIB_ADD_FLAG_UNIX_DATA
+#define WIMLIB_ADD_IMAGE_FLAG_NO_ACLS WIMLIB_ADD_FLAG_NO_ACLS
+#define WIMLIB_ADD_IMAGE_FLAG_STRICT_ACLS WIMLIB_ADD_FLAG_STRICT_ACLS
+#define WIMLIB_ADD_IMAGE_FLAG_EXCLUDE_VERBOSE WIMLIB_ADD_FLAG_EXCLUDE_VERBOSE
+#define WIMLIB_ADD_IMAGE_FLAG_RPFIX WIMLIB_ADD_FLAG_RPFIX
+#define WIMLIB_ADD_IMAGE_FLAG_NORPFIX WIMLIB_ADD_FLAG_NORPFIX
+
+/******************************
+ * WIMLIB_DELETE_FLAG_*
+ ******************************/
/** Do not issue an error if the path to delete does not exist. */
#define WIMLIB_DELETE_FLAG_FORCE 0x00000001
-/** Delete a file or directory tree recursively; if not specified, an error is
+/** Delete the file or directory tree recursively; if not specified, an error is
* issued if the path to delete is a directory. */
#define WIMLIB_DELETE_FLAG_RECURSIVE 0x00000002
/******************************
- * WIMLIB_EXPORT_FLAG_* *
+ * WIMLIB_EXPORT_FLAG_*
******************************/
/** See documentation for wimlib_export_image(). */
#define WIMLIB_EXPORT_FLAG_BOOT 0x00000001
/******************************
- * WIMLIB_EXTRACT_FLAG_* *
+ * WIMLIB_EXTRACT_FLAG_*
******************************/
/** Extract the image directly to a NTFS volume rather than a generic directory.
/** Read the WIM file sequentially while extracting the image. */
#define WIMLIB_EXTRACT_FLAG_SEQUENTIAL 0x00000010
-/** Extract special UNIX data captured with ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA.
+/** Extract special UNIX data captured with ::WIMLIB_ADD_FLAG_UNIX_DATA.
* Cannot be used with ::WIMLIB_EXTRACT_FLAG_NTFS. */
#define WIMLIB_EXTRACT_FLAG_UNIX_DATA 0x00000020
* not have permission to set the desired one. */
#define WIMLIB_EXTRACT_FLAG_STRICT_ACLS 0x00000080
-/* Extract equivalent to ::WIMLIB_ADD_IMAGE_FLAG_RPFIX; force reparse-point
+/* Extract equivalent to ::WIMLIB_ADD_FLAG_RPFIX; force reparse-point
* fixups on, so absolute symbolic links or junction points will be fixed to be
* absolute relative to the actual extraction root. Done by default if
* WIM_HDR_FLAG_RP_FIX is set in the WIM header. This flag may only be
#define WIMLIB_EXTRACT_FLAG_TO_STDOUT 0x00000400
/******************************
- * WIMLIB_MOUNT_FLAG_* *
+ * WIMLIB_MOUNT_FLAG_*
******************************/
/** Mount the WIM image read-write rather than the default of read-only. */
#define WIMLIB_MOUNT_FLAG_STREAM_INTERFACE_WINDOWS 0x00000010
/** Use UNIX file owners, groups, and modes if available in the WIM (see
- * ::WIMLIB_ADD_IMAGE_FLAG_UNIX_DATA). */
+ * ::WIMLIB_ADD_FLAG_UNIX_DATA). */
#define WIMLIB_MOUNT_FLAG_UNIX_DATA 0x00000020
/** Allow other users to see the mounted filesystem. (this passes the @c
#define WIMLIB_MOUNT_FLAG_ALLOW_OTHER 0x00000040
/******************************
- * WIMLIB_OPEN_FLAG_* *
+ * WIMLIB_OPEN_FLAG_*
******************************/
/** Verify the WIM contents against the WIM's integrity table, if present. */
#define WIMLIB_OPEN_FLAG_SPLIT_OK 0x00000002
/******************************
- * WIMLIB_UNMOUNT_FLAG_* *
+ * WIMLIB_UNMOUNT_FLAG_*
******************************/
/** Include an integrity table in the WIM after it's been unmounted. Ignored
#define WIMLIB_UNMOUNT_FLAG_RECOMPRESS 0x00000008
/******************************
- * WIMLIB_WRITE_FLAG_* *
+ * WIMLIB_WRITE_FLAG_*
******************************/
/** Include an integrity table in the new WIM file. */
* deleting an image in this way. */
#define WIMLIB_WRITE_FLAG_SOFT_DELETE 0x00000010
+/******************************
+ * WIMLIB_INIT_FLAG_*
+ ******************************/
+
/** Assume that strings are represented in UTF-8, even if this is not the
* locale's character encoding. */
#define WIMLIB_INIT_FLAG_ASSUME_UTF8 0x00000001
-/** XXX */
+/** Specification of an update to perform on a WIM image. */
struct wimlib_update_command {
- enum {
+
+ /** The specific type of update to perform. */
+ enum wimlib_update_op {
+ /** Add a new file or directory tree to the WIM image in a
+ * certain location. */
WIMLIB_UPDATE_OP_ADD = 0,
+
+ /** Delete a file or directory tree from the WIM image. */
WIMLIB_UPDATE_OP_DELETE,
+
+ /** Rename a file or directory tree in the WIM image. */
WIMLIB_UPDATE_OP_RENAME,
} op;
union {
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_ADD operation. */
+ struct wimlib_add_command {
+ /** Filesystem path to the file or directory tree to
+ * add. */
wimlib_tchar *fs_source_path;
+ /** Path, specified from the root of the WIM image, at
+ * which to add the file or directory tree within the
+ * WIM image. */
wimlib_tchar *wim_target_path;
+
+ /** Configuration for excluded files. @c NULL means
+ * exclude no files. */
struct wimlib_capture_config *config;
+
+ /** Bitwise OR of WIMLIB_ADD_FLAG_* flags. */
int add_flags;
} add;
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_DELETE operation. */
+ struct wimlib_delete_command {
+ /** Path, specified from the root of the WIM image, for
+ * the file or directory tree within the WIM image to be
+ * deleted. */
wimlib_tchar *wim_path;
+ /** Bitwise OR of WIMLIB_DELETE_FLAG_* flags. */
int delete_flags;
} delete;
- struct {
+ /** Data for a ::WIMLIB_UPDATE_OP_RENAME operation. */
+ struct wimlib_rename_command {
+ /** Path, specified from the root of the WIM image, for
+ * the source file or directory tree within the WIM
+ * image. */
wimlib_tchar *wim_source_path;
+ /** Path, specified from the root of the WIM image, for
+ * the destination file or directory tree within the WIM
+ * image. */
wimlib_tchar *wim_target_path;
+ /** Reserved; set to 0. */
int rename_flags;
} rename;
};
* See the documentation for each wimlib function to see specifically what error
* codes can be returned by a given function, and what they mean.
*/
-/* Note: these are currently in alphabetic order, but new error codes should be
- * added at the end to maintain a compatible ABI, except when it's being broken
- * anyway. */
enum wimlib_error_code {
WIMLIB_ERR_SUCCESS = 0,
WIMLIB_ERR_ALREADY_LOCKED,
WIMLIB_ERR_PATH_DOES_NOT_EXIST,
WIMLIB_ERR_NOT_A_REGULAR_FILE,
WIMLIB_ERR_IS_DIRECTORY,
+ WIMLIB_ERR_NOTEMPTY,
};
*
* See the manual page for the @b wimlib-imagex program for more information
* about the "normal" capture mode versus the NTFS capture mode (entered by
- * providing the flag ::WIMLIB_ADD_IMAGE_FLAG_NTFS).
+ * providing the flag ::WIMLIB_ADD_FLAG_NTFS).
*
* Note that @b no changes are committed to the underlying WIM file (if
* any) until wimlib_write() or wimlib_overwrite() is called.
* 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. This must be non-@c NULL.
+ * The name to give the image. It must be nonempty and must specify a name
+ * that does not yet 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
* no paths are treated specially is used.
- * @param add_image_flags
- * Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
+ * @param add_flags
+ * Bitwise OR of flags prefixed with WIMLIB_ADD_FLAG.
* @param progress_func
* If non-NULL, a function that will be called periodically with the
* progress of the current operation.
* discarded so that it appears to be in the same state as when this function
* was called.
*
- * @retval ::WIMLIB_ERR_IMAGE_NAME_COLLISION
- * There is already an image named @a name in @a wim.
- * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
- * @a config was not @c NULL and did not specify a valid image capture
- * configuration.
- * @retval ::WIMLIB_ERR_INVALID_PARAM
- * @a dir was @c NULL, @a name was @c NULL, or @a name was the empty string.
- * @retval ::WIMLIB_ERR_NOMEM
- * Failed to allocate needed memory.
- * @retval ::WIMLIB_ERR_NOTDIR
- * @a source is not a directory (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was
- * not specified in @a add_image_flags).
- * @retval ::WIMLIB_ERR_NTFS_3G
- * An error was returned from a libntfs-3g function when the NTFS volume
- * was being opened, scanned, or closed (only if
- * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags).
- * @retval ::WIMLIB_ERR_OPEN
- * Failed to open a file or directory in the directory tree rooted at @a
- * source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
- * add_image_flags).
- * @retval ::WIMLIB_ERR_READ
- * Failed to read a file in the directory tree rooted at @a source (only if
- * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a add_image_flags).
- * @retval ::WIMLIB_ERR_SPECIAL_FILE
- * The directory tree rooted at @a source contains a special file that is
- * not a directory, regular file, or symbolic link. This currently can
- * only be returned if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not specified in @a
- * add_image_flags, but it may be returned for unsupported NTFS files in
- * the future.
- * @retval ::WIMLIB_ERR_STAT
- * Failed obtain the metadata for a file or directory in the directory tree
- * rooted at @a source (only if ::WIMLIB_ADD_IMAGE_FLAG_NTFS was not
- * specified in @a add_image_flags).
- * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
- * @a wim is part of a split WIM. Adding an image to a split WIM is
- * unsupported.
- * @retval ::WIMLIB_ERR_UNSUPPORTED
- * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags, but
- * wimlib was configured with the @c --without-ntfs-3g flag.
+ * This function is implemented by calling wimlib_add_empty_image(), then
+ * calling wimlib_update_image() with a single "add" command, so any error code
+ * returned by wimlib_add_empty_image() may be returned, as well as any error
+ * codes returned by wimlib_update_image() other than ones documented as only
+ * being returned specifically by an update involving delete or rename commands.
*/
extern int
wimlib_add_image(WIMStruct *wim,
const wimlib_tchar *source,
const wimlib_tchar *name,
const struct wimlib_capture_config *config,
- int add_image_flags,
+ int add_flags,
wimlib_progress_func_t progress_func);
/** This function is equivalent to wimlib_add_image() except it allows for
* when trying to overlay a non-directory on a directory or when otherwise
* trying to overlay multiple conflicting files to the same location in the WIM
* image. It will also return ::WIMLIB_ERR_INVALID_PARAM if
- * ::WIMLIB_ADD_IMAGE_FLAG_NTFS was specified in @a add_image_flags but there
+ * ::WIMLIB_ADD_FLAG_NTFS was specified in @a add_flags but there
* was not exactly one capture source with the target being the root directory.
* (In this respect, there is no advantage to using
* wimlib_add_image_multisource() instead of wimlib_add_image() when requesting
* NTFS mode.) */
extern int
-wimlib_add_image_multisource(WIMStruct *w,
+wimlib_add_image_multisource(WIMStruct *wim,
const struct wimlib_capture_source *sources,
size_t num_sources,
const wimlib_tchar *name,
const struct wimlib_capture_config *config,
- int add_image_flags,
+ int add_flags,
wimlib_progress_func_t progress_func);
/**
* wimlib_write() or wimlib_overwrite() on @a dest_wim because @a dest_wim will
* have references back to @a src_wim.
*
- * Previous versions of this function left @a dest_wim in an indeterminate state
- * on failure. This is no longer the case; all changes to @a dest_wim made by
- * this function are rolled back on failure.
+ * If this function fails, all changes to @a dest_wim are rolled back.
*
- * Previous versions of this function did not allow exporting an image that had
- * been added by wimlib_add_image(). This is no longer the case; you may now
- * export an image regardless of how it was added.
- *
- * Regardless of whether this function succeeds or fails, no changes are made to
- * @a src_wim.
+ * No changes shall be made to @a src_wim by this function.
*
* Please note that no changes are committed to the underlying WIM file of @a
* dest_wim (if any) until wimlib_write() or wimlib_overwrite() is called.
* If non-NULL, a function that will be called periodically with the
* progress of the current operation.
*
- * @return 0 on success; nonzero on error. There are many possible error codes
- * (TODO: document them.)
+ * @return 0 on success; nonzero on error. On failure, some but not all of the
+ * update commands may have been executed. No individual update command will
+ * have been partially executed. Possible error codes include:
+ *
+ * @retval ::WIMLIB_ERR_DECOMPRESSION
+ * Failed to decompress the metadata resource from @a image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_CAPTURE_CONFIG
+ * The capture configuration structure specified for an add command was
+ * invalid.
+ * @retval ::WIMLIB_ERR_INVALID_DENTRY
+ * A directory entry for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_IMAGE
+ * @a image did not specify a single, existing image in @a wim.
+ * @retval ::WIMLIB_ERR_INVALID_OVERLAY
+ * Attempted to perform an add command that conflicted with previously
+ * existing files in the WIM when an overlay was attempted.
+ * @retval ::WIMLIB_ERR_INVALID_PARAM
+ * An unknown operation type was specified in the update commands; or,
+ * attempted to execute an add command where ::WIMLIB_ADD_FLAG_NTFS was set
+ * in the @a add_flags, but the same image had previously already been
+ * added from a NTFS volume; or, both ::WIMLIB_ADD_FLAG_RPFIX and
+ * ::WIMLIB_ADD_FLAG_NORPFIX were specified in the @a add_flags for one add
+ * command; or, ::WIMLIB_ADD_FLAG_NTFS or ::WIMLIB_ADD_FLAG_RPFIX were
+ * specified in the @a add_flags for an add command in which @a
+ * wim_target_path was not the root directory of the WIM image.
+ * @retval ::WIMLIB_ERR_INVALID_REPARSE_DATA
+ * (Windows only): While executing an add command, tried to capture a
+ * reparse point with invalid data.
+ * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
+ * The metadata resource for @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
+ * The security data for image @a image in @a wim is invalid.
+ * @retval ::WIMLIB_ERR_IS_DIRECTORY
+ * A delete command without ::WIMLIB_DELETE_FLAG_RECURSIVE specified was
+ * for a WIM path that corresponded to a directory; or, a rename command
+ * attempted to rename a directory to a non-directory.
+ * @retval ::WIMLIB_ERR_NOMEM
+ * Failed to allocate needed memory.
+ * @retval ::WIMLIB_ERR_NOTDIR
+ * A rename command attempted to rename a directory to a non-directory; or,
+ * an add command was executed that attempted to set the root of the WIM
+ * image as a non-directory.
+ * @retval ::WIMLIB_ERR_NOTEMPTY
+ * A rename command attempted to rename a directory to a non-empty
+ * directory.
+ * @retval ::WIMLIB_ERR_NTFS_3G
+ * While executing an add command with ::WIMLIB_ADD_FLAG_NTFS specified, an
+ * error occurred while reading data from the NTFS volume using libntfs-3g.
+ * @retval ::WIMLIB_ERR_OPEN
+ * Failed to open a file to be captured while executing an add command.
+ * @retval ::WIMLIB_ERR_OPENDIR
+ * Failed to open a file to be captured while executing an add command.
+ * @retval ::WIMLIB_ERR_PATH_DOES_NOT_EXIST
+ * A delete command without ::WIMLIB_DELETE_FLAG_FORCE specified was for a
+ * WIM path that did not exist; or, a component of the path of the source
+ * or destination of a rename command was used as a directory but was not,
+ * in fact, a directory.
+ * @retval ::WIMLIB_ERR_READ
+ * Failed to read the metadata resource for @a image in @a wim; or, while
+ * executing an add command, failed to read data from a file or directory
+ * to be captured.
+ * @retval ::WIMLIB_ERR_READLINK
+ * While executing an add command, failed to read the target of a symbolic
+ * link or junction point.
+ * @retval ::WIMLIB_ERR_REPARSE_POINT_FIXUP_FAILED
+ * (Windows only) Failed to perform a reparse point fixup because of
+ * problems with the data of a reparse point.
+ * @retval ::WIMLIB_ERR_SPECIAL_FILE
+ * While executing an add command, attempted to capture a file that was not
+ * a supported file type, such as a regular file, directory, symbolic link,
+ * or (on Windows) a reparse point.
+ * @retval ::WIMLIB_ERR_SPLIT_UNSUPPORTED
+ * @a wim is part of a split WIM. Updating a split WIM is unsupported.
+ * @retval ::WIMLIB_ERR_STAT
+ * While executing an add command, failed to get attributes for a file or
+ * directory.
+ * @retval ::WIMLIB_ERR_UNSUPPORTED
+ * ::WIMLIB_ADD_FLAG_NTFS was specified in the @a add_flags for an update
+ * command, but wimlib was configured with the @c --without-ntfs-3g flag;
+ * or, the platform is Windows and either the ::WIMLIB_ADD_FLAG_UNIX_DATA
+ * or the ::WIMLIB_ADD_FLAG_DEREFERENCE flags were specified in the @a
+ * add_flags for an update command.
*/
extern int
wimlib_update_image(WIMStruct *wim,
git://wimlib.net / wimlib / blobdiff