Win32 API 日本語リファレンス
ホームNetworkManagement.NetManagement › I_NetLogonControl2

I_NetLogonControl2

関数
Netlogonサービスの状態を制御する内部関数を呼び出す。
DLLNETAPI32.dll呼出規約winapi

シグネチャ

// NETAPI32.dll
#include <windows.h>

DWORD I_NetLogonControl2(
    LPCWSTR ServerName,   // optional
    DWORD FunctionCode,
    DWORD QueryLevel,
    BYTE* Data,
    BYTE** Buffer
);

パラメーター

名前方向説明
ServerNameLPCWSTRinoptionalリモートサーバーの名前です。
FunctionCodeDWORDin

実行する操作です。この値には次のいずれかを指定できます。

意味
NETLOGON_CONTROL_QUERY
1
操作を行いません。要求された情報のみを返します。
NETLOGON_CONTROL_REPLICATE
2
バックアップドメインコントローラー (BDC) 上のセキュリティアカウントマネージャー (SAM) データベースを、プライマリドメインコントローラー (PDC) 上のコピーと同期させます。この操作は完全な同期を意味するものではありません。Netlogon サービスは、可能であれば未処理の差分のみをレプリケートします。
NETLOGON_CONTROL_SYNCHRONIZE
3
BDC に対し、PDC から SAM データベースの新しいコピーを取得させます。この操作は完全な同期を実行します。
NETLOGON_CONTROL_PDC_REPLICATE
4
PDC に対し、各 BDC に今すぐレプリケートするよう要求させます。
NETLOGON_CONTROL_REDISCOVER
5
ドメインコントローラー (DC) に対し、指定された信頼ドメインの DC を再検出させます。
NETLOGON_CONTROL_TC_QUERY
6
セキュアチャネルに対してクエリを実行し、その最終使用に関する状態の更新を要求します。
NETLOGON_CONTROL_TC_VERIFY
10
指定された信頼ドメインのセキュアチャネルの現在の状態を検証します。状態が成功を示している場合、ドメインコントローラーに ping が送信されます。状態または ping が失敗を示している場合、新しい信頼ドメインコントローラーが再検出されます。
NETLOGON_CONTROL_CHANGE_PASSWORD
9
信頼ドメインへのセキュアチャネル上でパスワードの変更を強制します。
NETLOGON_CONTROL_FORCE_DNS_REG
11
ドメインコントローラーに対し、すべての DNS レコードを再登録させます。QueryLevel パラメーターは 1 に設定する必要があります。
NETLOGON_CONTROL_QUERY_DNS_REG
12
Netlogon サービスによって実行された DNS 更新の状態を要求するクエリを発行します。最後の更新で DNS の登録または登録解除のエラーが発生した場合、結果は否定的になります。QueryLevel パラメーターは 1 に設定する必要があります。
QueryLevelDWORDin

Netlogon サービスから返される情報を指定します。この値には次のいずれかの構造体を指定できます。

NETLOGON_INFO_1 (1)

NETLOGON_INFO_2 (2)

NETLOGON_INFO_3 (3)

NETLOGON_INFO_4 (4)

DataBYTE*inFunctionCode パラメーターに指定された値に応じた入力データを保持します。NETLOGON_CONTROL_REDISCOVER および NETLOGON_CONTROL_TC_QUERY の関数コードでは、信頼ドメイン名を指定します (データ型は LPWSTR * です)。
BufferBYTE**out

QueryLevel パラメーターで渡された構造体内に、要求された情報を格納するバッファーへのポインターを返します。

バッファーは NetApiBufferFree を使用して解放する必要があります。

戻り値の型: DWORD

公式ドキュメント

Netlogon サービスのさまざまな側面を制御します。

戻り値

このメソッドは、成功した場合に 0x00000000 (NERR_Success) を返します。それ以外の場合は、Lmerr.h または Winerror.h で定義された 0 以外のエラーコードを返します。NET_API_STATUS のエラーコードは 0x00000834 の値から始まります。ネットワーク管理エラーコードの詳細については、Network_Management_Error_Codes を参照してください。次の表に、返される可能性のある値を示します。

