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

SetComputerNameA

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SetComputerNameA(
    LPCSTR lpComputerName
);

パラメーター

名前方向説明
lpComputerNameLPCSTRin

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (ANSI / -A)
#include <windows.h>

BOOL SetComputerNameA(
    LPCSTR lpComputerName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetComputerNameA(
    [MarshalAs(UnmanagedType.LPStr)] string lpComputerName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetComputerNameA(
    <MarshalAs(UnmanagedType.LPStr)> lpComputerName As String   ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpComputerName : LPCSTR
Declare PtrSafe Function SetComputerNameA Lib "kernel32" ( _
    ByVal lpComputerName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('KERNEL32.dll')
SetComputerNameA = Fiddle::Function.new(
  lib['SetComputerNameA'],
  [
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetComputerNameA(
        lpComputerName: *const u8  // LPCSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetComputerNameA([MarshalAs(UnmanagedType.LPStr)] string lpComputerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetComputerNameA' -Namespace Win32 -PassThru
# $api::SetComputerNameA(lpComputerName)
#uselib "KERNEL32.dll"
#func global SetComputerNameA "SetComputerNameA" sptr
; SetComputerNameA lpComputerName   ; 戻り値は stat
; lpComputerName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameA "SetComputerNameA" str
; res = SetComputerNameA(lpComputerName)
; lpComputerName : LPCSTR -> "str"
; BOOL SetComputerNameA(LPCSTR lpComputerName)
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameA "SetComputerNameA" str
; res = SetComputerNameA(lpComputerName)
; lpComputerName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetComputerNameA = kernel32.NewProc("SetComputerNameA")
)

// lpComputerName (LPCSTR)
r1, _, err := procSetComputerNameA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpComputerName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetComputerNameA(
  lpComputerName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetComputerNameA';
result := DllCall("KERNEL32\SetComputerNameA"
    , "AStr", lpComputerName   ; LPCSTR
    , "Int")   ; return: BOOL
●SetComputerNameA(lpComputerName) = DLL("KERNEL32.dll", "bool SetComputerNameA(char*)")
# 呼び出し: SetComputerNameA(lpComputerName)
# lpComputerName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetComputerNameA(
    lpComputerName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;
proc SetComputerNameA(
    lpComputerName: cstring  # LPCSTR
): int32 {.importc: "SetComputerNameA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetComputerNameA(
    const(char)* lpComputerName   // LPCSTR
);
ccall((:SetComputerNameA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring,),
      lpComputerName)
# lpComputerName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetComputerNameA(
    const char* lpComputerName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetComputerNameA(lpComputerName)
-- lpComputerName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetComputerNameA = lib.func('__stdcall', 'SetComputerNameA', 'int32_t', ['str']);
// SetComputerNameA(lpComputerName)
// lpComputerName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetComputerNameA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetComputerNameA(lpComputerName)
// lpComputerName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetComputerNameA(
    const char* lpComputerName);
C, "KERNEL32.dll");
// $ffi->SetComputerNameA(lpComputerName);
// lpComputerName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
    boolean SetComputerNameA(
        String lpComputerName   // LPCSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetComputerNameA = SetComputerNameA(
    lpComputerName : UInt8*   # LPCSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetComputerNameANative = Int32 Function(Pointer<Utf8>);
typedef SetComputerNameADart = int Function(Pointer<Utf8>);
final SetComputerNameA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetComputerNameANative, SetComputerNameADart>('SetComputerNameA');
// lpComputerName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetComputerNameA(
  lpComputerName: PAnsiChar   // LPCSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetComputerNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setcomputernamea =
  foreign "SetComputerNameA"
    (string @-> returning int32_t)
(* lpComputerName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetComputerNameA" set-computer-name-a :convention :stdcall) :int32
  (lp-computer-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetComputerNameA = Win32::API::More->new('KERNEL32',
    'BOOL SetComputerNameA(LPCSTR lpComputerName)');
# my $ret = $SetComputerNameA->Call($lpComputerName);
# lpComputerName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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