nc-wdsclientapi-pfn_wdsclicallback.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NC:wdsclientapi.PFN_WdsCliCallback	PFN_WdsCliCallback (wdsclientapi.h)	Defines a callback function that WDS can call for progress notification and error messages during a file or image transfer.	PFN_WdsCliCallback PFN_WdsCliCallback callback PFN_WdsCliCallback callback function [Windows Deployment Services] WDS_CLI_MSG_COMPLETE WDS_CLI_MSG_PROGRESS WDS_CLI_MSG_START WDS_CLI_MSG_TEXT wds.pfn_wdsclicallback wdsclientapi/PFN_WdsCliCallback	wds\pfn_wdsclicallback.htm	wds	b071ba1c-5860-4492-ad86-71eaeeb74df4	12/05/2018	PFN_WdsCliCallback, PFN_WdsCliCallback callback, PFN_WdsCliCallback callback function [Windows Deployment Services], WDS_CLI_MSG_COMPLETE, WDS_CLI_MSG_PROGRESS, WDS_CLI_MSG_START, WDS_CLI_MSG_TEXT, wds.pfn_wdsclicallback, wdsclientapi/PFN_WdsCliCallback	wdsclientapi.h		Windows	Windows Vista with SP1 [desktop apps only]	Windows Server 2008 [desktop apps only]													Windows			19H1	PFN_WdsCliCallback wdsclientapi/PFN_WdsCliCallback	c++	APIRef kbSyntax	UserDefined	WdsClientAPI.h	PFN_WdsCliCallback

-description

Defines a callback function that WDS can call for progress notification and error messages during a file or image transfer.

-parameters

-param dwMessageId [in]

The type of message and the meaning of the lParam parameter.

This parameter can have only one of the following values.

Value	Meaning
WDS_CLI_MSG_START 0	The transfer start message. The lParam parameter is a pointer to a LARGE_INTEGER value containing the file size of the transfer.
WDS_CLI_MSG_COMPLETE 1	The transfer complete message. The lParam parameter is an HRESULT value.
WDS_CLI_MSG_PROGRESS 2	The transfer progress message. The lParam parameter is a ULONG value that is the percentage of transfer completed.
WDS_CLI_MSG_TEXT 3	The informational message. The lParam parameter is pointer to a debugging string that can be used for diagnostic purposes.

-param wParam [in, optional]

This message parameter should always be set to the value of the transfer handle returned by the WdsCliTransferImage or WdsCliTransferFile function.

-param lParam [in, optional]

The meaning of the value contained by this parameter depends upon the dwMessageId parameter.

-param pvUserData [in, optional]

A pointer to optional user information attached to this session by the WdsCliTransferImage or WdsCliTransferFile function.

-remarks

A callback function can call the WdsCliCancelTransfer function to cancel a transfer. Although a callback function can also call the WdsCliWaitForTransfer function, this is not recommended because no additional callbacks will be received until the current callback is unblocked.