Fungsi SHGetIconOverlayIndexA (shlobj_core.h)

Artikel
08/26/2023

Mengembalikan indeks ikon overlay dalam daftar gambar sistem.

Sintaks

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

Parameter

[in, optional] pszIconPath

Jenis: LPCTSTR

Penunjuk ke string yang dihentikan null dengan panjang maksimum MAX_PATH yang berisi jalur file yang sepenuhnya memenuhi syarat yang berisi ikon.

iIconIndex

Jenis: int

Indeks ikon dalam file yang ditujukan oleh pszIconPath. Untuk meminta ikon overlay standar, atur pszIconPath ke NULL, dan iIconIndex ke salah satu hal berikut:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Ikon overlay yang menunjukkan folder bersama.

IDO_SHGIOI_LINK (0x0FFFFFFE)

Ikon overlay yang menunjukkan folder atau file yang ditautkan.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Ikon overlay yang menunjukkan file lambat.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 dan yang lebih baru. Ikon overlay yang menunjukkan bahwa item adalah default dalam satu set. Salah satu contohnya adalah printer default.

Menampilkan nilai

Jenis: int

Mengembalikan indeks ikon overlay dalam daftar gambar sistem jika berhasil, atau -1 jika tidak.

Keterangan

Overlay ikon adalah bagian dari daftar gambar sistem. Mereka memiliki dua pengidentifikasi. Yang pertama adalah indeks overlay berbasis satu yang mengidentifikasi overlay relatif terhadap overlay lain dalam daftar gambar. Yang lainnya adalah indeks gambar yang mengidentifikasi gambar aktual. Kedua indeks ini setara dengan nilai yang Anda tetapkan ke parameter iOverlay dan iImage , masing-masing, saat Anda menambahkan overlay ikon ke daftar gambar privat dengan ImageList_SetOverlayImage. SHGetIconOverlayIndex mengembalikan indeks overlay. Untuk mengonversi indeks overlay ke indeks gambar yang setara, panggil INDEXTOOVERLAYMASK.

Catatan Setelah gambar dimuat ke dalam daftar gambar sistem selama inisialisasi, gambar tidak dapat diubah. Nama file dan indeks yang ditentukan oleh pszIconPath dan iIconIndex hanya digunakan untuk mengidentifikasi overlay ikon. SHGetIconOverlayIndex tidak dapat digunakan untuk mengubah daftar gambar sistem.

Catatan

Header shlobj_core.h mendefinisikan SHGetIconOverlayIndex 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 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shlobj_core.h (termasuk Shlobj.h, Shlobj_core.h)
Pustaka	Shell32.lib
DLL	Shell32.dll (versi 5.0 atau yang lebih baru)

Lihat juga

IShelliconOverlay

IShelliconOverlayidentifier

Bagikan melalui