IFPCReadOnlyIpRangeSet::IsIpInSet method

  • Article

Applies to: desktop apps only

The IsIpInSet method determines whether the specified IP address is included in an IP address range in the collection.

Syntax

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

FPCReadOnlyIpRangeSet.IsIpInSet( _
  ByVal IpStr As String, _
  ByRef pIsIpInSet As VARIANT_BOOL _
) As Boolean

Parameters

  • IpStr [in]

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

  • pIsIpInSet [out]
    Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the IP address is included in an IP address range in the collection, or to VARIANT_FALSE if the specified IP address is not included in an IP address range in the collection.

Return value

C++

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed.

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

FPCReadOnlyIpRangeSet

 

 

Build date: 7/12/2010