Metode IScheduledWorkItem::GetIdleWait (mstask.h)

[[API ini dapat diubah atau tidak tersedia dalam versi sistem operasi atau produk berikutnya. Silakan gunakan Antarmuka Penjadwal Tugas 2.0 sebagai gantinya.] ]

Mengambil waktu tunggu diam untuk item kerja.

Untuk informasi tentang kondisi menganggur, lihat Kondisi Menganggur Tugas.

Sintaks

HRESULT GetIdleWait(
  [out] WORD *pwIdleMinutes,
  [out] WORD *pwDeadlineMinutes
);

Parameter

[out] pwIdleMinutes

Penunjuk ke WORD yang berisi waktu tunggu diam untuk item kerja saat ini, dalam hitungan menit.

[out] pwDeadlineMinutes

Penunjuk ke WORD yang menentukan jumlah menit maksimum penjadwal Tugas akan menunggu periode idle-time yang dikembalikan dalam pwIdleMinutes.

Nilai kembali

Metode GetIdleWait mengembalikan salah satu nilai berikut.

Menampilkan kode	Deskripsi
S_OK	Operasi berhasil.
E_INVALIDARG	Argumen tidak valid.

Keterangan

Waktu menganggur yang dikembalikan di sini digunakan bersama dengan pemicu menganggur dan kondisi menganggur. Pemicu diam adalah pemicu berbasis peristiwa yang tidak terkait dengan waktu terjadwal. Kondisi diam dikaitkan dengan waktu mulai terjadwal untuk tugas.

Pemicu menganggur ditentukan dengan mengatur anggota TASK_TRIGGER_TYPE struktur TASK_TRIGGER ke nilai TASK_EVENT_TRIGGER_ON_IDLE. Pemicu diam diaktifkan ketika sistem menjadi menganggur untuk jumlah waktu yang dikembalikan dalam pwIdleMinutes.

Anda dapat mengatur kondisi diam dengan memanggil IScheduledWorkItem::SetFlags. Jika bendera TASK_FLAG_START_ONLY_IF_IDLE diatur, item kerja berjalan pada waktu yang dijadwalkan hanya jika sistem menganggur selama jumlah waktu yang dikembalikan dalam pwIdleMinutes. Layanan Penjadwal Tugas akan menunggu hingga pwDeadlineMinutes melewati waktu mulai yang dijadwalkan untuk melihat apakah sistem menjadi menganggur.

Contoh

Untuk contoh cara mengambil waktu tunggu diam tugas, lihat Contoh Kode C/C++: Mengambil Waktu Diam-tunggu Tugas.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	mstask.h
Pustaka	Mstask.lib
DLL	Mstask.dll
Redistribusi	Internet Explorer 4.0 atau yang lebih baru pada Windows NT 4.0 dan Windows 95

Lihat juga

IScheduledWorkItem

IScheduledWorkItem::SetIdleWait