PFN_WdsCliCallback回调函数 (wdsclientapi.h)

  • 项目

定义一个回调函数，WDS 可以在文件或图像传输期间调用该函数以获取进度通知和错误消息。

语法

PFN_WdsCliCallback PfnWdsclicallback;

void PfnWdsclicallback(
  [in]           DWORD dwMessageId,
  [in, optional] WPARAM wParam,
  [in, optional] LPARAM lParam,
  [in, optional] PVOID pvUserData
)
{...}

参数

[in] dwMessageId

消息的类型和 lParam 参数的含义。

此参数只能具有以下值之一。

值 含义
WDS_CLI_MSG_START
0
 传输开始消息。 lParam 参数是指向包含传输文件大小的LARGE_INTEGER值的指针。
WDS_CLI_MSG_COMPLETE
1
 传输完成消息。 lParam 参数是 HRESULT 值。
WDS_CLI_MSG_PROGRESS
2
 传输进度消息。 lParam 参数是 ULONG 值，表示传输完成的百分比。
WDS_CLI_MSG_TEXT
3
 信息性消息。 lParam 参数是指向可用于诊断的调试字符串的指针。

[in, optional] wParam

此消息参数应始终设置为 WdsCliTransferImage 或 WdsCliTransferFile 函数返回的传输句柄的值。

[in, optional] lParam

此参数包含的值的含义取决于 dwMessageId 参数。

[in, optional] pvUserData

指向 WdsCliTransferImage 或 WdsCliTransferFile 函数附加到此会话 的 可选用户信息的指针。

返回值

无

备注

回调函数可以调用 WdsCliCancelTransfer 函数来取消传输。 尽管回调函数也可以调用 WdsCliWaitForTransfer 函数，但不建议这样做，因为在取消阻止当前回调之前，不会收到其他回调。

要求

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