IXtfDeployCallback::OnDeployFileProgress Method

Callback invoked to report progress in deploying a file to the console

This callback is invoked every time that a buffer block is successfully transferred for a file. Note that the transfer process uses multiple threads, and your code must ensure that it is correlating progress messages by pszFilePath and protecting against the usual multi-threading issues.

This callback is always invoked once at the start of the deployment, and once at the end of deployment, so that if a zero-length file is being deployed, both invocations will report that zero bytes out of zero bytes have been transferred.

Once files have been copied to the console, canceling the deployment by returning a failure HRESULT from this callback does not revert those changes made to the console. Another deployment must be completed in order to ensure that all files on the console are complete and up to date.

Syntax

public:
HRESULT OnDeployFileProgress(
         LPCWSTR pszFilePath,
         ULONGLONG ullBytesTransferred,
         ULONGLONG ullFileSize
)  

Parameters

pszFilePath
Type: LPCWSTR 

File path of the file.

ullBytesTransferred
Type: ULONGLONG 

Bytes transferred so far.

ullFileSize
Type: ULONGLONG 

Total size of the file being transferred, in bytes.

Return value

Type: HRESULT 

Return S_OK to continue deployment, or a failure HRESULT to cancel the deployment.

Requirements

Header: Declared in xtfapplication.h.

Library: Use xtfapplication.lib.