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

NetUserModalsGet

関数
ドメイン全体のユーザーアカウントポリシー情報を取得する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetUserModalsGet(
    LPCWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前方向説明
servernameLPCWSTRinoptional関数を実行するリモート サーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカル コンピューターが使用されます。詳細については、後述の「解説」セクションを参照してください。
levelDWORDin

要求するデータの情報レベルです。このパラメーターには、次のいずれかの値を指定できます。

意味
0
グローバルなパスワード パラメーターを返します。bufptr パラメーターは USER_MODALS_INFO_0 構造体を指します。
1
ログオン サーバーおよびドメイン コントローラーの情報を返します。bufptr パラメーターは USER_MODALS_INFO_1 構造体を指します。
2
ドメイン名と識別子を返します。bufptr パラメーターは USER_MODALS_INFO_2 構造体を指します。詳細については、後述の「解説」セクションを参照してください。
3
ロックアウト情報を返します。bufptr パラメーターは USER_MODALS_INFO_3 構造体を指します。

Null セッション ログオンでは、情報レベル 0 および 3 で NetUserModalsGet を匿名で呼び出すことができます。

bufptrBYTE**out

データを受け取るバッファーへのポインターです。このデータの形式は、level パラメーターの値によって異なります。

このデータ用のバッファーはシステムによって割り当てられます。返されたデータが不要になったら、アプリケーションは NetApiBufferFree 関数を呼び出して、割り当てられたメモリを解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetUserModalsGet 関数は、セキュリティ データベース(セキュリティ アカウント マネージャー(SAM)データベース、またはドメイン コントローラーの場合は Active Directory)内のすべてのユーザーおよびグローバル グループに関するグローバル情報を取得します。

戻り値

関数が成功した場合、戻り値は NERR_Success です。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

戻りコード 説明
ERROR_ACCESS_DENIED
ユーザーに、要求された情報へのアクセス権がありません。
ERROR_BAD_NETPATH
ネットワーク パスが見つかりませんでした。このエラーは、servername パラメーターが見つからなかった場合に返されます。
ERROR_INVALID_LEVEL
システム呼び出しのレベルが正しくありません。このエラーは、level パラメーターがサポートされている値のいずれでもない場合に返されます。
ERROR_INVALID_NAME
ファイル名、ディレクトリ名、またはボリューム ラベルの構文が正しくありません。このエラーは、servername パラメーターの構文が正しくない場合に返されます。
ERROR_WRONG_TARGET_NAME
ターゲット アカウント名が正しくありません。このエラーは、Windows Vista 上で実行されているリモートの servername パラメーターへのログオンが失敗した場合に返されます。
NERR_InvalidComputer
コンピューター名が無効です。

解説(Remarks)

Active Directory 向けにプログラミングを行う場合、ネットワーク管理のユーザー モーダル関数を呼び出して実現できる機能と同じ機能を、特定の Active Directory Service Interface(ADSI)メソッドを呼び出すことで実現できる場合があります。詳細については、 IADsDomain を参照してください。

Active Directory を実行しているドメイン コントローラー上でこの関数を呼び出す場合、アクセスの許可または拒否は、セキュリティ保護可能なオブジェクトのアクセス制御リスト(ACL)に基づいて行われます。既定の ACL では、認証されたすべてのユーザーと、「Pre-Windows 2000 compatible access」グループのメンバーが情報を表示できます。メンバー サーバーまたはワークステーション上でこの関数を呼び出す場合、認証されたすべてのユーザーが情報を表示できます。これらのプラットフォームでの匿名アクセスおよび匿名アクセスの制限については、 Security Requirements for the Network Management Functions を参照してください。ACL、ACE、およびアクセス トークンの詳細については、 Access Control Model を参照してください。

この関数のアクセス チェックには、Domain オブジェクトのセキュリティ記述子が使用されます。

コンピューターが属するドメインの セキュリティ識別子(SID)を取得するには、servername パラメーターに NULL を指定し、 USER_MODALS_INFO_2 構造体を指定して NetUserModalsGet 関数を呼び出します。コンピューターがドメインのメンバーでない場合、この関数は NULL ポインターを返します。

次のコード サンプルは、NetUserModalsGet 関数の呼び出しによって、すべてのユーザーおよびグローバル グループのグローバル情報を取得する方法を示しています。このサンプルは、情報レベル 0(USER_MODALS_INFO_0)を指定して NetUserModalsGet を呼び出します。呼び出しが成功すると、サンプルはグローバルなパスワード情報を出力します。最後に、コード サンプルは情報バッファー用に割り当てられたメモリを解放します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 0;
   USER_MODALS_INFO_0 *pBuf = NULL;
   NET_API_STATUS nStatus;
   LPTSTR pszServerName = NULL;

   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = (LPTSTR) argv[1];
   //
   // Call the NetUserModalsGet function; specify level 0.
   //
   nStatus = NetUserModalsGet((LPCWSTR) pszServerName,
                              dwLevel,
                              (LPBYTE *)&pBuf);
   //
   // If the call succeeds, print the global information.
   //
   if (nStatus == NERR_Success)
   {
      if (pBuf != NULL)
      {
         printf("\tMinimum password length:  %d\n", pBuf->usrmod0_min_passwd_len);
         printf("\tMaximum password age (d): %d\n", pBuf->usrmod0_max_passwd_age/86400);
         printf("\tMinimum password age (d): %d\n", pBuf->usrmod0_min_passwd_age/86400);
         printf("\tForced log off time (s):  %d\n", pBuf->usrmod0_force_logoff);
         printf("\tPassword history length:  %d\n", pBuf->usrmod0_password_hist_len);
      }
   }
   // Otherwise, print the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated memory.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

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

各言語での呼び出し定義

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

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

NetUserModalsGet = ctypes.windll.netapi32.NetUserModalsGet
NetUserModalsGet.restype = wintypes.DWORD
NetUserModalsGet.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetUserModalsGet = netapi32.NewProc("NetUserModalsGet")
)

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

