ホーム › NetworkManagement.NetManagement › NetGetDisplayInformationIndex

NetGetDisplayInformationIndex

関数

指定プレフィックスに対応する表示情報のインデックスを取得する。

DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetGetDisplayInformationIndex(
    LPCWSTR ServerName,
    DWORD Level,
    LPCWSTR Prefix,
    DWORD* Index
);

パラメーター

名前

型

方向

説明

ServerName

LPCWSTR

関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。

Level

DWORD

照会するアカウントのレベルを指定します。このパラメーターには次のいずれかの値を指定できます。

値	意味
1	すべてのローカルおよびグローバル(通常の)ユーザーアカウントを照会します。
2	すべてのワークステーションおよびサーバーのユーザーアカウントを照会します。
3	すべてのグローバルグループを照会します。

Prefix

LPCWSTR

検索対象のプレフィックスを指定する文字列へのポインターです。

Index

DWORD*

inout

要求されたエントリのインデックスを受け取る値へのポインターです。

戻り値の型: DWORD

公式ドキュメント

NetGetDisplayInformationIndex 関数は、名前が指定した文字列で始まる、または名前がその文字列のアルファベット順で後に続く最初の表示情報エントリのインデックスを返します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL	Level パラメーターに指定された値が無効です。
ERROR_NO_MORE_ITEMS	操作対象の項目がこれ以上ありませんでした。
NERR_InvalidComputer	コンピューター名が無効です。

解説(Remarks)

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

この関数は、呼び出し元が Read アクセス権を持つ情報のみを返します。呼び出し元は、ドメインオブジェクトに対する List Contents アクセス権と、System コンテナー内にある SAM Server オブジェクトに対する Enumerate Entire SAM Domain アクセス権を持っている必要があります。

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

各言語での呼び出し定義

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

DWORD NetGetDisplayInformationIndex(
    LPCWSTR ServerName,
    DWORD Level,
    LPCWSTR Prefix,
    DWORD* Index
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetGetDisplayInformationIndex(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerName,   // LPCWSTR
    uint Level,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string Prefix,   // LPCWSTR
    ref uint Index   // DWORD* in/out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetGetDisplayInformationIndex(
    <MarshalAs(UnmanagedType.LPWStr)> ServerName As String,   ' LPCWSTR
    Level As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Prefix As String,   ' LPCWSTR
    ByRef Index As UInteger   ' DWORD* in/out
) As UInteger
End Function

' ServerName : LPCWSTR
' Level : DWORD
' Prefix : LPCWSTR
' Index : DWORD* in/out
Declare PtrSafe Function NetGetDisplayInformationIndex Lib "netapi32" ( _
    ByVal ServerName As LongPtr, _
    ByVal Level As Long, _
    ByVal Prefix As LongPtr, _
    ByRef Index As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetGetDisplayInformationIndex = ctypes.windll.netapi32.NetGetDisplayInformationIndex
NetGetDisplayInformationIndex.restype = wintypes.DWORD
NetGetDisplayInformationIndex.argtypes = [
    wintypes.LPCWSTR,  # ServerName : LPCWSTR
    wintypes.DWORD,  # Level : DWORD
    wintypes.LPCWSTR,  # Prefix : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # Index : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGetDisplayInformationIndex = Fiddle::Function.new(
  lib['NetGetDisplayInformationIndex'],
  [
    Fiddle::TYPE_VOIDP,  # ServerName : LPCWSTR
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # Prefix : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Index : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetGetDisplayInformationIndex(
        ServerName: *const u16,  // LPCWSTR
        Level: u32,  // DWORD
        Prefix: *const u16,  // LPCWSTR
        Index: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetGetDisplayInformationIndex([MarshalAs(UnmanagedType.LPWStr)] string ServerName, uint Level, [MarshalAs(UnmanagedType.LPWStr)] string Prefix, ref uint Index);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetGetDisplayInformationIndex' -Namespace Win32 -PassThru
# $api::NetGetDisplayInformationIndex(ServerName, Level, Prefix, Index)

#uselib "NETAPI32.dll"
#func global NetGetDisplayInformationIndex "NetGetDisplayInformationIndex" sptr, sptr, sptr, sptr
; NetGetDisplayInformationIndex ServerName, Level, Prefix, varptr(Index)   ; 戻り値は stat
; ServerName : LPCWSTR -> "sptr"
; Level : DWORD -> "sptr"
; Prefix : LPCWSTR -> "sptr"
; Index : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetGetDisplayInformationIndex "NetGetDisplayInformationIndex" wstr, int, wstr, var
; res = NetGetDisplayInformationIndex(ServerName, Level, Prefix, Index)
; ServerName : LPCWSTR -> "wstr"
; Level : DWORD -> "int"
; Prefix : LPCWSTR -> "wstr"
; Index : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetGetDisplayInformationIndex "NetGetDisplayInformationIndex" wstr, int, wstr, sptr
; res = NetGetDisplayInformationIndex(ServerName, Level, Prefix, varptr(Index))
; ServerName : LPCWSTR -> "wstr"
; Level : DWORD -> "int"
; Prefix : LPCWSTR -> "wstr"
; Index : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。