IsIpInSet Method of the IFPCIpRangeSet Interface
The IsIpInSet method determines whether the specified IP address is included in any of the IP address ranges in the collection.
C++
Syntax
HRESULT IsIpInSet(
[in] BSTR IpStr,
[out] VARIANT_BOOL* pfIsIpInSet
);
Parameters
IpStr
Required. BSTR that specifies the IP address.pfIsIpInSet
Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the specified IP address is included in any IP address range in the collection, or to VARIANT_FALSE if the specified IP address is not included in any IP address range in the collection.
Return Value
This method returns S_OK if the call is successful; otherwise, it returns an error code.
Visual Basic
Syntax
Function IsIpInSet( _
ByVal IpStr As String _
) As Boolean
Parameters
- IpStr
Required. String that specifies the IP address.
Return Value
This method returns a Boolean value that is set to True if the specified IP address is included in any IP address range in the collection, or to False if the specified IP address is not included in any IP address range in the collection. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.
Requirements
Client | Requires Windows 7 or Windows Vista. |
Server | Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2. |
Version | Requires Forefront Threat Management Gateway (TMG) 2010. |
IDL | Declared in Msfpccom.idl. |
DLL | Requires Msfpccom.dll. |
See Also
Send comments about this topic to Microsoft
Build date: 6/30/2010