...
void OS_TLS_SetValue (OS_TCB *p_tcb,
...
OS_TLS_ID id,
...
OS_TLS value,
...
OS_ERR *p_err);
...
...
File |
...
Called from |
...
Code enabled by |
...
|
...
Task |
...
OS_CFG_TLS_TBL_SIZE |
...
OS_TLS_SetValue()
allows your application to set the value of a TLS (thread-local storage) entry in the specified task’s OS_TCB
. Specifically, this function assigns value to p_tcb->TLS_Tbl[id]
. See Chapter 20Chapter 20, “Thread Safety of the Compiler’s Run-Time Library” on page 419 for details on TLS. 1078040 Anchor
Arguments
Anchor
p_tcb
is a pointer to the OS_TCB
of the task you wish to assign the TLS value to. value
will thus be assigned to p_tcb->TLS_Tbl[id]
.
Anchor
id
is the TLS ID of the entry you are setting.
...
value
Anchor
is the value to store at p_tcb->TLS_Tbl[id]
.
...
p_err
1078048 Anchor
is a pointer to a variable that contains an error code returned by this function. Possible values are:
...
...
OS_ERR_NONE
...
class | WebWorks_Indent_2 |
---|
...
if the call was successful and the caller was returned the value.
...
class | WebWorks_Indent_1 |
---|
...
...
OS_ERR_OS_NOT_RUNNING
...
...
if you called OS_TLS_SetValue()
and the kernel has not started yet. However, it’s acceptable to call this function prior to starting multitasking but in this case, you must specify a non-NULL
pointer for p_tcb
.
...
class | WebWorks_Indent_1 |
---|
...
OS_ERR_TLS_ID_INVALID
...
class | WebWorks_Indent_2 |
---|
...
if you called OS_TLS_GetValue()
and specified a TLS ID that has not been assigned. See OS_TLS_GetID()
about assigning TLS IDs.
...
class | WebWorks_Indent_1 |
---|
...
OS_ERR_TLS_NOT_EN
...
...
if you called OS_TLS_SetValue()
but the task was created with the option OS_OPT_TASK_NO_TLS
indicating that the task does not need TLS support.
...
Returned Value
...
None Anchor
Notes/Warnings
...
You cannot call OS_TLS_SetValue()
for a task until that task gets created. Anchor
Example
...
rowspan | 13 |
---|
...