IFPCProtocolConnections::AddICMP method

  • Article

Applies to: desktop apps only

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

Syntax

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

FPCProtocolConnections.AddICMP( _
  ByVal Direction As FpcUDPConnectionDirectionType, _
  ByVal Code As Long, _
  ByVal Type As Long, _
  ByRef ppNewProtocolConnection As IFPCProtocolConnection _
) As FPCProtocolConnection

Parameters

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

  • Code [in]
    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 [in]
    A 32-bit integer that specifies the ICMP type number used by the filter. It can have a value from 0 to 255.

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

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. In this case, the [out] parameter returned is a null object.

VB

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

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

FPCProtocolConnections

 

 

Build date: 7/12/2010