DrainStopped Property of the IFPCPublishedServer Interface

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.

[C++]

HRESULT put_DrainStopped(
	VARIANT_BOOL fDrainStopped
);
HRESULT get_DrainStopped(
	VARIANT_BOOL* pfDrainStopped
);

Parameters

pfDrainStopped: Pointer to a Boolean variable that is set on return to VARIANT_TRUE if all connections to the published server should be drained and then the sending of requests to the server should be stopped, or to VARIANT_FALSE if new connections with the published server can be created.
fDrainStopped: 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.

Return Value

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

[Visual Basic]

Property DrainStopped 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.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.