DsIsNTDSOnline 関数

[この関数は、[要件] セクションで指定されたオペレーティングシステムで使用できます。それより後のバージョンでは、変更されるか、使用できなくなる場合があります。 Windows Vista 以降では、代わりにボリュームシャドウコピーサービス (VSS) を使用します。

DsIsNTDSOnline 関数は、Active Directory ドメイン Services が指定されたサーバー上でオンラインかどうかを判断します。

構文

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

szServerName [in]: テストするサーバーの名前を含む null で終わる文字列へのポインター。前の円記号は省略可能です。サーバーは、この関数が呼び出されるコンピューターと同じである必要があります。サーバー名にアンダースコア (_) 文字を含めることはできません。サーバー名の例として、"\\server1" があります。
pfNTDSOnline [out]: 結果を受け取る BOOL 値へのポインター。 ディレクトリサービスがオンラインの場合は TRUE、ディレクトリサービスがオフラインの場合は FAL Standard Editionを受け取ります。

関数が 成功した場合はS_OK を返し、それ以外の場合はエラーコードを返します。考えられるエラーコードの一覧を次に示します。

ERROR_ACCESS_DENIED: 呼び出し元には、この関数を呼び出す適切なアクセス特権がありません。 DsSetAuthIdentity 関数を使用して、バックアップおよび復元関数に使用する資格情報を設定できます。
hrCouldNotConnect: szServerName 内のサーバーが見つからないか、doメインコントローラーではないか、szServerName が正しく書式設定されていません。この値は Ntdsbmsg.h で定義されています。
RPC_S_INVALID_BINDING: DsIsNTDSOnline 関数がリモートで呼び出されているか、szServerName 内のサーバーが doメインコントローラーではありません。

ディレクトリバックアップまたは復元関数のいずれかを呼び出す前に、この関数を呼び出します。バックアップを実行するには、ディレクトリがオンラインである必要があります。復元を実行するには、ディレクトリをオフラインにする必要があります。

この関数は、szServerName で指定されたターゲットサーバーでもある doメインコントローラーからのみ呼び出すことができます。この関数をリモートで呼び出すことはできません。

要件	Value
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
ヘッダー	Ntdsbcli.h
ライブラリ	Ntdsbcli.lib
[DLL]	Ntdsbcli.dll
Unicode 名と ANSI 名	DsIsNTDSOnlineW (Unicode) と DsIsNTDSOnlineA (ANSI)