ホーム › System.DeploymentServices › PFN_WdsCliCallback

PFN_WdsCliCallback

コールバック

シグネチャ

void PFN_WdsCliCallback(
    PFN_WDS_CLI_CALLBACK_MESSAGE_ID dwMessageId,
    WPARAM wParam,
    LPARAM lParam,
    void* pvUserData
);

パラメーター

フィールド型説明

dwMessageId

PFN_WDS_CLI_CALLBACK_MESSAGE_ID

メッセージの種類、および 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 パラメーターは、診断目的で使用できるデバッグ文字列へのポインターです。

wParam WPARAM このメッセージパラメーターには、常に WdsCliTransferImage 関数または WdsCliTransferFile 関数から返された転送ハンドルの値を設定してください。

lParam LPARAM このパラメーターに格納される値の意味は、 dwMessageId パラメーターによって異なります。

pvUserData

void*

  <a href="/windows/desktop/api/wdsclientapi/nf-wdsclientapi-wdsclitransferimage">WdsCliTransferImage</a> 関数または 
  <a href="/windows/desktop/api/wdsclientapi/nf-wdsclientapi-wdsclitransferfile">WdsCliTransferFile</a> 関数によってこのセッションに付加された、省略可能なユーザー情報へのポインターです。

公式ドキュメント

ファイルまたはイメージの転送中に、進行状況の通知やエラーメッセージのために WDS が呼び出すことのできるコールバック関数を定義します。

解説(Remarks)

コールバック関数は、 WdsCliCancelTransfer 関数を呼び出して転送を取り消すことができます。コールバック関数から WdsCliWaitForTransfer 関数を呼び出すこともできますが、現在のコールバックのブロックが解除されるまで以降のコールバックを受け取れないため、推奨されません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)