smartinspectpython.siconnectionsbuilder
Module: siconnectionsbuilder.py
Revision History
Date | Version | Description |
---|---|---|
2023/05/30 | 3.0.0.0 | Initial Version. |
Assists in building a SmartInspect connections string.
This class assists in creating connections strings as used by the SmartInspect.Connections property. For general information about connections strings, please refer to the SmartInspect.Connections property.
Get the Connections property value.
This read-only property returns the connections string which has previously been built with the BeginProtocol, AddOption and EndProtocol methods.
Adds a new boolean option to the current protocol section.
Arguments:
- key (str): Option key name to add.
- value (bool): Option key boolean value to add.
Adds a new file rotate option to the current protocol section.
Arguments:
- key (str): Option key name to add.
- value (SIFileRotate): Option key SIFileRotate value to add.
Adds a new integer option to the current protocol section.
Arguments:
- key (str): Option key name to add.
- value (int): Option key integer value to add.
Adds a new level option to the current protocol section.
Arguments:
- key (str): Option key name to add.
- value (SILevel): Option key Level value to add.
Adds a new string option to the current protocol section.
Arguments:
- key (str): Option key name to add.
- value (str): Option key string value to add.
This method adds a new string option to the current protocol section. The supplied value argument is properly escaped if necessary.
Begins a new protocol section.
Arguments:
- protocolName (str): The protocol name (e.g. file, text, tcp, etc).
This method begins a new protocol with the supplied name. All subsequent protocol options are added to this protocol until the new protocol section is closed by calling the EndProtocol method.
Clears this instance by removing all protocols and their options.
After this method has been called, the Connections property returns an empty string.