Edit

IBackgroundCopyJob1::GetFile method (qmgr.h)

  • Article

[IBackgroundCopyJob1 is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use the BITS interfaces.]

Use the GetFile method to retrieve the remote and local file names for the given file in the job.

Syntax

HRESULT GetFile(
  [in]  ULONG       cFileIndex,
  [out] FILESETINFO *pFileInfo
);

Parameters

[in] cFileIndex

Zero-based index that identifies the file in the job.

[out] pFileInfo

A FILESETINFO structure that contains the remote and local names of the file.

Return value

This method returns the following HRESULT values, as well as others.

Return code Description
S_OK
 Successfully retrieved the file from the job.
QM_E_ITEM_NOT_FOUND
 The specified index is greater than the number of files in the job.

Remarks

Use with IBackgroundCopyJob1::GetFileCount to iterate through the files of a job.

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header qmgr.h
DLL QmgrPrxy.dll

See also

IBackgroundCopyJob1