戻り値/値 説明
NERR_Success
0x00000000
メソッドの呼び出しがエラーなく完了しました。
ERROR_ACCESS_DENIED
0x00000005
呼び出し元に対するアクセス検証が false を返しました。アクセスが拒否されました。
ERROR_NOT_ENOUGH_MEMORY
0x00000008
このコマンドを処理するのに十分なストレージがありません。
ERROR_NOT_SUPPORTED
0x00000032
指定されたサーバーでは関数コードが無効です。たとえば、NETLOGON_CONTROL_REPLICATE がプライマリドメインコントローラー (PDC) に渡された場合などです。
ERROR_INVALID_PARAMETER
0x00000057
パラメーターが正しくありません。
ERROR_INVALID_LEVEL
0x0000007C
クエリの呼び出しレベルが正しくありません。
ERROR_SERVICE_NOT_ACTIVE
0x000004261210121
サービスが開始されていません。
ERROR_INVALID_COMPUTERNAME
0x000004BA
指定されたコンピューター名の形式が無効です。
ERROR_NO_LOGON_SERVERS
0x0000051F
現在、ログオン要求を処理できるログオンサーバーがありません。
ERROR_INVALID_DOMAIN_ROLE
0x0000054A
バックアップドメインコントローラー (BDC) でドメイン間信頼アカウントのパスワード変更が試行されました。この操作はドメインの PDC でのみ許可されます。
ERROR_NO_SUCH_DOMAIN
0x0000054B
指定されたドメインが存在しないか、接続できませんでした。
NERR_UserNotFound
0x000008AD
ユーザー名が見つかりませんでした。

解説(Remarks)

この関数は、BDC に対して SAM データベースのコピーが最新の状態に保たれていることを確認するよう要求するために使用できます。また、BDC が現在 PDC へのセキュアチャネルを開いているかどうかを判断するためにも使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// NETAPI32.dll
#include <windows.h>

