IFPCLoadBalancingConfig::AffinityType property

Article
08/27/2012

Applies to: desktop apps only

The AffinityType property gets or sets a value from the FpcLoadBalancingAffinityType enumerated type that specifies the type of affinity that will be maintained with the published server farm.

This property is read/write.

Syntax

HRESULT put_AffinityType(
  FpcLoadBalancingAffinityType *AffinityType
);

HRESULT get_AffinityType(
  FpcLoadBalancingAffinityType pAffinityType
);

' Data type: FpcLoadBalancingAffinityType

Property AffinityType( _
  ByVal AffinityType As FpcLoadBalancingAffinityType, _
  ByVal pAffinityType As FpcLoadBalancingAffinityType _
) As FpcLoadBalancingAffinityType

Property value

Value from the FpcLoadBalancingAffinityType enumerated type that specifies the type of affinity that will be maintained with the published server farm.

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 fpcSessionAffinity, which indicates that cookie-based load balancing with session affinity will be maintained with the published server farm. This means that all requests related to the same session, as indicated by the presence of the same unique cookie for the session, will be forwarded to the same server in the server farm.

When this property is set to fpcIPAffinity, client IP affinity will be maintained with the published server farm. This means that all requests from the same client (source) IP address will be forwarded to the same server in the server farm.

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