WdsCliGetImagePath function (wdsclientapi.h)

Returns the path to the file that contains the current image.

Syntax

HRESULT WDSCLIAPI WdsCliGetImagePath(
  [in]  HANDLE hIfh,
  [out] PWSTR  *ppwszValue
);

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] ppwszValue

A pointer to a pointer to a null-terminated string that contains the relative path of the image file for the current image.

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.

To obtain the full path to the image file, prefix the relative path returned in ppWszValue with "\\Server\RemInst".

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