SetComputerNameExA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetComputerNameExA(
COMPUTER_NAME_FORMAT NameType,
LPCSTR lpBuffer
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| NameType | COMPUTER_NAME_FORMAT | in | 設定する名前の種類です。このパラメーターには、 COMPUTER_NAME_FORMAT 列挙型の次のいずれかの値を指定できます。
| ||||||||
| lpBuffer | LPCSTR | in | 新しい名前です。名前には、制御文字、先頭または末尾の空白、および次の文字を含めることはできません: " / \ [ ] : | < > + = ; , ? |
戻り値の型: BOOL
公式ドキュメント
ローカルコンピューターに新しい NetBIOS 名または DNS 名を設定します。(ANSI)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
SetComputerNameEx は、ローカルコンピューターのコンピューター名 (完全な DNS 名の先頭ラベル) またはプライマリ DNS サフィックスを設定できます。完全修飾 DNS 名を 1 回の呼び出しで設定することはできません。
ローカルコンピューターがクラスター内のノードである場合、 SetComputerNameEx はクラスター仮想サーバーではなく、ローカルコンピューターの NetBIOS 名または DNS 名を設定します。
SetComputerNameEx 関数を呼び出すプロセスには、ローカルコンピューターでの管理者特権が必要です。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。
sysinfoapi.h ヘッダーは SetComputerNameEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetComputerNameExA(
COMPUTER_NAME_FORMAT NameType,
LPCSTR lpBuffer
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetComputerNameExA(
int NameType, // COMPUTER_NAME_FORMAT
[MarshalAs(UnmanagedType.LPStr)] string lpBuffer // LPCSTR
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetComputerNameExA(
NameType As Integer, ' COMPUTER_NAME_FORMAT
<MarshalAs(UnmanagedType.LPStr)> lpBuffer As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' NameType : COMPUTER_NAME_FORMAT
' lpBuffer : LPCSTR
Declare PtrSafe Function SetComputerNameExA Lib "kernel32" ( _
ByVal NameType As Long, _
ByVal lpBuffer As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetComputerNameExA = ctypes.windll.kernel32.SetComputerNameExA
SetComputerNameExA.restype = wintypes.BOOL
SetComputerNameExA.argtypes = [
ctypes.c_int, # NameType : COMPUTER_NAME_FORMAT
wintypes.LPCSTR, # lpBuffer : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetComputerNameExA = Fiddle::Function.new(
lib['SetComputerNameExA'],
[
Fiddle::TYPE_INT, # NameType : COMPUTER_NAME_FORMAT
Fiddle::TYPE_VOIDP, # lpBuffer : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetComputerNameExA(
NameType: i32, // COMPUTER_NAME_FORMAT
lpBuffer: *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 SetComputerNameExA(int NameType, [MarshalAs(UnmanagedType.LPStr)] string lpBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetComputerNameExA' -Namespace Win32 -PassThru
# $api::SetComputerNameExA(NameType, lpBuffer)#uselib "KERNEL32.dll"
#func global SetComputerNameExA "SetComputerNameExA" sptr, sptr
; SetComputerNameExA NameType, lpBuffer ; 戻り値は stat
; NameType : COMPUTER_NAME_FORMAT -> "sptr"
; lpBuffer : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetComputerNameExA "SetComputerNameExA" int, str
; res = SetComputerNameExA(NameType, lpBuffer)
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPCSTR -> "str"; BOOL SetComputerNameExA(COMPUTER_NAME_FORMAT NameType, LPCSTR lpBuffer)
#uselib "KERNEL32.dll"
#cfunc global SetComputerNameExA "SetComputerNameExA" int, str
; res = SetComputerNameExA(NameType, lpBuffer)
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetComputerNameExA = kernel32.NewProc("SetComputerNameExA")
)
// NameType (COMPUTER_NAME_FORMAT), lpBuffer (LPCSTR)
r1, _, err := procSetComputerNameExA.Call(
uintptr(NameType),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBuffer))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetComputerNameExA(
NameType: Integer; // COMPUTER_NAME_FORMAT
lpBuffer: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetComputerNameExA';result := DllCall("KERNEL32\SetComputerNameExA"
, "Int", NameType ; COMPUTER_NAME_FORMAT
, "AStr", lpBuffer ; LPCSTR
, "Int") ; return: BOOL●SetComputerNameExA(NameType, lpBuffer) = DLL("KERNEL32.dll", "bool SetComputerNameExA(int, char*)")
# 呼び出し: SetComputerNameExA(NameType, lpBuffer)
# NameType : COMPUTER_NAME_FORMAT -> "int"
# lpBuffer : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetComputerNameExA(
NameType: i32, // COMPUTER_NAME_FORMAT
lpBuffer: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc SetComputerNameExA(
NameType: int32, # COMPUTER_NAME_FORMAT
lpBuffer: cstring # LPCSTR
): int32 {.importc: "SetComputerNameExA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetComputerNameExA(
int NameType, // COMPUTER_NAME_FORMAT
const(char)* lpBuffer // LPCSTR
);ccall((:SetComputerNameExA, "KERNEL32.dll"), stdcall, Int32,
(Int32, Cstring),
NameType, lpBuffer)
# NameType : COMPUTER_NAME_FORMAT -> Int32
# lpBuffer : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetComputerNameExA(
int32_t NameType,
const char* lpBuffer);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetComputerNameExA(NameType, lpBuffer)
-- NameType : COMPUTER_NAME_FORMAT
-- lpBuffer : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetComputerNameExA = lib.func('__stdcall', 'SetComputerNameExA', 'int32_t', ['int32_t', 'str']);
// SetComputerNameExA(NameType, lpBuffer)
// NameType : COMPUTER_NAME_FORMAT -> 'int32_t'
// lpBuffer : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetComputerNameExA: { parameters: ["i32", "buffer"], result: "i32" },
});
// lib.symbols.SetComputerNameExA(NameType, lpBuffer)
// NameType : COMPUTER_NAME_FORMAT -> "i32"
// lpBuffer : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetComputerNameExA(
int32_t NameType,
const char* lpBuffer);
C, "KERNEL32.dll");
// $ffi->SetComputerNameExA(NameType, lpBuffer);
// NameType : COMPUTER_NAME_FORMAT
// lpBuffer : 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 SetComputerNameExA(
int NameType, // COMPUTER_NAME_FORMAT
String lpBuffer // LPCSTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetComputerNameExA = SetComputerNameExA(
NameType : Int32, # COMPUTER_NAME_FORMAT
lpBuffer : 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 SetComputerNameExANative = Int32 Function(Int32, Pointer<Utf8>);
typedef SetComputerNameExADart = int Function(int, Pointer<Utf8>);
final SetComputerNameExA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetComputerNameExANative, SetComputerNameExADart>('SetComputerNameExA');
// NameType : COMPUTER_NAME_FORMAT -> Int32
// lpBuffer : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetComputerNameExA(
NameType: Integer; // COMPUTER_NAME_FORMAT
lpBuffer: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetComputerNameExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetComputerNameExA"
c_SetComputerNameExA :: Int32 -> CString -> IO CInt
-- NameType : COMPUTER_NAME_FORMAT -> Int32
-- lpBuffer : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setcomputernameexa =
foreign "SetComputerNameExA"
(int32_t @-> string @-> returning int32_t)
(* NameType : COMPUTER_NAME_FORMAT -> int32_t *)
(* lpBuffer : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetComputerNameExA" set-computer-name-ex-a :convention :stdcall) :int32
(name-type :int32) ; COMPUTER_NAME_FORMAT
(lp-buffer :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetComputerNameExA = Win32::API::More->new('KERNEL32',
'BOOL SetComputerNameExA(int NameType, LPCSTR lpBuffer)');
# my $ret = $SetComputerNameExA->Call($NameType, $lpBuffer);
# NameType : COMPUTER_NAME_FORMAT -> int
# lpBuffer : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SetComputerNameExW (Unicode版) — 指定した形式でコンピューター名を設定する(Unicode版)。
- f SetComputerNameA — コンピューター名を設定する(ANSI版)。
- f DnsHostnameToComputerNameA — DNSホスト名をNetBIOSコンピューター名に変換する(ANSI版)。
- f GetComputerNameA — 現在のコンピューターのNetBIOS名を取得する(ANSI版)。
- f GetComputerNameExA — 指定した形式でコンピューター名を取得する(ANSI版)。