1.2.5.8.20 PPP_SendAdminEvent Function

C

bool PPP_SendAdminEvent(DRV_HANDLE hMac, PPP_EVENT event, PPP_CTRL_PROTO ctlProt);

Returns

  • true - if the call succeeds

  • false - if the call failed (invalid handle)

Description

This function sends an administrative event to the PPP driver

Remarks

In normal operation just administrative PPP_EVENT_OPEN/PPP_EVENT_CLOSE events should be used

The event should be sent to LCP.An LCP PPP_EVENT_OPEN will eventually open IPCP too.An LCP PPP_EVENT_CLOSE will close IPCP too.

Sending events to IPCP is for testing purposes only and should not be normall used.

Preconditions

The PPP module must be initialized.

Parameters

hMac - driver handle (obtained by calling TCPIP_MAC_Open/DRV_PPP_MAC_Open)

event - event to be sent

ctlProt - the control protocol type: LCP or IPCP

Example