PropValues Function

Returns a property value for instances identified by arguments 2 and 3.

Arguments

Number Type Compulsory Default Description
1 string Yes Property name whose value is required
2 string No Use selected components if omitted Property name to identify instance
3 string No All instances with property name in arg2 Property value to identify instance
4 real No -1 Schematic ID
5 string array No options

Argument 1

Property name whose value is required

Argument 2

Along with argument 3, if present these arguments identify the instances to be examined. If only argument 2 is specified then all instances on the specified schematic that possess that property will be used. If argument 3 is also present then the instance name and value must match argument 2 and 3 respectively. If neither are present the selected instances will be used.

Argument 3

See argument 2.

Argument 4

Schematic ID as returned by the function OpenSchematic . This allows this function to be used with a schematic that is not open or not currently selected. If omitted or -1, the currently selected schematic will be used.

Argument 5

Array of length up to three to set these options:

  • 'empty' : Return an empty vector if there are no matches. Otherwise an empty string
  • 'skipdisabled' : Ignores instances that are disabled
  • 'mustpossess' : No match if instance does not possess the target property.

Returns

Return type: string array

The function returns a string array of length equal to the number of instances identified by arguments 2 and 3. Each element will hold a value for the property specified in argument 1.

The function will return an empty vector if the specified schematic could not be found. If no instance matches arguments 2 and 3, an empty string will be returned.