vTaskSuspend() - syntax, references, call tree, description

vTaskSuspend() function

INCLUDE_vTaskSuspend must be defined as 1 for this function to be available. See the configuration section for more information. Suspend any task. When suspended a task will never get any microcontroller processing time, no matter what its priority. Calls to vTaskSuspend are not accumulative - i.e. calling vTaskSuspend () twice on the same task still only requires one call to vTaskResume () to ready the suspended task. Example usage:

 void vAFunction( void )
 {
 TaskHandle_t xHandle;
	 // Create a task, storing the handle.
	 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
	 // ...
	 // Use the handle to suspend the created task.
	 vTaskSuspend( xHandle );
	 // ...
	 // The created task will not run during this period, unless
	 // another task calls vTaskResume( xHandle ).
	 //...
	 // Suspend ourselves.
	 vTaskSuspend( NULL );
	 // We cannot get here unless another task calls vTaskResume
	 // with our handle as the parameter.
 }
   

Location	Referrer	Text
tasks.c:1704		void vTaskSuspend( TaskHandle_t xTaskToSuspend )
task.h:1069		void vTaskSuspend( TaskHandle_t xTaskToSuspend ) PRIVILEGED_FUNCTION;
cmsis_os.c:1435	osThreadSuspend()	vTaskSuspend(thread_id);
mpu_wrappers.c:262	MPU_vTaskSuspend()	vTaskSuspend( pxTaskToSuspend );

Location

Referrer

Text

tasks.c:1704