Bagikan melalui

Fungsi SHRegSetPathA (shlwapi.h)

  • Artikel

Mengambil jalur file, mengganti nama folder dengan string lingkungan, dan menempatkan string yang dihasilkan dalam registri.

Sintaks

LSTATUS SHRegSetPathA(
  [in] HKEY   hKey,
  [in] LPCSTR pcszSubKey,
  [in] LPCSTR pcszValue,
  [in] LPCSTR pcszPath,
       DWORD  dwFlags
);

Parameter

[in] hKey

Jenis: HKEY

Handel ke kunci yang saat ini terbuka, atau kunci akar registri.

[in] pcszSubKey

Jenis: LPCTSTR

Penunjuk ke string yang dihentikan null yang berisi nama subkunci yang ada. Jika subkunci tidak ada, SHRegSetPath akan gagal.

[in] pcszValue

Jenis: LPCTSTR

Penunjuk ke string yang dihentikan null dengan nama nilai untuk menahan string jalur.

[in] pcszPath

Jenis: LPCTSTR

Penunjuk ke string yang dihentikan null dengan jalur file yang sepenuhnya memenuhi syarat.

dwFlags

Jenis: DWORD

Dicadangkan.

Nilai kembali

Jenis: LSTATUS

Mengembalikan ERROR_SUCCESS jika berhasil, atau kode kesalahan Windows sebaliknya.

Keterangan

Untuk Windows 2000, SHRegSetPath menggunakan PathUnExpandEnvStrings untuk mengonversi nama folder ke string lingkungan yang sesuai. Jika ada variabel lingkungan yang diganti, nilai registri akan diatur dengan jenis data REG_EXPAND_SZ . Jika tidak, itu akan diatur dengan jenis data REG_SZ .

Jalur folder berikut akan digantikan oleh string lingkungan yang setara.

Folder String lingkungan
Folder profil pengguna saat ini %USERPROFILE%
Folder profil Semua Pengguna %ALLUSERSPROFILE%
Folder File Program %ProgramFiles%
Folder akar sistem %SystemRoot%
Huruf kandar sistem %SystemDrive%
 
Catatan %USERPROFILE% relatif terhadap pengguna yang melakukan panggilan. Fungsi ini tidak berfungsi jika pengguna ditiru dari layanan.
 
Variabel lingkungan yang tercantum dalam tabel di atas mungkin tidak semuanya diatur pada sistem tertentu. Jika variabel lingkungan tidak diatur, variabel tersebut tidak akan terlampaui. Secara khusus, tidak ada variabel ini yang diatur untuk lingkungan default Windows 95 atau Windows 98. Variabel %ProgramFiles% baru untuk Windows 2000, dan biasanya tidak akan diatur pada sistem Microsoft Windows NT 4.0.

Catatan

Header shlwapi.h mendefinisikan SHRegSetPath sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor 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, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung Windows 2000 Server [hanya aplikasi desktop]
Target Platform Windows
Header shlwapi.h
Pustaka Shlwapi.lib
DLL Shlwapi.dll (versi 5.0 atau yang lebih baru)