Query_Lang-PCBFunctions_LayerChecks_OnSolderMaskOnSolderMask_AD

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

Nexus message

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 - Layer Checks

Summary

Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer. The pad and via objects are returned because they also render to the Top Solder or Bottom Solder layer respectively.

Syntax

OnSolderMask : Boolean

Example Usage

OnSolderMask
OnSolderMask = True
Returns all objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.

Not OnSolderMask
OnSolderMask = False
Returns all objects except objects on the Top Solder and Bottom Solder layers, all pads on the Top Layer, Bottom Layer and Multi-Layer, and all vias starting on the Top Layer, or ending on the Bottom Layer.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.