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