Metode IShellFolder::EnumObjects (shobjidl_core.h)

Artikel
03/15/2023

Memungkinkan klien menentukan konten folder dengan membuat objek enumerasi pengidentifikasi item dan mengembalikan antarmuka IEnumIDList-nya . Metode yang didukung oleh antarmuka tersebut kemudian dapat digunakan untuk menghitung konten folder.

Sintaks

HRESULT EnumObjects(
  [in]  HWND        hwnd,
  [in]  SHCONTF     grfFlags,
  [out] IEnumIDList **ppenumIDList
);

Parameter

[in] hwnd

Jenis: HWND

Jika input pengguna diperlukan untuk melakukan enumerasi, handel jendela ini harus digunakan oleh objek enumerasi sebagai jendela induk untuk mengambil input pengguna. Contohnya adalah kotak dialog untuk meminta kata sandi atau meminta pengguna untuk menyisipkan CD atau disket. Jika hwndOwner diatur ke NULL, enumerator tidak boleh memposting pesan apa pun, dan jika input pengguna diperlukan, itu akan gagal secara diam-diam.

[in] grfFlags

Jenis: SHCONTF

Bendera yang menunjukkan item mana yang akan disertakan dalam enumerasi. Untuk daftar nilai yang mungkin, lihat jenis enumerasi SHCONTF .

[out] ppenumIDList

Jenis: IEnumIDList**

Alamat yang menerima penunjuk ke antarmuka IEnumIDList dari objek enumerasi yang dibuat oleh metode ini. Jika terjadi kesalahan atau tidak ada subobjek yang sesuai yang ditemukan, ppenumIDList diatur ke NULL.

Nilai kembali

Jenis: HRESULT

Mengembalikan S_OK jika berhasil, atau nilai kesalahan sebaliknya. Beberapa implementasi juga dapat mengembalikan S_FALSE, menunjukkan bahwa tidak ada anak yang cocok dengan grfFlags yang diteruskan. Jika S_FALSE dikembalikan, ppenumIDList diatur ke NULL.

Keterangan

Jika metode mengembalikan S_OK, maka ppenumIDList menerima penunjuk ke enumerator. Dalam hal ini, aplikasi panggilan harus membebaskan objek IEnumIDList yang dikembalikan dengan memanggil metode Rilisnya .

Jika metode mengembalikan S_FALSE, maka folder tidak berisi subobjek yang sesuai dan penunjuk yang ditentukan dalam ppenumIDList diatur ke NULL.

Jika metode gagal, nilai kesalahan dikembalikan dan penunjuk yang ditentukan dalam ppenumIDList diatur ke NULL.

Jika folder tidak berisi subobject yang sesuai, maka metode IShellFolder::EnumObjects diizinkan baik untuk mengatur *ppenumIDList ke NULL dan mengembalikan S_FALSE, atau untuk mengatur *ppenumIDList ke enumerator yang tidak menghasilkan objek dan mengembalikan S_OK. Aplikasi panggilan harus disiapkan untuk kedua kasus keberhasilan.

Persyaratan


Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	shobjidl_core.h (termasuk Shobjidl.h)
DLL	Shell32.dll (versi 4.0 atau yang lebih baru)

Lihat juga

IShellFolder

IShellFolder2

SHGetDesktopFolder

Share via