IDedupReadFileCallback::ReadBackupFile method

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, size_is(SizeToRead), length_is(*ReturnedSize)]  BYTE *FileBuffer,
  [out]                                                 ULONG *ReturnedSize,
  [in]                                                  DWORD Flags
);

Parameters

FileFullPath [in]

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

FileOffset [in]

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

SizeToRead [in]

The number of bytes to read from the file.

FileBuffer [out]

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.

ReturnedSize [out]

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.

Flags [in]

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.

Return code/valueDescription
S_OK
0x00000000L

The method completed successfully.

DDP_E_PATH_NOT_FOUND
0x80565304L

The specified container path was not found in the backup store.

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Header

DdpBackup.h

See also

IDedupReadFileCallback
CreateFile
ReadFile

 

 

Show:
© 2014 Microsoft