Metode IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)

Artikel
08/26/2023

Menyediakan lokasi bitmap overlay ikon.

Sintaks

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

Parameter

[out] pwszIconFile

Jenis: PWSTR

String Unicode yang dihentikan null yang berisi jalur file yang sepenuhnya memenuhi syarat yang berisi ikon. Jenis file .dll, .exe, dan .ico semuanya dapat diterima. Anda harus mengatur bendera ISIOI_ICONFILE di pdwFlags jika Anda mengembalikan nama file.

cchMax

Jenis: int

Ukuran buffer pwszIconFile , dalam karakter Unicode.

[out] pIndex

Jenis: int*

Penunjuk ke nilai indeks yang digunakan untuk mengidentifikasi ikon dalam file yang berisi beberapa ikon. Anda harus mengatur bendera ISIOI_ICONINDEX di pdwFlags jika Anda mengembalikan indeks.

[out] pdwFlags

Jenis: DWORD*

Penunjuk ke bitmap yang menentukan informasi yang dikembalikan oleh metode . Parameter ini bisa menjadi salah satu atau kedua nilai berikut.

ISIOI_ICONFILE (0x00000001)

Jalur file ikon dikembalikan melalui pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

Ada lebih dari satu ikon di pwszIconFile. Indeks ikon dikembalikan melalui pIndex.

Menampilkan nilai

Jenis: HRESULT

Jika metode ini berhasil, metode akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Metode ini dipanggil oleh Shell saat startup sehingga overlay ikon handler dapat ditambahkan ke daftar gambar sistem. Setelah inisialisasi selesai, Shell memanggil GetOverlayInfo saat perlu menampilkan overlay ikon handler.

Catatan Setelah gambar dimuat ke dalam daftar gambar sistem selama inisialisasi, gambar tidak dapat diubah. Setelah inisialisasi, nama file dan indeks hanya digunakan untuk mengidentifikasi overlay ikon. Sistem tidak akan memuat overlay ikon baru. Ketika GetOverlayInfo dipanggil, handler Anda harus mengembalikan nama file dan indeks yang sama yang ditentukan saat fungsi pertama kali dipanggil.

Persyaratan


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	shobjidl_core.h (termasuk Shlobj.h)
DLL	Shell32.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui