add a note for svcExitThread and the thread API

Calling svcExitThread will make it so that threadCreate detached parameter won't work.
This commit is contained in:
Lectem 2016-02-16 10:21:17 -05:00
parent e4e51e758b
commit 6d5a06227b

View File

@ -31,6 +31,9 @@ typedef struct Thread_tag* Thread;
* - Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set. * - Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set.
* - Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core. * - Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core.
* - Processes in the BASE memory region can always create threads on processors #2 and #3. * - Processes in the BASE memory region can always create threads on processors #2 and #3.
*
* @note Default exit code of a thread is 0.
* @warning @ref svcExitThread should never be called from the thread, use @ref threadExit instead.
*/ */
Thread threadCreate(ThreadFunc entrypoint, void* arg, size_t stack_size, int prio, int affinity, bool detached); Thread threadCreate(ThreadFunc entrypoint, void* arg, size_t stack_size, int prio, int affinity, bool detached);