OSSetThreadName

Syntax

#include <cafe/os.h>

void OSSetThreadName (OSThread* thread, const char* name);

Parameters

thread Pointer to the thread structure.
name Pointer to the thread name.

Return Values

None.

Description

Sets the thread name to the specified thread.

The OSSetThreadName function stores the pointer name in the OSThread structure. If the thread name is dynamically generated, the programmer must allocate memory to store the name. That memory belongs to the thread until the thread goes away or a new thread name is set with OSSetThreadName.

Do Not Call From

None.

See Also

OSGetThreadName

Revision History

2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup pass.
2011-05-11 Initial version.


CONFIDENTIAL