extern "netapi32" fn NetUserModalsGet(
    servername: [*c]const u16, // LPCWSTR optional
    level: u32, // DWORD
    bufptr: [*c][*c]u8 // BYTE** out
) callconv(std.os.windows.WINAPI) u32;
proc NetUserModalsGet(
    servername: WideCString,  # LPCWSTR optional
    level: uint32,  # DWORD
    bufptr: ptr uint8  # BYTE** out
): uint32 {.importc: "NetUserModalsGet", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetUserModalsGet(
    const(wchar)* servername,   // LPCWSTR optional
    uint level,   // DWORD
    ubyte** bufptr   // BYTE** out
);
ccall((:NetUserModalsGet, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt8}),
      servername, level, bufptr)
# servername : LPCWSTR optional -> Cwstring
# level : DWORD -> UInt32
# bufptr : BYTE** out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetUserModalsGet(
    const uint16_t* servername,
    uint32_t level,
    uint8_t** bufptr);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetUserModalsGet(servername, level, bufptr)
-- servername : LPCWSTR optional
-- level : DWORD
-- bufptr : BYTE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetUserModalsGet = lib.func('__stdcall', 'NetUserModalsGet', 'uint32_t', ['str16', 'uint32_t', 'uint8_t *']);
// NetUserModalsGet(servername, level, bufptr)
// servername : LPCWSTR optional -> 'str16'
// level : DWORD -> 'uint32_t'
// bufptr : BYTE** out -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetUserModalsGet: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.NetUserModalsGet(servername, level, bufptr)
// servername : LPCWSTR optional -> "buffer"
// level : DWORD -> "u32"
// bufptr : BYTE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetUserModalsGet(
    const uint16_t* servername,
    uint32_t level,
    uint8_t** bufptr);
C, "NETAPI32.dll");
// $ffi->NetUserModalsGet(servername, level, bufptr);
// servername : LPCWSTR optional
// level : DWORD
// bufptr : 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 NetUserModalsGet(
        WString servername,   // LPCWSTR optional
        int level,   // DWORD
        Pointer bufptr   // BYTE** out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetUserModalsGet = NetUserModalsGet(
    servername : UInt16*,   # LPCWSTR optional
    level : UInt32,   # DWORD
    bufptr : 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 NetUserModalsGetNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef NetUserModalsGetDart = int Function(Pointer<Utf16>, int, Pointer<Uint8>);
final NetUserModalsGet = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetUserModalsGetNative, NetUserModalsGetDart>('NetUserModalsGet');
// servername : LPCWSTR optional -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetUserModalsGet(
  servername: PWideChar;   // LPCWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetUserModalsGet';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let netusermodalsget =
  foreign "NetUserModalsGet"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* servername : LPCWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : 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 ("NetUserModalsGet" net-user-modals-get :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPCWSTR optional
  (level :uint32)   ; DWORD
  (bufptr :pointer))   ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetUserModalsGet = Win32::API::More->new('NETAPI32',
    'DWORD NetUserModalsGet(LPCWSTR servername, DWORD level, LPVOID bufptr)');
# my $ret = $NetUserModalsGet->Call($servername, $level, $bufptr);
# servername : LPCWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目