Fungsi GetFileTitleA (commdlg.h)

Artikel
11/20/2024

Mengambil nama file yang ditentukan.

Sintaksis

short GetFileTitleA(
  [in]  LPCSTR unnamedParam1,
  [out] LPSTR  Buf,
  [in]  WORD   cchSize
);

Parameter

[in] unnamedParam1

Jenis: LPCTSTR

Nama dan lokasi file.

[out] Buf

Jenis: LPTSTR

Buffer yang menerima nama file.

[in] cchSize

Jenis: WORD

Panjangnya, dalam karakter, dari buffer yang ditunjukkan oleh parameter lpszTitle.

Mengembalikan nilai

Jenis: pendek

Jika fungsi berhasil, nilai yang dikembalikan adalah nol.

Jika nama file tidak valid, nilai pengembalian tidak diketahui. Jika ada kesalahan, nilai yang dikembalikan adalah angka negatif.

Jika buffer yang diarahkan oleh parameter lpszTitle terlalu kecil, nilai yang dikembalikan adalah bilangan bulat positif yang menentukan ukuran buffer yang diperlukan, dalam karakter. Ukuran buffer yang diperlukan mencakup karakter null yang dihentikan.

Komentar

GetFileTitle hanya boleh dipanggil dengan nama file legal; menggunakan nama file ilegal memiliki hasil yang tidak ditentukan.

Untuk mendapatkan ukuran buffer yang diperlukan untuk nama file, panggil fungsi dengan lpszTitle diatur ke NULL dan cchSize diatur ke nol. Fungsi mengembalikan ukuran yang diperlukan.

GetFileTitle mengembalikan string yang akan digunakan sistem untuk menampilkan nama file kepada pengguna. Nama tampilan hanya menyertakan ekstensi jika itu adalah preferensi pengguna untuk menampilkan nama file. Ini berarti bahwa string yang dikembalikan mungkin tidak secara akurat mengidentifikasi file jika digunakan dalam panggilan ke fungsi sistem file.

Jika buffer lpszTitle terlalu kecil, GetFileTitle mengembalikan ukuran yang diperlukan untuk menahan nama tampilan. Namun, tidak ada hubungan yang dijamin antara ukuran yang diperlukan dan karakter yang awalnya ditentukan dalam buffer lpszFile . Misalnya, jangan panggil GetFileTitle dengan lpszTitle diatur ke NULL dan cchSize diatur ke nol, lalu coba gunakan nilai pengembalian sebagai indeks ke dalam string lpszFile. Anda biasanya dapat mencapai hasil serupa (dan performa unggul) dengan fungsi pustaka run-time C seperti strrchr, wcsrchr, dan _mbsrchr.

Nota

Header commdlg.h mendefinisikan GetFileTitle 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 [hanya aplikasi desktop]
server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Platform Target	Windows
Header	commdlg.h (termasuk Windows.h)
Pustaka	Comdlg32.lib
DLL	Comdlg32.dll
set API	ext-ms-win-shell-comdlg32-l1-1-1 (diperkenalkan di Windows 10, versi 10.0.14393)

Lihat juga

Pustaka Kotak Dialog Umum

Konseptual

GetOpenFileName

GetSaveFileName

Referensi

Bagikan melalui