Fungsi WaitForSingleObjectEx (synchapi.h)

Artikel
03/02/2024

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

Untuk menunggu beberapa objek, gunakan WaitForMultipleObjectsEx.

Sintaks

DWORD WaitForSingleObjectEx(
  [in] HANDLE hHandle,
  [in] DWORD  dwMilliseconds,
  [in] BOOL   bAlertable
);

Parameter

[in] hHandle

Handel ke objek . Untuk daftar jenis objek yang handelnya dapat ditentukan, lihat bagian Keterangan berikut.

Jika handel ini ditutup saat penantian masih tertunda, perilaku fungsi tidak terdefinis.

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

[in] dwMilliseconds

Interval waktu habis, dalam milidetik. Jika nilai bukan nol ditentukan, fungsi menunggu hingga objek 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 akan kembali hanya ketika objek 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 kembali, dan fungsi rutinitas penyelesaian atau 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.

Mengembalikan kode/nilai	Deskripsi
WAIT_ABANDONED 0x00000080L	Objek yang ditentukan adalah objek mutex yang tidak dirilis oleh utas yang memiliki objek mutex sebelum utas pemilik dihentikan. 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_OBJECT_0 0x00000000L	Status objek yang ditentukan disinyalir.
WAIT_TIMEOUT 0x00000102L	Interval waktu habis berlalu, dan status objek tidak ditandatangani.
WAIT_FAILED (DWORD)0xFFFFFFFF	Fungsi telah gagal. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Fungsi WaitForSingleObjectEx 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.

Fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek yang status sinyalnya menyebabkan fungsi kembali. Misalnya, jumlah objek semaphore dikurangi satu.

Fungsi WaitForSingleObjectEx dapat menunggu objek berikut:

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 WaitForSingleObjectEx.

Contoh

Misalnya, lihat Server Pipa Bernama Menggunakan Rutinitas Penyelesaian.

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