Back to product page

Blocking property


Determines if methods are blocking.

Type

A Boolean value. When set to True, wodSFTP methods are blocking.

Syntax

  • Basic
object.Blocking [= value]
The Blocking(object,value) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
valueA Boolean value.

Remarks

Blocking mode is ideal for scripting environments where you cannot use asynchronous connections. Although events are still fired, you can just ignore them and check to see if an error occurred during method execution.

The difference between blocking and non-blocking operation may be shown using the Connect method.

If Blocking is set to True, wodSFTP will wait until it actually connects with the remote server. Once connected, control will be given back to your program and you can continue with its execution. If an error is generated, control will be returned immediately.

If Blocking is set to False, wodSFTP will immediately return after Connect is called, whether it managed to connect with the remote server (at that particular moment) or not. Following the call to connect, you should wait for the Connected event to be fired to determine if Connect was successful or not.

The above applies also to all methods used in wodSFTP (such as ListDir, MakeDir...). If an error occurs, it will be returned when the method finishes.

Platforms

Windows