Fungsi ExtractIconA (shellapi.h)

Artikel
08/26/2023

Mendapatkan handel ke ikon dari file yang dapat dieksekusi, DLL, atau file ikon yang ditentukan.

Untuk mengambil array handel ke ikon besar atau kecil, gunakan fungsi ExtractIconEx .

Sintaks

HICON ExtractIconA(
  [in] HINSTANCE hInst,
  [in] LPCSTR    pszExeFileName,
       UINT      nIconIndex
);

Parameter

[in] hInst

Jenis: HINSTANCE

Tangani ke instans aplikasi yang memanggil fungsi.

[in] pszExeFileName

Jenis: LPCTSTR

Penunjuk ke string yang dihentikan null yang menentukan nama file, DLL, atau file ikon yang dapat dieksekusi.

nIconIndex

Jenis: UINT

Menentukan indeks berbasis nol dari ikon yang akan diambil. Misalnya, jika nilai ini adalah 0, fungsi mengembalikan handel ke ikon pertama dalam file yang ditentukan.

Jika nilai ini adalah -1, fungsi mengembalikan jumlah total ikon dalam file yang ditentukan. Jika file adalah file yang dapat dieksekusi atau DLL, nilai yang dikembalikan adalah jumlah sumber daya RT_GROUP_ICON. Jika file adalah . File ICO, nilai yang dikembalikan adalah 1.

Jika nilai ini adalah angka negatif yang tidak sama dengan –1, fungsi mengembalikan handel ke ikon dalam file yang ditentukan yang pengidentifikasi sumber dayanya sama dengan nilai absolut nIconIndex. Misalnya, Anda harus menggunakan –3 untuk mengekstrak ikon yang pengidentifikasi sumber dayanya adalah 3. Untuk mengekstrak ikon yang pengidentifikasi sumber dayanya adalah 1, gunakan fungsi ExtractIconEx .

Mengembalikan nilai

Jenis: HICON

Nilai yang dikembalikan adalah handel ke ikon. Jika file yang ditentukan bukan file yang dapat dieksekusi, DLL, atau file ikon, pengembaliannya adalah 1. Jika tidak ada ikon yang ditemukan dalam file, nilai yang dikembalikan adalah NULL.

Keterangan

Ketika tidak lagi diperlukan, Anda harus menghancurkan handel ikon yang dikembalikan oleh ExtractIcon dengan memanggil fungsi DestroyIcon .

Catatan

Header shellapi.h mendefinisikan ExtractIcon 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 [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shellapi.h
DLL	Shell32.dll
Set API	ext-ms-win-shell-shell32-l1-2-1 (diperkenalkan dalam Windows 10, versi 10.0.10240)

Lihat juga

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx