Fungsi WaitForMultipleObjectsEx (synchapi.h)

Artikel
03/02/2024

Menunggu hingga satu atau semua objek yang ditentukan dalam status bersinyali, panggilan prosedur rutin penyelesaian I/O atau asinkron (APC) diantrekan ke utas, atau interval waktu habis berlalu.

Sintaks

DWORD WaitForMultipleObjectsEx(
  [in] DWORD        nCount,
  [in] const HANDLE *lpHandles,
  [in] BOOL         bWaitAll,
  [in] DWORD        dwMilliseconds,
  [in] BOOL         bAlertable
);

Parameter

[in] nCount

Jumlah handel objek yang akan ditunggu dalam array yang ditunjukkan oleh lpHandles. Jumlah maksimum handel objek adalah MAXIMUM_WAIT_OBJECTS. Parameter ini tidak boleh nol.

[in] lpHandles

Array handel objek. Untuk daftar jenis objek yang handelnya dapat ditentukan, lihat bagian Keterangan berikut. Array dapat berisi handel objek dari berbagai jenis. Ini mungkin tidak berisi beberapa salinan dari handel yang sama.

Jika salah satu handel ini ditutup saat penantian masih tertunda, perilaku fungsi tidak terdefinisi.

Handel harus memiliki hak akses SYNCHRONIZE . Untuk informasi selengkapnya, lihat Hak Akses Standar.

[in] bWaitAll

Jika parameter ini TRUE, fungsi akan kembali saat status semua objek dalam array lpHandles diatur ke sinyal. Jika FALSE, fungsi akan kembali saat status salah satu objek diatur ke sinyal. Dalam kasus terakhir, nilai pengembalian menunjukkan objek yang statusnya menyebabkan fungsi dikembalikan.

[in] dwMilliseconds

Interval waktu habis, dalam milidetik. Jika nilai bukan nol ditentukan, fungsi menunggu hingga objek yang ditentukan diberi sinyal, rutinitas penyelesaian I/O atau APC diantrekan, atau interval berlalu. Jika dwMilliseconds adalah nol, fungsi tidak memasuki status tunggu jika kriteria tidak terpenuhi; itu selalu segera kembali. Jika dwMilliseconds adalah INFINITE, fungsi hanya akan kembali ketika objek yang ditentukan diberi sinyal atau rutinitas penyelesaian I/O atau APC diantrekan.

Windows XP, Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 dan Windows Server 2008 R2: Nilai dwMilliseconds memang mencakup waktu yang dihabiskan dalam status berdaya rendah. Misalnya, waktu habis terus menghitung mundur saat komputer tertidur.

Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows 10 dan Windows Server 2016: Nilai dwMilliseconds tidak menyertakan waktu yang dihabiskan dalam status berdaya rendah. Misalnya, batas waktu tidak terus menghitung mundur saat komputer tertidur.

[in] bAlertable

Jika parameter ini TRUE dan utas dalam status menunggu, fungsi akan kembali saat sistem mengantrekan rutinitas penyelesaian I/O atau APC, dan utas menjalankan rutinitas atau fungsi. Jika tidak, fungsi tidak mengembalikan dan rutinitas penyelesaian atau fungsi APC tidak dijalankan.

Rutinitas penyelesaian diantrekan ketika fungsi ReadFileEx atau WriteFileEx tempat fungsi ditentukan telah selesai. Fungsi tunggu kembali dan rutinitas penyelesaian dipanggil hanya jika bAlertableTRUE dan utas panggilan adalah utas yang memulai operasi baca atau tulis. APC diantrekan saat Anda memanggil QueueUserAPC.

Nilai kembali

Jika fungsi berhasil, nilai pengembalian menunjukkan peristiwa yang menyebabkan fungsi dikembalikan. Ini bisa menjadi salah satu nilai berikut. (Perhatikan bahwa WAIT_OBJECT_0 didefinisikan sebagai 0 dan WAIT_ABANDONED_0 didefinisikan sebagai 0x00000080L.)

