Fungsi GetUserProfileDirectoryA (userenv.h)

Artikel
08/26/2023

Mengambil jalur ke direktori akar profil pengguna yang ditentukan.

Sintaks

USERENVAPI BOOL GetUserProfileDirectoryA(
  [in]            HANDLE  hToken,
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parameter

[in] hToken

Jenis: HANDEL

Token untuk pengguna, yang dikembalikan oleh fungsi LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken, atau OpenThreadToken . Token harus memiliki akses TOKEN_QUERY. Untuk informasi selengkapnya, lihat Hak Akses untuk Objek Access-Token.

[out, optional] lpProfileDir

Jenis: LPTSTR

Penunjuk ke buffer yang, ketika fungsi ini berhasil dikembalikan, menerima jalur ke direktori profil pengguna yang ditentukan.

[in, out] lpcchSize

Jenis: LPDWORD

Menentukan 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.

Menampilkan nilai

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 GetUserProfileDirectory di Windows XP:

C:\Documents and Settings\Joe

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

C:\Users\Joe

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

Catatan

Header userenv.h mendefinisikan GetUserProfileDirectory 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


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