Skip to content

Latest commit

 

History

History
73 lines (59 loc) · 2.63 KB

nf-wdsclientapi-wdscligetimagehandlefromtransferhandle.md

File metadata and controls

73 lines (59 loc) · 2.63 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:wdsclientapi.WdsCliGetImageHandleFromTransferHandle
WdsCliGetImageHandleFromTransferHandle function (wdsclientapi.h)
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.
WdsCliGetImageHandleFromTransferHandle
WdsCliGetImageHandleFromTransferHandle function [Windows Deployment Services]
wds.wdscligetimagehandlefromtransferhandle
wdsclientapi/WdsCliGetImageHandleFromTransferHandle
wds\wdscligetimagehandlefromtransferhandle.htm
wds
d2356f34-9ef8-4d7d-bb01-843d1aa1cbed
12/05/2018
WdsCliGetImageHandleFromTransferHandle, WdsCliGetImageHandleFromTransferHandle function [Windows Deployment Services], wds.wdscligetimagehandlefromtransferhandle, wdsclientapi/WdsCliGetImageHandleFromTransferHandle
wdsclientapi.h
Windows
Windows Vista with SP1 [desktop apps only]
Windows Server 2008 [desktop apps only]
WdsClientAPI.lib
WdsClientAPI.dll
Windows
19H1
WdsCliGetImageHandleFromTransferHandle
wdsclientapi/WdsCliGetImageHandleFromTransferHandle
c++
APIRef
kbSyntax
DllExport
WdsClientAPI.dll
WdsCliGetImageHandleFromTransferHandle

WdsCliGetImageHandleFromTransferHandle function

-description

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.

-parameters

-param hTransfer

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

-param phImageHandle [out]

A pointer to a location that contains an image handle.

-returns

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.