Class ApiBufferOptions
Defined in File ApiBufferApi.h
Class Documentation
-
class ApiBufferOptions
This class contains options for an API buffer channel. Also see API Buffer Options.
Public Functions
-
ApiBufferOptions()
Public Members
-
bool stopOnError
When this option is FALSE, the API buffer will continue execution when an API returns an error. When this option is TRUE, the API buffer will stop execution when an API returns an error. Execution may be resumed using the Execute function.
-
bool autoRewind
When this option is FALSE, the API buffer will wait for additional API functions to be entered into the buffer when the buffer becomes empty. When this option is TRUE, the API buffer will rewind when the buffer becomes empty and continue execution from the first API in the buffer. This option will not rewind the buffer when the first API in the buffer has been overwritten by an API that is added later.
-
bool stopOnLastBlock
When this option is FALSE, the API buffer will remain in Active state after the last API in the buffer is executed. When another API is added to the buffer, it is immediately executed. When this option is TRUE, the API buffer will change to the Stop state when the last API in the buffer is executed as if the Halt function is called. When another API is added to the buffer, it will not be executed until the Execute function is called.
-
ApiBufferOptions()