StateDMI / Command / CheckDiversionRights

• Overview
• Command Editor
• Command Syntax
• Examples
• Troubleshooting
• See Also

---

Overview

The CheckDiversionRights command (for StateCU and StateMod) checks diversion rights data for problems. The command should usually be used with a WriteCheckFile command at the end of a command file.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

CheckDiversionRights Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

CheckDiversionRights(Parameter="Value",...)

Command Parameters

Parameter	Description	Default
ID	The identifier for the location(s) to check. Use * to match a pattern.	None – must be specified.
IfNotFound	One of the following: Fail – generate a failure message if the location identifier is not matched Ignore – ignore (don’t generate a message) if the location identifier is not matched Warn – generate a warning message if the location identifier is not matched	Warn

Examples

See the automated tests.

Troubleshooting

See Also

• WriteCheckFile command