MarkProfile

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/27/2008

This function inserts a profile mark into the Remote Call Profiler .icp file.

The profile mark can used to specify the start or end of data returned in Remote Call Profiler views.

Profiling for the thread containing the MarkProfile function must be ON for the mark to be inserted.

        
        
        lMarkID
        
      

Parameters

• lMarkID
  A numeric marker.

  The value of the marker must greater than zero.

Return Values

The following table shows the values that this function returns.

Return value	Description
MARK_OK	The call was successful.
MARK_ERROR_MODE_OFF	The global profiling level was set to OFF when the function was called. The mark and comment were not recorded.
MARK_ERROR_MODE_NEVER	The profiling mode was set to NEVER when the function was called. The mark and comment were not recorded.
MARK_ERROR_MARKER_RESERVED	The lMarkId parameter is less than or equal to zero. The mark and comment were not recorded.

Remarks

Remote Call Profiler inserts the mark value into the .icp file each time the code executes if the thread containing the MarkProfile function is being profiled.

You can call the MarkProfile function multiple times, and you can use the same lMarker value in different calls to the MarkProfile function.

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 .icp file.

The Remote Call Profiler Collection Control window inserts marks regardless of the profiling state.

Requirements

Header	cecap.h
Library	cecap.lib
Windows Embedded CE	Windows CE .NET 4.0 and later

See Also

Concepts

Call Profiler Data Collection Functions
Call Profiler Data Collection API Reference