DataCollection.CommentMarkAtProfile - метод

Статья
11/01/2012

Метод CommentMarkAtProfile вставляет в VSP-файл значение метки времени, числовую метку и строку комментария.Значение отметки времени можно использовать для синхронизации внешних событий.Чтобы были вставлены метка и комментарий, необходимо, чтобы было включено профилирования для потока, содержащего функцию CommentMarkAtProfile.

Пространство имен: Microsoft.VisualStudio.Profiler
Сборка: Microsoft.VisualStudio.Profiler (в Microsoft.VisualStudio.Profiler.dll)

Синтаксис

'Декларация
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

Параметры

timestamp
Тип: System.Int64
64-разрядное целое число, представляющее значение метки времени.

markId
Тип: System.Int32
Числовая метка для вставки.Метка должна быть больше или равна нулю (0).

markText
Тип: System.String
Указатель на вставляемую текстовую строку.Длина строки не должна превышать 256 знаков, включая токен конца строки NULL.

Возвращаемое значение

Тип: Microsoft.VisualStudio.Profiler.MarkOperationResult
Возвращаемое значение MarkOperationResult является перечислением.

Заметки

Состояние профилирования для потока, который содержит функцию метки профиля, должно быть включено, если метки и комментарии вставлены при помощи команды Mark или функций API (CommentMarkAtProfile, CommentMarkProfile или MarkProfile).Метки профилирования имеют глобальную область видимости.Например, метка профиля, вставленная в поток, может использоваться для отметки начала и конца сегмента данных в любом потоке, определенном в .VSP-файле.

Важно
Метод CommentMarkAtProfile должен использоваться только при профилировании с инструментированием.

Примеры

В следующем примере показан вызов метода 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); 
        }

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

DataCollection Класс

Microsoft.VisualStudio.Profiler - пространство имен

Поделиться через