IFPCAdapter::IsIpInAddressSet method

  • Article

Applies to: desktop apps only

The IsIpInAddressSet method determines whether an IP address is included in the address set of the network adapter.

Syntax

HRESULT IsIpInAddressSet(
  [in]   BSTR IpStr,
  [out]  VARIANT_BOOL *pfIsIpInAddressSet
);

FPCAdapter.IsIpInAddressSet( _
  ByVal IpStr As String, _
  ByRef pfIsIpInAddressSet As VARIANT_BOOL _
) As Boolean

Parameters

  • IpStr [in]

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

  • pfIsIpInAddressSet [out]
    Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the IP address is included in the address set of the network adapter, or to VARIANT_FALSE if the IP address is not included in the address set of the network adapter.

Return value

C++

This method can return one of the following:

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

VB

This method returns a Boolean value that indicates whether the IP address is included in the address set of the network adapter if the call is successful. Otherwise, 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

FPCAdapter

 

 

Build date: 7/12/2010