WdsCliFindFirstImage function (wdsclientapi.h)

Starts the enumeration of images stored on a WDS server and returns a find handle that references the first image.

Syntax

HRESULT WDSCLIAPI WdsCliFindFirstImage(
  [in]  HANDLE  hSession,
  [out] PHANDLE phFindHandle
);

Parameters

[in] hSession

A handle to a session with a WDS server. This was a handle returned by the WdsCliCreateSession function.

[out] phFindHandle

Pointer to a HANDLE value that receives the find handle. If the function succeeds, the find handle will reference the first image stored on the WDS server. If the function is unsuccessful, this parameter is unchanged. Use the WdsCliFindNextImage function to advance the reference of the find handle to the next image.

Return value

If the function succeeds, the return is S_OK.

Remarks

The session must be authenticated to use this function. To authenticate an existing session, call the WdsCliAuthorizeSession function.

The WDS image find handle returned by this function can be used with the WdsCliFindNextImage function to enumerate the images stored on the WDS server.

Requirements

See also

Windows Deployment Services Client Functions