Win32 API 日本語リファレンス
ホームSystem.SystemInformation › SetComputerNameExW

SetComputerNameExW

関数
指定した形式でコンピューター名を設定する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetComputerNameExW(
    COMPUTER_NAME_FORMAT NameType,
    LPCWSTR lpBuffer
);

パラメーター

名前方向説明
NameTypeCOMPUTER_NAME_FORMATin

設定する名前の種類。このパラメーターには、 COMPUTER_NAME_FORMAT 列挙型の次のいずれかの値を指定できます。

意味
ComputerNamePhysicalDnsDomain
コンピューターのプライマリ DNS サフィックスを設定します。
ComputerNamePhysicalDnsHostname
NetBIOS 名およびコンピューター名(完全な DNS 名の最初のラベル)を lpBuffer で指定された名前に設定します。名前が MAX_COMPUTERNAME_LENGTH 文字を超える場合、NetBIOS 名は終端の null 文字を含めずに MAX_COMPUTERNAME_LENGTH 文字に切り詰められます。
ComputerNamePhysicalNetBIOS
NetBIOS 名を lpBuffer で指定された名前に設定します。名前は終端の null 文字を含めずに MAX_COMPUTERNAME_LENGTH 文字を超えることはできません。

警告: このオプションを使用して NetBIOS 名を設定すると、相互に依存する NetBIOS 名と DNS 名の規則が崩れます。 DnsHostnameToComputerName 関数を使用して DNS 名の最初のラベルから NetBIOS 名を導出するアプリケーションは、この規則が崩れると失敗します。

lpBufferLPCWSTRin新しい名前。名前には、制御文字、先頭または末尾のスペース、および次の文字を含めることはできません: " / \ [ ] : | < > + = ; , ?

戻り値の型: BOOL

公式ドキュメント

ローカルコンピューターに新しい NetBIOS 名または DNS 名を設定します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SetComputerNameEx は、ローカルコンピューターのコンピューター名(完全な DNS 名の最初のラベル)またはプライマリ DNS サフィックスを設定できます。完全修飾 DNS 名を 1 回の呼び出しで設定することはできません。

ローカルコンピューターがクラスター内のノードである場合、 SetComputerNameEx はクラスター仮想サーバーではなくローカルコンピューターの NetBIOS 名または DNS 名を設定します。

SetComputerNameEx 関数を呼び出すプロセスは、ローカルコンピューター上で管理者権限を持っている必要があります。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

メモ

sysinfoapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetComputerNameEx を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetComputerNameExW(
    COMPUTER_NAME_FORMAT NameType,
    LPCWSTR lpBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetComputerNameExW(
    int NameType,   // COMPUTER_NAME_FORMAT
    [MarshalAs(UnmanagedType.LPWStr)] string lpBuffer   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetComputerNameExW(
    NameType As Integer,   ' COMPUTER_NAME_FORMAT
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' NameType : COMPUTER_NAME_FORMAT
' lpBuffer : LPCWSTR
Declare PtrSafe Function SetComputerNameExW Lib "kernel32" ( _
    ByVal NameType As Long, _
    ByVal lpBuffer As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetComputerNameExW = ctypes.windll.kernel32.SetComputerNameExW
SetComputerNameExW.restype = wintypes.BOOL
SetComputerNameExW.argtypes = [
    ctypes.c_int,  # NameType : COMPUTER_NAME_FORMAT
    wintypes.LPCWSTR,  # lpBuffer : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetComputerNameExW = Fiddle::Function.new(
  lib['SetComputerNameExW'],
  [
    Fiddle::TYPE_INT,  # NameType : COMPUTER_NAME_FORMAT
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetComputerNameExW(
        NameType: i32,  // COMPUTER_NAME_FORMAT
        lpBuffer: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetComputerNameExW(int NameType, [MarshalAs(UnmanagedType.LPWStr)] string lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetComputerNameExW' -Namespace Win32 -PassThru
# $api::SetComputerNameExW(NameType, lpBuffer)
#uselib "KERNEL32.dll"
#func global SetComputerNameExW "SetComputerNameExW" wptr, wptr
; SetComputerNameExW NameType, lpBuffer   ; 戻り値は stat
; NameType : COMPUTER_NAME_FORMAT -> "wptr"
; lpBuffer : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameExW "SetComputerNameExW" int, wstr
; res = SetComputerNameExW(NameType, lpBuffer)
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPCWSTR -> "wstr"
; BOOL SetComputerNameExW(COMPUTER_NAME_FORMAT NameType, LPCWSTR lpBuffer)
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameExW "SetComputerNameExW" int, wstr
; res = SetComputerNameExW(NameType, lpBuffer)
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetComputerNameExW = kernel32.NewProc("SetComputerNameExW")
)

// NameType (COMPUTER_NAME_FORMAT), lpBuffer (LPCWSTR)
r1, _, err := procSetComputerNameExW.Call(
	uintptr(NameType),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBuffer))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetComputerNameExW(
  NameType: Integer;   // COMPUTER_NAME_FORMAT
  lpBuffer: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetComputerNameExW';
result := DllCall("KERNEL32\SetComputerNameExW"
    , "Int", NameType   ; COMPUTER_NAME_FORMAT
    , "WStr", lpBuffer   ; LPCWSTR
    , "Int")   ; return: BOOL
●SetComputerNameExW(NameType, lpBuffer) = DLL("KERNEL32.dll", "bool SetComputerNameExW(int, char*)")
# 呼び出し: SetComputerNameExW(NameType, lpBuffer)
# NameType : COMPUTER_NAME_FORMAT -> "int"
# lpBuffer : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn SetComputerNameExW(
    NameType: i32, // COMPUTER_NAME_FORMAT
    lpBuffer: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetComputerNameExW(
    NameType: int32,  # COMPUTER_NAME_FORMAT
    lpBuffer: WideCString  # LPCWSTR
): int32 {.importc: "SetComputerNameExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int SetComputerNameExW(
    int NameType,   // COMPUTER_NAME_FORMAT
    const(wchar)* lpBuffer   // LPCWSTR
);
ccall((:SetComputerNameExW, "KERNEL32.dll"), stdcall, Int32,
      (Int32, Cwstring),
      NameType, lpBuffer)
# NameType : COMPUTER_NAME_FORMAT -> Int32
# lpBuffer : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetComputerNameExW(
    int32_t NameType,
    const uint16_t* lpBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetComputerNameExW(NameType, lpBuffer)
-- NameType : COMPUTER_NAME_FORMAT
-- lpBuffer : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetComputerNameExW = lib.func('__stdcall', 'SetComputerNameExW', 'int32_t', ['int32_t', 'str16']);
// SetComputerNameExW(NameType, lpBuffer)
// NameType : COMPUTER_NAME_FORMAT -> 'int32_t'
// lpBuffer : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetComputerNameExW: { parameters: ["i32", "buffer"], result: "i32" },
});
// lib.symbols.SetComputerNameExW(NameType, lpBuffer)
// NameType : COMPUTER_NAME_FORMAT -> "i32"
// lpBuffer : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetComputerNameExW(
    int32_t NameType,
    const uint16_t* lpBuffer);
C, "KERNEL32.dll");
// $ffi->SetComputerNameExW(NameType, lpBuffer);
// NameType : COMPUTER_NAME_FORMAT
// lpBuffer : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetComputerNameExW(
        int NameType,   // COMPUTER_NAME_FORMAT
        WString lpBuffer   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun SetComputerNameExW = SetComputerNameExW(
    NameType : Int32,   # COMPUTER_NAME_FORMAT
    lpBuffer : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetComputerNameExWNative = Int32 Function(Int32, Pointer<Utf16>);
typedef SetComputerNameExWDart = int Function(int, Pointer<Utf16>);
final SetComputerNameExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetComputerNameExWNative, SetComputerNameExWDart>('SetComputerNameExW');
// NameType : COMPUTER_NAME_FORMAT -> Int32
// lpBuffer : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetComputerNameExW(
  NameType: Integer;   // COMPUTER_NAME_FORMAT
  lpBuffer: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetComputerNameExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetComputerNameExW"
  c_SetComputerNameExW :: Int32 -> CWString -> IO CInt
-- NameType : COMPUTER_NAME_FORMAT -> Int32
-- lpBuffer : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setcomputernameexw =
  foreign "SetComputerNameExW"
    (int32_t @-> (ptr uint16_t) @-> returning int32_t)
(* NameType : COMPUTER_NAME_FORMAT -> int32_t *)
(* lpBuffer : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetComputerNameExW" set-computer-name-ex-w :convention :stdcall) :int32
  (name-type :int32)   ; COMPUTER_NAME_FORMAT
  (lp-buffer (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetComputerNameExW = Win32::API::More->new('KERNEL32',
    'BOOL SetComputerNameExW(int NameType, LPCWSTR lpBuffer)');
# my $ret = $SetComputerNameExW->Call($NameType, $lpBuffer);
# NameType : COMPUTER_NAME_FORMAT -> int
# lpBuffer : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型