For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

For the latest documentation on Visual Studio 2017, see CommentMarkAtProfile on The CommentMarkAtProfile method inserts a timestamp value, a numeric mark, and a comment string in the .vsp file. The timestamp value can be used to synchronize external events. For the mark and comment to be inserted, profiling for the thread that contains the CommentMarkAtProfile function must be ON.

                                   __int64 dnTimestamp,  
                                   long lMarker,  
                                   LPCTSTR szComment);  



A 64-bit integer that represents a timestamp value.


The numeric marker to insert. The marker must greater than or equal to 0 (zero).


A pointer to the text string to insert. The string must be less than 256 characters including the NULL terminator.

The function indicates success or failure by using PROFILE_COMMAND_STATUS enumeration. The return value can be one of the following:

MARK_ERROR_MARKER_RESERVEDThe parameter is less than or equal to 0. These values are reserved. The mark and comment are not recorded.
MARK_ERROR_MODE_NEVERThe profiling mode was set to NEVER when the function was called. The mark and comment are not recorded.
MARK_ERROR_MODE_OFFThe profiling mode was set to OFF when the function was called. The mark and comment are not recorded.
MARK_ERROR_NO_SUPPORTNo mark support in this context. The mark and comment are not recorded.
MARK_ERROR_OUTOFMEMORYMemory was not available to record the event. The mark and comment are not recorded.
MARK_TEXTTOOLONGThe string exceeds the maximum of 256 characters. The comment string is truncated and the mark and comment are recorded.
MARK_OKMARK_OK is returned to indicate success.

The profiling state for the thread that contains the mark profile function must be on when marks and comments inserted with the Mark command or with API functions (CommentMarkAtProfile, CommentMarkProfile, or MarkProfile). Profile marks are global in scope. For example, a profile mark inserted in one thread can be used to mark the start or end of a data segment in any thread in the .vsp file.

System_CAPS_ICON_important.jpg Important

CommentMarkAtProfile methods should be used with instrumentation only.


HeaderInclude VSPerf.h
LibraryUse VSPerf.lib
UnicodeImplemented as CommentMarkAtProfileW (Unicode) and CommentMarkAtProfileA (ANSI).

The following code illustrates the use of the CommentMarkAtProfile generic function call. The example assumes the use of Win32 string macros and the compiler settings for ANSI to determine whether the code calls the ANSI enabled function.

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.  
    markResult = CommentMarkAtProfile(  
    // Format and print result.  
    LPCTSTR pszFormat = TEXT("%s %d.\0");  
    TCHAR* pszTxt = TEXT("CommentMarkAtProfile returned");  
    hResult = StringCchPrintf(tchBuffer, 256, pszFormat,   
    pszTxt, markResult);  
#ifdef DEBUG  

Visual Studio Profiler API Reference (Native)