Metodo DataCollection.CommentMarkAtProfile

Il metodo CommentMarkAtProfile inserisce un valore di timestamp, un indicatore numerico e una stringa di commento nel file vsp. Il valore di timestamp può essere utilizzato per sincronizzare gli eventi esterni. Il profilo del thread contenente la funzione CommentMarkAtProfile deve essere impostato su ON per consentire l'inserimento dell'indicatore e del commento.

Spazio dei nomi:  Microsoft.VisualStudio.Profiler
Assembly:  Microsoft.VisualStudio.Profiler (in Microsoft.VisualStudio.Profiler.dll)

Sintassi

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

Parametri

  • timestamp
    Tipo: System.Int64
    Integer a 64 bit che rappresenta un valore di timestamp.
  • markId
    Tipo: System.Int32
    Indicatore numerico da inserireche deve essere maggiore o uguale a 0 (zero).
  • markText
    Tipo: System.String
    Puntatore alla stringa di testo da inserire.La stringa deve contenere meno di 256 caratteri, incluso il carattere di terminazione NULL.

Valore restituito

Tipo: Microsoft.VisualStudio.Profiler.MarkOperationResult
Il valore restituito, MarkOperationResult, è un'enumerazione.

Note

La stato di profilatura per il thread contenente la funzione relativa al contrassegno di profilo deve essere impostato su ON quando vengono inseriti indicatori e commenti con il comando Mark o con le funzioni API (CommentMarkAtProfile, CommentMarkProfile o MarkProfile). Gli indicatori di profilo hanno un ambito globale. Un indicatore di profilo inserito in un thread può, ad esempio, essere utilizzato per contrassegnare l'inizio o la fine di un segmento di dati in qualsiasi thread del file vsp.

Nota importanteImportante

I metodi CommentMarkAtProfile vanno utilizzati esclusivamente con la strumentazione.

Esempi

L'esempio riportato di seguito illustra una chiamata al metodo 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); 
        }

Sicurezza di .NET Framework

Vedere anche

Riferimenti

DataCollection Classe

Spazio dei nomi Microsoft.VisualStudio.Profiler