ホーム › System.SystemInformation › GetComputerNameExW

GetComputerNameExW

関数

指定した形式でコンピューター名を取得する(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetComputerNameExW(
    COMPUTER_NAME_FORMAT NameType,
    LPWSTR lpBuffer,   // optional
    DWORD* nSize
);

パラメーター

名前

型

方向

説明

NameType

COMPUTER_NAME_FORMAT

取得する名前の種類。このパラメーターは COMPUTER_NAME_FORMAT 列挙型の値です。次の表に追加情報を示します。

値	意味
ComputerNameDnsDomain	ローカルコンピューターに割り当てられた DNS ドメインの名前。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの DNS ドメイン名を受け取ります。
ComputerNameDnsFullyQualified	ローカルコンピューターを一意に識別する完全修飾 DNS 名。この名前は DNS ホスト名と DNS ドメイン名を組み合わせたもので、HostName.DomainName という形式を取ります。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの完全修飾 DNS 名を受け取ります。
ComputerNameDnsHostname	ローカルコンピューターの DNS ホスト名。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの DNS ホスト名を受け取ります。
ComputerNameNetBIOS	ローカルコンピューターの NetBIOS 名。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの NetBIOS 名を受け取ります。
ComputerNamePhysicalDnsDomain	ローカルコンピューターに割り当てられた DNS ドメインの名前。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの名前ではなく、ローカルコンピューターの DNS ドメイン名を受け取ります。
ComputerNamePhysicalDnsFullyQualified	コンピューターを一意に識別する完全修飾 DNS 名。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの名前ではなく、ローカルコンピューターの完全修飾 DNS 名を受け取ります。完全修飾 DNS 名は DNS ホスト名と DNS ドメイン名を組み合わせたもので、HostName.DomainName という形式を取ります。
ComputerNamePhysicalDnsHostname	ローカルコンピューターの DNS ホスト名。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの名前ではなく、ローカルコンピューターの DNS ホスト名を受け取ります。
ComputerNamePhysicalNetBIOS	ローカルコンピューターの NetBIOS 名。ローカルコンピューターがクラスター内のノードである場合、lpBuffer はクラスター仮想サーバーの名前ではなく、ローカルコンピューターの NetBIOS 名を受け取ります。

lpBuffer

LPWSTR

outoptional

コンピューター名またはクラスター仮想サーバー名を受け取るバッファーへのポインター。

DNS はより長い名前を許可するため、名前の長さが MAX_COMPUTERNAME_LENGTH 文字を超える場合があります。このバッファーが十分な大きさであることを保証するには、このパラメーターを NULL に設定し、lpnSize パラメーターで返される必要なバッファーサイズを使用してください。

nSize

DWORD*

inout

入力時には、バッファーのサイズを TCHAR 単位で指定します。出力時には、終端の null 文字を含まない、コピー先バッファーにコピーされた TCHAR 数を受け取ります。

バッファーが小さすぎる場合、関数は失敗し、GetLastError は ERROR_MORE_DATA を返します。このパラメーターは、終端の null 文字を含む、必要なバッファーのサイズを受け取ります。

lpBuffer が NULL の場合、このパラメーターはゼロでなければなりません。

戻り値の型: BOOL

公式ドキュメント

ローカルコンピューターに関連付けられた NetBIOS 名または DNS 名を取得します。これらの名前はシステム起動時に確立され、システムがレジストリから読み取ります。(Unicode)

戻り値

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

関数が失敗した場合、戻り値はゼロです。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられる値には次のものがあります。

戻りコード	説明
ERROR_MORE_DATA	lpBuffer バッファーが小さすぎます。lpnSize パラメーターには、名前を受け取るために必要なバイト数が格納されます。

解説(Remarks)

ローカルマシンにグループポリシーが設定されていない場合、 GetComputerNameEx 関数はシステム起動時に確立された NetBIOS 名または DNS 名を取得します。グループポリシーが設定されている場合、関数はグループポリシーによって設定されたプライマリドメイン名を返します。 SetComputerName または SetComputerNameEx 関数による名前の変更は、ユーザーがコンピューターを再起動するまで反映されません。

ローカルコンピューターが DNS 名を使用するように構成されていない場合、GetComputerNameEx は DNS 情報を返しません。これを構成するには、オペレーティングシステムのヘルプに記載された手順に従ってコンピューターのプライマリ DNS サフィックスを変更し、コンピューターを再起動してください。

この関数の動作は、ローカルコンピューターがクラスター内のノードである場合に影響を受けることがあります。詳細については、ResUtilGetEnvironmentWithNetName および UseNetworkName を参照してください。

コンピューターの FQDN がそのドメインの FQDN と一致しない、異なる DNS レイアウトを使用する環境で作業している場合は、代わりに LsaQueryInformationPolicy を使用してください。

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

例

#define _WIN32_WINNT 0x0500

#include <windows.h>
#include <stdio.h>
#include <tchar.h>

void _tmain(void)
{
    TCHAR buffer[256] = TEXT("");
    TCHAR szDescription[8][32] = {TEXT("NetBIOS"), 
        TEXT("DNS hostname"), 
        TEXT("DNS domain"), 
        TEXT("DNS fully-qualified"), 
        TEXT("Physical NetBIOS"), 
        TEXT("Physical DNS hostname"), 
        TEXT("Physical DNS domain"), 
        TEXT("Physical DNS fully-qualified")};
    int cnf = 0;
    DWORD dwSize = _countof(buffer);
    
    for (cnf = 0; cnf < ComputerNameMax; cnf++)
    {
        if (!GetComputerNameEx((COMPUTER_NAME_FORMAT)cnf, buffer, &dwSize))
        {
            _tprintf(TEXT("GetComputerNameEx failed (%d)\n"), GetLastError());
            return;
        }
        else _tprintf(TEXT("%s: %s\n"), szDescription[cnf], buffer);

        dwSize = _countof(buffer);
        ZeroMemory(buffer, dwSize);
    }
}

メモ

sysinfoapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetComputerNameEx を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 GetComputerNameExW(
    COMPUTER_NAME_FORMAT NameType,
    LPWSTR lpBuffer,   // optional
    DWORD* nSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetComputerNameExW(
    int NameType,   // COMPUTER_NAME_FORMAT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    ref uint nSize   // DWORD* in/out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetComputerNameExW(
    NameType As Integer,   ' COMPUTER_NAME_FORMAT
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef nSize As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' NameType : COMPUTER_NAME_FORMAT
' lpBuffer : LPWSTR optional, out
' nSize : DWORD* in/out
Declare PtrSafe Function GetComputerNameExW Lib "kernel32" ( _
    ByVal NameType As Long, _
    ByVal lpBuffer As LongPtr, _
    ByRef nSize As Long) 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

GetComputerNameExW = ctypes.windll.kernel32.GetComputerNameExW
GetComputerNameExW.restype = wintypes.BOOL
GetComputerNameExW.argtypes = [
    ctypes.c_int,  # NameType : COMPUTER_NAME_FORMAT
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # nSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetComputerNameExW = Fiddle::Function.new(
  lib['GetComputerNameExW'],
  [
    Fiddle::TYPE_INT,  # NameType : COMPUTER_NAME_FORMAT
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # nSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetComputerNameExW(
        NameType: i32,  // COMPUTER_NAME_FORMAT
        lpBuffer: *mut u16,  // LPWSTR optional, out
        nSize: *mut u32  // DWORD* in/out
    ) -> 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 GetComputerNameExW(int NameType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, ref uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetComputerNameExW' -Namespace Win32 -PassThru
# $api::GetComputerNameExW(NameType, lpBuffer, nSize)

#uselib "KERNEL32.dll"
#func global GetComputerNameExW "GetComputerNameExW" wptr, wptr, wptr
; GetComputerNameExW NameType, varptr(lpBuffer), varptr(nSize)   ; 戻り値は stat
; NameType : COMPUTER_NAME_FORMAT -> "wptr"
; lpBuffer : LPWSTR optional, out -> "wptr"
; nSize : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetComputerNameExW "GetComputerNameExW" int, var, var
; res = GetComputerNameExW(NameType, lpBuffer, nSize)
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPWSTR optional, out -> "var"
; nSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetComputerNameExW "GetComputerNameExW" int, sptr, sptr
; res = GetComputerNameExW(NameType, varptr(lpBuffer), varptr(nSize))
; NameType : COMPUTER_NAME_FORMAT -> "int"
; lpBuffer : LPWSTR optional, out -> "sptr"
; nSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。