Fungsi LoadIconA (winuser.h)

Artikel
08/27/2023

Memuat sumber daya ikon yang ditentukan dari file yang dapat dieksekusi (.exe) yang terkait dengan instans aplikasi.

Catatan

Fungsi ini telah digantikan oleh fungsi LoadImage (dengan set bendera LR_DEFAULTSIZE dan LR_SHARED ).

Sintaks

HICON LoadIconA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpIconName
);

Parameter

[in, optional] hInstance

Jenis: HINSTANCE

Handel ke modul file DLL atau file yang dapat dieksekusi (.exe) yang berisi ikon yang akan dimuat. Untuk informasi selengkapnya, lihat GetModuleHandle.

Untuk memuat ikon sistem yang telah ditentukan sebelumnya, atur parameter ini ke NULL.

[in] lpIconName

Jenis: LPCTSTR

Jika hInstance bukan NULL, lpIconName menentukan sumber daya ikon baik berdasarkan nama atau ordinal. Ordinal ini harus dikemas dengan menggunakan makro MAKEINTRESOURCE .

Jika hInstanceADALAH NULL, lpIconName menentukan pengidentifikasi (dimulai dengan awalan IDI_) dari ikon sistem yang telah ditentukan sebelumnya untuk dimuat.

Mengembalikan nilai

Jenis: HICON

Jika fungsi berhasil, nilai yang dikembalikan adalah handel ke ikon yang baru dimuat.

Jika fungsi gagal, nilai yang dikembalikan adalah NULL. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

LoadIcon memuat sumber daya ikon hanya jika belum dimuat; jika tidak, ia mengambil handel ke sumber daya yang ada. Fungsi ini mencari sumber daya ikon untuk ikon yang paling sesuai untuk tampilan saat ini. Sumber daya ikon dapat berupa bitmap warna atau monokrom.

LoadIcon hanya dapat memuat ikon yang ukurannya sesuai dengan nilai metrik sistem SM_CXICON dan SM_CYICON . Gunakan fungsi LoadImage untuk memuat ikon dengan ukuran lain.

Catatan

Header winuser.h mendefinisikan LoadIcon sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosedur 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	winuser.h (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-gui-l1-1-0 (diperkenalkan dalam Windows 8)