Metode IScheduledWorkItem::GetTriggerString (mstask.h)

  • Artikel

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

Mengambil string yang menjelaskan pemicu item kerja .

Sintaks

HRESULT GetTriggerString(
  [in]  WORD   iTrigger,
  [out] LPWSTR *ppwszTrigger
);

Parameter

[in] iTrigger

Indeks pemicu yang akan diambil. Pemicu pertama selalu dirujuk oleh 0. Untuk informasi selengkapnya, lihat Keterangan.

[out] ppwszTrigger

Penunjuk ke string yang dihentikan null yang berisi deskripsi pemicu yang diambil. Perhatikan bahwa string ini harus dirilis dengan panggilan ke CoTaskMemFree setelah string tidak lagi diperlukan.

Nilai kembali

Metode GetTriggerString mengembalikan salah satu nilai berikut.

Menampilkan kode Deskripsi
S_OK
 Operasi berhasil.
E_INVALIDARG
 Argumen tidak valid.
E_OUTOFMEMORY
 Tidak tersedia cukup memori.

Keterangan

Indeks pemicu bukanlah pengidentifikasi. Ini hanya menunjukkan posisi pemicu relatif terhadap pemicu saat ini yang terkait dengan item kerja. Misalnya, jika Anda membuat empat pemicu, pemicu akan diberi nomor 0 hingga 3. Tetapi jika pemicu kedua dihapus, pemicu yang tersisa akan diberi nomor 0 hingga 2. Perhatikan bahwa indeks pemicu pertama selalu 0, dan indeks pemicu terakhir kurang dari jumlah total pemicu untuk item kerja (TriggerCount -1).

Anda dapat mengambil jumlah pemicu menggunakan IScheduledWorkItem::GetTriggerCount.

Contoh

Untuk contoh cara mengambil string pemicu dari semua pemicu yang terkait dengan tugas, lihat Mengambil Contoh String Pemicu.

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

ITask