Documentation

Function: create_stamp

C Prototype

void *aclprofCreateStamp(void)

Python Function

stamp = acl.prof.create_stamp()

Function Usage

Creates a msproftx event flag. When Function: mark, Function: set_stamp_trace_message, Function: push, or Function: range_start is called, the pointer address that describes the event is used as the input to record the time span of the event.

This API must be used in pair with Function: destroy_stamp and after Function: start.

Input Description

None

Return Value

stamp: int, pointer address.

  • If 0 is returned, the operation fails.
  • If a pointer address of the void type is returned, the operation is successful.

Restrictions

None

Reference

For the API call example, see Profile Data Collection.