Share via

AddICMP Method of the IFPCProtocolConnections Interface

  • Article

The AddICMP method creates a new FPCProtocolConnection object for an ICMP connection and returns a reference to it.

C++

Syntax

HRESULT AddICMP(
  [in]   FpcUDPConnectionDirectionType Direction,
  [in]   long Code,
  [in]   long Type,
  [out]  IFPCProtocolConnection** ppNewProtocolConnection
);

Parameters

  • Direction
    Required. Value from the FpcUDPConnectionDirectionType enumerated type that specifies the direction for the new connection.

  • Code
    A 32-bit integer that specifies the ICMP code number used by the filter. It can have a value from 0 to 255. The ICMP code is a subdescriptor of the ICMP type.

  • Type
    A 32-bit integer that specifies the ICMP type number used by the filter. It can have a value from 0 to 255.

  • ppNewProtocolConnection
    Address of an interface pointer that on return points to the new IFPCProtocolConnection interface created.

Return Value

This method can return one of the following:

  • S_OK, indicating that the operation succeeded.
  • An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

Visual Basic

Syntax

Function AddICMP( _
  ByVal Direction As FpcUDPConnectionDirectionType, _
  ByVal Code As Long, _
  ByVal Type As Long _
) As FPCProtocolConnection

Parameters

  • Direction
    Required. Value from the FpcUDPConnectionDirectionType enumerated type that specifies the direction for the new connection.

  • Code
    A 32-bit integer that specifies the ICMP code number used by the filter. It can have a value from 0 to 255. The ICMP code is a subdescriptor of the ICMP type.

  • Type
    A 32-bit integer that specifies the ICMP type number used by the filter. It can have a value from 0 to 255.

Return Value

This method returns a reference to an FPCProtocolConnection object if 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

FPCProtocolConnections

Send comments about this topic to Microsoft

Build date: 6/30/2010