IFPCServerPublishingProperties::OverrideServerPort property

Article
08/27/2012

Applies to: desktop apps only

The OverrideServerPort property gets or sets the port number for overriding the default port on the server published by the rule to which the Forefront TMG computer will forward requests. The default port is specified in the PrimaryConnections property of the FPCProtocolDefinition object for the protocol specified in the PublishedProtocol property. If the value of the OverrideServerPort property is nonzero and if the protocol definition specifies only a single port for primary connections, this value will override the default port number. If the protocol definition specifies multiple ports for primary connections, these ports cannot be overridden, and the value of the OverrideServerPort property must be set to zero.

This property is read/write.

Syntax

HRESULT put_OverrideServerPort(
  long lServerPort
);

HRESULT get_OverrideServerPort(
  long *plServerPort
);

' Data type: Long

Property OverrideServerPort( _
  ByVal lServerPort As long, _
  ByVal plServerPort As long _
) As Long

Property value

A 32-bit integer that specifies the port number for overriding the default port on the server published by the rule to which the Forefront TMG computer will forward requests.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. Its default value is 0, and its range of permissible values is from 0 through 65535.

If the value of this property is 0, the default port number assigned to the published protocol is used.

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