WdsCliGetImageIndex function (wdsclientapi.h)

Returns the index within the Windows Imaging Format(WIM) file for the current image.

Syntax

HRESULT WDSCLIAPI WdsCliGetImageIndex(
  [in]  HANDLE hIfh,
  [out] PDWORD pdwValue
);

Parameters

[in] hIfh

A find handle returned by the WdsCliFindFirstImage function. The image referenced by the find handle can be advanced using the WdsCliFindNextImage function.

[out] pdwValue

A pointer to a value that contains the image index for the current image WIM file.

Return value

If the function succeeds, the return is S_OK.

Remarks

This value is valid until the WdsCliFindNextImage or WdsCliClose function is used to change or close the current handle.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wdsclientapi.h
Library WdsClientAPI.lib
DLL WdsClientAPI.dll

See also

WdsCliClose

WdsCliFindFirstImage

WdsCliFindNextImage

Windows Deployment Services Client Functions