WdsCliTransferFile 函数 (wdsclientapi.h)

  • 项目

使用多播传输协议将文件从 WDS 服务器传输到 WDS 客户端。

语法

HRESULT WDSCLIAPI WdsCliTransferFile(
  [in]           PCWSTR             pwszServer,
  [in]           PCWSTR             pwszNamespace,
  [in]           PCWSTR             pwszRemoteFilePath,
  [in]           PCWSTR             pwszLocalFilePath,
  [in]           DWORD              dwFlags,
  [in]           DWORD              dwReserved,
  [in, optional] PFN_WdsCliCallback pfnWdsCliCallback,
  [in, optional] PVOID              pvUserData,
  [out]          PHANDLE            phTransfer
);

参数

[in] pwszServer

指向包含 WDS 服务器名称的以 null 结尾的字符串值的指针。

[in] pwszNamespace

指向包含映像的多播命名空间名称的以 null 结尾的字符串值的指针。

[in] pwszRemoteFilePath

指向以 null 结尾的字符串值的指针，该值包含要从中复制要从中传输的文件的远程位置的完整路径。

[in] pwszLocalFilePath

指向以 null 结尾的字符串值的指针，该值包含用于存储要传输的文件的本地位置的完整路径。

[in] dwFlags

与文件传输关联的选项。

值 含义
WDS_CLI_TRANSFER_ASYNCHRONOUS
 此标志指定异步传输。

[in] dwReserved

此参数为保留参数。

[in, optional] pfnWdsCliCallback

指向此传输的可选回调函数的指针。

[in, optional] pvUserData

指向可传递给回调函数的可选用户信息的指针。

[out] phTransfer

指向可与 WdsCliWaitForTransfer 或 WdsCliCancelTransfer 函数一起使用以等待传输完成或取消传输的传输句柄的指针。

返回值

如果函数成功，则 返回S_OK。

注解

调用 WdsCliClose 函数以关闭此函数返回的句柄。

要求

要求 值
最低受支持的客户端 Windows Vista SP1 [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 wdsclientapi.h
Library WdsClientAPI.lib
DLL WdsClientAPI.dll