Query_Lang-PCBFunctions_Fields_RuleCommentRuleComment_AD

This document is no longer available beyond version 4. Information can now be found here: RuleComment for version 5

Applies to NEXUS Client version: 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: PCB Query Functions - Fields

Summary

Returns all design rule and objects whose Rule Comment property complies with the Query.

Syntax

RuleComment : String

The entered string must target the comment defined for a rule (e.g. 'This is an example clearance rule').

Example Usage

RuleComment = 'All fiducials masked on Paste Mask layers'
Returns all design rule objects whose Rule Comment property is All fiducials masked on Paste Mask layers.

RuleComment Like '*Clearance*'
Returns all design rule objects whose Rule Comment property contains the term Clearance. For example, a clearance rule with Comment = Example Clearance Rule, and a component clearance rule with Comment = Example Component Clearance Rule, would both be returned using this expression.

RuleComment = ''
Returns all objects except design rule objects that have an entry for their Rule Comment property.

Tips

  1. The Rule Comment property is only defined for design rule objects.