ホーム › NetworkManagement.NetManagement › NetMessageNameGetInfo

NetMessageNameGetInfo

関数

指定したメッセージ名の情報を取得する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPCWSTR

inoptional

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

msgname

LPCWSTR

情報を取得する対象のメッセージエイリアスを指定する定数文字列へのポインターです。

level

DWORD

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

値	意味
0	メッセージエイリアスを返します。bufptr パラメーターは MSG_INFO_0 構造体を指します。
1	メッセージエイリアスを返します。bufptr パラメーターは MSG_INFO_1 構造体を指します。このレベルは互換性のためにのみ存在します。メッセージの転送はサポートされていません。

bufptr

BYTE**

データを受け取るバッファーへのポインターです。このデータの形式は level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

NetMessageNameGetInfo 関数は、メッセージ名テーブル内の特定のメッセージエイリアスに関する情報を取得します。この関数を使用するには、Messenger サービスが開始されている必要があります。

戻り値

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	呼び出し元に、この操作を完了するための適切なアクセス権がありません。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。
ERROR_NOT_ENOUGH_MEMORY	使用可能なメモリが不足しています。
ERROR_NOT_SUPPORTED	この要求はサポートされていません。このエラーは Windows Vista 以降で返されます。
NERR_NotLocalName	メッセージエイリアスがローカルコンピューター上にありません。

解説(Remarks)

リモートサーバー上で NetMessageNameGetInfo 関数を正常に実行できるのは、Administrators ローカルグループのメンバーのみです。

メッセージ名テーブル内のすべてのメッセージエイリアスを列挙するには、 NetMessageNameEnum 関数を呼び出します。

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

各言語での呼び出し定義

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

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

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetMessageNameGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string msgname,   // LPCWSTR
    uint level,   // DWORD
    IntPtr bufptr   // BYTE**
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetMessageNameGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> msgname As String,   ' LPCWSTR
    level As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE**
) As UInteger
End Function

' servername : LPCWSTR optional
' msgname : LPCWSTR
' level : DWORD
' bufptr : BYTE**
Declare PtrSafe Function NetMessageNameGetInfo Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal msgname 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

NetMessageNameGetInfo = ctypes.windll.netapi32.NetMessageNameGetInfo
NetMessageNameGetInfo.restype = wintypes.DWORD
NetMessageNameGetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # msgname : LPCWSTR
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE**
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetMessageNameGetInfo = Fiddle::Function.new(
  lib['NetMessageNameGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # msgname : LPCWSTR
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE**
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetMessageNameGetInfo(
        servername: *const u16,  // LPCWSTR optional
        msgname: *const u16,  // LPCWSTR
        level: u32,  // DWORD
        bufptr: *mut *mut u8  // BYTE**
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetMessageNameGetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string msgname, uint level, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetMessageNameGetInfo' -Namespace Win32 -PassThru
# $api::NetMessageNameGetInfo(servername, msgname, level, bufptr)

#uselib "NETAPI32.dll"
#func global NetMessageNameGetInfo "NetMessageNameGetInfo" sptr, sptr, sptr, sptr
; NetMessageNameGetInfo servername, msgname, level, varptr(bufptr)   ; 戻り値は stat
; servername : LPCWSTR optional -> "sptr"
; msgname : LPCWSTR -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE** -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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