Win32 API 日本語リファレンス
ホームNetworking.WinSock › GetHostNameW

GetHostNameW

関数
ローカルホスト名をUnicode文字列で取得する。
DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

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

INT GetHostNameW(
    LPWSTR name,
    INT namelen
);

パラメーター

名前方向説明
nameLPWSTRoutローカルホスト名を null 終端の Unicode 文字列として受け取るバッファーへのポインター。
namelenINTinname パラメーターが指すバッファーの長さ(ワイド文字数)。

戻り値の型: INT

公式ドキュメント

GetHostNameW 関数は、ローカルコンピューターの標準ホスト名を Unicode 文字列として取得します。

戻り値

エラーが発生しなかった場合、 GetHostNameW は 0 を返します。それ以外の場合は SOCKET_ERROR を返し、 WSAGetLastError を呼び出すことで具体的なエラーコードを取得できます。

エラーコード 意味
WSAEFAULT
name パラメーターが NULL ポインターであるか、ユーザーアドレス空間の有効な部分ではありません。このエラーは、namelen パラメーターで指定されたバッファーサイズが、完全なホスト名を格納するには小さすぎる場合にも返されます。
WSANOTINITIALISED
この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN
ネットワークサブシステムが失敗しました。

解説(Remarks)

GetHostNameW 関数は、ローカルホストの名前を name パラメーターで指定されたバッファーに Unicode(UTF-16)で返します。ホスト名は null 終端の Unicode 文字列として返されます。ホスト名の形式は Windows Sockets プロバイダーに依存し、単純なホスト名の場合もあれば、完全修飾ドメイン名(FQDN)の場合もあります。ただし、返される名前は GetAddrInfoW によって正常に解析されることが保証されています。

インターネットの成長に伴い、ASCII 文字セットでは表現できない他言語のインターネットホスト名を識別する必要性が高まっています。この需要に応え、非 ASCII 文字(Unicode)を特別な ASCII 文字列(Punycode)として表現できる識別子は、国際化ドメイン名(IDN: Internationalized Domain Names)と呼ばれます。IDN を標準的な方法で扱うために、アプリケーションにおけるドメイン名の国際化(IDNA: Internationalizing Domain Names in Applications)と呼ばれるメカニズムが使用されます。GetHostNameW 関数は、ローカルホスト名を Punycode と Unicode の間で変換しません。GetAddrInfoW 関数は、国際化ドメイン名(IDN)の解析をサポートし、Punycode/IDN のエンコードと変換を実行します。

Windows Server 2012 のクラスターリソース上で GetHostNameW 関数が使用され、CLUSTER_NETWORK_NAME 環境変数が定義されている場合、この環境変数の値が実際のホスト名を上書きして返されます。クラスターリソース上では、CLUSTER_NETWORK_NAME 環境変数にはクラスターの名前が含まれます。

GetHostNameW 関数は、Svgguid.h ヘッダーファイルで定義された SVCID_HOSTNAME GUID を使用して名前空間プロバイダーに照会し、ローカルホスト名を判別します。応答する名前空間プロバイダーがない場合、 GetHostNameW 関数はローカルコンピューターの NetBIOS 名を Unicode で返します。

name パラメーターが指すバッファーに返される文字列の最大長(ワイド文字数)は名前空間プロバイダーに依存しますが、この文字列は 256 ワイド文字以下である必要があります。したがって、256 ワイド文字のバッファーを name パラメーターに渡し、namelen パラメーターを 256 に設定すれば、バッファーサイズは常に十分です。

注意 ローカルホスト名が構成されていない場合でも、 GetHostNameW は成功し、 GetAddrInfoW が解決できるトークンホスト名を返す必要があります。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

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

各言語での呼び出し定義

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

