ホーム › NetworkManagement.NetManagement › NetMessageBufferSend

NetMessageBufferSend

関数

指定したメッセージ名へメッセージバッファを送信する。

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

シグネチャ

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

DWORD NetMessageBufferSend(
    LPCWSTR servername,   // optional
    LPCWSTR msgname,
    LPCWSTR fromname,
    BYTE* buf,
    DWORD buflen
);

パラメーター

名前	型	方向	説明
servername	LPCWSTR	inoptional	関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
msgname	LPCWSTR	in	メッセージバッファの送信先となるメッセージエイリアスを指定する定数文字列へのポインターです。
fromname	LPCWSTR	in	メッセージの送信元を指定する定数文字列へのポインターです。このパラメーターが NULL の場合、メッセージはローカルコンピューター名から送信されます。
buf	BYTE*	in	メッセージテキストを格納するバッファへのポインターです。詳細については、 Network Management Function Buffers を参照してください。
buflen	DWORD	in	buf パラメーターが指すメッセージテキストの長さ(バイト単位)を表す値を指定します。

戻り値の型: DWORD

公式ドキュメント

NetMessageBufferSend 関数は、登録されたメッセージエイリアスに情報のバッファを送信します。

戻り値

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

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

Return code	Description
ERROR_ACCESS_DENIED	呼び出し元が、操作を完了するための適切なアクセス権を持っていません。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。
ERROR_NOT_SUPPORTED	この要求はサポートされていません。このエラーは Windows Vista 以降で返されます。
NERR_NameNotFound	ユーザー名が見つかりませんでした。
NERR_NetworkError	ネットワークハードウェアで一般的な障害が発生しました。

解説(Remarks)

Active Directory を実行しているドメインコントローラー上でこの関数を呼び出す場合、アクセスはセキュリティ保護可能なオブジェクトのアクセス制御リスト (ACL) に基づいて許可または拒否されます。既定の ACL では、Domain Admins と Account Operators のみがこの関数を呼び出すことを許可されています。メンバーサーバーまたはワークステーションでは、Administrators と Server Operators のみがこの関数を呼び出すことができます。詳細については、 Security Requirements for the Network Management Functions を参照してください。ACL および ACE の詳細については、 Access Control Model を参照してください。

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

各言語での呼び出し定義

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

DWORD NetMessageBufferSend(
    LPCWSTR servername,   // optional
    LPCWSTR msgname,
    LPCWSTR fromname,
    BYTE* buf,
    DWORD buflen
);

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

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

' servername : LPCWSTR optional
' msgname : LPCWSTR
' fromname : LPCWSTR
' buf : BYTE*
' buflen : DWORD
Declare PtrSafe Function NetMessageBufferSend Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal msgname As LongPtr, _
    ByVal fromname As LongPtr, _
    ByVal buf As LongPtr, _
    ByVal buflen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetMessageBufferSend = ctypes.windll.netapi32.NetMessageBufferSend
NetMessageBufferSend.restype = wintypes.DWORD
NetMessageBufferSend.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # msgname : LPCWSTR
    wintypes.LPCWSTR,  # fromname : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # buf : BYTE*
    wintypes.DWORD,  # buflen : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetMessageBufferSend = Fiddle::Function.new(
  lib['NetMessageBufferSend'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # msgname : LPCWSTR
    Fiddle::TYPE_VOIDP,  # fromname : LPCWSTR
    Fiddle::TYPE_VOIDP,  # buf : BYTE*
    -Fiddle::TYPE_INT,  # buflen : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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