A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-A171BA6B-4F3C-418C-9508-597F6480EFAC
Visible to Intel only — GUID: GUID-A171BA6B-4F3C-418C-9508-597F6480EFAC
String Handle API
Many API calls require names to identify API objects. String handles are pointers to names. They enable efficient handling of named objects in run time and make collected traces data more compact.
To create and return a handle value that can be associated with a string, use the following primitive:
__itt_string_handle *ITTAPI __itt_string_handle_createA ( const char *name)
__itt_string_handle *ITTAPI __itt_string_handle_createW ( const wchar_t *name)
Or use the macro in the following way:
__itt_string_handle *ITTAPI __itt_string_handle_create (__TEXT("My Task"))
Consecutive calls to __itt_string_handle_create with the same name return the same value. The set of string handles is expected to remain static during the application’s execution time, therefore, there is no mechanism to destroy a string handle. Any string handle can be accessed by any thread in the process, regardless of which thread created the string handle. This call is thread-safe.
Parameters of the primitive:
[in] |
name |
The input string |