IFPCServer::LoadFactor property

Article
08/27/2012

Applies to: desktop apps only

The LoadFactor property gets or sets the load factor of the server.

This property is read/write.

Syntax

HRESULT put_LoadFactor(
  long lLoadFactor
);

HRESULT get_LoadFactor(
  long *plLoadFactor
);

' Data type: Long

Property LoadFactor( _
  ByVal lLoadFactor As long, _
  ByVal plLoadFactor As long _
) As Long

Property value

A 32-bit integer that specifies the load factor of the server.

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 100, and it must be equal to or greater than 1.

When the Cache Array Routing Protocol (CARP) is enabled in an array with multiple Forefront TMG computers, the load factor assigned to each array member is a relative number that determines the distribution of client Web requests and cached objects among the array members by the CARP algorithm. For more information, see Cache Array Routing Protocol.

CARP is enabled for Web requests coming from a particular network when the ResolveInArray property of the network's listener is set to True (VARIANT_TRUE in C++). However, no objects are cached on any server in the array unless the CacheLimitInMegs property of at least one cache drive of at least one server belonging to the array is set to a nonzero value.

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