LibraryPath

This document is no longer available beyond version 4. Information can now be found here: LibraryPath 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: Library Query Functions - All

Summary

Returns all components, or footprints, that are resident in the library specified as part of the Query.

Syntax

LibraryPath : String

Example Usage

LibraryPath = 'C:\Documents\Altium\Library\MyExampleLibrary.SchLib'
Returns all components whose parent library is MyExampleLibrary.SchLib, and where that library is resident in the  C:\Documents\Altium\Library folder.

LibraryPath Like ' C:\Documents\Altium\Library\Miscellaneous*.IntLib'
Returns all components, or footprints, whose parent library name starts with Miscellaneous and ends with .IntLib, and where that library is resident in the  C:\Documents\Altium\Library folder.

LibraryPath = 'C:\Test Projects\Example DBLib\VishayCapacitor.DBLib'
Returns all components whose parent library is VishayCapacitor.DBLib, and where that library is resident in the  C:\Test Projects\Example DBLib folder.

Tips

  1. The entities returned - Components or Footprints - depends on the chosen scope, defined using the Search in field in the File Libraries Search dialog.
  2. When searching components, all SchLib, IntLib and DbLib libraries - available along the defined library path - will be interrogated. When searching footprints, all PcbLib and IntLib libraries will be interrogated.
  3. All results are listed in the Query Results listing, back in the Components panel.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.