Mengembalikan kode/nilai	Deskripsi
WAIT_OBJECT_0 ke (WAIT_OBJECT_0 + nCount– 1)	Jika bWaitAllTRUE, nilai pengembalian dalam rentang ini menunjukkan bahwa status semua objek yang ditentukan diberi sinyal. Jika bWaitAllFALSE, nilai yang dikembalikan dikurangi WAIT_OBJECT_0 menunjukkan indeks array lpHandles dari objek yang memenuhi penantian. Jika lebih dari satu objek menjadi sinyal selama panggilan, ini adalah indeks array objek yang disinyalir dengan nilai indeks terkecil dari semua objek yang disinyalir.
WAIT_ABANDONED_0 ke (WAIT_ABANDONED_0 + nCount– 1)	Jika bWaitAllTRUE, nilai pengembalian dalam rentang ini menunjukkan bahwa status semua objek yang ditentukan diberi sinyal, dan setidaknya salah satu objek adalah objek mutex yang ditinggalkan. Jika bWaitAllFALSE, nilai yang dikembalikan dikurangi WAIT_ABANDONED_0 menunjukkan indeks array lpHandles dari objek mutex yang ditinggalkan yang memenuhi waktu tunggu. Kepemilikan objek mutex diberikan ke utas panggilan, dan mutex diatur ke nonsignaled. Jika mutex melindungi informasi status persisten, Anda harus memeriksanya untuk konsistensi.
WAIT_IO_COMPLETION 0x000000C0L	Penantian berakhir dengan satu atau beberapa panggilan prosedur asinkron mode pengguna (APC) yang diantrekan ke utas.
WAIT_TIMEOUT 0x00000102L	Interval waktu habis berlalu, kondisi yang ditentukan oleh parameter bWaitAll tidak terpenuhi, dan tidak ada rutinitas penyelesaian yang diantrekan.
WAIT_FAILED (DWORD)0xFFFFFFFF	Fungsi telah gagal. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Fungsi WaitForMultipleObjectsEx menentukan apakah kriteria tunggu telah terpenuhi. Jika kriteria belum terpenuhi, utas panggilan memasuki status tunggu hingga kondisi kriteria tunggu terpenuhi atau interval waktu habis berlalu.

Ketika bWaitAllTRUE, operasi tunggu fungsi selesai hanya ketika status semua objek telah diatur ke sinyal. Fungsi tidak mengubah status objek yang ditentukan sampai status semua objek telah diatur ke sinyal. Misalnya, mutex dapat disinyalir, tetapi utas tidak mendapatkan kepemilikan sampai status objek lain juga diatur ke sinyal. Sementara itu, beberapa utas lain mungkin mendapatkan kepemilikan mutex, sehingga mengatur statusnya menjadi tidak sejajar.

Ketika bWaitAllFALSE, fungsi ini memeriksa handel dalam array agar dimulai dengan indeks 0, hingga salah satu objek diberi sinyal. Jika beberapa objek menjadi sinyal, fungsi mengembalikan indeks handel pertama dalam array yang objeknya diberi sinyal.

Fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek atau objek yang status sinyalnya menyebabkan fungsi kembali. Misalnya, jumlah objek semaphore dikurangi satu. Untuk informasi selengkapnya, lihat dokumentasi untuk objek sinkronisasi individual.

Untuk menunggu lebih dari MAXIMUM_WAIT_OBJECTS handel, gunakan salah satu metode berikut:

Buat utas untuk menunggu handel MAXIMUM_WAIT_OBJECTS , lalu tunggu di utas tersebut ditambah handel lainnya. Gunakan teknik ini untuk memecah handel menjadi grup MAXIMUM_WAIT_OBJECTS.
Panggil RegisterWaitForSingleObject atau SetThreadpoolWait untuk menunggu di setiap handel. Kumpulan utas menunggu secara efisien pada handel dan menetapkan utas pekerja setelah objek diberi sinyal atau interval waktu habis kedaluwarsa.

Fungsi WaitForMultipleObjectsEx dapat menentukan handel dari salah satu jenis objek berikut dalam array lpHandles :

Mengubah pemberitahuan
Input konsol
Kejadian
Pemberitahuan sumber daya memori
Mutex
Proses
Semaphore
Rangkaian
Timer yang dapat ditunda

Berhati-hatilah saat memanggil fungsi tunggu dan kode yang secara langsung atau tidak langsung membuat jendela. Jika utas membuat jendela apa pun, utas harus memproses pesan. Siaran pesan dikirim ke semua jendela dalam sistem. Utas yang menggunakan fungsi tunggu tanpa interval waktu habis dapat menyebabkan sistem menjadi mengalami kebuntuan. Dua contoh kode yang secara tidak langsung membuat jendela adalah DDE dan fungsi CoInitialize . Oleh karena itu, jika Anda memiliki utas yang membuat jendela, gunakan MsgWaitForMultipleObjects atau MsgWaitForMultipleObjectsEx, bukan WaitForMultipleObjectsEx.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2003 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	synchapi.h (termasuk Windows.h pada Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Pustaka	Kernel32.lib
DLL	Kernel32.dll

Lihat juga

Fungsi Sinkronisasi

Fungsi Tunggu

Share via