DataCollection.CommentMarkAtProfile, méthode

Article
08/10/2011

La méthode CommentMarkAtProfile insère une valeur d'horodatage, une marque numérique et une chaîne de commentaire dans le fichier .vsp. La valeur d'horodatage peut être utilisée pour synchroniser les événements externes. Le profilage du thread contenant la fonction CommentMarkAtProfile doit être ON pour que la marque et le commentaire soient insérés.

Espace de noms : Microsoft.VisualStudio.Profiler
Assembly : Microsoft.VisualStudio.Profiler (dans Microsoft.VisualStudio.Profiler.dll)

Syntaxe

'Déclaration
Public Shared Function CommentMarkAtProfile ( _
    timestamp As Long, _
    markId As Integer, _
    markText As String _
) As MarkOperationResult

public static MarkOperationResult CommentMarkAtProfile(
    long timestamp,
    int markId,
    string markText
)

public:
static MarkOperationResult CommentMarkAtProfile(
    long long timestamp, 
    int markId, 
    String^ markText
)

static member CommentMarkAtProfile : 
        timestamp:int64 * 
        markId:int * 
        markText:string -> MarkOperationResult

public static function CommentMarkAtProfile(
    timestamp : long, 
    markId : int, 
    markText : String
) : MarkOperationResult

Paramètres

timestamp
Type : System.Int64
Entier 64 bits représentant une valeur d'horodatage.

markId
Type : System.Int32
Marqueur numérique à insérer.Le marqueur doit être supérieur ou égal à 0 (zéro).

markText
Type : System.String
Pointeur sur la chaîne de texte à insérer.La chaîne doit être inférieure à 256 caractères y compris le terminateur NULL.

Valeur de retour

Type : Microsoft.VisualStudio.Profiler.MarkOperationResult
La valeur de retour, MarkOperationResult, est un enum.

Notes

L'état de profilage du thread qui contient la fonction de profil de la marque doit être activé lorsque les marques et les commentaires sont insérés à l'aide de la commande Mark ou des fonctions API (CommentMarkAtProfile, CommentMarkProfile ou MarkProfile). Les marques de profil sont globales dans la portée. Par exemple, une marque de profil insérée dans un seul thread peut être utilisée pour marquer le début ou la fin d'un segment de données de n'importe quel thread dans le fichier .vsp.

Important

Les méthodes CommentMarkAtProfile doivent être utilisées uniquement avec l'instrumentation.

Exemples

L'exemple suivant illustre un appel à la méthode CommentMarkAtProfile.

        public void ExerciseCommentMarkAtProfile()
        {
            // Declare and initalize variables to pass to 
            // CommentMarkAtProfile.  The values of these 
            // parameters are assigned based on the needs 
            // of the code; and for the sake of simplicity
            // in this example, the variables are assigned
            // arbitrary values.
            long timestamp = 0x1111;
            int markId = 01;
            string markText = "Exercising CommentMarkAtProfile...";

            // Declare MarkOperationResult Enumerator.  
            // Holds return value from call to CommentMarkAtProfile.
            MarkOperationResult markResult;

            markResult = DataCollection.CommentMarkAtProfile(
                timestamp,
                markId,
                markText);

            // Check result of CommentMarkAtProfile call.
            Console.WriteLine("CommentMarkAtProfile returned {0}",
                markResult); 
        }

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.

Voir aussi

Référence

DataCollection Classe

Microsoft.VisualStudio.Profiler, espace de noms

Partager via