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

NetSetPrimaryComputerName

関数
コンピューターのプライマリ名を設定する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetSetPrimaryComputerName(
    LPCWSTR Server,   // optional
    LPCWSTR PrimaryName,
    LPCWSTR DomainAccount,   // optional
    LPCWSTR DomainAccountPassword,   // optional
    DWORD Reserved
);

パラメーター

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

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

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

DomainAccountPasswordLPCWSTRinoptional

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

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

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

戻り値の型: DWORD

公式ドキュメント

指定したコンピューターのプライマリ コンピューター名を設定します。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、呼び出し元が対象コンピューターの Administrators ローカル グループのメンバーでない場合に返されます。
ERROR_INVALID_NAME
名前パラメーターが正しくありません。このエラーは、PrimaryName パラメーターに有効な名前が含まれていない場合に返されます。
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)

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

NetSetPrimaryComputerName 関数は、コンピューターの名前変更操作の一部として使用されます。指定した名前は、対象コンピューターに構成された代替名リストから削除され、プライマリ名として構成されます。コンピューター アカウント名はプライマリ名に一致するように変更されます。以前のプライマリ コンピューター名は、コンピューターに構成された代替コンピューター名リストに移動されます。

NetSetPrimaryComputerName 関数では、呼び出し元が対象コンピューターの 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 NetSetPrimaryComputerName(
    LPCWSTR Server,   // optional
    LPCWSTR PrimaryName,
    LPCWSTR DomainAccount,   // optional
    LPCWSTR DomainAccountPassword,   // optional
    DWORD Reserved
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetSetPrimaryComputerName(
    [MarshalAs(UnmanagedType.LPWStr)] string Server,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string PrimaryName,   // 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 NetSetPrimaryComputerName(
    <MarshalAs(UnmanagedType.LPWStr)> Server As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> PrimaryName 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
' PrimaryName : LPCWSTR
' DomainAccount : LPCWSTR optional
' DomainAccountPassword : LPCWSTR optional
' Reserved : DWORD
Declare PtrSafe Function NetSetPrimaryComputerName Lib "netapi32" ( _
    ByVal Server As LongPtr, _
    ByVal PrimaryName 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

NetSetPrimaryComputerName = ctypes.windll.netapi32.NetSetPrimaryComputerName
NetSetPrimaryComputerName.restype = wintypes.DWORD
NetSetPrimaryComputerName.argtypes = [
    wintypes.LPCWSTR,  # Server : LPCWSTR optional
    wintypes.LPCWSTR,  # PrimaryName : 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')
NetSetPrimaryComputerName = Fiddle::Function.new(
  lib['NetSetPrimaryComputerName'],
  [
    Fiddle::TYPE_VOIDP,  # Server : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # PrimaryName : 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 NetSetPrimaryComputerName(
        Server: *const u16,  // LPCWSTR optional
        PrimaryName: *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 NetSetPrimaryComputerName([MarshalAs(UnmanagedType.LPWStr)] string Server, [MarshalAs(UnmanagedType.LPWStr)] string PrimaryName, [MarshalAs(UnmanagedType.LPWStr)] string DomainAccount, [MarshalAs(UnmanagedType.LPWStr)] string DomainAccountPassword, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetSetPrimaryComputerName' -Namespace Win32 -PassThru
# $api::NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
#uselib "NETAPI32.dll"
#func global NetSetPrimaryComputerName "NetSetPrimaryComputerName" sptr, sptr, sptr, sptr, sptr
; NetSetPrimaryComputerName Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved   ; 戻り値は stat
; Server : LPCWSTR optional -> "sptr"
; PrimaryName : LPCWSTR -> "sptr"
; DomainAccount : LPCWSTR optional -> "sptr"
; DomainAccountPassword : LPCWSTR optional -> "sptr"
; Reserved : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NETAPI32.dll"
#cfunc global NetSetPrimaryComputerName "NetSetPrimaryComputerName" wstr, wstr, wstr, wstr, int
; res = NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
; Server : LPCWSTR optional -> "wstr"
; PrimaryName : LPCWSTR -> "wstr"
; DomainAccount : LPCWSTR optional -> "wstr"
; DomainAccountPassword : LPCWSTR optional -> "wstr"
; Reserved : DWORD -> "int"
; DWORD NetSetPrimaryComputerName(LPCWSTR Server, LPCWSTR PrimaryName, LPCWSTR DomainAccount, LPCWSTR DomainAccountPassword, DWORD Reserved)
#uselib "NETAPI32.dll"
#cfunc global NetSetPrimaryComputerName "NetSetPrimaryComputerName" wstr, wstr, wstr, wstr, int
; res = NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
; Server : LPCWSTR optional -> "wstr"
; PrimaryName : 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")
	procNetSetPrimaryComputerName = netapi32.NewProc("NetSetPrimaryComputerName")
)

// Server (LPCWSTR optional), PrimaryName (LPCWSTR), DomainAccount (LPCWSTR optional), DomainAccountPassword (LPCWSTR optional), Reserved (DWORD)
r1, _, err := procNetSetPrimaryComputerName.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Server))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(PrimaryName))),
	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 NetSetPrimaryComputerName(
  Server: PWideChar;   // LPCWSTR optional
  PrimaryName: PWideChar;   // LPCWSTR
  DomainAccount: PWideChar;   // LPCWSTR optional
  DomainAccountPassword: PWideChar;   // LPCWSTR optional
  Reserved: DWORD   // DWORD
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetSetPrimaryComputerName';
result := DllCall("NETAPI32\NetSetPrimaryComputerName"
    , "WStr", Server   ; LPCWSTR optional
    , "WStr", PrimaryName   ; LPCWSTR
    , "WStr", DomainAccount   ; LPCWSTR optional
    , "WStr", DomainAccountPassword   ; LPCWSTR optional
    , "UInt", Reserved   ; DWORD
    , "UInt")   ; return: DWORD
●NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved) = DLL("NETAPI32.dll", "dword NetSetPrimaryComputerName(char*, char*, char*, char*, dword)")
# 呼び出し: NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
# Server : LPCWSTR optional -> "char*"
# PrimaryName : 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 NetSetPrimaryComputerName(
    Server: [*c]const u16, // LPCWSTR optional
    PrimaryName: [*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 NetSetPrimaryComputerName(
    Server: WideCString,  # LPCWSTR optional
    PrimaryName: WideCString,  # LPCWSTR
    DomainAccount: WideCString,  # LPCWSTR optional
    DomainAccountPassword: WideCString,  # LPCWSTR optional
    Reserved: uint32  # DWORD
): uint32 {.importc: "NetSetPrimaryComputerName", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetSetPrimaryComputerName(
    const(wchar)* Server,   // LPCWSTR optional
    const(wchar)* PrimaryName,   // LPCWSTR
    const(wchar)* DomainAccount,   // LPCWSTR optional
    const(wchar)* DomainAccountPassword,   // LPCWSTR optional
    uint Reserved   // DWORD
);
ccall((:NetSetPrimaryComputerName, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, Cwstring, Cwstring, UInt32),
      Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
# Server : LPCWSTR optional -> Cwstring
# PrimaryName : LPCWSTR -> Cwstring
# DomainAccount : LPCWSTR optional -> Cwstring
# DomainAccountPassword : LPCWSTR optional -> Cwstring
# Reserved : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetSetPrimaryComputerName(
    const uint16_t* Server,
    const uint16_t* PrimaryName,
    const uint16_t* DomainAccount,
    const uint16_t* DomainAccountPassword,
    uint32_t Reserved);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
-- Server : LPCWSTR optional
-- PrimaryName : 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 NetSetPrimaryComputerName = lib.func('__stdcall', 'NetSetPrimaryComputerName', 'uint32_t', ['str16', 'str16', 'str16', 'str16', 'uint32_t']);
// NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
// Server : LPCWSTR optional -> 'str16'
// PrimaryName : LPCWSTR -> 'str16'
// DomainAccount : LPCWSTR optional -> 'str16'
// DomainAccountPassword : LPCWSTR optional -> 'str16'
// Reserved : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetSetPrimaryComputerName: { parameters: ["buffer", "buffer", "buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved)
// Server : LPCWSTR optional -> "buffer"
// PrimaryName : 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 NetSetPrimaryComputerName(
    const uint16_t* Server,
    const uint16_t* PrimaryName,
    const uint16_t* DomainAccount,
    const uint16_t* DomainAccountPassword,
    uint32_t Reserved);
C, "NETAPI32.dll");
// $ffi->NetSetPrimaryComputerName(Server, PrimaryName, DomainAccount, DomainAccountPassword, Reserved);
// Server : LPCWSTR optional
// PrimaryName : 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 NetSetPrimaryComputerName(
        WString Server,   // LPCWSTR optional
        WString PrimaryName,   // LPCWSTR
        WString DomainAccount,   // LPCWSTR optional
        WString DomainAccountPassword,   // LPCWSTR optional
        int Reserved   // DWORD
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetSetPrimaryComputerName = NetSetPrimaryComputerName(
    Server : UInt16*,   # LPCWSTR optional
    PrimaryName : 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 NetSetPrimaryComputerNameNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef NetSetPrimaryComputerNameDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final NetSetPrimaryComputerName = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetSetPrimaryComputerNameNative, NetSetPrimaryComputerNameDart>('NetSetPrimaryComputerName');
// Server : LPCWSTR optional -> Pointer<Utf16>
// PrimaryName : LPCWSTR -> Pointer<Utf16>
// DomainAccount : LPCWSTR optional -> Pointer<Utf16>
// DomainAccountPassword : LPCWSTR optional -> Pointer<Utf16>
// Reserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetSetPrimaryComputerName(
  Server: PWideChar;   // LPCWSTR optional
  PrimaryName: PWideChar;   // LPCWSTR
  DomainAccount: PWideChar;   // LPCWSTR optional
  DomainAccountPassword: PWideChar;   // LPCWSTR optional
  Reserved: DWORD   // DWORD
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetSetPrimaryComputerName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetSetPrimaryComputerName"
  c_NetSetPrimaryComputerName :: CWString -> CWString -> CWString -> CWString -> Word32 -> IO Word32
-- Server : LPCWSTR optional -> CWString
-- PrimaryName : 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 netsetprimarycomputername =
  foreign "NetSetPrimaryComputerName"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* Server : LPCWSTR optional -> (ptr uint16_t) *)
(* PrimaryName : 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 ("NetSetPrimaryComputerName" net-set-primary-computer-name :convention :stdcall) :uint32
  (server (:string :encoding :utf-16le))   ; LPCWSTR optional
  (primary-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 $NetSetPrimaryComputerName = Win32::API::More->new('NETAPI32',
    'DWORD NetSetPrimaryComputerName(LPCWSTR Server, LPCWSTR PrimaryName, LPCWSTR DomainAccount, LPCWSTR DomainAccountPassword, DWORD Reserved)');
# my $ret = $NetSetPrimaryComputerName->Call($Server, $PrimaryName, $DomainAccount, $DomainAccountPassword, $Reserved);
# Server : LPCWSTR optional -> LPCWSTR
# PrimaryName : LPCWSTR -> LPCWSTR
# DomainAccount : LPCWSTR optional -> LPCWSTR
# DomainAccountPassword : LPCWSTR optional -> LPCWSTR
# Reserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目