Returns information about an image within the .wim (Windows image) file.

BOOL
WINAPI
WIMGetImageInformation(
	 HANDLE  hImage,
	 PVOID  *ppvImageInfo,
	 PDWORD  pcbImageInfo
	);

Parameters

hImage

[in] A handle returned by the WIMCreateFile, WIMLoadImage, or WIMCaptureImage function.

ppvImageInfo

[out] A pointer to a buffer that receives the address of the XML information about the volume image. When the function returns, this value contains the address of an allocated buffer, containing XML information about the volume image.

pcbImageInfo

[out] A pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the value of the ppvImageInfo parameter.

Return Value

If the function succeeds, then the return value is nonzero.

If the function fails, then the return value is zero. To obtain extended error information, call the GetLastError function.

Remarks

When the function succeeds, then the data describing the image is in Unicode XML format. Use the LocalFree function to free the memory pointed to by the ppvImageInfo parameter when no longer needed.

See Also