Metode IShellIconOverlay::GetOverlayIndex (shlobj_core.h)

Artikel
03/04/2024

Mendapatkan indeks overlay dalam daftar gambar sistem.

Sintaks

HRESULT GetOverlayIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIndex
);

Parameter

[in] pidl

Jenis: PCUITEMID_CHILD

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

[in, out] pIndex

Jenis: int*

Penunjuk ke nilai yang menyatakan indeks overlay (berbasis satu) dalam daftar gambar sistem. Indeks ini setara dengan nilai iOverlay 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.
E_INVALIDARG	Argumen tidak valid, misalnya, jika pIndex adalah NULL.
E_PENDING	Aplikasi panggilan lulus OI_ASYNC untuk menandakan bahwa operasi penghitungan indeks overlay akan memakan waktu.

Keterangan

Untuk mengambil indeks overlay dalam daftar gambar sistem, panggil SHGetIconOverlayIndex.

Jika Anda mengatur pIndex untuk menunjuk ke OI_ASYNC saat Anda memanggil metode ini, handler overlay ikon Shell mungkin mengembalikan E_PENDING alih-alih menyimpan indeks overlay di pIndex. Nilai pengembalian ini menunjukkan bahwa komputasi overlay adalah operasi yang lambat dan harus ditangani di latar belakang. Ketika implementasi IShellIconOverlay mengembalikan E_PENDING, implementasi ini dipanggil kembali pada utas pekerja latar belakang tanpa bendera OI_ASYNC. Jika Anda tidak menggunakan OI_ASYNC saat memanggil GetOverlayIndex, handler overlay harus menghitung indeks overlay dan menyimpan nilai dalam pIndex sebelum kembali.

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