IFPCPublishedServer::DrainStopped property

Article
08/27/2012

Applies to: desktop apps only

The DrainStopped property gets or sets a Boolean value that indicates whether all connections to the published server should be drained and then the sending of requests to the server should be stopped. During draining, no new connections are allowed, but existing connections are allowed to complete their jobs and terminate gracefully.

This property is read/write.

Syntax

HRESULT put_DrainStopped(
  VARIANT_BOOL fDrainStopped
);

HRESULT get_DrainStopped(
  VARIANT_BOOL *pfDrainStopped
);

' Data type: Boolean

Property DrainStopped( _
  ByVal fDrainStopped As VARIANT_BOOL, _
  ByVal pfDrainStopped As VARIANT_BOOL _
) As Boolean

Property value

Boolean value that indicates whether all connections to the published server should be drained and then the sending of requests to the server should be stopped.

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 False (VARIANT_FALSE in C++).

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