DWORD I_NetLogonControl2(
    LPCWSTR ServerName,   // optional
    DWORD FunctionCode,
    DWORD QueryLevel,
    BYTE* Data,
    BYTE** Buffer
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint I_NetLogonControl2(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerName,   // LPCWSTR optional
    uint FunctionCode,   // DWORD
    uint QueryLevel,   // DWORD
    IntPtr Data,   // BYTE*
    IntPtr Buffer   // BYTE** out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function I_NetLogonControl2(
    <MarshalAs(UnmanagedType.LPWStr)> ServerName As String,   ' LPCWSTR optional
    FunctionCode As UInteger,   ' DWORD
    QueryLevel As UInteger,   ' DWORD
    Data As IntPtr,   ' BYTE*
    Buffer As IntPtr   ' BYTE** out
) As UInteger
End Function
' ServerName : LPCWSTR optional
' FunctionCode : DWORD
' QueryLevel : DWORD
' Data : BYTE*
' Buffer : BYTE** out
Declare PtrSafe Function I_NetLogonControl2 Lib "netapi32" ( _
    ByVal ServerName As LongPtr, _
    ByVal FunctionCode As Long, _
    ByVal QueryLevel As Long, _
    ByVal Data As LongPtr, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

I_NetLogonControl2 = ctypes.windll.netapi32.I_NetLogonControl2
I_NetLogonControl2.restype = wintypes.DWORD
I_NetLogonControl2.argtypes = [
    wintypes.LPCWSTR,  # ServerName : LPCWSTR optional
    wintypes.DWORD,  # FunctionCode : DWORD
    wintypes.DWORD,  # QueryLevel : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # Data : BYTE*
    ctypes.c_void_p,  # Buffer : BYTE** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
I_NetLogonControl2 = Fiddle::Function.new(
  lib['I_NetLogonControl2'],
  [
    Fiddle::TYPE_VOIDP,  # ServerName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # FunctionCode : DWORD
    -Fiddle::TYPE_INT,  # QueryLevel : DWORD
    Fiddle::TYPE_VOIDP,  # Data : BYTE*
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn I_NetLogonControl2(
        ServerName: *const u16,  // LPCWSTR optional
        FunctionCode: u32,  // DWORD
        QueryLevel: u32,  // DWORD
        Data: *mut u8,  // BYTE*
        Buffer: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint I_NetLogonControl2([MarshalAs(UnmanagedType.LPWStr)] string ServerName, uint FunctionCode, uint QueryLevel, IntPtr Data, IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_I_NetLogonControl2' -Namespace Win32 -PassThru
# $api::I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
#uselib "NETAPI32.dll"
#func global I_NetLogonControl2 "I_NetLogonControl2" sptr, sptr, sptr, sptr, sptr
; I_NetLogonControl2 ServerName, FunctionCode, QueryLevel, varptr(Data), varptr(Buffer)   ; 戻り値は stat
; ServerName : LPCWSTR optional -> "sptr"
; FunctionCode : DWORD -> "sptr"
; QueryLevel : DWORD -> "sptr"
; Data : BYTE* -> "sptr"
; Buffer : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global I_NetLogonControl2 "I_NetLogonControl2" wstr, int, int, var, var
; res = I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
; ServerName : LPCWSTR optional -> "wstr"
; FunctionCode : DWORD -> "int"
; QueryLevel : DWORD -> "int"
; Data : BYTE* -> "var"
; Buffer : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD I_NetLogonControl2(LPCWSTR ServerName, DWORD FunctionCode, DWORD QueryLevel, BYTE* Data, BYTE** Buffer)
#uselib "NETAPI32.dll"
#cfunc global I_NetLogonControl2 "I_NetLogonControl2" wstr, int, int, var, var
; res = I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
; ServerName : LPCWSTR optional -> "wstr"
; FunctionCode : DWORD -> "int"
; QueryLevel : DWORD -> "int"
; Data : BYTE* -> "var"
; Buffer : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procI_NetLogonControl2 = netapi32.NewProc("I_NetLogonControl2")
)

// ServerName (LPCWSTR optional), FunctionCode (DWORD), QueryLevel (DWORD), Data (BYTE*), Buffer (BYTE** out)
r1, _, err := procI_NetLogonControl2.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerName))),
	uintptr(FunctionCode),
	uintptr(QueryLevel),
	uintptr(Data),
	uintptr(Buffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function I_NetLogonControl2(
  ServerName: PWideChar;   // LPCWSTR optional
  FunctionCode: DWORD;   // DWORD
  QueryLevel: DWORD;   // DWORD
  Data: Pointer;   // BYTE*
  Buffer: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'I_NetLogonControl2';
result := DllCall("NETAPI32\I_NetLogonControl2"
    , "WStr", ServerName   ; LPCWSTR optional
    , "UInt", FunctionCode   ; DWORD
    , "UInt", QueryLevel   ; DWORD
    , "Ptr", Data   ; BYTE*
    , "Ptr", Buffer   ; BYTE** out
    , "UInt")   ; return: DWORD
●I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer) = DLL("NETAPI32.dll", "dword I_NetLogonControl2(char*, dword, dword, void*, void*)")
# 呼び出し: I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
# ServerName : LPCWSTR optional -> "char*"
# FunctionCode : DWORD -> "dword"
# QueryLevel : DWORD -> "dword"
# Data : BYTE* -> "void*"
# Buffer : BYTE** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn I_NetLogonControl2(
    ServerName: [*c]const u16, // LPCWSTR optional
    FunctionCode: u32, // DWORD
    QueryLevel: u32, // DWORD
    Data: [*c]u8, // BYTE*
    Buffer: [*c][*c]u8 // BYTE** out
) callconv(std.os.windows.WINAPI) u32;
proc I_NetLogonControl2(
    ServerName: WideCString,  # LPCWSTR optional
    FunctionCode: uint32,  # DWORD
    QueryLevel: uint32,  # DWORD
    Data: ptr uint8,  # BYTE*
    Buffer: ptr uint8  # BYTE** out
): uint32 {.importc: "I_NetLogonControl2", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint I_NetLogonControl2(
    const(wchar)* ServerName,   // LPCWSTR optional
    uint FunctionCode,   // DWORD
    uint QueryLevel,   // DWORD
    ubyte* Data,   // BYTE*
    ubyte** Buffer   // BYTE** out
);
ccall((:I_NetLogonControl2, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, UInt32, Ptr{UInt8}, Ptr{UInt8}),
      ServerName, FunctionCode, QueryLevel, Data, Buffer)
# ServerName : LPCWSTR optional -> Cwstring
# FunctionCode : DWORD -> UInt32
# QueryLevel : DWORD -> UInt32
# Data : BYTE* -> Ptr{UInt8}
# Buffer : BYTE** out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t I_NetLogonControl2(
    const uint16_t* ServerName,
    uint32_t FunctionCode,
    uint32_t QueryLevel,
    uint8_t* Data,
    uint8_t** Buffer);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
-- ServerName : LPCWSTR optional
-- FunctionCode : DWORD
-- QueryLevel : DWORD
-- Data : BYTE*
-- Buffer : BYTE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const I_NetLogonControl2 = lib.func('__stdcall', 'I_NetLogonControl2', 'uint32_t', ['str16', 'uint32_t', 'uint32_t', 'uint8_t *', 'uint8_t *']);
// I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
// ServerName : LPCWSTR optional -> 'str16'
// FunctionCode : DWORD -> 'uint32_t'
// QueryLevel : DWORD -> 'uint32_t'
// Data : BYTE* -> 'uint8_t *'
// Buffer : BYTE** out -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  I_NetLogonControl2: { parameters: ["buffer", "u32", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer)
// ServerName : LPCWSTR optional -> "buffer"
// FunctionCode : DWORD -> "u32"
// QueryLevel : DWORD -> "u32"
// Data : BYTE* -> "pointer"
// Buffer : BYTE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t I_NetLogonControl2(
    const uint16_t* ServerName,
    uint32_t FunctionCode,
    uint32_t QueryLevel,
    uint8_t* Data,
    uint8_t** Buffer);
C, "NETAPI32.dll");
// $ffi->I_NetLogonControl2(ServerName, FunctionCode, QueryLevel, Data, Buffer);
// ServerName : LPCWSTR optional
// FunctionCode : DWORD
// QueryLevel : DWORD
// Data : BYTE*
// Buffer : BYTE** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int I_NetLogonControl2(
        WString ServerName,   // LPCWSTR optional
        int FunctionCode,   // DWORD
        int QueryLevel,   // DWORD
        byte[] Data,   // BYTE*
        Pointer Buffer   // BYTE** out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun I_NetLogonControl2 = I_NetLogonControl2(
    ServerName : UInt16*,   # LPCWSTR optional
    FunctionCode : UInt32,   # DWORD
    QueryLevel : UInt32,   # DWORD
    Data : UInt8*,   # BYTE*
    Buffer : UInt8**   # BYTE** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef I_NetLogonControl2Native = Uint32 Function(Pointer<Utf16>, Uint32, Uint32, Pointer<Uint8>, Pointer<Uint8>);
typedef I_NetLogonControl2Dart = int Function(Pointer<Utf16>, int, int, Pointer<Uint8>, Pointer<Uint8>);
final I_NetLogonControl2 = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<I_NetLogonControl2Native, I_NetLogonControl2Dart>('I_NetLogonControl2');
// ServerName : LPCWSTR optional -> Pointer<Utf16>
// FunctionCode : DWORD -> Uint32
// QueryLevel : DWORD -> Uint32
// Data : BYTE* -> Pointer<Uint8>
// Buffer : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function I_NetLogonControl2(
  ServerName: PWideChar;   // LPCWSTR optional
  FunctionCode: DWORD;   // DWORD
  QueryLevel: DWORD;   // DWORD
  Data: Pointer;   // BYTE*
  Buffer: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'I_NetLogonControl2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "I_NetLogonControl2"
  c_I_NetLogonControl2 :: CWString -> Word32 -> Word32 -> Ptr Word8 -> Ptr Word8 -> IO Word32
-- ServerName : LPCWSTR optional -> CWString
-- FunctionCode : DWORD -> Word32
-- QueryLevel : DWORD -> Word32
-- Data : BYTE* -> Ptr Word8
-- Buffer : BYTE** out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let i_netlogoncontrol2 =
  foreign "I_NetLogonControl2"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint8_t) @-> returning uint32_t)
(* ServerName : LPCWSTR optional -> (ptr uint16_t) *)
(* FunctionCode : DWORD -> uint32_t *)
(* QueryLevel : DWORD -> uint32_t *)
(* Data : BYTE* -> (ptr uint8_t) *)
(* Buffer : BYTE** out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("I_NetLogonControl2" i-net-logon-control2 :convention :stdcall) :uint32
  (server-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (function-code :uint32)   ; DWORD
  (query-level :uint32)   ; DWORD
  (data :pointer)   ; BYTE*
  (buffer :pointer))   ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $I_NetLogonControl2 = Win32::API::More->new('NETAPI32',
    'DWORD I_NetLogonControl2(LPCWSTR ServerName, DWORD FunctionCode, DWORD QueryLevel, LPVOID Data, LPVOID Buffer)');
# my $ret = $I_NetLogonControl2->Call($ServerName, $FunctionCode, $QueryLevel, $Data, $Buffer);
# ServerName : LPCWSTR optional -> LPCWSTR
# FunctionCode : DWORD -> DWORD
# QueryLevel : DWORD -> DWORD
# Data : BYTE* -> LPVOID
# Buffer : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目