Fungsi GetAllUsersProfileDirectoryA (userenv.h)

Artikel
03/03/2024

Mengambil jalur ke akar direktori yang berisi data program yang dibagikan oleh semua pengguna.

Sintaks

USERENVAPI BOOL GetAllUsersProfileDirectoryA(
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parameter

[out, optional] lpProfileDir

Jenis: LPTSTR

Penunjuk ke buffer yang, ketika fungsi ini berhasil dikembalikan, menerima jalur. Atur nilai ini ke NULL untuk menentukan ukuran buffer yang diperlukan, termasuk karakter null yang mengakhiri.

[in, out] lpcchSize

Jenis: LPDWORD

Penunjuk ke ukuran buffer lpProfileDir , dalam TCHAR.

Jika buffer yang ditentukan oleh lpProfileDir tidak cukup besar atau lpProfileDir adalah NULL, fungsi gagal dan parameter ini menerima ukuran buffer yang diperlukan, termasuk karakter null yang mengakhiri.

Nilai kembali

Jenis: BOOL

TRUE jika berhasil; jika tidak, FALSE. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Berikut ini adalah contoh jalur yang dikembalikan oleh GetAllUsersProfileDirectory di Windows XP:

C:\Documents and Settings\All Users

Berikut ini adalah contoh jalur yang dikembalikan oleh GetAllUsersProfileDirectory di Windows 7:

C:\ProgramData

Untuk mendapatkan jalur subdirektori direktori ini, gunakan fungsi SHGetFolderPath (Windows XP dan sebelumnya) atau SHGetKnownFolderPath (Windows Vista).

Catatan

Header userenv.h mendefinisikan GetAllUsersProfileDirectory sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	userenv.h
Pustaka	Userenv.lib
DLL	Userenv.dll