diff options
Diffstat (limited to 'Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs')
| -rw-r--r-- | Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs index 95f94ad08..99d0f1878 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommand.cs @@ -6,12 +6,37 @@ using System.Threading.Tasks; namespace Tango.FSE.Common.SQL { + /// <summary> + /// Represents a SQL command that can be executed by a <see cref="IRemoteSqlProvider"/>. + /// </summary> + /// <example> + /// <para> + /// <i> + /// The following example demonstrates how to set the connected machine's demo state and query for the connected machine's jobs. + /// </i> + /// </para> + /// <code lang="C#" source="../Tango.FSE.Procedures/Examples/Sql/Program.cs" title="Remote SQL" region="Example" /> + /// </example> public class RemoteSqlCommand { + /// <summary> + /// Gets or sets the command execution mode. + /// </summary> public RemoteSqlCommandMode Mode { get; set; } + + /// <summary> + /// Gets or sets the SQL query. + /// </summary> public String SQL { get; set; } + + /// <summary> + /// Gets or sets the command timeout. + /// </summary> public int Timeout { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="RemoteSqlCommand"/> class. + /// </summary> public RemoteSqlCommand() { Timeout = 30; |
