X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=src%2Fwim.c;h=2942863c938859e44d2ba62f2c4c2073492e395a;hb=ee4fcdd5c4924803ae67a09fecac7d6b4b8ead6e;hp=ff4ac29be3e53b7c3d981924ee8f452be0b1dcdc;hpb=b5b9681794d1f5f13350e3567f6f6e74f5c779cf;p=wimlib

diff --git a/src/wim.c b/src/wim.c
index ff4ac29b..2942863c 100644
--- 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)
 {