DsIsNTDSOnline 函数

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

DsIsNTDSOnline 函数确定Active Directory 域服务是否在指定的服务器上处于联机状态。

语法

HRESULT DsIsNTDSOnline(
  _In_  LPCTSTR szServerName,
  _Out_ BOOL    *pfNTDSOnline
);

参数

szServerName [in]

指向包含要测试的服务器名称的以 null 结尾的字符串的指针。 前面的反斜杠是可选的。 服务器必须是从中调用此函数的同一台计算机。 服务器名称不能包含任何下划线 (_) 字符。 服务器名称的示例为“\\server1”。

pfNTDSOnline [out]

指向 接收结果的 BOOL 值的指针。 如果目录服务处于联机状态或 FAL,则接收 TRUE标准版如果目录服务处于脱机状态。

返回值

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

ERROR_ACCESS_DENIED

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

hrCouldNot连接

找不到 szServerName 中的服务器,不是域控制器,或者 szServerName 格式不正确。 此值在 Ntdsbmsg.h 中定义。

RPC_S_INVALID_BINDING

DsIsNTDSOnline 函数正在远程调用,或者 szServerName 中的服务器不是域控制器。

注解

在调用任何目录备份或还原函数之前调用此函数。 目录必须处于联机状态才能执行备份。 目录必须脱机执行还原。

只能从域控制器调用此函数,该域控制器也是 szServerName 中指定的目标服务器。 无法远程调用此函数。

要求

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

Ntdsbcli.lib
DLL
Ntdsbcli.dll
Unicode 和 ANSI 名称
DsIsNTDSOnlineW (Unicode) 和 DsIsNTDSOnlineA (ANSI)

另请参阅

DsSetAuthIdentity

目录备份函数

备份和还原 Active Directory 服务器