beautypg.com

Zgate_remove_ip_prot – Zilog EZ80F91GA User Manual

Page 96

background image

ZGATE API Reference

UM024502-1012

84

ZGATE Embedded Security Development Kit
User Manual

ZGATE_remove_ip_prot

Function Prototype

INT16 ZGATE_remove_ip_prot( INT32 IP_Prot );

Parameters

IP_Prot

IP protocol number to be removed from the IP Protocol number
static filtering list. The value of

IP_Prot

must be between 1 and

254.

Return Value

TRUE

IP_Prot

was successfully added to the IP Protocol number static

filtering list.

FALSE

IP_Prot

is invalid, does not exist in the IP Protocol static filter-

ing list or the IP Protocol filter is disabled.

Description

When the IP Protocol filter is operating in WHITELIST (forwarding) or BLACKLIST
(blocking) Mode, it extracts the IP protocol field from inbound IP packets and compares it
to entries in the IP Protocol number static filtering list. If a match is found, the frame is
forwarded to ZTP if the IP Protocol filter operates in WHITELIST Mode, and blocked
from TCP if the filter operates in BLACKLIST Mode.

This API is used to remove an entry from the IP protocol static filtering list. Entries cannot
be removed from the list if the IP protocol filter is disabled.