CheckRuleSyntax Method

The CheckRuleSyntax method validates the syntax of a Transact-SQL database rule prior to creating it.

Applies To

Syntax

object.CheckRuleSyntax( Rule )

Parts

object

Expression that evaluates to an object in the Applies To list

Rule

definition

Prototype (C/C++)

HRESULT CheckRuleSyntax(LPSQLDMORULE Rule);

Remarks

Database defaults and rules cannot be modified once they are created. They must first be dropped and then recreated. An application can call the CheckDefaultSyntax or CheckRuleSyntax method to validate the syntax of a Transact-SQL database rule prior to its creation.

An application might call the CheckDefaultSyntax or CheckRuleSyntax in a scenario in which a rule or default already exists, and it is necessary to change the definition (specified by the Text property). The application:

1. Creates a new rule or default object.
   
   
2. Sets the Name property of the new object to the name of the existing object.
   
   
3. Sets the Text property of the new object to define the default or rule.
   
   
4. Calls CheckDefaultSyntax or CheckRuleSyntax to verify the syntax of the Text property.
   
   
5. Drops the existing object and recreates it using the new object if CheckDefaultSyntax or CheckRuleSyntax returns TRUE.
   
   
6. CheckDefaultSyntax returns TRUE if the Transact-SQL syntax is valid.

   Note  CheckRuleSyntax can be used with Microsoft® SQL Server™ 2000 and SQL Server 7.0.

See Also

CheckDefaultSyntax Method