SelectPathCompPin Method (Application Object)

Scope: Schematic editor

Prerequisites: None

Opens a schematic and selects a component pin based on a path from the top of the design.

Note:

The method only opens the target document, and not all the documents along the path.

Usage

Application.SelectPathCompPin(ByVal FileName As String, ByVal HierPath As String, ByVal SheetNumber As String, ByVal PinNumber As String, ByVal SelectType As Long) As Boolean

Arguments

FileName

Name of the document which is the top of the design. This argument is a string with a specific format, resembling a path specification:

[library_name:]sch\name.sheetnumber

library_name is the (optional) alias assigned to the library containing this object. sch\ specifies that the sheet is a schematic. name.sheetnumber is the name and sheet number of the schematic. For example:

My_comps:sch\foo.1

Note:

In C++, you must escape the \ character as \\.

HierPath

Hierarchical path specification. Defines the path from the top-level document specified by FileName to the target item. It has the format of:

instance_name\instance_name\...\instance_name

For example, $1I2\$1I1\$1I1 or the C++ string would be

"$1I2\\$1I1\\$1I1"

SheetNumber

Contains either the actual sheet number of interest or, in most cases, “” which indicates that the application open the default sheet.

PinNumber

String that matches the pin number attribute assigned to the pin.

SelectType

Specifies which type of object to select. This value is ignored if HierPath is specified using the internal unique identifiers (as shown above). If the path is defined using labels, then the SelectType value must be one of the following:

0 - Selects a symbol pin name.
1 - Selects a component pin

Return Values

As Boolean. True - a pin was selected. False - No pin was found or selected.