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

GetUserNameW

関数
現在のスレッドに関連付けられたユーザー名を取得する(Unicode版)。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetUserNameW(
    LPWSTR lpBuffer,   // optional
    DWORD* pcbBuffer
);

パラメーター

名前方向説明
lpBufferLPWSTRoutoptional現在のスレッドに関連付けられたユーザー名を受け取るバッファ。
pcbBufferDWORD*inout入力時はバッファサイズ(文字数)、出力時は終端NULを含む格納文字数を受け取る。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetUserNameW(
    LPWSTR lpBuffer,   // optional
    DWORD* pcbBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUserNameW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    ref uint pcbBuffer   // DWORD* in/out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUserNameW(
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcbBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpBuffer : LPWSTR optional, out
' pcbBuffer : DWORD* in/out
Declare PtrSafe Function GetUserNameW Lib "advapi32" ( _
    ByVal lpBuffer As LongPtr, _
    ByRef pcbBuffer 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

GetUserNameW = ctypes.windll.advapi32.GetUserNameW
GetUserNameW.restype = wintypes.BOOL
GetUserNameW.argtypes = [
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetUserNameW = Fiddle::Function.new(
  lib['GetUserNameW'],
  [
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn GetUserNameW(
        lpBuffer: *mut u16,  // LPWSTR optional, out
        pcbBuffer: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetUserNameW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, ref uint pcbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetUserNameW' -Namespace Win32 -PassThru
# $api::GetUserNameW(lpBuffer, pcbBuffer)
#uselib "ADVAPI32.dll"
#func global GetUserNameW "GetUserNameW" wptr, wptr
; GetUserNameW varptr(lpBuffer), varptr(pcbBuffer)   ; 戻り値は stat
; lpBuffer : LPWSTR optional, out -> "wptr"
; pcbBuffer : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global GetUserNameW "GetUserNameW" var, var
; res = GetUserNameW(lpBuffer, pcbBuffer)
; lpBuffer : LPWSTR optional, out -> "var"
; pcbBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetUserNameW(LPWSTR lpBuffer, DWORD* pcbBuffer)
#uselib "ADVAPI32.dll"
#cfunc global GetUserNameW "GetUserNameW" var, var
; res = GetUserNameW(lpBuffer, pcbBuffer)
; lpBuffer : LPWSTR optional, out -> "var"
; pcbBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procGetUserNameW = advapi32.NewProc("GetUserNameW")
)

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

extern "advapi32" fn GetUserNameW(
    lpBuffer: [*c]u16, // LPWSTR optional, out
    pcbBuffer: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetUserNameW(
    lpBuffer: ptr uint16,  # LPWSTR optional, out
    pcbBuffer: ptr uint32  # DWORD* in/out
): int32 {.importc: "GetUserNameW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int GetUserNameW(
    wchar* lpBuffer,   // LPWSTR optional, out
    uint* pcbBuffer   // DWORD* in/out
);
ccall((:GetUserNameW, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{UInt16}, Ptr{UInt32}),
      lpBuffer, pcbBuffer)
# lpBuffer : LPWSTR optional, out -> Ptr{UInt16}
# pcbBuffer : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetUserNameW(
    uint16_t* lpBuffer,
    uint32_t* pcbBuffer);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.GetUserNameW(lpBuffer, pcbBuffer)
-- lpBuffer : LPWSTR optional, out
-- pcbBuffer : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const GetUserNameW = lib.func('__stdcall', 'GetUserNameW', 'int32_t', ['uint16_t *', 'uint32_t *']);
// GetUserNameW(lpBuffer, pcbBuffer)
// lpBuffer : LPWSTR optional, out -> 'uint16_t *'
// pcbBuffer : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  GetUserNameW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetUserNameW(lpBuffer, pcbBuffer)
// lpBuffer : LPWSTR optional, out -> "buffer"
// pcbBuffer : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetUserNameW(
    uint16_t* lpBuffer,
    uint32_t* pcbBuffer);
C, "ADVAPI32.dll");
// $ffi->GetUserNameW(lpBuffer, pcbBuffer);
// lpBuffer : LPWSTR optional, out
// pcbBuffer : DWORD* in/out
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetUserNameW(
        char[] lpBuffer,   // LPWSTR optional, out
        IntByReference pcbBuffer   // DWORD* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun GetUserNameW = GetUserNameW(
    lpBuffer : UInt16*,   # LPWSTR optional, out
    pcbBuffer : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetUserNameWNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef GetUserNameWDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final GetUserNameW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<GetUserNameWNative, GetUserNameWDart>('GetUserNameW');
// lpBuffer : LPWSTR optional, out -> Pointer<Utf16>
// pcbBuffer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUserNameW(
  lpBuffer: PWideChar;   // LPWSTR optional, out
  pcbBuffer: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'GetUserNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUserNameW"
  c_GetUserNameW :: CWString -> Ptr Word32 -> IO CInt
-- lpBuffer : LPWSTR optional, out -> CWString
-- pcbBuffer : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getusernamew =
  foreign "GetUserNameW"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* lpBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcbBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("GetUserNameW" get-user-name-w :convention :stdcall) :int32
  (lp-buffer :pointer)   ; LPWSTR optional, out
  (pcb-buffer :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUserNameW = Win32::API::More->new('ADVAPI32',
    'BOOL GetUserNameW(LPWSTR lpBuffer, LPVOID pcbBuffer)');
# my $ret = $GetUserNameW->Call($lpBuffer, $pcbBuffer);
# lpBuffer : LPWSTR optional, out -> LPWSTR
# pcbBuffer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い