CommentMarkAtProfile

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

• Windows Embedded CE 6.0 R3

8/27/2008

This function inserts a timestamp value, a numeric mark, and a text string into the .icp file:

• The timestamp value can be used to synchronize external events.
• The numeric mark can used to specify the start or end of a range of data to be processed in Remote Call Profiler views.
• The Call Trace and Function Trace Views display the text string.

int MarkProfile(
  _int64 dnTimestamp,
  long lMarkID,
  char* pszText
);

Parameters

• dnTimestamp
  A 64-bit integer representing a timestamp value.

• lMarkID
  A numeric marker.

  The value of the marker must greater than zero.

• pszText
  A pointer to a text string.

  The text string must contain fewer than 256 characters, including the terminating null character.

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.
MARK_TEXTTOOLONG	The pszText parameter exceeds the maximum length of 255 characters. The string was truncated and the mark and comment were recorded.

Remarks

To insert comments into your .icp file, we recommend that you use the CommentMarkProfile function rather than this function to accomplish this task.

Profiling for the thread containing the CommentMarkAtProfile function must be ON in order for Remote Call Profiler to insert the mark and comment.

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

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.

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 Trace and Function Trace Views
CommentMarkProfile