Fungsi GetLongPathNameA (fileapi.h)

Artikel
02/28/2024

Mengonversi jalur yang ditentukan ke bentuk panjangnya.

Untuk melakukan operasi ini sebagai operasi yang ditransaksikan, gunakan fungsi GetLongPathNameTransacted .

Untuk informasi selengkapnya tentang nama file dan jalur, lihat Menamai File, Jalur, dan Namespace.

Sintaks

DWORD GetLongPathNameA(
  [in]  LPCSTR lpszShortPath,
  [out] LPSTR  lpszLongPath,
  [in]  DWORD  cchBuffer
);

Parameter

[in] lpszShortPath

Jalur yang akan dikonversi.

[out] lpszLongPath

Penunjuk ke buffer untuk menerima jalur panjang.

Anda dapat menggunakan buffer yang sama dengan yang Anda gunakan untuk parameter lpszShortPath .

[in] cchBuffer

Ukuran buffer lpszLongPath menunjuk ke, dalam TCHAR.

Menampilkan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah panjangnya, dalam TCHAR, dari string yang disalin ke lpszLongPath, tidak termasuk karakter null yang mengakhiri.

Jika buffer lpBuffer terlalu kecil untuk memuat jalur, nilai yang dikembalikan adalah ukuran, dalam TCHAR, dari buffer yang diperlukan untuk menahan jalur dan karakter null yang mengakhiri.

Jika fungsi gagal karena alasan lain, seperti jika file tidak ada, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Pada banyak sistem file, nama file pendek berisi karakter tilde (~). Namun, tidak semua sistem file mengikuti konvensi ini. Oleh karena itu, jangan berasumsi bahwa Anda dapat melewati panggilan GetLongPathName jika jalur tidak berisi karakter tilde (~).

Jika file atau direktori ada tetapi jalur panjang tidak ditemukan, GetLongPathName berhasil, setelah menyalin string yang dirujuk oleh parameter lpszShortPath ke buffer yang disebut oleh parameter lpszLongPath .

Jika nilai yang dikembalikan lebih besar dari nilai yang ditentukan dalam cchBuffer, Anda dapat memanggil fungsi lagi dengan buffer yang cukup besar untuk menahan jalur. Untuk contoh kasus ini, lihat bagian Contoh Kode untuk GetFullPathName.

Catatan Meskipun nilai yang dikembalikan dalam kasus ini adalah panjang yang mencakup karakter null yang mengakhiri, nilai pengembalian pada keberhasilan tidak menyertakan karakter null yang mengakhiri dalam hitungan.

Dimungkinkan untuk memiliki akses ke file atau direktori tetapi tidak memiliki akses ke beberapa direktori induk file atau direktori tersebut. Akibatnya, GetLongPathName mungkin gagal ketika tidak dapat mengkueri direktori induk komponen jalur untuk menentukan nama panjang untuk komponen tersebut. Pemeriksaan ini dapat dilewati untuk komponen direktori yang memiliki ekstensi file lebih panjang dari 3 karakter, atau total panjang lebih dari 12 karakter. Untuk informasi selengkapnya, lihat bagian Nama Pendek vs. Panjang dari Penamaan File, Jalur, dan Namespace.

Di Windows 8 dan Windows Server 2012, fungsi ini didukung oleh teknologi berikut.

Teknologi	Didukung
Protokol Server Message Block (SMB) 3.0	Ya
SMB 3.0 Transparent Failover (TFO)	Ya
SMB 3.0 dengan Berbagi File Peluasan Skala (SO)	Ya
Sistem File Volume Bersama Kluster (CsvFS)	Ya
Sistem File Tangguh (ReFS)	Ya

Contoh

Untuk contoh yang menggunakan GetLongPathName, lihat bagian Contoh Kode untuk GetFullPathName.

Catatan

Header fileapi.h mendefinisikan GetLongPathName sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor 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 XP [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	fileapi.h (sertakan Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll