Fungsi SHGetFolderPathAndSubDirA (shlobj_core.h)

Mendapatkan jalur folder dan menambahkan jalur subfolder yang disediakan pengguna.

Sintaks

HRESULT SHGetFolderPathAndSubDirA(
  [in]  HWND   hwnd,
  [in]  int    csidl,
  [in]  HANDLE hToken,
  [in]  DWORD  dwFlags,
  [in]  LPCSTR pszSubDir,
  [out] LPSTR  pszPath
);

Parameter

[in] hwnd

Jenis: HWND

Dicadangkan.

[in] csidl

Jenis: int

Nilai CSIDL yang mengidentifikasi folder yang jalurnya akan diambil. Hanya folder nyata yang valid. Jika folder virtual ditentukan, fungsi ini gagal. Anda dapat memaksa pembuatan folder dengan SHGetFolderPathAndSubDir dengan menggabungkan CSIDL folder dengan CSIDL_FLAG_CREATE.

[in] hToken

Jenis: HANDEL

Token akses yang mewakili pengguna tertentu. Untuk sistem yang lebih lama dari Windows 2000, atur nilai ini ke NULL. Untuk sistem selanjutnya, hToken biasanya, tetapi tidak selalu, diatur ke NULL. Anda mungkin perlu menetapkan nilai ke hToken untuk folder yang dapat memiliki beberapa pengguna tetapi diperlakukan sebagai milik satu pengguna. Folder yang paling umum digunakan dari jenis ini adalah Dokumen Saya.

[in] dwFlags

Jenis: DWORD

Menentukan apakah jalur yang akan dikembalikan adalah jalur aktual folder atau jalur default. Nilai ini digunakan dalam kasus di mana folder yang terkait dengan nilai CSIDL dapat dipindahkan atau diganti namanya oleh pengguna.

SHGFP_TYPE_CURRENT

Mengembalikan jalur folder saat ini.

SHGFP_TYPE_DEFAULT

Mengembalikan jalur default folder.

[in] pszSubDir

Jenis: LPCTSTR

Penunjuk ke subjalur untuk ditambahkan ke jalur folder. Ini adalah string panjang yang dihentikan null MAX_PATH. Jika Anda tidak membuat direktori baru, ini harus merupakan subdirektori yang ada atau fungsi mengembalikan kesalahan. Nilai ini bisa NULL jika tidak ada subjalur yang akan ditambahkan.

[out] pszPath

Jenis: LPTSTR

Ketika fungsi ini kembali, nilai ini menunjuk ke jalur direktori dan subjalur yang ditambahkan. Ini adalah string panjang yang dihentikan null MAX_PATH. String ini kosong ketika fungsi mengembalikan kode kesalahan.

Menampilkan nilai

Jenis: HRESULT

Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Catatan

Header shlobj_core.h mendefinisikan SHGetFolderPathAndSubDir 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

Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	shlobj_core.h (termasuk Shlobj.h, Shlobj_core.h)
Pustaka	Shell32.lib
DLL	Shell32.dll (versi 5.60 atau yang lebih baru)

Lihat juga

SHGetFolderPath