Edit

Share via

WdsCliGetImageHandleFromTransferHandle function (wdsclientapi.h)

  • Article

Returns an image handle from a completed transfer handle. The handle is to the local copy of the image that's been transferred from the server to the client.

Syntax

HRESULT WDSCLIAPI WdsCliGetImageHandleFromTransferHandle(
        HANDLE  hTransfer,
  [out] PHANDLE phImageHandle
);

Parameters

hTransfer

A WDS transfer handle that has completed the transfer. This can be the handle returned by the WdsCliTransferImage or WdsCliTransferFile functions.

[out] phImageHandle

A pointer to a location that contains an image handle.

Return value

If the function succeeds, the return is S_OK.

Remarks

If the transfer is not yet complete when this function is called, it will return an error code.

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