GetLibraryPartsByPartNumber Method

In This Topic

Get library parts by part number with option to specify part's version and variant.

Syntax

public IEnumerable<BaseLibraryPart> GetLibraryPartsByPartNumber( 
   string partNumber,
   PartVersion version,
   bool ignoreRevision,
   string variant
)

Parameters

partNumber: Desired part number.
version: Desired part's version.
ignoreRevision: Ignore revision part of version number.
variant: Desired part's variant.

Return Value

Parts with desired name (and version and variant).

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.NoActiveLibraryException	The exception that is thrown when the project has no active library.
EPLAN.Harness.API.Exceptions.ArgumentException	Argument is invalid. The exception is thrown when a wrong argument is passed to the method or the setter of property.

Example

This example shows how to get parts from a connected library using part name.

// Open a project beforehand.
Project project = ...

// There can be more parts with the same part number (for example: more variants of the same part).
IEnumerable<BaseLibraryPart> parts = project.ActiveConnection.GetLibraryPartsByPartNumber("part number");

// Get parts specified by part number and version (still can contain more than one element, because of more possible variants).
IEnumerable<BaseLibraryPart> parts2 = project.ActiveConnection.GetLibraryPartsByPartNumber("part number", version: "1.0");

// Get unique part specified by part number, version and variant (still returned as array of one part).
IEnumerable<BaseLibraryPart> parts3 = project.ActiveConnection.GetLibraryPartsByPartNumber("part number", "2.1", "3");

// Will be empty because of wrong version format.
IEnumerable<BaseLibraryPart> parts4 = project.ActiveConnection.GetLibraryPartsByPartNumber("part number", "2.", "3");

Reference

ActiveLibraryConnection Class
ActiveLibraryConnection Members

Send Feedback