CheckIPMask
(Engine-Level Function)
Description: | Determines whether an IP Address is in the address ranges defined by MaskSet. |
Returns: | Varies. See comments. |
Usage: | Script Only. |
Function Groups: | Network and Workstation |
Related to: | IPMaskToText | MakeIPMask |
Format: | CheckIPMask(IPAddress, MaskSet) |
Parameters: |
IPAddress |
Required. Any single legal IP address. |
MaskSet |
Required. A MaskSet constructed by one or more calls to MakeIPMask |
Comments: |
For advanced use only. Returns Invalid for a bad parameter and where the specified IP address is not in the IP address range described by the MaskSet. Otherwise, returns the index into MaskSet of the matching subnet entry. This index can be used as an input parameter to IPMaskToText to obtain the subnet address as text. |