Share via

IFPCIpRangeSet::IsIpInSet method

  • Article

Applies to: desktop apps only

The IsIpInSet method determines whether the specified IP address is included in any of the IP address ranges in the collection.

Syntax

HRESULT IsIpInSet(
  [in]   BSTR IpStr,
  [out]  VARIANT_BOOL *pfIsIpInSet
);

FPCIpRangeSet.IsIpInSet( _
  ByVal IpStr As String, _
  ByRef pfIsIpInSet As VARIANT_BOOL _
) As Boolean

Parameters

  • IpStr [in]

    C++ Required. BSTR that specifies the IP address.
    VB Required. String that specifies the IP address.

  • pfIsIpInSet [out]
    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

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

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

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

 Forefront Threat Management Gateway (TMG) 2010

IDL

 Msfpccom.idl

DLL

 Msfpccom.dll

See also

FPCIpRangeSet

 

 

Build date: 7/12/2010