Loads a volume image from a Windows image (.wim) file.

HANDLE
WIMLoadImage(
	HANDLE hWim,
	DWORD  dwImageIndex
	);

Parameters

hWim

[in] A handle to a .wim file returned by the WIMCreateFile function.

dwImageIndex

[in] Specifies the one-based index of the image to load. An image file may store multiple images.

Return Value

If the function succeeds, then the return value is a handle to an object representing the volume image. If the function fails, then the return value is NULL. To obtain extended error information, call the GetLastError function.

Remarks

You must call the WIMSetTemporaryPath function before calling the WIMLoadImage function so the image metadata can be extracted and processed from the temporary location.

Use the WIMCloseHandle function to unload the volume image.

See Also