Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwProjectManufacturerPartX Interface Reference

Use this interface to manage manufacturer part inside a project. More...

Inheritance diagram for IEwProjectManufacturerPartX:
[legend]

Public Member Functions

BSTR get3DPartFilePath (EwErrorCode *errorCode)
 Get the file path of the associated 3D part. More...
 
BSTR getReference (EwErrorCode *errorCode)
 Get the reference name of this manufacturer part. More...
 
BSTR getManufacturer (EwErrorCode *errorCode)
 Get the manufacturer's name. More...
 
BSTR getDescription (BSTR strLanguageCode, EwErrorCode *errorCode)
 Get the manufacturer part description. More...
 
LONG getClassificationID ()
 Get the classification ID of the manufacturer part. More...
 
VARIANT_BOOL isRailOrDuct (EwErrorCode *errorCode)
 Check if the manufacturer part is a rail or a duct. More...
 
DOUBLE getWidth (EwErrorCode *errorCode)
 Get the width of the manufacturer part. More...
 
DOUBLE getHeight (EwErrorCode *errorCode)
 Get the height of the manufacturer part. More...
 
DOUBLE getDepth (EwErrorCode *errorCode)
 Get the depth of the manufacturer part. More...
 
DOUBLE getLength (EwErrorCode *errorCode)
 Get the length of the manufacturer part. More...
 
DOUBLE getAdjustableLength (EwErrorCode *errorCode)
 Get the adjustable length of the manufacturer part. More...
 
LONG getEwProjectManufacturerPartCircuitCount (EwErrorCode *errorCode)
 Get the number of circuits associated to the manufacturer part. More...
 
IEwProjectComponentX getEwProjectComponent (EwErrorCode *errorCode)
 Get the component to which the manufacturer part is associated. More...
 
IEwProjectLocationX getEwProjectLocation (EwErrorCode *errorCode)
 Get the location to which the manufacturer part is associated. More...
 
LONG getID ()
 
EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object Project must be opened to be able to call this method. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object Project must be opened to be able to call this method. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text Project must be opened to be able to call this method. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
BSTR getArticleNumber (EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
EwErrorCode setArticleNumber (BSTR strArticleNumber)
 Set the value of a translated text. More...
 
EwErrorCode insert ()
 
EwErrorCode remove ()
 
EwErrorCode update ()
 
BSTR getExternalID (EwErrorCode *errorCode)
 Get external identifier. More...
 
EwErrorCode setExternalID (BSTR strExternalID)
 Set the external identifier. More...
 

Detailed Description

Use this interface to manage manufacturer part inside a project.

Since
2018 SP0

Member Function Documentation

◆ get3DPartFilePath()

BSTR IEwProjectManufacturerPartX::get3DPartFilePath ( EwErrorCode *  errorCode)

Get the file path of the associated 3D part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
File Path

◆ getAdjustableLength()

DOUBLE IEwProjectManufacturerPartX::getAdjustableLength ( EwErrorCode *  errorCode)

Get the adjustable length of the manufacturer part.

If the object is not adjustable, the depth is returned

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Adjustable length value

◆ getArticleNumber()

BSTR IEwProjectManufacturerPartX::getArticleNumber ( EwErrorCode *  errorCode)

Get the value of a translated text.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the string article number

◆ getClassificationID()

LONG IEwProjectManufacturerPartX::getClassificationID ( )

Get the classification ID of the manufacturer part.

Returns
Classification ID. -1 if the object is not valid

◆ getDepth()

DOUBLE IEwProjectManufacturerPartX::getDepth ( EwErrorCode *  errorCode)

Get the depth of the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Depth value

◆ getDescription()

BSTR IEwProjectManufacturerPartX::getDescription ( BSTR  strLanguageCode,
EwErrorCode *  errorCode 
)

Get the manufacturer part description.

Parameters
[in]strLanguageCodeLanguage of the resulting description
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Description

◆ getEwProjectComponent()

IEwProjectComponentX IEwProjectManufacturerPartX::getEwProjectComponent ( EwErrorCode *  errorCode)

Get the component to which the manufacturer part is associated.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Pointer to the component. NULL if the manufacturer part is not associated to a component

◆ getEwProjectLocation()

IEwProjectLocationX IEwProjectManufacturerPartX::getEwProjectLocation ( EwErrorCode *  errorCode)

Get the location to which the manufacturer part is associated.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Pointer to the location. NULL if the manufacturer part is not associated to a location

◆ getEwProjectManufacturerPartCircuitCount()

LONG IEwProjectManufacturerPartX::getEwProjectManufacturerPartCircuitCount ( EwErrorCode *  errorCode)

Get the number of circuits associated to the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Number of circuits

◆ getExternalID()

BSTR IEwProjectManufacturerPartX::getExternalID ( EwErrorCode *  errorCode)

Get external identifier.

Since
2019
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
the string external identifier

◆ getHeight()

DOUBLE IEwProjectManufacturerPartX::getHeight ( EwErrorCode *  errorCode)

Get the height of the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Height value

◆ getID()

LONG IEwProjectManufacturerPartX::getID ( )

◆ getLength()

DOUBLE IEwProjectManufacturerPartX::getLength ( EwErrorCode *  errorCode)

Get the length of the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Length value

◆ getManufacturer()

BSTR IEwProjectManufacturerPartX::getManufacturer ( EwErrorCode *  errorCode)

Get the manufacturer's name.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Manufacturer's name

◆ getReference()

BSTR IEwProjectManufacturerPartX::getReference ( EwErrorCode *  errorCode)

Get the reference name of this manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Reference name

◆ getTranslatedData()

BSTR IEwProjectManufacturerPartX::getTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
Returns
Value of the text to get

◆ getUserData()

BSTR IEwProjectManufacturerPartX::getUserData ( LONG  nUserDataNumber,
EwErrorCode *  errorCode 
)

Get user data of the object Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumbernumber of the user data
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_UNDEFINED_ERROR if an error occurred
Returns
value of the user data requested

◆ getWidth()

DOUBLE IEwProjectManufacturerPartX::getWidth ( EwErrorCode *  errorCode)

Get the width of the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Width value

◆ insert()

EwErrorCode IEwProjectManufacturerPartX::insert ( )

◆ isRailOrDuct()

VARIANT_BOOL IEwProjectManufacturerPartX::isRailOrDuct ( EwErrorCode *  errorCode)

Check if the manufacturer part is a rail or a duct.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if the manufacturer part is a rail or a duct

◆ remove()

EwErrorCode IEwProjectManufacturerPartX::remove ( )

◆ setArticleNumber()

EwErrorCode IEwProjectManufacturerPartX::setArticleNumber ( BSTR  strArticleNumber)

Set the value of a translated text.

Parameters
[in]strArticleNumberstring to set on the article number
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setExternalID()

EwErrorCode IEwProjectManufacturerPartX::setExternalID ( BSTR  strExternalID)

Set the external identifier.

Since
2019
Parameters
[in]strExternalIDThe external identifier you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred

◆ setTranslatedData()

EwErrorCode IEwProjectManufacturerPartX::setTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
BSTR  strValue 
)

Set the value of a translated text Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumberNumber of the text to set
[in]strLanguageLanguage of the text
[in]strValueValue of the text
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported

◆ setUserData()

EwErrorCode IEwProjectManufacturerPartX::setUserData ( LONG  nUserDataNumber,
BSTR  strValue 
)

Set user data of the object Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_UNDEFINED_ERROR if an error occurred

◆ update()

EwErrorCode IEwProjectManufacturerPartX::update ( )
Generated on Tue Sep 1 2020 17:01:24 for SOLIDWORKS Electrical API by   doxygen 1.8.18


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwProjectManufacturerPartX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2020 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.46