INT GetHostNameW(
    LPWSTR name,
    INT namelen
);
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetHostNameW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder name,   // LPWSTR out
    int namelen   // INT
);
<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetHostNameW(
    <MarshalAs(UnmanagedType.LPWStr)> name As System.Text.StringBuilder,   ' LPWSTR out
    namelen As Integer   ' INT
) As Integer
End Function
' name : LPWSTR out
' namelen : INT
Declare PtrSafe Function GetHostNameW Lib "ws2_32" ( _
    ByVal name As LongPtr, _
    ByVal namelen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetHostNameW = ctypes.windll.ws2_32.GetHostNameW
GetHostNameW.restype = ctypes.c_int
GetHostNameW.argtypes = [
    wintypes.LPWSTR,  # name : LPWSTR out
    ctypes.c_int,  # namelen : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
GetHostNameW = Fiddle::Function.new(
  lib['GetHostNameW'],
  [
    Fiddle::TYPE_VOIDP,  # name : LPWSTR out
    Fiddle::TYPE_INT,  # namelen : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "ws2_32")]
extern "system" {
    fn GetHostNameW(
        name: *mut u16,  // LPWSTR out
        namelen: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int GetHostNameW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder name, int namelen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_GetHostNameW' -Namespace Win32 -PassThru
# $api::GetHostNameW(name, namelen)
#uselib "WS2_32.dll"
#func global GetHostNameW "GetHostNameW" sptr, sptr
; GetHostNameW varptr(name), namelen   ; 戻り値は stat
; name : LPWSTR out -> "sptr"
; namelen : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WS2_32.dll"
#cfunc global GetHostNameW "GetHostNameW" var, int
; res = GetHostNameW(name, namelen)
; name : LPWSTR out -> "var"
; namelen : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetHostNameW(LPWSTR name, INT namelen)
#uselib "WS2_32.dll"
#cfunc global GetHostNameW "GetHostNameW" var, int
; res = GetHostNameW(name, namelen)
; name : LPWSTR out -> "var"
; namelen : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procGetHostNameW = ws2_32.NewProc("GetHostNameW")
)

// name (LPWSTR out), namelen (INT)
r1, _, err := procGetHostNameW.Call(
	uintptr(name),
	uintptr(namelen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetHostNameW(
  name: PWideChar;   // LPWSTR out
  namelen: Integer   // INT
): Integer; stdcall;
  external 'WS2_32.dll' name 'GetHostNameW';
result := DllCall("WS2_32\GetHostNameW"
    , "Ptr", name   ; LPWSTR out
    , "Int", namelen   ; INT
    , "Int")   ; return: INT
●GetHostNameW(name, namelen) = DLL("WS2_32.dll", "int GetHostNameW(char*, int)")
# 呼び出し: GetHostNameW(name, namelen)
# name : LPWSTR out -> "char*"
# namelen : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn GetHostNameW(
    name: [*c]u16, // LPWSTR out
    namelen: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc GetHostNameW(
    name: ptr uint16,  # LPWSTR out
    namelen: int32  # INT
): int32 {.importc: "GetHostNameW", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int GetHostNameW(
    wchar* name,   // LPWSTR out
    int namelen   // INT
);
ccall((:GetHostNameW, "WS2_32.dll"), stdcall, Int32,
      (Ptr{UInt16}, Int32),
      name, namelen)
# name : LPWSTR out -> Ptr{UInt16}
# namelen : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetHostNameW(
    uint16_t* name,
    int32_t namelen);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.GetHostNameW(name, namelen)
-- name : LPWSTR out
-- namelen : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const GetHostNameW = lib.func('__stdcall', 'GetHostNameW', 'int32_t', ['uint16_t *', 'int32_t']);
// GetHostNameW(name, namelen)
// name : LPWSTR out -> 'uint16_t *'
// namelen : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  GetHostNameW: { parameters: ["buffer", "i32"], result: "i32" },
});
// lib.symbols.GetHostNameW(name, namelen)
// name : LPWSTR out -> "buffer"
// namelen : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetHostNameW(
    uint16_t* name,
    int32_t namelen);
C, "WS2_32.dll");
// $ffi->GetHostNameW(name, namelen);
// name : LPWSTR out
// namelen : INT
// 構造体/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 Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
    int GetHostNameW(
        char[] name,   // LPWSTR out
        int namelen   // INT
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun GetHostNameW = GetHostNameW(
    name : UInt16*,   # LPWSTR out
    namelen : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetHostNameWNative = Int32 Function(Pointer<Utf16>, Int32);
typedef GetHostNameWDart = int Function(Pointer<Utf16>, int);
final GetHostNameW = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<GetHostNameWNative, GetHostNameWDart>('GetHostNameW');
// name : LPWSTR out -> Pointer<Utf16>
// namelen : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetHostNameW(
  name: PWideChar;   // LPWSTR out
  namelen: Integer   // INT
): Integer; stdcall;
  external 'WS2_32.dll' name 'GetHostNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetHostNameW"
  c_GetHostNameW :: CWString -> Int32 -> IO Int32
-- name : LPWSTR out -> CWString
-- namelen : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gethostnamew =
  foreign "GetHostNameW"
    ((ptr uint16_t) @-> int32_t @-> returning int32_t)
(* name : LPWSTR out -> (ptr uint16_t) *)
(* namelen : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("GetHostNameW" get-host-name-w :convention :stdcall) :int32
  (name :pointer)   ; LPWSTR out
  (namelen :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetHostNameW = Win32::API::More->new('WS2_32',
    'int GetHostNameW(LPWSTR name, int namelen)');
# my $ret = $GetHostNameW->Call($name, $namelen);
# name : LPWSTR out -> LPWSTR
# namelen : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目