Antarmuka IDataCollectorSet (pla.h)
Mengelola informasi konfigurasi yang umum untuk semua objek pengumpul data dalam set; menambahkan dan menghapus pengumpul data dari set; dan memulai pengumpulan data. Ini adalah antarmuka PLA utama yang Anda gunakan.
Untuk mendapatkan antarmuka ini, panggil fungsi CoCreateInstance , meneruskan __uuidof(DataCollectorSet) sebagai pengidentifikasi kelas dan __uuidof(IDataCollectorSet) sebagai pengidentifikasi antarmuka.
Warisan
Antarmuka IDataCollectorSet mewarisi dari antarmuka IDispatch . IDataCollectorSet juga memiliki jenis anggota ini:
Metode
Antarmuka IDataCollectorSet memiliki metode ini.
| IDataCollectorSet::Commit Menyimpan, memperbarui, atau memvalidasi kumpulan pengumpul data. Anda juga dapat menggunakan metode ini untuk membersihkan sesi pelacakan. |
| IDataCollectorSet::D elete Menghapus salinan kumpulan pengumpul data yang dipertahankan jika set tidak berjalan. |
| IDataCollectorSet::get_DataCollectors Mengambil daftar pengumpul data dalam set ini. |
| IDataCollectorSet::get_DataManager Mengambil manajer data yang terkait dengan kumpulan pengumpul data ini. |
| IDataCollectorSet::get_Description Mengambil atau mengatur deskripsi kumpulan pengumpul data. Deskripsi akan ditambahkan ke semua file output sebagai metadata dan dimasukkan ke dalam log Pembantu Data Performa sebagai komentar. (Dapatkan) |
| IDataCollectorSet::get_DescriptionUnresolved Mengambil deskripsi kumpulan pengumpul data dalam bentuk aslinya. |
| IDataCollectorSet::get_DisplayName Mengambil atau mengatur nama tampilan kumpulan pengumpul data. (Dapatkan) |
| IDataCollectorSet::get_DisplayNameUnresolved Mengambil nama tampilan kumpulan pengumpul data dalam bentuk aslinya. |
| IDataCollectorSet::get_Duration Mengambil dan mengatur durasi yang dijalankan kumpulan pengumpul data. (Dapatkan) |
| IDataCollectorSet::get_Keywords Mengambil atau mengatur kata kunci yang menjelaskan kumpulan pengumpul data. Daftar kata kunci ditambahkan ke file output sebagai metadata. (Dapatkan) |
| IDataCollectorSet::get_LatestOutputLocation Mengambil atau mengatur nama folder yang sepenuhnya dihiasi bahwa PLA menggunakan log terakhir kali ditulis. (IDataCollectorSet.get_LatestOutputLocation) |
| IDataCollectorSet::get_Name Mengambil nama unik yang digunakan untuk mengidentifikasi kumpulan pengumpul data. |
| IDataCollectorSet::get_OutputLocation Mengambil nama folder yang dihiasi jika PLA akan membuatnya sekarang. |
| IDataCollectorSet::get_RootPath Mengambil atau mengatur jalur dasar tempat subdirektori dibuat. (Dapatkan) |
| IDataCollectorSet::get_Schedules Mengambil daftar jadwal yang menentukan kapan kumpulan pengumpul data berjalan. |
| IDataCollectorSet::get_SchedulesEnabled Mengambil atau menetapkan nilai yang menunjukkan apakah jadwal diaktifkan. (Dapatkan) |
| IDataCollectorSet::get_Security Mengambil atau mengatur informasi kontrol akses yang menentukan siapa yang dapat mengakses kumpulan pengumpul data ini. (Dapatkan) |
| IDataCollectorSet::get_Segment Mengambil atau menetapkan nilai yang menunjukkan apakah PLA membuat log baru jika ukuran maksimum atau durasi segmen tercapai sebelum kumpulan pengumpul data dihentikan. (Dapatkan) |
| IDataCollectorSet::get_SegmentMaxDuration Mengambil atau mengatur durasi yang dapat dijalankan kumpulan pengumpul data sebelum mulai menulis ke file log baru. (Dapatkan) |
| IDataCollectorSet::get_SegmentMaxSize Mengambil atau mengatur ukuran maksimum file log apa pun di kumpulan pengumpul data. (Dapatkan) |
| IDataCollectorSet::get_SerialNumber Mengambil atau mengatur berapa kali kumpulan pengumpul data ini telah dimulai, termasuk segmen. (Dapatkan) |
| IDataCollectorSet::get_Server Mengambil nama server tempat kumpulan pengumpul data dijalankan. |
| IDataCollectorSet::get_Status Mengambil status kumpulan pengumpul data. |
| IDataCollectorSet::get_StopOnCompletion Mengambil atau menetapkan nilai yang menentukan apakah kumpulan pengumpul data berhenti ketika semua pengumpul data dalam set berada dalam status selesai. (Dapatkan) |
| IDataCollectorSet::get_Subdirectory Mengambil atau mengatur subdirektori dasar jalur akar tempat instans kumpulan pengumpul data berikutnya akan menulis log-nya. (Dapatkan) |
| IDataCollectorSet::get_SubdirectoryFormat Mengambil atau mengatur bendera yang menjelaskan cara menghias nama subdirektori. (Dapatkan) |
| IDataCollectorSet::get_SubdirectoryFormatPattern Mengambil atau mengatur pola format yang akan digunakan saat mendekorasi nama folder. (Dapatkan) |
| IDataCollectorSet::get_Task Mengambil atau mengatur nama pekerjaan Penjadwal Tugas untuk memulai setiap kali kumpulan pengumpul data berhenti, termasuk antar segmen. (Dapatkan) |
| IDataCollectorSet::get_TaskArguments Mengambil atau mengatur argumen baris perintah untuk diteruskan ke pekerjaan Penjadwal Tugas yang ditentukan dalam properti IDataCollectorSet::Task. (Dapatkan) |
| IDataCollectorSet::get_TaskRunAsSelf Mengambil atau menetapkan nilai yang menentukan apakah tugas berjalan sebagai pengguna kumpulan pengumpul data atau sebagai pengguna yang ditentukan dalam tugas. (IDataCollectorSet.get_TaskRunAsSelf) |
| IDataCollectorSet::get_TaskUserTextArguments Mengambil atau mengatur argumen baris perintah yang digantikan untuk variabel substitusi {usertext} di properti IDataCollectorSet::TaskArguments. (Dapatkan) |
| IDataCollectorSet::get_UserAccount Mengambil akun pengguna tempat kumpulan pengumpul data akan berjalan. |
| IDataCollectorSet::get_Xml Mengambil string XML yang menjelaskan nilai properti kumpulan pengumpul data, termasuk yang terkandung dalam kumpulan pengumpul data. |
| IDataCollectorSet::GetValue Mengambil nilai yang ditentukan pengguna. |
| IDataCollectorSet::p ut_Description Mengambil atau mengatur deskripsi kumpulan pengumpul data. Deskripsi akan ditambahkan ke semua file output sebagai metadata dan dimasukkan ke dalam log Pembantu Data Performa sebagai komentar. (Put) |
| IDataCollectorSet::p ut_DisplayName Mengambil atau mengatur nama tampilan kumpulan pengumpul data. (Put) |
| IDataCollectorSet::p ut_Duration Mengambil dan mengatur durasi yang dijalankan kumpulan pengumpul data. (Put) |
| IDataCollectorSet::p ut_Keywords Mengambil atau mengatur kata kunci yang menjelaskan kumpulan pengumpul data. Daftar kata kunci ditambahkan ke file output sebagai metadata. (Put) |
| IDataCollectorSet::p ut_LatestOutputLocation Mengambil atau mengatur nama folder yang sepenuhnya didekorasi bahwa PLA menggunakan log terakhir kali ditulis. (IDataCollectorSet.put_LatestOutputLocation) |
| IDataCollectorSet::p ut_RootPath Mengambil atau mengatur jalur dasar tempat subdirektori dibuat. (Put) |
| IDataCollectorSet::p ut_SchedulesEnabled Mengambil atau menetapkan nilai yang menunjukkan apakah jadwal diaktifkan. (Put) |
| IDataCollectorSet::p ut_Security Mengambil atau mengatur informasi kontrol akses yang menentukan siapa yang dapat mengakses kumpulan pengumpul data ini. (Put) |
| IDataCollectorSet::p ut_Segment Mengambil atau menetapkan nilai yang menunjukkan apakah PLA membuat log baru jika ukuran maksimum atau durasi segmen tercapai sebelum kumpulan pengumpul data dihentikan. (Put) |
| IDataCollectorSet::p ut_SegmentMaxDuration Mengambil atau mengatur durasi yang dapat dijalankan pengumpul data sebelum mulai menulis ke file log baru. (Put) |
| IDataCollectorSet::p ut_SegmentMaxSize Mengambil atau mengatur ukuran maksimum file log apa pun di kumpulan pengumpul data. (Put) |
| IDataCollectorSet::p ut_SerialNumber Mengambil atau mengatur berapa kali kumpulan pengumpul data ini telah dimulai, termasuk segmen. (Put) |
| IDataCollectorSet::p ut_StopOnCompletion Mengambil atau menetapkan nilai yang menentukan apakah kumpulan pengumpul data berhenti ketika semua pengumpul data dalam set berada dalam status selesai. (Put) |
| IDataCollectorSet::p ut_Subdirectory Mengambil atau mengatur subdirektori dasar dari jalur akar tempat instans kumpulan pengumpul data berikutnya akan menulis lognya. (Put) |
| IDataCollectorSet::p ut_SubdirectoryFormat Mengambil atau mengatur bendera yang menjelaskan cara menghias nama subdirektori. (Put) |
| IDataCollectorSet::p ut_SubdirectoryFormatPattern Mengambil atau mengatur pola format yang akan digunakan saat mendekorasi nama folder. (Put) |
| IDataCollectorSet::p ut_Task Mengambil atau mengatur nama pekerjaan Penjadwal Tugas untuk memulai setiap kali kumpulan pengumpul data berhenti, termasuk di antara segmen. (Put) |
| IDataCollectorSet::p ut_TaskArguments Mengambil atau mengatur argumen baris perintah untuk diteruskan ke pekerjaan Penjadwal Tugas yang ditentukan dalam properti IDataCollectorSet::Task. (Put) |
| IDataCollectorSet::p ut_TaskRunAsSelf Mengambil atau menetapkan nilai yang menentukan apakah tugas berjalan sebagai pengguna kumpulan pengumpul data atau sebagai pengguna yang ditentukan dalam tugas. (IDataCollectorSet.put_TaskRunAsSelf) |
| IDataCollectorSet::p ut_TaskUserTextArguments Mengambil atau mengatur argumen baris perintah yang diganti untuk variabel substitusi {usertext} di properti IDataCollectorSet::TaskArguments. (Put) |
| IDataCollectorSet::Query Mengambil kumpulan pengumpul data yang ditentukan. |
| IDataCollectorSet::SetCredentials Menentukan akun pengguna tempat kumpulan pengumpul data berjalan. |
| IDataCollectorSet::SetValue Mengatur nilai yang ditentukan pengguna. |
| IDataCollectorSet::SetXml Mengatur nilai properti properti yang disertakan dalam XML. (IDataCollectorSet.SetXml) |
| IDataCollectorSet::Start Memulai kumpulan pengumpul data secara manual. |
| IDataCollectorSet::Stop Menghentikan kumpulan pengumpul data secara manual. |
Keterangan
Untuk membuat objek dari skrip, gunakan pengidentifikasi program "Pla.DataCollectorSet".
Untuk mengambil kumpulan pengumpul data yang ada, buat instans objek kumpulan pengumpul data lalu panggil metode IDataCollectorSet::Query untuk mengkueri properti kumpulan pengumpul data yang sebelumnya bertahan .
Untuk membuat set, buat instans objek kumpulan pengumpul data dan atur properti yang sesuai. Anda dapat mengatur properti satu per satu atau meneruskan XML yang berisi nilai properti ke metode IDataCollectorSet::SetXml .
Untuk menambahkan objek pengumpul data baru ke set, ambil koleksi dari properti IDataCollectorSet::D ataCollectors . Untuk mempertahankan kumpulan pengumpul data, panggil metode IDataCollectorSet::Commit .
Anda dapat memulai pengumpul data secara manual menggunakan metode IDataCollectorSet::Start atau secara otomatis menggunakan properti IDataCollectorSet::Schedules . Atau, pemberitahuan dapat memicu koleksi untuk dijalankan jika properti IAlertDataCollector::TriggerDataCollectorSet diatur.
Jika Anda ingin mengelola data yang dikumpulkan, ambil antarmuka IDataManager dari properti IDataCollectorSet::D ataManager .
Contoh berikut menunjukkan elemen XML untuk kumpulan pengumpul data. Untuk detailnya, lihat properti yang sesuai.
<DataCollectorSet>
<DataManager>
<Enabled/> <!-- 0 (false), nonzero (true) -->
<CheckBeforeRunning/> <!-- 0 (false), nonzero (true) -->
<MinFreeDisk/>
<MaxSize/>
<MaxFolderCount/>
<ResourcePolicy/>
<ReportFileName/>
<RuleTargetFileName/>
<EventsFileName/>
<FolderAction> <!-- Include a <FolderAction> element for -->
<Actions/> <!-- each action to take. -->
<Age/>
<SendCabTo/>
<Size/>
</FolderAction>
</DataManager>
<Description/>
<DescriptionUnresolved/> <!-- Output only -->
<DisplayName/>
<DisplayNameUnresolved/> <!-- Output only -->
<Duration/>
<Keyword/> <!-- Specify for each keyword -->
<LatestOutputLocation/>
<Name/> <!-- Output only -->
<OutputLocation/> <!-- Output only -->
<RootPath/>
<Segment/>
<SegmentMaxDuration/>
<SegmentMaxSize/>
<SerialNumber/>
<Server/> <!-- Output only -->
<Status/> <!-- Output only -->
<Subdirectory/>
<SubdirectoryFormat/>
<SubdirectoryFormatPattern/>
<Task/>
<TaskArguments/>
<TaskRunAsSelf/> <!-- 0 (false), -1 (true) -->
<TaskUserTextArguments/>
<Schedule>
<Days/>
<EndDate/> <!-- mm/dd/yyyy -->
<StartDate/> <!-- mm/dd/yyyy -->
<StartTime/> <!-- hh:mm:ss (use 24-hour clock) -->
</Schedule>
<SchedulesEnabled/> <!-- 0 (false), nonzero (true) -->
<Security/> <!-- Security Descriptor Definition Language -->
<StopOnCompletion/> <!-- 0 (false), nonzero (true) -->
<UserAccount/> <!-- Output only. Set using SetCredentials --></DataCollectorSet>
Jika Anda memanggil IDataCollectorSet::Xml untuk mengambil XML untuk satu set dan set menyertakan pengumpul data, XML juga akan berisi elemen XML untuk setiap pengumpul data dalam set.
Untuk menggunakan elemen kumpulan pengumpul data untuk menginisialisasi nilai properti kumpulan pengumpul data, panggil metode SetXml . Konten XML akan menimpa konten set yang ada. Berikut ini menunjukkan cara menyertakan elemen untuk pengumpul data pemberitahuan.
<DataCollectorSet>
<!-- Data collector set elements go here. -->
<AlertDataCollector>
<Alert/> <!-- Specify an <Alert> element for each alert -->
<EventLog/>
<SampleInterval/>
<Task/>
<TaskArguments/>
<TaskRunAsSelf/> <!-- 0 (false), nonzero (true) -->
<TaskUserTextArguments/>
<TriggerDataCollectorSet/>
<!-- Data collector elements go here. -->
</AlertDataCollector>
</DataCollectorSet>
Anda hanya dapat menentukan elemen untuk properti yang ingin Anda atur. Jika Anda tidak menentukan properti, PLA menyediakan nilai default. Saat Anda mengambil XML untuk set, XML menyertakan semua elemen, termasuk dari pengumpul data yang terkandung dalam set (untuk detail tentang properti pengumpul data, lihat setiap antarmuka pengumpul data). Namun, elemen tindakan jadwal dan folder tidak disertakan jika tidak ditentukan untuk set.
Persyaratan
| Persyaratan | Nilai |
|---|---|
| Klien minimum yang didukung | Windows Vista [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows Server 2008 [hanya aplikasi desktop] |
| Target Platform | Windows |
| Header | pla.h |