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

NetMessageNameDel

関数
登録済みのメッセージ名を削除する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetMessageNameDel(
    LPCWSTR servername,   // optional
    LPCWSTR msgname
);

パラメーター

名前方向説明
servernameLPCWSTRinoptional関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合、ローカルコンピューターが使用されます。
msgnameLPCWSTRin削除するメッセージ別名を指定する定数文字列へのポインターです。文字列は 15 文字を超えることはできません。

戻り値の型: DWORD

公式ドキュメント

NetMessageNameDel 関数は、メッセージ名テーブル内のメッセージ別名を削除します。この関数を使用するには、Messenger サービスが開始されている必要があります。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
呼び出し元が、操作を完了するための適切な アクセス権を持っていません。
ERROR_INVALID_PARAMETER
パラメーターが正しくありません。
ERROR_NOT_SUPPORTED
この要求はサポートされていません。このエラーは Windows Vista 以降で返されます。
NERR_DelComputerName
コンピューター名でもあるメッセージ別名は削除できません。
NERR_IncompleteDel
メッセージ別名がすべてのネットワークから正常に削除されませんでした。
NERR_NameInUse
メッセージ別名は現在使用中です。後でもう一度お試しください。
NERR_NotLocalName
メッセージ別名がローカルコンピューター上にありません。

解説(Remarks)

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

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

各言語での呼び出し定義

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

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

NetMessageNameDel = ctypes.windll.netapi32.NetMessageNameDel
NetMessageNameDel.restype = wintypes.DWORD
NetMessageNameDel.argtypes = [
    wintypes.LPCWSTR,  # servername : LPCWSTR optional
    wintypes.LPCWSTR,  # msgname : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetMessageNameDel = Fiddle::Function.new(
  lib['NetMessageNameDel'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # msgname : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetMessageNameDel(
        servername: *const u16,  // LPCWSTR optional
        msgname: *const u16  // LPCWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetMessageNameDel([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string msgname);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetMessageNameDel' -Namespace Win32 -PassThru
# $api::NetMessageNameDel(servername, msgname)
#uselib "NETAPI32.dll"
#func global NetMessageNameDel "NetMessageNameDel" sptr, sptr
; NetMessageNameDel servername, msgname   ; 戻り値は stat
; servername : LPCWSTR optional -> "sptr"
; msgname : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NETAPI32.dll"
#cfunc global NetMessageNameDel "NetMessageNameDel" wstr, wstr
; res = NetMessageNameDel(servername, msgname)
; servername : LPCWSTR optional -> "wstr"
; msgname : LPCWSTR -> "wstr"
; DWORD NetMessageNameDel(LPCWSTR servername, LPCWSTR msgname)
#uselib "NETAPI32.dll"
#cfunc global NetMessageNameDel "NetMessageNameDel" wstr, wstr
; res = NetMessageNameDel(servername, msgname)
; servername : LPCWSTR optional -> "wstr"
; msgname : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetMessageNameDel = netapi32.NewProc("NetMessageNameDel")
)

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

extern "netapi32" fn NetMessageNameDel(
    servername: [*c]const u16, // LPCWSTR optional
    msgname: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
proc NetMessageNameDel(
    servername: WideCString,  # LPCWSTR optional
    msgname: WideCString  # LPCWSTR
): uint32 {.importc: "NetMessageNameDel", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetMessageNameDel(
    const(wchar)* servername,   // LPCWSTR optional
    const(wchar)* msgname   // LPCWSTR
);
ccall((:NetMessageNameDel, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring),
      servername, msgname)
# servername : LPCWSTR optional -> Cwstring
# msgname : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetMessageNameDel(
    const uint16_t* servername,
    const uint16_t* msgname);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetMessageNameDel(servername, msgname)
-- servername : LPCWSTR optional
-- msgname : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetMessageNameDel = lib.func('__stdcall', 'NetMessageNameDel', 'uint32_t', ['str16', 'str16']);
// NetMessageNameDel(servername, msgname)
// servername : LPCWSTR optional -> 'str16'
// msgname : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetMessageNameDel: { parameters: ["buffer", "buffer"], result: "u32" },
});
// lib.symbols.NetMessageNameDel(servername, msgname)
// servername : LPCWSTR optional -> "buffer"
// msgname : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetMessageNameDel(
    const uint16_t* servername,
    const uint16_t* msgname);
C, "NETAPI32.dll");
// $ffi->NetMessageNameDel(servername, msgname);
// servername : LPCWSTR optional
// msgname : LPCWSTR
// 構造体/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 NetMessageNameDel(
        WString servername,   // LPCWSTR optional
        WString msgname   // LPCWSTR
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetMessageNameDel = NetMessageNameDel(
    servername : UInt16*,   # LPCWSTR optional
    msgname : UInt16*   # LPCWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetMessageNameDelNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef NetMessageNameDelDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final NetMessageNameDel = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetMessageNameDelNative, NetMessageNameDelDart>('NetMessageNameDel');
// servername : LPCWSTR optional -> Pointer<Utf16>
// msgname : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetMessageNameDel(
  servername: PWideChar;   // LPCWSTR optional
  msgname: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetMessageNameDel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetMessageNameDel"
  c_NetMessageNameDel :: CWString -> CWString -> IO Word32
-- servername : LPCWSTR optional -> CWString
-- msgname : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netmessagenamedel =
  foreign "NetMessageNameDel"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* servername : LPCWSTR optional -> (ptr uint16_t) *)
(* msgname : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetMessageNameDel" net-message-name-del :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPCWSTR optional
  (msgname (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetMessageNameDel = Win32::API::More->new('NETAPI32',
    'DWORD NetMessageNameDel(LPCWSTR servername, LPCWSTR msgname)');
# my $ret = $NetMessageNameDel->Call($servername, $msgname);
# servername : LPCWSTR optional -> LPCWSTR
# msgname : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目