EtherCAT SubDevice2.03.00
 
Loading...
Searching...
No Matches

◆ EC_API_SLV_VoE_cbRegisterInitHandler()

uint32_t EC_API_SLV_VoE_cbRegisterInitHandler ( EC_API_SLV_SHandle_t *  pHandle,
EC_API_SLV_VoE_CBInitHandler_t  cbFunc,
void *  pContext 
)

Function to register a VoE init handler.

if the mailbox service could not be sent (or stored), the VoE service will be stored in this variable and will be sent automatically from the mailbox handler (VOE_ContinueInd) when the send mailbox will be read the next time from the master

This function registers a function pointer which must be implemented by the user. The user defined function will be called during SubDevice power up or ESM state change to INIT from OP/SAFE-OP/PRE-OP.

Parameters
[in]pHandleThe pointer to the EtherCAT API instance.
[in]cbFuncFunction pointer to the VoE Init Handler.
[in]pContextVoE initHandler call context.
Returns
ErrorCode API Error Code.
Example
#include <ecSlvApi.h>
// the Call
EC_API_SLV_VoE_cbRegisterInitHandler(ecSlaveApi, cbFunc, pCtxt);
uint32_t EC_API_SLV_VoE_cbRegisterInitHandler(EC_API_SLV_SHandle_t *pHandle, EC_API_SLV_VoE_CBInitHandler_t cbFunc, void *pContext)
Function to register a VoE init handler.
Definition ecSlvApi_VoE.c:63
Note
This is a premium API.