Fungsi PathUnExpandEnvStringsA (shlwapi.h)

Mengganti nama folder tertentu dalam jalur yang sepenuhnya memenuhi syarat dengan string lingkungan terkait.

Sintaksis

BOOL PathUnExpandEnvStringsA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

Parameter

[in] pszPath

Jenis: LPCTSTR

Penunjuk ke string panjang maksimum yang dihentikan null MAX_PATH yang berisi jalur yang tidak akan dijangkau.

[out] pszBuf

Jenis: LPTSTR

Penunjuk ke buffer yang, ketika metode ini berhasil dikembalikan, menerima string yang tidak tersedia. Ukuran buffer ini harus diatur ke MAX_PATH untuk memastikan bahwa itu cukup besar untuk menahan string yang dikembalikan.

[in] cchBuf

Jenis: UINT

Ukurannya, dalam karakter, dalam pszBuf buffer.

Mengembalikan nilai

Jenis: BOOL

Mengembalikan TRUE jika berhasil; jika tidak, FALSE.

Komentar

Jalur folder berikut digantikan oleh string lingkungan yang setara.

Map	String Lingkungan
Folder profil Semua Pengguna	%ALLUSERSPROFILE%
Folder data aplikasi pengguna saat ini (Hanya Windows Vista dan yang lebih baru).	%APPDATA%
Nama sistem	%COMPUTERNAME%
Folder File Program	%ProgramFiles%
Folder akar sistem	%SystemRoot%
Huruf kandar sistem	%SystemDrive%
Folder profil pengguna saat ini	%USERPROFILE%

 

Catatan %APPDATA% dan %USERPROFILE% relatif terhadap pengguna yang melakukan panggilan. Fungsi ini tidak berfungsi jika pengguna ditiru dari layanan. Untuk diskusi lebih lanjut tentang masalah kontrol akses, lihat Access Control.

 

Variabel lingkungan yang tercantum dalam tabel di atas mungkin tidak semuanya diatur pada semua sistem. Jika variabel lingkungan tidak diatur, variabel tersebut tidak perlu.

Nota

Header shlwapi.h mendefinisikan PathUnExpandEnvStrings 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

Syarat	Nilai
klien minimum yang didukung	Windows 2000 Professional, Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Lihat juga

DoEnvironmentSubst