DataCollection.CommentMarkAtProfile 方法

CommentMarkAtProfile 方法在 .vsp 文件中插入时间戳值、数值标记和注释字符串。 时间戳值可用于同步外部事件。 对包含 CommentMarkAtProfile 函数的线程进行的分析必须为 ON,才能插入标记和注释。

命名空间:  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 命名空间