Freigeben über


DataCollection.CommentMarkAtProfile-Methode

Mit der CommentMarkAtProfile-Methode werden ein Timestampwert, eine numerische Markierung und eine Kommentarzeichenfolge in die VSP-Datei eingefügt. Der Timestampwert kann verwendet werden, um externe Ereignisse zu synchronisieren. Damit die Markierung und der Kommentar eingefügt werden, muss die Profilerstellung für den Thread, der die CommentMarkAtProfile-Funktion enthält, auf ON festgelegt sein.

Namespace:  Microsoft.VisualStudio.Profiler
Assembly:  Microsoft.VisualStudio.Profiler (in Microsoft.VisualStudio.Profiler.dll)

Syntax

'Declaration
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

Parameter

  • timestamp
    Typ: System.Int64
    Eine 64-Bit-Ganzzahl, die einen Timestampwert darstellt.
  • markId
    Typ: System.Int32
    Die numerische Markierung, die eingefügt werden soll.Diese muss größer oder gleich 0 (null) sein.
  • markText
    Typ: System.String
    Ein Zeiger auf die Textzeichenfolge, die eingefügt werden soll.Die Zeichenfolge muss einschließlich des NULL-Abschlusszeichens weniger als 256 Zeichen umfassen.

Rückgabewert

Typ: Microsoft.VisualStudio.Profiler.MarkOperationResult
Der Rückgabewert MarkOperationResult ist eine Enumeration.

Hinweise

Der Profilerstellungszustand des Threads, der die Funktion zum Markieren von Profilen enthält, muss ON lauten, wenn Markierungen und Kommentare mit dem Mark-Befehl oder mit API-Funktionen (CommentMarkAtProfile, CommentMarkProfile oder MarkProfile) eingefügt werden. Profilmarkierungen weisen einen globalen Gültigkeitsbereich auf. So kann beispielsweise eine Profilmarkierung, die in einem Thread eingefügt wurde, verwendet werden, um den Anfang oder das Ende eines Datensegments in einem beliebigen Thread in der VSP-Datei zu markieren.

Wichtig

CommentMarkAtProfile-Methoden sollten nur mit der Instrumentation verwendet werden.

Beispiele

Das folgende Beispiel veranschaulicht einen Aufruf der CommentMarkAtProfile-Methode.

        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); 
        }

.NET Framework-Sicherheit

Siehe auch

Referenz

DataCollection Klasse

Microsoft.VisualStudio.Profiler-Namespace