Metode IShellIconOverlay::GetOverlayIconIndex (shlobj_core.h)

Artikel
03/02/2024

Mendapatkan indeks overlay ikon dalam daftar gambar sistem.

Sintaks

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

Parameter

[in] pidl

Jenis: PCUITEMID_CHILD

Penunjuk ke struktur ITEMIDLIST yang mengidentifikasi objek yang ikonnya sedang ditampilkan.

[in, out] pIconIndex

Jenis: int*

Arahkan ke indeks gambar overlay ikon dalam daftar gambar sistem. Indeks ini setara dengan nilai iImage yang ditentukan saat Anda menambahkan gambar overlay ke daftar gambar privat dengan fungsi ImageList::SetOverlayImage .

Mengembalikan nilai

Jenis: HRESULT

Metode ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
S_OK	Indeks overlay ditemukan.
S_FALSE	Tidak ada overlay untuk file ini.
E_FAIL	PIDL tidak valid.

Keterangan

Untuk mengambil indeks gambar overlay dalam daftar gambar sistem, Anda harus terlebih dahulu memanggil SHGetIconOverlayIndex untuk mengambil indeks overlay. Kemudian gunakan makro INDEXTOOVERLAYMASK untuk mengonversi indeks overlay menjadi indeks gambar yang setara.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional, Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	shlobj_core.h
DLL	Shell32.dll (versi 5.0 atau yang lebih baru)

Lihat juga

IShellIconOverlay

Bagikan melalui