WdsCliTransferImage function (wdsclientapi.h)

Article
02/22/2024

Transfers an image from a WDS server to the WDS client.

Syntax

HRESULT WDSCLIAPI WdsCliTransferImage(
  [in]           HANDLE             hImage,
  [in]           PWSTR              pwszLocalPath,
  [in]           DWORD              dwFlags,
  [in]           DWORD              dwReserved,
  [in, optional] PFN_WdsCliCallback pfnWdsCliCallback,
  [in, optional] PVOID              pvUserData,
  [out]          PHANDLE            phTransfer
);

Parameters

[in] hImage

A WDS image handle that refers to a remote image.

[in] pwszLocalPath

A pointer to a null-terminated string value that contains the full path to the local location to store the image file being transferred.

[in] dwFlags

Options associated with the file transfer.

Value	Meaning
WDS_CLI_TRANSFER_ASYNCHRONOUS	This flag specifies an asynchronous transfer.

[in] dwReserved

This parameter is reserved.

[in, optional] pfnWdsCliCallback

A pointer to an optional callback function that will receive callbacks for this transfer.

[in, optional] pvUserData

A pointer to optional user information that can be passed to the callback function.

[out] phTransfer

A pointer to a transfer handle that can be used with the WdsCliWaitForTransfer or WdsCliCancelTransfer functions to wait for the transfer to complete or to cancel the transfer.

Return value

If the function succeeds, the return is S_OK.

Remarks

Call the WdsCliClose function to close the 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

Share via