DsBackupOpenFile 函数

[此函数可用于“要求”部分中指定的操作系统。 在后续版本中,它可能会被修改,也可能无法使用。 从 Windows Vista 开始,请改用卷影复制服务(VSS)。

DsBackupOpenFile 函数将打开指定的文件,并执行为备份准备文件所需的客户端和服务器操作。

语法

HRESULT DsBackupOpenFile(
  _In_  HBC           hbc,
  _In_  LPCTSTR       szAttachmentName,
  _In_  DWORD         cbReadHintSize,
  _Out_ LARGE_INTEGER *pliFileSize
);

参数

hbc [in]

包含使用 DsBackupPrepare 函数获取的备份上下文句柄。

szAttachmentName [in]

指向以 null 结尾的字符串的指针,该字符串指定要打开的备份文件的名称。

cbReadHintSize [in]

包含作为 DsBackupRead 函数中 pvBuffer 参数传递缓冲区的可能大小(以字节为单位)。 备份函数使用此值作为优化网络流量的提示。 此值必须是 8192 的倍数,并且必须大于或等于 24576。

pliFileSize [out]

指向 LARGE_INTEGER 值的指针,该值接收打开的备份文件的大小(以字节为单位)。

返回值

如果函数成功或 Win32 或 RPC 错误代码,则返回S_OK否则返回。 以下列表列出了其他可能的错误代码。

ERROR_ACCESS_DENIED

调用方没有调用此函数的适当访问权限。 DsSetAuthIdentity 函数可用于设置用于备份和还原函数的凭据。

ERROR_INVALID_PARAMETER

hbcszAttachmentNamepliFileSize 无效。

要求

要求
最低受支持的客户端
Windows Vista
最低受支持的服务器
Windows Server 2008
标头
Ntdsbcli.h

Ntdsbcli.lib
DLL
Ntdsbcli.dll
Unicode 和 ANSI 名称
DsBackupOpenFileW (Unicode) 和 DsBackupOpenFileA (ANSI)

另请参阅

DsBackupRead

备份 Active Directory 服务器

目录备份函数