ホーム › UI.Shell › GetUserProfileDirectoryA

GetUserProfileDirectoryA

関数

トークンが示すユーザーのプロファイルディレクトリを取得する(ANSI版)。

DLLUSERENV.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USERENV.dll  (ANSI / -A)
#include <windows.h>

BOOL GetUserProfileDirectoryA(
    HANDLE hToken,
    LPSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

パラメーター

名前	型	方向	説明
hToken	HANDLE	in	ユーザーのトークン。LogonUser、CreateRestrictedToken、DuplicateToken、OpenProcessToken、または OpenThreadToken 関数によって返されます。このトークンには TOKEN_QUERY アクセス権が必要です。詳細については、Access Rights for Access-Token Objects を参照してください。
lpProfileDir	LPSTR	outoptional	バッファーへのポインター。この関数が正常に終了すると、指定したユーザーのプロファイルディレクトリへのパスを受け取ります。
lpcchSize	DWORD*	inout	lpProfileDir バッファーのサイズを TCHARs 単位で指定します。 lpProfileDir で指定したバッファーが十分な大きさでない場合、または lpProfileDir が NULL の場合、この関数は失敗し、このパラメーターは終端の null 文字を含む必要なバッファーサイズを受け取ります。関数が成功した場合、このパラメーターは終端の null 文字を含む、lpProfileDir に書き込まれた TCHARs の数を受け取ります。

名前

型

方向

説明

hToken

HANDLE

ユーザーのトークン。LogonUser、CreateRestrictedToken、DuplicateToken、OpenProcessToken、または OpenThreadToken 関数によって返されます。このトークンには TOKEN_QUERY アクセス権が必要です。詳細については、Access Rights for Access-Token Objects を参照してください。

lpProfileDir

LPSTR

outoptional

バッファーへのポインター。この関数が正常に終了すると、指定したユーザーのプロファイルディレクトリへのパスを受け取ります。

lpcchSize

DWORD*

inout

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

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

関数が成功した場合、このパラメーターは終端の null 文字を含む、lpProfileDir に書き込まれた TCHARs の数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーのプロファイルのルートディレクトリへのパスを取得します。(ANSI)

戻り値

型: BOOL

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

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

C:\Documents and Settings\Joe

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

C:\Users\Joe

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

メモ

userenv.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetUserProfileDirectory を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が発生し、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USERENV.dll  (ANSI / -A)
#include <windows.h>

BOOL GetUserProfileDirectoryA(
    HANDLE hToken,
    LPSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetUserProfileDirectoryA(
    IntPtr hToken,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpProfileDir,   // LPSTR optional, out
    ref uint lpcchSize   // DWORD* in/out
);

<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUserProfileDirectoryA(
    hToken As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> lpProfileDir As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef lpcchSize As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hToken : HANDLE
' lpProfileDir : LPSTR optional, out
' lpcchSize : DWORD* in/out
Declare PtrSafe Function GetUserProfileDirectoryA Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpProfileDir As String, _
    ByRef lpcchSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetUserProfileDirectoryA = ctypes.windll.userenv.GetUserProfileDirectoryA
GetUserProfileDirectoryA.restype = wintypes.BOOL
GetUserProfileDirectoryA.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE
    wintypes.LPSTR,  # lpProfileDir : LPSTR 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')
GetUserProfileDirectoryA = Fiddle::Function.new(
  lib['GetUserProfileDirectoryA'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE
    Fiddle::TYPE_VOIDP,  # lpProfileDir : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "userenv")]
extern "system" {
    fn GetUserProfileDirectoryA(
        hToken: *mut core::ffi::c_void,  // HANDLE
        lpProfileDir: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool GetUserProfileDirectoryA(IntPtr hToken, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpProfileDir, ref uint lpcchSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetUserProfileDirectoryA' -Namespace Win32 -PassThru
# $api::GetUserProfileDirectoryA(hToken, lpProfileDir, lpcchSize)

#uselib "USERENV.dll"
#func global GetUserProfileDirectoryA "GetUserProfileDirectoryA" sptr, sptr, sptr
; GetUserProfileDirectoryA hToken, varptr(lpProfileDir), varptr(lpcchSize)   ; 戻り値は stat
; hToken : HANDLE -> "sptr"
; lpProfileDir : LPSTR optional, out -> "sptr"
; lpcchSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USERENV.dll"
#cfunc global GetUserProfileDirectoryA "GetUserProfileDirectoryA" sptr, var, var
; res = GetUserProfileDirectoryA(hToken, lpProfileDir, lpcchSize)
; hToken : HANDLE -> "sptr"
; lpProfileDir : LPSTR optional, out -> "var"
; lpcchSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USERENV.dll"
#cfunc global GetUserProfileDirectoryA "GetUserProfileDirectoryA" sptr, sptr, sptr
; res = GetUserProfileDirectoryA(hToken, varptr(lpProfileDir), varptr(lpcchSize))
; hToken : HANDLE -> "sptr"
; lpProfileDir : LPSTR optional, out -> "sptr"
; lpcchSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。