WdsCliGetImageHandleFromFindHandle function (wdsclientapi.h)

Returns an image handle for the current image in an image enumeration.

Syntax

HRESULT WDSCLIAPI WdsCliGetImageHandleFromFindHandle(
  [in]  HANDLE  FindHandle,
  [out] PHANDLE phImageHandle
);

Parameters

[in] FindHandle

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

[out] phImageHandle

A pointer to a location that contains an image handle for the current image referenced by the find handle.

Return value

If the function succeeds, the return is S_OK.

Remarks

Use the WdsCliClose function to close the image handle returned by this function.

Requirements

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