WdsCliGetImageDescription function (wdsclientapi.h)

Returns a description of the current image.

Syntax

HRESULT WDSCLIAPI WdsCliGetImageDescription(
  [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 value that contains a description of 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.

Requirements

See also

WdsCliClose

WdsCliFindFirstImage

WdsCliFindNextImage

Windows Deployment Services Client Functions