IFlow.Stop Method

Solclient

IFlowStop Method
version: 7.2.1.27
Stops or closes the transport window resulting in the eventual halt of message delivery. Stopping a flow does not result in message loss. It simply "pauses" message delivery until Start() is called again.

To restart a flow after it is been stopped, clients must call Start on the stopped flow.

Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
ReturnCode Stop()
Function Stop As ReturnCode
ReturnCode Stop()

Return Value

Type: ReturnCode
When successful, it returns SOLCLIENT_OK.
Exceptions
ExceptionCondition
OperationErrorException Thrown when the start operation fails.
ObjectDisposedException Thrown when the flow is already disposed (terminal state).
FatalErrorException Thrown when an unrecoverable error occurs.
See Also