OSSetThreadDeallocator

Syntax

#include <cafe/os.h>

typedef void (*OSThreadDeallocator)(void* thread, void* stackEnd);

OSThreadDeallocator OSSetThreadDeallocator (OSThread* thread,
                                            OSThreadDeallocator deallocator);

Parameters

thread Pointer to thread.
deallocator Pointer to deallocator.

Return Values

The function pointer to the previously set deallocator.

Description

Registers a deallocator that runs after the thread terminates. When the thread structure and stack are being allocated dynamically, the deallocator can be used to release the memory. The thread stack is not used to run the deallocator. The thread structure and thread stack end (stack base - stack size) pointer are provided as deallocator arguments.

Do Not Call From

None.

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2012/05/25 Matched the actual header.
2011/11/28 Initial version.


CONFIDENTIAL