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

SetComputerNameW

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

シグネチャ

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

BOOL SetComputerNameW(
    LPCWSTR lpComputerName
);

パラメーター

名前方向説明
lpComputerNameLPCWSTRin

次にコンピューターを起動したときに有効になるコンピューター名です。名前は MAX_COMPUTERNAME_LENGTH 文字を超えてはなりません。

標準文字セットには、英字、数字、および次の記号が含まれます: ! @ # $ % ^ & ' ) ( . - _ { } ~ 。このパラメーターに標準文字セット外の文字が 1 つ以上含まれている場合、 SetComputerNameERROR_INVALID_PARAMETER を返します。

戻り値の型: BOOL

公式ドキュメント

ローカルコンピューターに新しい NetBIOS 名を設定します。名前はレジストリに格納され、名前の変更はユーザーが次にコンピューターを再起動したときに有効になります。(Unicode)

戻り値

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

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

解説(Remarks)

この関数を使用するアプリケーションには管理者権限が必要です。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetComputerNameW(
    LPCWSTR lpComputerName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetComputerNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpComputerName   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetComputerNameW(
    <MarshalAs(UnmanagedType.LPWStr)> lpComputerName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpComputerName : LPCWSTR
Declare PtrSafe Function SetComputerNameW Lib "kernel32" ( _
    ByVal lpComputerName 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

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

lib = Fiddle.dlopen('KERNEL32.dll')
SetComputerNameW = Fiddle::Function.new(
  lib['SetComputerNameW'],
  [
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetComputerNameW(
        lpComputerName: *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 SetComputerNameW([MarshalAs(UnmanagedType.LPWStr)] string lpComputerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetComputerNameW' -Namespace Win32 -PassThru
# $api::SetComputerNameW(lpComputerName)
#uselib "KERNEL32.dll"
#func global SetComputerNameW "SetComputerNameW" wptr
; SetComputerNameW lpComputerName   ; 戻り値は stat
; lpComputerName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameW "SetComputerNameW" wstr
; res = SetComputerNameW(lpComputerName)
; lpComputerName : LPCWSTR -> "wstr"
; BOOL SetComputerNameW(LPCWSTR lpComputerName)
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameW "SetComputerNameW" wstr
; res = SetComputerNameW(lpComputerName)
; lpComputerName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetComputerNameW = kernel32.NewProc("SetComputerNameW")
)

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

extern "kernel32" fn SetComputerNameW(
    lpComputerName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetComputerNameW(
    lpComputerName: WideCString  # LPCWSTR
): int32 {.importc: "SetComputerNameW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int SetComputerNameW(
    const(wchar)* lpComputerName   // LPCWSTR
);
ccall((:SetComputerNameW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring,),
      lpComputerName)
# lpComputerName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetComputerNameW(
    const uint16_t* lpComputerName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetComputerNameW(lpComputerName)
-- lpComputerName : 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 SetComputerNameW = lib.func('__stdcall', 'SetComputerNameW', 'int32_t', ['str16']);
// SetComputerNameW(lpComputerName)
// lpComputerName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetComputerNameW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetComputerNameW(lpComputerName)
// lpComputerName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetComputerNameW(
    const uint16_t* lpComputerName);
C, "KERNEL32.dll");
// $ffi->SetComputerNameW(lpComputerName);
// lpComputerName : 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 SetComputerNameW(
        WString lpComputerName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun SetComputerNameW = SetComputerNameW(
    lpComputerName : 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 SetComputerNameWNative = Int32 Function(Pointer<Utf16>);
typedef SetComputerNameWDart = int Function(Pointer<Utf16>);
final SetComputerNameW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetComputerNameWNative, SetComputerNameWDart>('SetComputerNameW');
// lpComputerName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetComputerNameW(
  lpComputerName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetComputerNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setcomputernamew =
  foreign "SetComputerNameW"
    ((ptr uint16_t) @-> returning int32_t)
(* lpComputerName : 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 ("SetComputerNameW" set-computer-name-w :convention :stdcall) :int32
  (lp-computer-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetComputerNameW = Win32::API::More->new('KERNEL32',
    'BOOL SetComputerNameW(LPCWSTR lpComputerName)');
# my $ret = $SetComputerNameW->Call($lpComputerName);
# lpComputerName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目