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

NetRemoveAlternateComputerName

関数
コンピューターから代替名を削除する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetRemoveAlternateComputerName(
    LPCWSTR Server,   // optional
    LPCWSTR AlternateName,
    LPCWSTR DomainAccount,   // optional
    LPCWSTR DomainAccountPassword,   // optional
    DWORD Reserved
);

パラメーター

名前方向説明
ServerLPCWSTRinoptionalこの関数を実行するコンピューターの名前を指定する定数文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
AlternateNameLPCWSTRin削除する代替名を指定する定数文字列へのポインター。この名前は完全修飾 DNS 名の形式である必要があります。
DomainAccountLPCWSTRinoptional

Active Directory 内の Server パラメーターで指定されたコンピューターのマシンアカウントオブジェクトにアクセスするために使用するドメインアカウントを指定する定数文字列へのポインター。このパラメーターが NULL の場合は、このルーチンを実行しているユーザーの資格情報が使用されます。

この関数を実行するサーバーがドメインに参加していない場合、このパラメーターは使用されません。

DomainAccountPasswordLPCWSTRinoptional

DomainAccount パラメーターで渡されたドメインアカウントに対応するパスワードを指定する定数文字列へのポインター。このパラメーターが NULL の場合は、このルーチンを実行しているユーザーの資格情報が使用されます。

DomainAccount パラメーターが NULL の場合、このパラメーターは無視されます。この関数を実行するサーバーがドメインに参加していない場合、このパラメーターは使用されません。

ReservedDWORDin将来の使用のために予約されています。このパラメーターは NULL である必要があります。

戻り値の型: DWORD

公式ドキュメント

指定したコンピューターの代替名を削除します。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、呼び出し元が対象コンピューターの Administrators ローカルグループのメンバーでなかった場合に返されます。
ERROR_INVALID_NAME
名前パラメーターが正しくありません。このエラーは、AlternateName パラメーターに有効な名前が含まれていない場合に返されます。
ERROR_INVALID_PARAMETER
パラメーターが正しくありません。このエラーは、DomainAccount パラメーターに有効なドメインが含まれていない場合に返されます。また、DomainAccount パラメーターが NULL ではなく、DomainAccountPassword パラメーターが NULL ではないものの Unicode 文字列を含んでいない場合にも返されます。
ERROR_NOT_ENOUGH_MEMORY
このコマンドを処理するために十分なメモリがありません。
ERROR_NOT_SUPPORTED
要求はサポートされていません。このエラーは、この関数を実行する Server パラメーターで指定された対象コンピューターが Windows 2000 以前で動作している場合に返されます。
NERR_WkstaNotStarted
Workstation サービスが開始されていません。
RPC_S_CALL_IN_PROGRESS
このスレッドではリモートプロシージャコールが既に進行中です。
RPC_S_PROTSEQ_NOT_SUPPORTED
リモートプロシージャコールのプロトコルシーケンスがサポートされていません。

解説(Remarks)

NetRemoveAlternateComputerName 関数は、Windows XP 以降でサポートされています。

NetRemoveAlternateComputerName 関数は、対象コンピューターに構成されたセカンダリコンピューター名を削除するために使用されます。

NetRemoveAlternateComputerName 関数では、呼び出し元が対象コンピューターの Administrators ローカルグループのメンバーである必要があります。

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

各言語での呼び出し定義

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

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

NetRemoveAlternateComputerName = ctypes.windll.netapi32.NetRemoveAlternateComputerName
NetRemoveAlternateComputerName.restype = wintypes.DWORD
NetRemoveAlternateComputerName.argtypes = [
    wintypes.LPCWSTR,  # Server : LPCWSTR optional
    wintypes.LPCWSTR,  # AlternateName : LPCWSTR
    wintypes.LPCWSTR,  # DomainAccount : LPCWSTR optional
    wintypes.LPCWSTR,  # DomainAccountPassword : LPCWSTR optional
    wintypes.DWORD,  # Reserved : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetRemoveAlternateComputerName = netapi32.NewProc("NetRemoveAlternateComputerName")
)

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

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

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

foreign import stdcall safe "NetRemoveAlternateComputerName"
  c_NetRemoveAlternateComputerName :: CWString -> CWString -> CWString -> CWString -> Word32 -> IO Word32
-- Server : LPCWSTR optional -> CWString
-- AlternateName : LPCWSTR -> CWString
-- DomainAccount : LPCWSTR optional -> CWString
-- DomainAccountPassword : LPCWSTR optional -> CWString
-- Reserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("NetRemoveAlternateComputerName" net-remove-alternate-computer-name :convention :stdcall) :uint32
  (server (:string :encoding :utf-16le))   ; LPCWSTR optional
  (alternate-name (:string :encoding :utf-16le))   ; LPCWSTR
  (domain-account (:string :encoding :utf-16le))   ; LPCWSTR optional
  (domain-account-password (:string :encoding :utf-16le))   ; LPCWSTR optional
  (reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetRemoveAlternateComputerName = Win32::API::More->new('NETAPI32',
    'DWORD NetRemoveAlternateComputerName(LPCWSTR Server, LPCWSTR AlternateName, LPCWSTR DomainAccount, LPCWSTR DomainAccountPassword, DWORD Reserved)');
# my $ret = $NetRemoveAlternateComputerName->Call($Server, $AlternateName, $DomainAccount, $DomainAccountPassword, $Reserved);
# Server : LPCWSTR optional -> LPCWSTR
# AlternateName : LPCWSTR -> LPCWSTR
# DomainAccount : LPCWSTR optional -> LPCWSTR
# DomainAccountPassword : LPCWSTR optional -> LPCWSTR
# Reserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目