Edit

IBackgroundCopyError::GetFile method (bits.h)

  • Article

Retrieves an interface pointer to the file object associated with the error.

Syntax

HRESULT GetFile(
  [out] IBackgroundCopyFile **pVal
);

Parameters

[out] pVal

An IBackgroundCopyFile interface pointer whose methods you use to determine the local and remote file names associated with the error. The ppFile parameter is set to NULL if the error is not associated with the local or remote file. When done, release ppFile.

Return value

This method returns the following HRESULT values.

Return code Description
S_OK
 Successfully retrieved an interface pointer to the file object.
BG_E_FILE_NOT_AVAILABLE
 The error is not associated with a local or remote file. The ppFile parameter is set to NULL.

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

See also

IBackgroundCopyError::GetError

IBackgroundCopyError::GetErrorContextDescription

IBackgroundCopyError::GetErrorDescription