Platform SDK: Exchange Server

HrBackupOpenFile

The HrBackupOpenFile function opens a remote file for backup and performs whatever client and server side operations are necessary to prepare for the backup.

Quick Info

Header file: EDBBCLI.H
Library: EDBBCLI.LIB
Unicode: Yes

HRESULT HrBackupOpenFile(
  HBC pvBackupContext,        
  WCHAR * wszAttachmentName,  
  DWORD cbReadHintSize,       
  LARGE_INTEGER * pliFileSize  
);
 

Parameters

pvBackupContext
Input parameter. Points to the client-side context handle of the backup.
wszAttachmentName
Input parameter. Specifies the name of the file to back up.
cbReadHintSize
Input parameter. The size of the buffer (in 4096-byte multiples) that is passed as the pvBuffer argument to HrBackupRead. The backup functions use this value to optimize the network traffic.
pliFileSize
Output parameter. Points to the size (in bytes) of the file to back up.

Return Values

See Return Values.

Remarks

For more information on the HrBackupOpenFile function, see Backing Up and Restoring Data.

See Also

HrBackupRead