[#util-ThreadRename]
= xref:util.adoc[util]::ThreadRename
:relfileprefix: ../
:mrdocs:

Rename a thread both in terms of an internal (in‐memory) name as well as its system thread name.

== Synopsis

Declared in `<util/threadnames.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
void
ThreadRename(std::string const& name);
----

== Description

[NOTE]
====
Do not call this for the main thread, as this will interfere with UNIX utilities such as top and killall. Use ThreadSetInternalName instead.

====

== Parameters

[cols="1,4"]
|===
| Name| Description
| *name*
| New internal and system name for the current thread.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#