CommentMarkAtProfile

更新：2007 年 11 月

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

PROFILE_COMMAND_STATUS PROFILERAPI CommentMarkAtProfileA(
                                                                      __int64 dnTimestamp,
                                                                      long lMarker,
                                                                      LPCTSTR szComment);

参数

dnTimestamp

表示时间戳值的 64 位整数。

lMarker

要插入的数值标记。该标记必须大于或等于 0（零）。

szComment

指向要插入的文本字符串的指针。该字符串的长度必须小于 256 个字符（包括 NULL 结束符）。

属性值/返回值

该函数使用 PROFILE_COMMAND_STATUS 枚举指示成功或失败。返回值可以是下列值之一：

枚举数	说明
MARK_ERROR_MARKER_RESERVED	该参数小于或等于 0。这些值被保留。未记录标记和注释。
MARK_ERROR_MODE_NEVER	调用该函数时，分析模式设置为 NEVER。未记录标记和注释。
MARK_ERROR_MODE_OFF	调用该函数时，分析模式设置为 OFF。未记录标记和注释。
MARK_ERROR_NO_SUPPORT	在此上下文中不支持标记。未记录标记和注释。
MARK_ERROR_OUTOFMEMORY	内存不可用于记录事件。未记录标记和注释。
MARK_TEXTTOOLONG	字符串长度超过最大 256 个字符的限制。注释字符串被截断，并记录了标记和注释。
MARK_OK	返回 MARK_OK 指示成功。

备注

当通过 Mark 命令或 API 函数（CommentMarkAtProfile、CommentMarkProfile 或 MarkProfile）插入标记和注释时，包含标记分析函数的线程的分析状态必须为开启。分析标记具有全局范围。例如，插入到一个线程中的分析标记可用于标记 .vsp 文件中任何线程的数据段的开始或结束。

重要说明：
CommentMarkAtProfile 方法应仅用于检测。

.NET Framework 等效项

Microsoft.VisualStudio.Profiler.dll

函数信息

头文件	包含 VSPerf.h
库	使用 VSPerf.lib
Unicode	作为 CommentMarkAtProfileW (Unicode) 和 CommentMarkAtProfileA (ANSI) 实现。

示例

下面的代码演示如何使用 CommentMarkAtProfile 泛型函数调用。该示例使用 Win32 字符串宏和 ANSI 编译器设置，确定代码是否调用启用了 ANSI 的函数。

void ExerciseCommentMarkAtProfile(void)
{
    // 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.
    int64 timeStamp = 0x1111;
    long markId = 01;
    TCHAR * markText = TEXT("Exercising CommentMarkAtProfile...");

    // Variables used to print output.
    HRESULT hResult;
    TCHAR tchBuffer[256];

    // Declare MarkOperationResult Enumerator.  
    // Holds return value from call to CommentMarkAtProfile.
    PROFILE_COMMAND_STATUS markResult;

    markResult = CommentMarkAtProfile(
        timeStamp,
        markId,
        markText);

    // Format and print result.
    LPCTSTR pszFormat = TEXT("%s %d.\0");
    TCHAR* pszTxt = TEXT("CommentMarkAtProfile returned");
    hResult = StringCchPrintf(tchBuffer, 256, pszFormat, 
    pszTxt, markResult);

#ifdef DEBUG
    OutputDebugString(tchBuffer);
#endif
}

请参见

其他资源

Visual Studio 探查器 API 参考（本机）