ホーム › 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
lpcchSize	DWORD*	inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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(変数))。

出力引数:

; BOOL GetAllUsersProfileDirectoryA(LPSTR lpProfileDir, DWORD* lpcchSize)
#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 方式にも切替可。; BOOL GetAllUsersProfileDirectoryA(LPSTR lpProfileDir, DWORD* lpcchSize)
#uselib "USERENV.dll"
#cfunc global GetAllUsersProfileDirectoryA "GetAllUsersProfileDirectoryA" intptr, intptr
; res = GetAllUsersProfileDirectoryA(varptr(lpProfileDir), varptr(lpcchSize))
; lpProfileDir : LPSTR optional, out -> "intptr"
; lpcchSize : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetAllUsersProfileDirectoryA = userenv.NewProc("GetAllUsersProfileDirectoryA")
)

// lpProfileDir (LPSTR optional, out), lpcchSize (DWORD* in/out)
r1, _, err := procGetAllUsersProfileDirectoryA.Call(
	uintptr(lpProfileDir),
	uintptr(lpcchSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetAllUsersProfileDirectoryA(
  lpProfileDir: PAnsiChar;   // LPSTR optional, out
  lpcchSize: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'USERENV.dll' name 'GetAllUsersProfileDirectoryA';

result := DllCall("USERENV\GetAllUsersProfileDirectoryA"
    , "Ptr", lpProfileDir   ; LPSTR optional, out
    , "Ptr", lpcchSize   ; DWORD* in/out
    , "Int")   ; return: BOOL

●GetAllUsersProfileDirectoryA(lpProfileDir, lpcchSize) = DLL("USERENV.dll", "bool GetAllUsersProfileDirectoryA(char*, void*)")
# 呼び出し: GetAllUsersProfileDirectoryA(lpProfileDir, lpcchSize)
# lpProfileDir : LPSTR optional, out -> "char*"
# lpcchSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。