Fungsi SHDefExtractIconA (shlobj_core.h)

Artikel
03/15/2023

Menyediakan handler default untuk mengekstrak ikon dari file.

Sintaks

SHSTDAPI SHDefExtractIconA(
  [in]            LPCSTR pszIconFile,
                  int    iIndex,
  [in]            UINT   uFlags,
  [out, optional] HICON  *phiconLarge,
  [out, optional] HICON  *phiconSmall,
                  UINT   nIconSize
);

Parameter

[in] pszIconFile

Jenis: LPCTSTR

Penunjuk ke buffer yang dihentikan null yang berisi jalur dan nama file tempat ikon diekstraksi.

iIndex

Jenis: int

Lokasi ikon dalam file bernama dalam pszIconFile. Jika ini adalah angka positif, itu mengacu pada posisi ikon berbasis nol dalam file. Misalnya, 0 mengacu pada ikon ke-1 dalam file sumber daya dan 2 mengacu pada yang ke-3. Jika ini adalah angka negatif, itu mengacu pada ID sumber daya ikon.

[in] uFlags

Jenis: UINT

Bendera yang mengontrol ekstraksi ikon.

GIL_SIMULATEDOC

Melapisi ikon yang diekstrak pada ikon dokumen default untuk membuat ikon akhir. Ikon ini dapat digunakan ketika tidak ada ikon yang lebih tepat yang dapat ditemukan atau diambil.

[out, optional] phiconLarge

Jenis: HICON*

Penunjuk ke HICON yang, ketika fungsi ini berhasil dikembalikan, menerima handel dari versi besar ikon yang ditentukan dalam LOWORDnIconSize. Nilai ini bisa NULL.

[out, optional] phiconSmall

Jenis: HICON*

Penunjuk ke HICON yang, ketika fungsi ini berhasil dikembalikan, menerima handel dari versi kecil ikon yang ditentukan dalam HIWORDdari nIconSize.

nIconSize

Jenis: UINT

Nilai yang berisi ukuran ikon besar dalam LOWORD-nya dan ukuran ikon kecil dalam HIWORD-nya. Ukuran diukur dalam piksel. Teruskan 0 untuk menentukan ukuran besar dan kecil default.

Menampilkan nilai

Jenis: HRESULT

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
S_OK	Berhasil.
S_FALSE	Ikon yang diminta tidak ada.
E_FAIL	File tidak dapat diakses, atau sedang diakses melalui tautan lambat.

Keterangan

Pemanggil bertanggung jawab untuk membebaskan sumber daya ikon yang dibuat melalui fungsi ini ketika mereka tidak lagi diperlukan. Ini dapat dilakukan melalui fungsi DestroyIcon .

Catatan

Header shlobj_core.h mendefinisikan SHDefExtractIcon 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


Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	shlobj_core.h (termasuk Shlobj.h, Shlobj_core.h)
Pustaka	Shell32.lib
DLL	Shell32.dll (versi 6.0 atau yang lebih baru)
Set API	ext-ms-win-shell-shell32-l1-2-1 (diperkenalkan dalam Windows 10, versi 10.0.10240)

Bagikan melalui