Fungsi GetProfileStringA (winbase.h)
Mengambil string yang terkait dengan kunci di bagian yang ditentukan dari file Win.ini.
Sintaks
DWORD GetProfileStringA(
[in] LPCSTR lpAppName,
[in] LPCSTR lpKeyName,
[in] LPCSTR lpDefault,
[out] LPSTR lpReturnedString,
[in] DWORD nSize
);
Parameter
[in] lpAppName
Nama bagian yang berisi kunci. Jika parameter ini NULL, fungsi menyalin semua nama bagian dalam file ke buffer yang disediakan.
[in] lpKeyName
Nama kunci yang string terkaitnya akan diambil. Jika parameter ini NULL, fungsi menyalin semua kunci di bagian yang diberikan ke buffer yang disediakan. Setiap string diikuti oleh karakter null , dan string akhir diikuti oleh karakter null kedua.
[in] lpDefault
String default. Jika kunci lpKeyName tidak dapat ditemukan dalam file inisialisasi, GetProfileString menyalin string default ke buffer lpReturnedString . Jika parameter ini NULL, defaultnya adalah string kosong, "".
Hindari menentukan string default dengan karakter kosong berikutnya. Fungsi ini menyisipkan karakter null dalam buffer lpReturnedString untuk menghapus kosong berikutnya.
[out] lpReturnedString
Penunjuk ke buffer yang menerima string karakter.
[in] nSize
Ukuran buffer yang ditujukkan oleh parameter lpReturnedString , dalam karakter.
Mengembalikan nilai
Nilai yang dikembalikan adalah jumlah karakter yang disalin ke buffer, tidak termasuk karakter null-terminating.
Jika lpAppName maupun lpKeyName bukan NULL dan buffer tujuan yang disediakan terlalu kecil untuk menahan string yang diminta, string dipotong dan diikuti oleh karakter null , dan nilai yang dikembalikan sama dengan nSize minus satu.
Jika lpAppName atau lpKeyNameNULL dan buffer tujuan yang disediakan terlalu kecil untuk menahan semua string, string terakhir dipotong dan diikuti oleh dua karakter null . Dalam hal ini, nilai yang dikembalikan sama dengan nSize dikurangi dua.
Keterangan
Jika string yang terkait dengan parameter lpKeyName diapit dalam tanda kutip tunggal atau ganda, tanda akan dibuang saat fungsi GetProfileString mengembalikan string.
Fungsi GetProfileString tidak peka huruf besar/kecil; string dapat berisi kombinasi huruf besar dan huruf kecil.
Bagian dalam file Win.ini harus memiliki formulir berikut:
[section]
key=string
.
.
.
Aplikasi dapat menggunakan fungsi GetPrivateProfileString untuk mengambil string dari file inisialisasi tertentu.
Parameter lpDefault harus menunjuk ke string yang valid, bahkan jika string kosong (yaitu, bahkan jika karakter pertamanya adalah karakter null ).
Windows Server 2003 dan Windows XP/2000: Panggilan ke fungsi profil dapat dipetakan ke registri alih-alih ke file inisialisasi. Pemetaan ini terjadi ketika file dan bagian inisialisasi ditentukan dalam registri di bawah kunci berikut:
\ HKEY_LOCAL_MACHINEPerangkat lunak\Microsoft\Windows NT\CurrentVersion\IniFileMapping
Ketika operasi telah dipetakan, fungsi GetProfileString mengambil informasi dari registri, bukan dari file inisialisasi; perubahan lokasi penyimpanan tidak berpengaruh pada perilaku fungsi.
Fungsi profil menggunakan langkah-langkah berikut untuk menemukan informasi inisialisasi:
- Lihat di registri untuk nama file inisialisasi di bawah kunci IniFileMapping .
- Cari nama bagian yang ditentukan oleh lpAppName. Ini akan menjadi nilai bernama di bawah kunci yang memiliki nama file inisialisasi, atau subkunjuk dengan nama ini, atau nama tidak akan ada sebagai nilai atau subkun tangan.
- Jika nama bagian yang ditentukan oleh lpAppName adalah nilai bernama, maka nilai tersebut menentukan di mana dalam registri Anda akan menemukan kunci untuk bagian tersebut.
- Jika nama bagian yang ditentukan oleh lpAppName adalah subkunci, maka nilai bernama di bawah subkunci tersebut menentukan di mana dalam registri Anda akan menemukan kunci untuk bagian tersebut. Jika kunci yang Anda cari tidak ada sebagai nilai bernama, maka akan ada nilai yang tidak disebutkan namanya (ditampilkan sebagai <Tidak Ada Nama>) yang menentukan lokasi default di registri tempat Anda akan menemukan kunci.
- Jika nama bagian yang ditentukan oleh lpAppName tidak ada sebagai nilai bernama atau sebagai subkey, maka akan ada nilai yang tidak disebutkan namanya (ditampilkan sebagai <Tidak Ada Nama>) yang menentukan lokasi default di registri tempat Anda akan menemukan kunci untuk bagian tersebut.
- Jika tidak ada subkuntang atau entri untuk nama bagian, cari file inisialisasi aktual pada disk dan baca kontennya.
- ! - karakter ini memaksa semua penulisan untuk masuk ke registri dan ke file .ini pada disk.
- # - karakter ini menyebabkan nilai registri diatur ke nilai dalam file .ini Windows 3.1 saat pengguna baru masuk untuk pertama kalinya setelah penyiapan.
- @ - karakter ini mencegah pembacaan masuk ke file .ini pada disk jika data yang diminta tidak ditemukan di registri.
- USR: - awalan ini adalah singkatan dari HKEY_CURRENT_USER, dan teks setelah awalan relatif terhadap kunci tersebut.
- SYS: - awalan ini adalah singkatan dariHKEY_LOCAL_MACHINE\SOFTWARE, dan teks setelah awalan relatif terhadap kunci tersebut.
Catatan
Header winbase.h mendefinisikan GetProfileString 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
| Persyaratan | Nilai |
|---|---|
| Klien minimum yang didukung | Windows 2000 Professional [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | winbase.h (termasuk Windows.h) |
| Pustaka | Kernel32.lib |
| DLL | Kernel32.dll |