CommandResult Class |
This class is used to indicate the result of OpsCommands and other functions.
Inheritance HierarchyNamespace: Micros.Ops
Assembly: Ops (in Ops.dll) Version: 18.2
SyntaxC#
public class CommandResult : ResultBase
The CommandResult type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CommandResult(EErrorIds) |
Constructor
|
| CommandResult(PosCoreResult) |
Constructor
|
| CommandResult(EErrorIds, Object) |
Constructor
|
| CommandResult(EErrorIds, Object, PosCoreResult) |
Constructor
|
Properties| Name | Description | |
|---|---|---|
  | Cancelled | Command was cancelled. |
| Failure | Micros internal use only. |
| IdEnum | EErrorIds value. (Overrides ResultBase.IdEnum.) |
| Next | Next set of data requested. |
| NoMessage | Command failed but an error message should not be displayed. |
| NotImplemented | Micros internal use only. |
| OperationNotAllowedForThisPlatform | Micros internal use only. |
| Previous | Previous set of data requested. |
| Success | Command was successful. |
| Temp | Micros internal use only. |
| TransText | The TranslatedText instance to be used in translating/formatting an error message. |
Methods| Name | Description | |
|---|---|---|
| Format |
Format an error message for a failed command.
If the EErrorId = ErrorWithString and Data is a string, Data will be used as the error message.
If Data is an object[] it is assumed to be arguments for the pre-formated error message.
(Overrides ResultBase.Format.) |
| ToAutoTestString | String representation of this CommandResult for use in testing. |
| ToLogString | String representation of this CommandResult for use in logging. |
Fields| Name | Description | |
|---|---|---|
 | Data | Data to be used when formatting the error message for a failed command. |
| DsResult | DataStore result instance. |
| Id | EErrorIds value. |
See Also