Add Method of the IFPCRestrictedPorts Interface

  • Article

The Add method creates a new FPCRestrictedPortsRange object in the collection and returns a reference to it.

C++

Syntax

HRESULT Add(
  [in]   USHORT usPortLow,
  [in]   USHORT usPortHigh,
  [out]  IFPCRestrictedPortsRange** ppPortsRange
);

Parameters

  • usPortLow
    Required. A USHORT that specifies the lowest-numbered port in the new range.

  • usPortHigh
    Required. A USHORT that specifies the highest-numbered port in the new range.

  • ppPortsRange
    Address of an interface pointer that on return points to the new IFPCRestrictedPortsRange 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 Add( _
  ByVal usPortLow As UShort, _
  ByVal usPortHigh As UShort _
) As FPCRestrictedPortsRange

Parameters

  • usPortLow
    Required. An unsigned 16-bit integer that specifies the lowest-numbered port in the new range.

  • usPortHigh
    Required. An unsigned 16-bit integer that specifies the highest-numbered port in the range.

Return Value

This method returns a reference to the FPCRestrictedPortsRange object created if successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

Use this method to add a new element to the collection of restricted port ranges. Fully or partially overlapping ranges are allowed in the collection and will be handled correctly.

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

FPCRestrictedPorts

Send comments about this topic to Microsoft

Build date: 6/30/2010