diff options
Diffstat (limited to 'Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs')
| -rw-r--r-- | Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs | 50 |
1 files changed, 48 insertions, 2 deletions
diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs index 34ab74a68..da21ae24d 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/SQL/RemoteSqlCommandResult.cs @@ -7,22 +7,68 @@ using Tango.PPC.Shared.SQL; namespace Tango.FSE.Common.SQL { + /// <summary> + /// Represents a <see cref="RemoteSqlCommand"/> result. + /// </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 RemoteSqlCommandResult { + /// <summary> + /// Gets or sets the connected machine's database affected records. + /// </summary> public int LocalAffectedRecords { get; set; } + + /// <summary> + /// Gets or sets the data set retrieved from the connected machine's database. + /// </summary> public RemoteSqlDataSet LocalDatSet { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether the query against the connected machine's database has encountered an error. + /// </summary> public bool HasLocalError { get; set; } + + /// <summary> + /// Gets or sets the error encountered by the query when it was executed against the connected machine's database. + /// Relevant only if <see cref="HasLocalError"/> equals true. + /// </summary> public String LocalError { get; set; } + /// <summary> + /// Gets or sets the global database affected records. + /// </summary> public int GlobalAffectedRecords { get; set; } - public RemoteSqlDataSet GLobalDataSet { get; set; } + + /// <summary> + /// Gets or sets the data set retrieved from the global database. + /// </summary> + public RemoteSqlDataSet GlobalDataSet { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether the query against the global database has encountered an error. + /// </summary> public bool HasGlobalError { get; set; } + + /// <summary> + /// Gets or sets the error encountered by the query when it was executed against the global database. + /// Relevant only if <see cref="HasGlobalError"/> equals true. + /// </summary> public String GlobalError { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="RemoteSqlCommandResult"/> class. + /// </summary> public RemoteSqlCommandResult() { LocalDatSet = new RemoteSqlDataSet(); - GLobalDataSet = new RemoteSqlDataSet(); + GlobalDataSet = new RemoteSqlDataSet(); } } } |
