Update mount implementation

[wimlib] / src / wim.c

diff --git a/src/wim.c b/src/wim.c
index ff4ac29be3e53b7c3d981924ee8f452be0b1dcdc..2942863c938859e44d2ba62f2c4c2073492e395a 100644 (file)
--- a/src/wim.c
+++ b/src/wim.c
@@ -328,8 +328,22 @@ new_image_metadata_array(unsigned num_images)
 }
 
 
-/* Load the metadata for the specified WIM image into memory and set it as the
- * WIMStruct's currently selected WIM image.  */
+/*
+ * Load the metadata for the specified WIM image into memory and set it
+ * as the WIMStruct's currently selected image.
+ *
+ * @wim
+ *     The WIMStruct for the WIM.
+ * @image
+ *     The 1-based index of the image in the WIM to select.
+ *
+ * On success, 0 will be returned, wim->current_image will be set to
+ * @image, and wim_get_current_image_metadata() can be used to retrieve
+ * metadata information for the image.
+ *
+ * On failure, WIMLIB_ERR_INVALID_IMAGE, WIMLIB_ERR_METADATA_NOT_FOUND,
+ * or another error code will be returned.
+ */
 int
 select_wim_image(WIMStruct *wim, int image)
 {