Freigeben über


DataCollection.CommentMarkProfile-Methode

Die CommentMarkProfile-Methode fügt eine numerische Markierung und eine Textzeichenfolge in der VSP-Datei ein. Damit die Markierung und der Kommentar eingefügt werden, muss die Profilerstellung für den Thread, der die CommentMarkProfile-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 CommentMarkProfile ( _
    markId As Integer, _
    markText As String _
) As MarkOperationResult
public static MarkOperationResult CommentMarkProfile(
    int markId,
    string markText
)
public:
static MarkOperationResult CommentMarkProfile(
    int markId, 
    String^ markText
)
static member CommentMarkProfile : 
        markId:int * 
        markText:string -> MarkOperationResult 
public static function CommentMarkProfile(
    markId : int, 
    markText : String
) : MarkOperationResult

Parameter

  • 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 von VSInstr oder mit Microsoft.VisualStudio.Profiler.DataCollection-Memberfunktionen (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

CommentMarkProfile-Methoden sollten nur mit der Instrumentation verwendet werden.

Beispiele

Das folgende Beispiel veranschaulicht die MarkOperationResult-Methode.

        public void ExerciseMarkOperationResult()
        {
            // Declare and initialize variables to pass to
            // MarkProfile.  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.
            int markID = 4;

            // Declare enumeration to hold return value of 
            // call to MarkProfile.
            MarkOperationResult result;

            result = DataCollection.MarkProfile(markID);

            // Compare result to MarkOperationResult value.  
            // In this case, the property value of 
            // MarkOperationResult is "OK".
            if (result == MarkOperationResult.OK)
            {
                Console.WriteLine("PASS -- Test {0}", result);
            }
            else
            {
                Console.WriteLine("FAIL -- MarkProfile Returned code {0} with normal input", result.ToString());
            }
        }

.NET Framework-Sicherheit

Siehe auch

Referenz

DataCollection Klasse

Microsoft.VisualStudio.Profiler-Namespace