(pla.h) IDataCollectorSet 介面
管理集合中所有數據收集器物件通用的組態資訊;會從集合中新增和移除數據收集器;和會啟動數據收集。 這是您使用的主要 PLA 介面。
若要取得此介面,請呼叫 CoCreateInstance 函式,並傳遞 __uuidof(DataCollectorSet)
作為類別標識碼和 __uuidof(IDataCollectorSet)
介面標識符。
繼承
IDataCollectorSet 介面繼承自 IDispatch 介面。 IDataCollectorSet 也有下列類型的成員:
方法
IDataCollectorSet 介面具有這些方法。
IDataCollectorSet::Commit 儲存、更新或驗證數據收集器集合。 您也可以使用這個方法來排清追蹤會話。 |
IDataCollectorSet::D elete 如果數據集未執行,則會刪除資料收集器集合的保存複本。 |
IDataCollectorSet::get_DataCollectors 擷取此集合中的數據收集器清單。 |
IDataCollectorSet::get_DataManager 擷取與此數據收集器集合相關聯的數據管理員。 |
IDataCollectorSet::get_Description 擷取或設定數據收集器集的描述。 描述會新增至所有輸出檔案做為元數據,並插入效能數據協助程序記錄中做為批注。 (取得) |
IDataCollectorSet::get_DescriptionUnresolved 擷取以原始形式設定之數據收集器的描述。 |
IDataCollectorSet::get_DisplayName 擷取或設定資料收集器集的顯示名稱。 (取得) |
IDataCollectorSet::get_DisplayNameUnresolved 擷取以原始形式設定之數據收集器的顯示名稱。 |
IDataCollectorSet::get_Duration 擷取並設定數據收集器集執行的持續時間。 (取得) |
IDataCollectorSet::get_Keywords 擷取或設定描述數據收集器集的關鍵詞。 關鍵詞清單會新增至輸出檔作為元數據。 (取得) |
IDataCollectorSet::get_LatestOutputLocation 擷取或設定 PLA 上次寫入記錄時所使用的完整裝飾資料夾名稱。 (IDataCollectorSet.get_LatestOutputLocation) |
IDataCollectorSet::get_Name 擷取用來識別數據收集器集合的唯一名稱。 |
IDataCollectorSet::get_OutputLocation 如果 PLA 現在要建立,則擷取裝飾的資料夾名稱。 |
IDataCollectorSet::get_RootPath 擷取或設定建立子目錄的基底路徑。 (取得) |
IDataCollectorSet::get_Schedules 擷取決定數據收集器集執行時間的排程清單。 |
IDataCollectorSet::get_SchedulesEnabled 擷取或設定值,指出是否啟用排程。 (取得) |
IDataCollectorSet::get_Security 擷取或設定訪問控制資訊,決定誰可以存取此數據收集器集合。 (取得) |
IDataCollectorSet::get_Segment 擷取或設定值,指出如果達到數據收集器集停止之前達到大小或區段持續時間上限,PLA 是否會建立新的記錄。 (取得) |
IDataCollectorSet::get_SegmentMaxDuration 擷取或設定資料收集器集合可以在開始寫入新記錄檔之前執行的持續時間。 (取得) |
IDataCollectorSet::get_SegmentMaxSize 擷取或設定數據收集器集合中任何記錄檔的大小上限。 (取得) |
IDataCollectorSet::get_SerialNumber 擷取或設定此數據收集器集合已啟動的次數,包括區段。 (取得) |
IDataCollectorSet::get_Server 擷取執行資料收集器集的伺服器名稱。 |
IDataCollectorSet::get_Status 擷取數據收集器集的狀態。 |
IDataCollectorSet::get_StopOnCompletion 擷取或設定值,判斷當集合中的所有數據收集器都處於已完成狀態時,數據收集器集合是否停止。 (取得) |
IDataCollectorSet::get_Subdirectory 擷取或設定根路徑的基底子目錄,其中下一個數據收集器集的實例會寫入其記錄。 (取得) |
IDataCollectorSet::get_SubdirectoryFormat 擷取或設定描述如何裝飾子目錄名稱的旗標。 (取得) |
IDataCollectorSet::get_SubdirectoryFormatPattern 擷取或設定裝飾資料夾名稱時要使用的格式模式。 (取得) |
IDataCollectorSet::get_Task 擷取或設定每次數據收集器集合停止時,要啟動的工作排程器工作名稱,包括區段之間。 (取得) |
IDataCollectorSet::get_TaskArguments 擷取或設定命令行自變數,以傳遞至 IDataCollectorSet::Task 屬性中指定的工作排程器工作。 (取得) |
IDataCollectorSet::get_TaskRunAsSelf 擷取或設定值,這個值會決定工作是以數據收集器設定使用者或工作中指定的使用者身分執行。 (IDataCollectorSet.get_TaskRunAsSelf) |
IDataCollectorSet::get_TaskUserTextArguments 擷取或設定在 IDataCollectorSet::TaskArguments 屬性中取代 {usertext} 替代變數的命令行自變數。 (取得) |
IDataCollectorSet::get_UserAccount 擷取將執行數據收集器集合的用戶帳戶。 |
IDataCollectorSet::get_Xml 擷取 XML 字串,描述數據收集器集屬性的值,包括集合中包含的數據收集器。 |
IDataCollectorSet::GetValue 擷取使用者定義的值。 |
IDataCollectorSet::p ut_Description 擷取或設定數據收集器集合的描述。 描述會新增至所有輸出檔案作為元數據,並插入效能數據協助程序記錄中作為批注。 (Put) |
IDataCollectorSet::p ut_DisplayName 擷取或設定資料收集器集的顯示名稱。 (Put) |
IDataCollectorSet::p ut_Duration 擷取並設定數據收集器集執行的持續時間。 (Put) |
IDataCollectorSet::p ut_Keywords 擷取或設定描述數據收集器集合的關鍵詞。 關鍵詞清單會新增至輸出檔作為元數據。 (Put) |
IDataCollectorSet::p ut_LatestOutputLocation 擷取或設定 PLA 上次寫入記錄時所使用的完整裝飾資料夾名稱。 (IDataCollectorSet.put_LatestOutputLocation) |
IDataCollectorSet::p ut_RootPath 擷取或設定建立子目錄的基底路徑。 (Put) |
IDataCollectorSet::p ut_SchedulesEnabled 擷取或設定值,指出是否啟用排程。 (Put) |
IDataCollectorSet::p ut_Security 擷取或設定訪問控制資訊,決定誰可以存取此數據收集器集合。 (Put) |
IDataCollectorSet::p ut_Segment 擷取或設定值,指出如果達到數據收集器集之前達到大小上限或區段持續時間,PLA 是否會建立新的記錄。 (Put) |
IDataCollectorSet::p ut_SegmentMaxDuration 擷取或設定資料收集器集合可以在開始寫入新記錄檔之前執行的持續時間。 (Put) |
IDataCollectorSet::p ut_SegmentMaxSize 擷取或設定數據收集器集合中任何記錄檔的大小上限。 (Put) |
IDataCollectorSet::p ut_SerialNumber 擷取或設定此數據收集器集合已啟動的次數,包括區段。 (Put) |
IDataCollectorSet::p ut_StopOnCompletion 擷取或設定值,判斷當集合中的所有數據收集器處於已完成狀態時,數據收集器集是否會停止。 (Put) |
IDataCollectorSet::p ut_Subdirectory 擷取或設定根路徑的基底子目錄,其中下一個數據收集器集合的實例會寫入其記錄檔。 (Put) |
IDataCollectorSet::p ut_SubdirectoryFormat 擷取或設定旗標,描述如何裝飾子目錄名稱。 (Put) |
IDataCollectorSet::p ut_SubdirectoryFormatPattern 擷取或設定裝飾資料夾名稱時要使用的格式模式。 (Put) |
IDataCollectorSet::p ut_Task 擷取或設定工作排程器工作的名稱,以在數據收集器集合停止時啟動,包括區段之間。 (Put) |
IDataCollectorSet::p ut_TaskArguments 擷取或設定命令行自變數,以傳遞至 IDataCollectorSet::Task 屬性中指定的工作排程器工作。 (Put) |
IDataCollectorSet::p ut_TaskRunAsSelf 擷取或設定值,判斷工作是否以數據收集器集使用者或工作中指定的使用者身分執行。 (IDataCollectorSet.put_TaskRunAsSelf) |
IDataCollectorSet::p ut_TaskUserTextArguments 擷取或設定命令行自變數,這些自變數會取代 IDataCollectorSet::TaskArguments 屬性中的 {usertext} 替代變數。 (Put) |
IDataCollectorSet::Query 擷取指定的數據收集器集合。 |
IDataCollectorSet::SetCredentials 指定數據收集器集合執行所在的用戶帳戶。 |
IDataCollectorSet::SetValue 設定使用者定義的值。 |
IDataCollectorSet::SetXml 設定 XML 中包含的這些屬性的屬性值。 (IDataCollectorSet.SetXml) |
IDataCollectorSet::Start 手動啟動數據收集器集合。 |
IDataCollectorSet::Stop 手動停止數據收集器集合。 |
備註
若要從腳本建立物件,請使用 「Pla.DataCollectorSet」 程式識別碼。
若要擷取現有的數據收集器集合,請建立數據收集器集合對象的實例,然後呼叫 IDataCollectorSet::Query 方法來查詢先前 保存 之數據收集器集的屬性。
若要建立集合,請建立數據收集器集合對象的實例,並視需要設定屬性。 您可以個別設定屬性,或將包含屬性值的 XML 傳遞至 IDataCollectorSet::SetXml 方法。
若要將新的數據收集器物件新增至集合,請從 IDataCollectorSet::D ataCollectors 屬性擷取集合。 若要保存數據收集器集合,請呼叫 IDataCollectorSet::Commit 方法。
您可以使用 IDataCollectorSet::Start 方法手動啟動數據收集器,或使用 IDataCollectorSet::Schedules 屬性自動啟動數據收集器。 或者,如果已設定 IAlertDataCollector::TriggerDataCollectorSet 屬性,警示可以觸發集合以執行。
如果您想要管理收集的數據,請從 IDataCollectorSet::D ataManager 屬性擷取 IDataManager 介面。
下列範例顯示數據收集器集合的 XML 元素。 如需詳細資訊,請參閱對應的屬性。
<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>
如果您呼叫 IDataCollectorSet::Xml 來擷取集合的 XML,而且集合包含數據收集器,XML 也會包含集合中每個數據收集器的 XML 元素。
若要使用數據收集器集合元素來初始化數據收集器集合的屬性值,請呼叫 SetXml 方法。 XML 的內容將會覆寫集合的現有內容。 下列示範如何包含警示數據收集器的專案。
<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>
您只能指定您要設定之屬性的專案。 如果您未指定屬性,PLA 會提供預設值。 當您擷取集合的 XML 時,XML 會包含所有元素,包括集合中所包含的數據收集器 (,以取得數據收集器屬性的詳細數據,請參閱每個數據收集器介面) 。 不過,如果未為集合定義排程和資料夾動作專案,則不會包含這些專案。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | pla.h |