EN
Dieser Inhalt ist in Ihrer Sprache leider nicht verfügbar. Im Folgenden finden Sie die englische Version.

IBackgroundCopyError::GetFile method

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

Syntax


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

Parameters

ppFile [out]

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 codeDescription
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.

 

Examples

See the example code in the Handling Errors topic.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyError is defined as 19C613A0-FCB8-4F28-81AE-897C3D078F81

See also

IBackgroundCopyError::GetError
IBackgroundCopyError::GetErrorContextDescription
IBackgroundCopyError::GetErrorDescription

 

 

Anzeigen: