CompParameterValue

Now reading version 1.0. For the latest, read: CompParameterValue for 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 - Parameters

Summary

Returns the string Value of a PCB component Parameter, which can be tested to return PCB components that comply to the Query.

Syntax

CompParameterValue(ParameterName : String) : String

Example Usage

CompParameterValue(‘Design Item Id’) Like 'CAP*'
Returns all components that incorporate the Design Item Id Parameter which has a Value string beginning with CAP, such as CAP-NP-100nF-50V-0805, CAP-P-22uF-10V-MCCT-B, etc. The associated child objects of a complying component object, such as tracks, arcs, pads, text etc, are also returned.

CompParameterValue(‘Design Item Id’) Like '*0805*'
Returns all components and their associated child objects where the Design Item Id Parameter has a Value string which includes 0805.

StrToNumber(CompParameterValue('VoltageRating'),V)  >  50
Returns all components and their associated child objects where the VoltageRating Parameter Value is greater than 50 volts. The string Value returned by CompParameterValue is converted to a number for the comparison by the unit-aware StrToNumber function.

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