1.2.5.40 ADP_SET_CFM_CALLBACK Typedef

C

typedef void (*ADP_SET_CFM_CALLBACK)(ADP_SET_CFM_PARAMS* pSetCfm);

Summary

Pointer to a Set Confirm Event handler function.

Description

This data type defines the required function signature for the ADP Set Confirm event handling callback function. The ADP Set Confirm primitive allows the upper layer to be notified of the completion of an ADP Set Request. A client must register a pointer using the event handling function whose function signature (parameter and return value types) matches the types specified by this function pointer in order to receive Set Confirm events back from module.

The Set Confirm is generated after ADP_SetRequest function call to indicate the result.

Parameters

ParamDescription
pSetCfmPointer to structure containing the Set result. See ADP_SET_CFM_PARAMS

Returns

None.

Example

App_SetConfirm(ADP_SET_CFM_PARAMS *params)
{
    // Check result
    if (params->status == G3_SUCCESS)
    {
        // Successful Set
    }
}

Remarks

None.