DsIsNTDSOnline 函式
[此函式可用於需求一節中指定的作業系統。 它在後續版本中可能會變更或無法使用。 從 Windows Vista 開始,請改用 磁片區陰影複製服務 (VSS) 。]
DsIsNTDSOnline函式會判斷Active Directory 網域服務是否在指定的伺服器上線上。
語法
HRESULT DsIsNTDSOnline(
_In_ LPCTSTR szServerName,
_Out_ BOOL *pfNTDSOnline
);
參數
-
szServerName [in]
-
Null 終止字串的指標,其中包含要測試的伺服器名稱。 上述反斜線是選擇性的。 伺服器必須是呼叫此函式的相同電腦。 伺服器名稱不能包含任何底線 (_) 字元。 伺服器名稱的範例是 「\\server1」。
-
pfNTDSOnline [out]
-
接收結果 的 BOOL 值指標。 如果目錄服務處於線上狀態,則會收到 TRUE ;如果目錄服務離線,則為 FALSE 。
傳回值
如果函式成功或錯誤碼,則傳回 S_OK 。 下列清單列出可能的錯誤碼。
-
ERROR_ACCESS_DENIED
-
呼叫端沒有適當的存取權限可呼叫此函式。 DsSetAuthIdentity函式可用來設定用於備份和還原函式的認證。
-
hrCouldNotConnect
-
找不到 szServerName 中的伺服器、不是網域控制站,或 szServerName 格式不正確。 此值定義于 Ntdsbmsg.h 中。
-
RPC_S_INVALID_BINDING
-
DsIsNTDSOnline函式正在遠端呼叫,或szServerName中的伺服器不是網域控制站。
備註
呼叫任何目錄備份或還原函式之前,請先呼叫此函式。 目錄必須處於線上狀態,才能執行備份。 目錄必須離線才能執行還原。
此函式只能從 szServerName中指定的目標伺服器網域控制站呼叫。 無法從遠端呼叫此函式。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 |
Windows Vista |
最低支援的伺服器 |
Windows Server 2008 |
標頭 |
|
程式庫 |
|
DLL |
|
Unicode 與 ANSI 名稱 |
DsIsNTDSOnlineW (Unicode) 和 DsIsNTDSOnlineA (ANSI) |