大网数据广告活动
域与目录服务

DsIsNTDSOnline function (Ntdsbcli.h)

· 52CE 我爱测

The function determines if Active Directory Domain Services (ADDS) are currently online on the specified server.

[This function is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Beginning with Windows Vista, use Volume Shadow Copy Service (VSS) instead.]

The DsIsNTDSOnline function determines if Active Directory Domain Services are online on the specified server.

Syntax

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

Parameters

szServerName [in]

Pointer to a null-terminated string that contains the name of the server to test. Preceding backslashes are optional. The server must be the same computer that this function is called from. The server name cannot contain any underscore (_) characters. An example of a server name is "\\server1".

pfNTDSOnline [out]

Pointer to BOOL value that receives the result. Receives TRUE if the directory service is online or FALSE if the directory service is offline.

Return value

Returns S_OK if the function is successful or an error code otherwise. The following list lists possible error codes.

ERROR_ACCESS_DENIED

The caller does not have the proper access privileges to call this function. The DsSetAuthIdentity function can be used to set the credentials to use for the backup and restore functions.

hrCouldNotConnect

The server in szServerName cannot be found, is not a domain controller, or szServerName is not formatted correctly. This value is defined in Ntdsbmsg.h.

RPC_S_INVALID_BINDING

The DsIsNTDSOnline function is being called remotely or the server in szServerName is not a domain controller.

Remarks

Call this function before calling any of the directory backup or restore functions. The directory must be online in order to perform a backup. The directory must by offline to perform a restore.

This function can only be called from a domain controller that is also the target server specified in szServerName. This function cannot be called remotely.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Header Ntdsbcli.h
Library Ntdsbcli.lib
DLL Ntdsbcli.dll
Unicode and ANSI names DsIsNTDSOnlineW (Unicode) and DsIsNTDSOnlineA (ANSI)

See also

DsSetAuthIdentity

Directory Backup Functions

Backing Up and Restoring an Active Directory Server

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 05/31/2018
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。