ホーム › UI.Shell › GetAllUsersProfileDirectoryA

GetAllUsersProfileDirectoryA

関数

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

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

シグネチャ

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

BOOL GetAllUsersProfileDirectoryA(
    LPSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

パラメーター

名前	型	方向	説明
lpProfileDir	LPSTR	outoptional	この関数が正常に終了したときにパスを受け取るバッファーへのポインターです。この値を NULL に設定すると、終端の null 文字を含めて必要なバッファーサイズを調べることができます。
lpcchSize	DWORD*	inout	lpProfileDir バッファーのサイズ(TCHAR 単位)へのポインターです。 lpProfileDir で指定されたバッファーが十分な大きさでない場合、または lpProfileDir が NULL の場合、関数は失敗し、このパラメーターは終端の null 文字を含めて必要なバッファーサイズを受け取ります。

名前

型

方向

説明

lpProfileDir

LPSTR

outoptional

この関数が正常に終了したときにパスを受け取るバッファーへのポインターです。この値を NULL に設定すると、終端の null 文字を含めて必要なバッファーサイズを調べることができます。

lpcchSize

DWORD*

inout

lpProfileDir バッファーのサイズ(TCHAR 単位)へのポインターです。

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

戻り値の型: BOOL

公式ドキュメント

すべてのユーザーで共有されるプログラムデータを格納するディレクトリのルートへのパスを取得します。(ANSI)

戻り値

型: BOOL

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

解説(Remarks)

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

C:\Documents and Settings\All Users

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

C:\ProgramData

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

メモ

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetAllUsersProfileDirectoryA(
    [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 GetAllUsersProfileDirectoryA(
    <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

' lpProfileDir : LPSTR optional, out
' lpcchSize : DWORD* in/out
Declare PtrSafe Function GetAllUsersProfileDirectoryA Lib "userenv" ( _
    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

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

#[link(name = "userenv")]
extern "system" {
    fn GetAllUsersProfileDirectoryA(
        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 GetAllUsersProfileDirectoryA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpProfileDir, ref uint lpcchSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetAllUsersProfileDirectoryA' -Namespace Win32 -PassThru
# $api::GetAllUsersProfileDirectoryA(lpProfileDir, lpcchSize)

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

出力引数:

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