EC_API_SLV_cbRegisterStopMbxHandler()

uint32_t EC_API_SLV_cbRegisterStopMbxHandler	(	EC_API_SLV_SHandle_t *	pHandle,
		EC_API_SLV_CBStopMbxHandler_t	cbFunc,
		void *	pContext
	)

This is the function to register a function which stops the mailbox handler.

The function is called in the state transition from PREEOP to INIT to stop the mailbox handler. This functions informs the application about the state transition, the application cannot refuse the state transition

Parameters

[in]	pHandle	The pointer to the EtherCAT API instance.
[in]	cbFunc	Function pointer to the Stop Mailbox Handler
[in]	pContext	stopMbxHandler call context

Returns

uint32_t Returns the API error code.

Example

#include <ecSlvApi.h>
 
 // the Call
EC_API_SLV_cbRegisterStopMbxHandler(pHandle, cbFunc);