IsIpInAddressSet Method of the IFPCAdapter Interface

  • Article

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

C++

Syntax

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

Parameters

  • IpStr
    Required. BSTR that specifies the IP address.

  • pfIsIpInAddressSet
    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

This method can return one of the following:

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

Visual Basic

Syntax

Function IsIpInAddressSet( _
  ByVal IpStr As String _
) As Boolean

Parameters

  • IpStr
    Required. String that specifies the IP address.

Return Value

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

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

FPCAdapter

Send comments about this topic to Microsoft

Build date: 6/30/2010