Win32 API 日本語リファレンス
ホームUI.Shell › GetProfilesDirectoryW

GetProfilesDirectoryW

関数
ユーザープロファイル格納ディレクトリを取得する(Unicode版)。
DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetProfilesDirectoryW(
    LPWSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

パラメーター

名前方向説明
lpProfileDirLPWSTRoutoptionalこの関数が正常に終了したときに、プロファイルディレクトリへのパスを受け取るバッファーへのポインターです。必要なバッファーサイズを調べるには、この値を NULL に設定します。
lpcchSizeDWORD*inout

lpProfilesDir バッファーのサイズを TCHAR 単位で指定します。

lpProfilesDir で指定されたバッファーが十分な大きさでない場合、または lpProfilesDirNULL の場合、この関数は失敗し、このパラメーターは終端の null 文字を含む必要なバッファーサイズを受け取ります。

戻り値の型: BOOL

公式ドキュメント

ユーザープロファイルが格納されているルートディレクトリへのパスを取得します。(Unicode)

戻り値

型: BOOL

成功した場合は TRUE、それ以外の場合は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

次は、Windows XP において GetProfilesDirectory が返すパスの例です。

C:\Documents and Settings

次は、Windows 7 において GetProfilesDirectory が返すパスの例です。

C:\Users

このディレクトリのサブディレクトリのパスを取得するには、SHGetFolderPath(Windows XP 以前)または SHGetKnownFolderPath(Windows Vista)関数を使用します。

メモ

userenv.h ヘッダーは GetProfilesDirectory を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こすことがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetProfilesDirectoryW = userenv.NewProc("GetProfilesDirectoryW")
)

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

extern "userenv" fn GetProfilesDirectoryW(
    lpProfileDir: [*c]u16, // LPWSTR optional, out
    lpcchSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetProfilesDirectoryW(
    lpProfileDir: ptr uint16,  # LPWSTR optional, out
    lpcchSize: ptr uint32  # DWORD* in/out
): int32 {.importc: "GetProfilesDirectoryW", stdcall, dynlib: "USERENV.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "userenv");
extern(Windows)
int GetProfilesDirectoryW(
    wchar* lpProfileDir,   // LPWSTR optional, out
    uint* lpcchSize   // DWORD* in/out
);
ccall((:GetProfilesDirectoryW, "USERENV.dll"), stdcall, Int32,
      (Ptr{UInt16}, Ptr{UInt32}),
      lpProfileDir, lpcchSize)
# lpProfileDir : LPWSTR optional, out -> Ptr{UInt16}
# lpcchSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetProfilesDirectoryW(
    uint16_t* lpProfileDir,
    uint32_t* lpcchSize);
]]
local userenv = ffi.load("userenv")
-- userenv.GetProfilesDirectoryW(lpProfileDir, lpcchSize)
-- lpProfileDir : LPWSTR optional, out
-- lpcchSize : 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('USERENV.dll');
const GetProfilesDirectoryW = lib.func('__stdcall', 'GetProfilesDirectoryW', 'int32_t', ['uint16_t *', 'uint32_t *']);
// GetProfilesDirectoryW(lpProfileDir, lpcchSize)
// lpProfileDir : LPWSTR optional, out -> 'uint16_t *'
// lpcchSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  GetProfilesDirectoryW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetProfilesDirectoryW(lpProfileDir, lpcchSize)
// lpProfileDir : LPWSTR optional, out -> "buffer"
// lpcchSize : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetProfilesDirectoryW(
    uint16_t* lpProfileDir,
    uint32_t* lpcchSize);
C, "USERENV.dll");
// $ffi->GetProfilesDirectoryW(lpProfileDir, lpcchSize);
// lpProfileDir : LPWSTR optional, out
// lpcchSize : 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 Userenv extends StdCallLibrary {
    Userenv INSTANCE = Native.load("userenv", Userenv.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetProfilesDirectoryW(
        char[] lpProfileDir,   // LPWSTR optional, out
        IntByReference lpcchSize   // DWORD* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("userenv")]
lib LibUSERENV
  fun GetProfilesDirectoryW = GetProfilesDirectoryW(
    lpProfileDir : UInt16*,   # LPWSTR optional, out
    lpcchSize : 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 GetProfilesDirectoryWNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef GetProfilesDirectoryWDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final GetProfilesDirectoryW = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<GetProfilesDirectoryWNative, GetProfilesDirectoryWDart>('GetProfilesDirectoryW');
// lpProfileDir : LPWSTR optional, out -> Pointer<Utf16>
// lpcchSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetProfilesDirectoryW(
  lpProfileDir: PWideChar;   // LPWSTR optional, out
  lpcchSize: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'USERENV.dll' name 'GetProfilesDirectoryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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