AddICMP Method of the IFPCProtocolConnections Interface

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:

[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 Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCProtocolConnections


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.