IDedupReadFileCallback::ReadBackupFile method (ddpbackup.h)

Reads data from a Data Deduplication store metadata or container file located in the backup store.

Syntax

HRESULT ReadBackupFile(
  [in]  BSTR  FileFullPath,
  [in]  hyper FileOffset,
  [in]  ULONG SizeToRead,
  [out] BYTE  *FileBuffer,
  [out] ULONG *ReturnedSize,
  [in]  DWORD Flags
);

Parameters

[in] FileFullPath

The full path from the root directory of the volume to the container file.

[in] FileOffset

The offset, in bytes, from the beginning of the file to the beginning of the data to be read.

[in] SizeToRead

The number of bytes to read from the file.

[out] FileBuffer

A pointer to a buffer that receives the data that is read from the file. The size of the buffer must be greater than or equal to the number specified in the SizeToRead parameter.

[out] ReturnedSize

Pointer to a ULONG variable that receives the number of bytes that were read from the backup store. If the call to ReadBackupFile is successful, this number is equal to the value that was specified in the SizeToRead parameter.

[in] Flags

This parameter is reserved for future use.

Return value

This method can return standard HRESULT values, such as S_OK. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Possible return values include the following.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	ddpbackup.h

See also

CreateFile

IDedupReadFileCallback

ReadFile