Interface IDataCollector (pla.h)

Article
03/01/2024

Définit et récupère les propriétés du collecteur à l’aide de XML, spécifie le nom du fichier journal et récupère l’emplacement du fichier journal.

Cette interface est une classe abstraite dont dérivent les collecteurs de données suivants :

Héritage

L’interface IDataCollector hérite de l’interface IDispatch . IDataCollector possède également les types de membres suivants :

Méthodes

L’interface IDataCollector a ces méthodes.


IDataCollector ::get_DataCollectorSet Récupère le jeu de collecteurs de données auquel appartient ce collecteur de données.
IDataCollector ::get_DataCollectorType Récupère le type de ce collecteur de données, par exemple, un collecteur de données de performances.
IDataCollector ::get_FileName Récupère ou définit le nom de base du fichier qui contiendra les données du collecteur de données. (Obtenir)
IDataCollector ::get_FileNameFormat Récupère ou définit des indicateurs qui décrivent comment décorer le nom de fichier. (Obtenir)
IDataCollector ::get_FileNameFormatPattern Récupère ou définit le modèle de format à utiliser lors de la décoration du nom de fichier. (Obtenir)
IDataCollector ::get_Index Récupère la valeur d’index du collecteur de données. La valeur d’index identifie le collecteur de données dans le jeu de collecteurs de données.
IDataCollector ::get_LatestOutputLocation Récupère ou définit le nom de fichier entièrement décoré utilisé par PLA lors de la dernière création du fichier. (IDataCollector.get_LatestOutputLocation)
IDataCollector ::get_LogAppend Récupère ou définit une valeur qui indique si PLA doit ajouter les données collectées au fichier actif. (Obtenir)
IDataCollector ::get_LogCircular Récupère ou définit une valeur qui indique si PLA doit créer un fichier circulaire. (Obtenir)
IDataCollector ::get_LogOverwrite Récupère ou définit une valeur qui indique si PLA doit remplacer le fichier actif. (Obtenir)
IDataCollector ::get_Name Récupère ou définit le nom du collecteur de données. (Obtenir)
IDataCollector ::get_OutputLocation Récupère le nom de fichier décoré si PLA devait le créer maintenant.
IDataCollector ::get_Xml Récupère une chaîne XML qui décrit les valeurs des propriétés du collecteur de données.
IDataCollector ::p ut_FileName Récupère ou définit le nom de base du fichier qui contiendra les données du collecteur de données. (Put)
IDataCollector ::p ut_FileNameFormat Récupère ou définit des indicateurs qui décrivent comment décorer le nom de fichier. (Put)
IDataCollector ::p ut_FileNameFormatPattern Récupère ou définit le modèle de format à utiliser lors de la décoration du nom de fichier. (Put)
IDataCollector ::p ut_LatestOutputLocation Récupère ou définit le nom de fichier entièrement décoré utilisé par PLA lors de la dernière création du fichier. (IDataCollector.put_LatestOutputLocation)
IDataCollector ::p ut_LogAppend Récupère ou définit une valeur qui indique si PLA doit ajouter les données collectées au fichier actif. (Put)
IDataCollector ::p ut_LogCircular Récupère ou définit une valeur qui indique si PLA doit créer un fichier circulaire. (Put)
IDataCollector ::p ut_LogOverwrite Récupère ou définit une valeur qui indique si PLA doit remplacer le fichier actif. (Put)
IDataCollector ::p ut_Name Récupère ou définit le nom du collecteur de données. (Put)
IDataCollector ::SetXml Définit les valeurs de propriété de ces propriétés incluses dans le code XML. (IDataCollector.SetXml)

Remarques

L’exemple suivant montre le code XML que vous pouvez utiliser pour initialiser cet objet si vous appelez la propriété IDataCollectorCollection ::CreateDataCollectorFromXml pour créer l’un des collecteurs de données dérivés. La propriété IDataCollector ::Xml retourne également ce code XML.


    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>

Notez que l’exemple n’affiche pas les éléments de propriété du collecteur de données dérivé (consultez chaque collecteur de données pour ses éléments XML). Incluez ces éléments dans le code XML des collecteurs de données le cas échéant. L’exemple suivant montre le code XML du collecteur de données d’alerte. Vous pouvez spécifier les éléments dans n’importe quel ordre.

<AlertDataCollector>
    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>
    <Alert/>  <!-- Specify an <Alert> element for each alert -->
    <EventLog/>
    <SampleInterval/>
    <Task/>
    <TaskArguments/>
    <TaskUserTextArguments/>
    <TaskSetWorkingDirectory/>
    <TriggerDataCollectorSet/>
</AlertDataCollector>

Lorsque vous spécifiez le code XML pour créer le collecteur, vous pouvez spécifier uniquement les éléments pour les propriétés que vous souhaitez définir. Si vous ne spécifiez pas de propriété, PLA fournit une valeur par défaut. Lorsque vous récupérez le code XML du collecteur, le code XML fournit tous les éléments, y compris ceux d’IDataCollector.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	pla.h