DataCollection.CommentMarkProfile 方法

CommentMarkProfile 方法在 .vsp 文件中插入数值标记和文本字符串。 对包含 CommentMarkProfile 函数的线程进行的分析必须为 ON,才能插入标记和注释。

命名空间:  Microsoft.VisualStudio.Profiler
程序集:  Microsoft.VisualStudio.Profiler(在 Microsoft.VisualStudio.Profiler.dll 中)

语法

声明
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

参数

  • markId
    类型:System.Int32
    要插入的数值标记。该标记必须大于或等于 0(零)。
  • markText
    类型:System.String
    指向要插入的文本字符串的指针。该字符串的长度必须小于 256 个字符(包括 NULL 结束符)。

返回值

类型:Microsoft.VisualStudio.Profiler.MarkOperationResult
返回值 MarkOperationResult 是一个枚举。

备注

当通过 VSInstr Mark 命令或 Microsoft.VisualStudio.Profiler.DataCollection 成员函数(CommentMarkAtProfile、CommentMarkProfile 或 MarkProfile)插入标记和注释时,包含标记分析函数的线程的分析状态必须为开启。

分析标记具有全局范围。 例如,插入到一个线程中的分析标记可用于标记 .vsp 文件中任何线程的数据段的开始或结束。

重要

CommentMarkProfile 方法应仅用于检测。

示例

下面的示例演示 MarkOperationResult 方法。

        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 安全性

请参见

参考

DataCollection 类

Microsoft.VisualStudio.Profiler 命名空间