Documentation

Function: set_stamp_trace_message

C Prototype

aclError aclprofSetStampTraceMessage(void *stamp, const char *msg, uint32_t msgLen)

Python Function

ret = acl.prof.set_stamp_trace_message(stamp, msg, msg_len)

Function Usage

Sets string description in a msproftx event stamp, which is parsed and exported in the msprof_tx summary data of the Profiling tool.

For details about how to parse and export profiling results, see "Profile Data File References > msproftx Data Description" in Profiling Instructions.

Input Description

stamp: int, stamp pointer address, indicating the msproftx event stamp. Specifies the pointer address of the Function: create_stamp API.

msg: int, string content address.

msg_len: int, string length.

Return Value

ret: int, error code.

  • 0 indicates success.
  • Other values indicate failure.

Restrictions

This API must be called between Function: create_stamp and Function: destroy_stamp.

Reference

For the API call example, see Profile Data Collection.