Interface IDataCollectorSet (pla.h)
Gère les informations de configuration communes à tous les objets collecteurs de données dans l’ensemble ; ajoute et supprime des collecteurs de données de l’ensemble ; et démarre la collecte de données. Il s’agit de l’interface PLA principale que vous utilisez.
Pour obtenir cette interface, appelez la fonction CoCreateInstance , en passant __uuidof(DataCollectorSet) comme identificateur de classe et __uuidof(IDataCollectorSet) comme identificateur d’interface.
Héritage
L’interface IDataCollectorSet hérite de l’interface IDispatch. IDataCollectorSet possède également les types de membres suivants :
Méthodes
L’interface IDataCollectorSet possède ces méthodes.
| IDataCollectorSet ::Commit Enregistre, met à jour ou valide le jeu de collecteurs de données. Vous pouvez également utiliser cette méthode pour vider une session de trace. |
| IDataCollectorSet ::D elete Supprime la copie persistante du jeu de collecteurs de données si le jeu n’est pas en cours d’exécution. |
| IDataCollectorSet ::get_DataCollectors Récupère la liste des collecteurs de données dans cet ensemble. |
| IDataCollectorSet ::get_DataManager Récupère le gestionnaire de données associé à ce jeu de collecteurs de données. |
| IDataCollectorSet ::get_Description Récupère ou définit la description du jeu de collecteurs de données. La description sera ajoutée à tous les fichiers de sortie en tant que métadonnées et insérée dans les journaux d’aide des données de performance en tant que commentaire. (Obtenir) |
| IDataCollectorSet ::get_DescriptionUnresolved Récupère la description du jeu de collecteurs de données dans sa forme d’origine. |
| IDataCollectorSet ::get_DisplayName Récupère ou définit le nom d’affichage du jeu de collecteurs de données. (Obtenir) |
| IDataCollectorSet ::get_DisplayNameUnresolved Récupère le nom d’affichage du jeu de collecteurs de données dans sa forme d’origine. |
| IDataCollectorSet ::get_Duration Récupère et définit la durée d’exécution du jeu de collecteurs de données. (Obtenir) |
| IDataCollectorSet ::get_Keywords Récupère ou définit des mots clés qui décrivent le jeu de collecteurs de données. La liste des mots clés est ajoutée aux fichiers de sortie en tant que métadonnées. (Obtenir) |
| IDataCollectorSet ::get_LatestOutputLocation Récupère ou définit le nom de dossier entièrement décoré utilisé par PLA lors de la dernière écriture des journaux. (IDataCollectorSet.get_LatestOutputLocation) |
| IDataCollectorSet ::get_Name Récupère le nom unique utilisé pour identifier le jeu de collecteurs de données. |
| IDataCollectorSet ::get_OutputLocation Récupère le nom du dossier décoré si PLA devait le créer maintenant. |
| IDataCollectorSet ::get_RootPath Récupère ou définit le chemin d’accès de base dans lequel les sous-répertoires sont créés. (Obtenir) |
| IDataCollectorSet ::get_Schedules Récupère la liste des planifications qui déterminent quand le jeu de collecteurs de données s’exécute. |
| IDataCollectorSet ::get_SchedulesEnabled Récupère ou définit une valeur qui indique si les planifications sont activées. (Obtenir) |
| IDataCollectorSet ::get_Security Récupère ou définit les informations de contrôle d’accès qui déterminent qui peut accéder à ce jeu de collecteurs de données. (Obtenir) |
| IDataCollectorSet ::get_Segment Récupère ou définit une valeur qui indique si PLA crée de nouveaux journaux si la taille maximale ou la durée du segment est atteinte avant l’arrêt du jeu de collecteurs de données. (Obtenir) |
| IDataCollectorSet ::get_SegmentMaxDuration Récupère ou définit la durée d’exécution du jeu de collecteurs de données avant de commencer à écrire dans les nouveaux fichiers journaux. (Obtenir) |
| IDataCollectorSet ::get_SegmentMaxSize Récupère ou définit la taille maximale d’un fichier journal dans le jeu de collecteurs de données. (Obtenir) |
| IDataCollectorSet ::get_SerialNumber Récupère ou définit le nombre de fois où ce jeu de collecteurs de données a été démarré, y compris les segments. (Obtenir) |
| IDataCollectorSet ::get_Server Récupère le nom du serveur sur lequel le jeu de collecteurs de données est exécuté. |
| IDataCollectorSet ::get_Status Récupère le status du jeu de collecteurs de données. |
| IDataCollectorSet ::get_StopOnCompletion Récupère ou définit une valeur qui détermine si le jeu de collecteurs de données s’arrête lorsque tous les collecteurs de données du jeu sont à l’état terminé. (Obtenir) |
| IDataCollectorSet ::get_Subdirectory Récupère ou définit un sous-répertoire de base du chemin d’accès racine dans lequel le instance suivant du jeu de collecteurs de données écrira ses journaux. (Obtenir) |
| IDataCollectorSet ::get_SubdirectoryFormat Récupère ou définit des indicateurs qui décrivent comment décorer le nom du sous-répertoire. (Obtenir) |
| IDataCollectorSet ::get_SubdirectoryFormatPattern Récupère ou définit un modèle de format à utiliser lors de la décoration du nom du dossier. (Obtenir) |
| IDataCollectorSet ::get_Task Récupère ou définit le nom d’un travail du planificateur de tâches à démarrer chaque fois que le jeu de collecteurs de données s’arrête, y compris entre les segments. (Obtenir) |
| IDataCollectorSet ::get_TaskArguments Récupère ou définit les arguments de ligne de commande à passer au travail du planificateur de tâches spécifié dans la propriété IDataCollectorSet ::Task. (Obtenir) |
| IDataCollectorSet ::get_TaskRunAsSelf Récupère ou définit une valeur qui détermine si la tâche s’exécute en tant qu’utilisateur du jeu de collecteurs de données ou en tant qu’utilisateur spécifié dans la tâche. (IDataCollectorSet.get_TaskRunAsSelf) |
| IDataCollectorSet ::get_TaskUserTextArguments Récupère ou définit les arguments de ligne de commande qui sont substitués à la variable de substitution {usertext} dans la propriété IDataCollectorSet ::TaskArguments. (Obtenir) |
| IDataCollectorSet ::get_UserAccount Récupère le compte d’utilisateur sous lequel le jeu de collecteurs de données s’exécutera. |
| IDataCollectorSet ::get_Xml Récupère une chaîne XML qui décrit les valeurs des propriétés du jeu de collecteurs de données, y compris celles des collecteurs de données contenus dans le jeu. |
| IDataCollectorSet ::GetValue Récupère une valeur définie par l’utilisateur. |
| IDataCollectorSet ::p ut_Description Récupère ou définit la description du jeu de collecteurs de données. La description sera ajoutée à tous les fichiers de sortie en tant que métadonnées et insérée dans les journaux d’assistance des données de performance en tant que commentaire. (Put) |
| IDataCollectorSet ::p ut_DisplayName Récupère ou définit le nom complet du jeu de collecteurs de données. (Put) |
| IDataCollectorSet ::p ut_Duration Récupère et définit la durée d’exécution du jeu de collecteurs de données. (Put) |
| IDataCollectorSet ::p ut_Keywords Récupère ou définit des mots clés qui décrivent le jeu de collecteurs de données. La liste des mots clés est ajoutée aux fichiers de sortie en tant que métadonnées. (Put) |
| IDataCollectorSet ::p ut_LatestOutputLocation Récupère ou définit le nom de dossier entièrement décoré utilisé par pla lors de la dernière écriture des journaux. (IDataCollectorSet.put_LatestOutputLocation) |
| IDataCollectorSet ::p ut_RootPath Récupère ou définit le chemin de base où les sous-répertoires sont créés. (Put) |
| IDataCollectorSet ::p ut_SchedulesEnabled Récupère ou définit une valeur qui indique si les planifications sont activées. (Put) |
| IDataCollectorSet ::p ut_Security Récupère ou définit des informations de contrôle d’accès qui déterminent qui peut accéder à ce jeu de collecteurs de données. (Put) |
| IDataCollectorSet ::p ut_Segment Récupère ou définit une valeur qui indique si PLA crée de nouveaux journaux si la taille maximale ou la durée du segment est atteinte avant l’arrêt du jeu de collecteurs de données. (Put) |
| IDataCollectorSet ::p ut_SegmentMaxDuration Récupère ou définit la durée pendant laquelle le jeu de collecteurs de données peut s’exécuter avant qu’il commence à écrire dans de nouveaux fichiers journaux. (Put) |
| IDataCollectorSet ::p ut_SegmentMaxSize Récupère ou définit la taille maximale d’un fichier journal dans le jeu de collecteurs de données. (Put) |
| IDataCollectorSet ::p ut_SerialNumber Récupère ou définit le nombre de fois où ce jeu de collecteurs de données a été démarré, y compris les segments. (Put) |
| IDataCollectorSet ::p ut_StopOnCompletion Récupère ou définit une valeur qui détermine si le jeu de collecteurs de données s’arrête lorsque tous les collecteurs de données du jeu sont dans un état terminé. (Put) |
| IDataCollectorSet ::p ut_Subdirectory Récupère ou définit un sous-répertoire de base du chemin d’accès racine où le instance suivant du jeu de collecteurs de données écrit ses journaux. (Put) |
| IDataCollectorSet ::p ut_SubdirectoryFormat Récupère ou définit des indicateurs qui décrivent comment décorer le nom du sous-répertoire. (Put) |
| IDataCollectorSet ::p ut_SubdirectoryFormatPattern Récupère ou définit un modèle de format à utiliser lors de la décoration du nom du dossier. (Put) |
| IDataCollectorSet ::p ut_Task Récupère ou définit le nom d’un travail du planificateur de tâches à démarrer chaque fois que le jeu de collecteurs de données s’arrête, y compris entre les segments. (Put) |
| IDataCollectorSet ::p ut_TaskArguments Récupère ou définit les arguments de ligne de commande à passer au travail du planificateur de tâches spécifié dans la propriété IDataCollectorSet ::Task. (Put) |
| IDataCollectorSet ::p ut_TaskRunAsSelf Récupère ou définit une valeur qui détermine si la tâche s’exécute en tant qu’utilisateur du jeu de collecteurs de données ou en tant qu’utilisateur spécifié dans la tâche. (IDataCollectorSet.put_TaskRunAsSelf) |
| IDataCollectorSet ::p ut_TaskUserTextArguments Récupère ou définit les arguments de ligne de commande qui sont remplacés par la variable de substitution {usertext} dans la propriété IDataCollectorSet ::TaskArguments. (Put) |
| IDataCollectorSet ::Query Récupère le jeu de collecteurs de données spécifié. |
| IDataCollectorSet ::SetCredentials Spécifie le compte d’utilisateur sous lequel le jeu de collecteurs de données s’exécute. |
| IDataCollectorSet ::SetValue Définit une valeur définie par l’utilisateur. |
| IDataCollectorSet ::SetXml Définit les valeurs de propriété de ces propriétés incluses dans le code XML. (IDataCollectorSet.SetXml) |
| IDataCollectorSet ::Start Démarre manuellement le jeu de collecteurs de données. |
| IDataCollectorSet ::Stop Arrête manuellement le jeu de collecteurs de données. |
Remarques
Pour créer l’objet à partir d’un script, utilisez l’identificateur de programme « Pla.DataCollectorSet ».
Pour récupérer un jeu de collecteurs de données existant, créez un instance de l’objet du jeu de collecteurs de données, puis appelez la méthode IDataCollectorSet ::Query pour interroger les propriétés d’un jeu de collecteurs de données précédemment persistant.
Pour créer un jeu, créez une instance de l’objet de jeu de collecteurs de données et définissez les propriétés comme il convient. Vous pouvez définir les propriétés individuellement ou passer le code XML qui contient les valeurs de propriété à la méthode IDataCollectorSet ::SetXml .
Pour ajouter de nouveaux objets collecteurs de données au jeu, récupérez la collection à partir de la propriété IDataCollectorSet ::D ataCollectors . Pour conserver le jeu de collecteurs de données, appelez la méthode IDataCollectorSet ::Commit .
Vous pouvez démarrer les collecteurs de données manuellement à l’aide de la méthode IDataCollectorSet ::Start ou automatiquement à l’aide de la propriété IDataCollectorSet ::Schedules . Une alerte peut également déclencher l’exécution d’une collection si la propriété IAlertDataCollector ::TriggerDataCollectorSet est définie.
Si vous souhaitez gérer les données collectées, récupérez une interface IDataManager à partir de la propriété IDataCollectorSet ::D ataManager .
L’exemple suivant montre les éléments XML d’un ensemble de collecteurs de données. Pour plus d’informations, consultez la propriété correspondante.
<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>
Si vous appelez IDataCollectorSet ::Xml pour récupérer le code XML d’un jeu et que le jeu inclut des collecteurs de données, le code XML contient également les éléments XML de chaque collecteur de données dans le jeu.
Pour utiliser les éléments du jeu de collecteurs de données afin d’initialiser les valeurs de propriété d’un ensemble de collecteurs de données, appelez la méthode SetXml . Le contenu du code XML remplacera le contenu existant de l’ensemble. L’exemple suivant montre comment inclure les éléments du collecteur de données d’alerte.
<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>
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 pour l’ensemble, le code XML inclut tous les éléments, y compris ceux des collecteurs de données contenus dans le jeu (pour plus d’informations sur les propriétés du collecteur de données, consultez chaque interface du collecteur de données). Toutefois, les éléments d’action schedule et folder ne sont pas inclus s’ils ne sont pas définis pour l’ensemble.
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 |