Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.


The MarkProfile method inserts a profile mark in the .vsp file. Profiling for the thread containing the MarkProfile function must be ON for the mark to be inserted.




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

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

Enumerator Description


The parameter is less than or equal to 0. These values are reserved. The mark and comment are not recorded.


The profiling mode was set to NEVER when the function was called. The mark and comment are not recorded.


The profiling mode was set to OFF when the function was called. The mark and comment are not recorded.


No mark support in this context. The mark and comment are not recorded.


Memory was not available to record the event. The mark and comment are not recorded.


The string exceeds the maximum of 256 characters. The comment string is truncated and the mark and comment are recorded.


MARK_OK is returned to indicate success.

The mark value is inserted into the .vsp file each time the code runs if the thread containing the MarkProfile function is being profiled. You can call MarkProfile multiple times.

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.

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).


MarkProfile method should be used with instrumentation only.


Header: Declared in VSPerf.h

Import library: VSPerf.lib

The following code illustrates the MarkProfile function.

void ExerciseMarkProfile()
    // 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 = 03;

    // Declare enumeration to hold return value of 
    // call to MarkProfile.

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

    markResult = MarkProfile(markId);

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

#ifdef DEBUG

Community Additions

© 2015 Microsoft