OS_GetThreadParameter

Syntax

#include <nitro/os.h>

void* OS_GetThreadParameter( const OSThread* thread );

Arguments

thread

Pointer to the thread structure

Return Values

Value of the user parameter of the specified thread.

Description

This function gets the user parameter of a thread.

The user parameter is a region that can be used freely by the user. One void* type region is give to all threads for this purpose, and its value may be used in any way. The system does not modify or reference this value.

The user parameter is set using OS_SetThreadParameter.

Revision History

2005/09/06 Added const to the argument of the OSThread* model.
2005/07/08 Initial version.