Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
Collapse IEwObjectBaseXIEwObjectBaseX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Collapse IEwObjectXIEwObjectX
IEwClassificationX
IEwProjectComponentCircuitX
IEwProjectConfigurationX
IEwProjectEntity3DX
IEwProjectInputOutputX
IEwProjectManufacturerPartX
IEwProjectMultilingualTextX
IEwProjectPrintConfigX
IEwProjectReportX
IEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
IEwProjectWireStyleGroupX
IEwProjectWireStyleX
IEwProjectWireX
IEwProjectComponentTerminalX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
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 Inspection API HelpSOLIDWORKS Inspection 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
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
IEwProjectManufacturerPartX Interface Reference

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

Inheritance diagram for IEwProjectManufacturerPartX:
Inheritance graph

Public Member Functions

EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
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...
 
EwErrorCode setReference (BSTR strReference)
 Set the reference name of this manufacturer part. More...
 
BSTR getManufacturer (EwErrorCode *errorCode)
 Get the manufacturer name of the current manufacturer part. More...
 
EwErrorCode setManufacturer (BSTR strManufacturerName)
 Set the manufacturer name of the current manufacturer part. More...
 
BSTR getSeries (EwErrorCode *errorCode)
 Get the series of the current manufacturer part. More...
 
EwErrorCode setSeries (BSTR strSeries)
 Set the series of the current manufacturer part. More...
 
BSTR getDataSheetFilePath (EwErrorCode *errorCode)
 Get the data sheet file path of the current manufacturer part. More...
 
EwErrorCode setDataSheetFilePath (BSTR strDataSheetFilePath)
 Set the data sheet file path of the current manufacturer part. More...
 
BSTR getSupplierName (EwErrorCode *errorCode)
 Get the supplier name of the current manufacturer part. More...
 
EwErrorCode setSupplierName (BSTR strSupplierName)
 Set the supplier name of the current manufacturer part. More...
 
BSTR getStockNumber (EwErrorCode *errorCode)
 Get the stock number of the current manufacturer part. More...
 
EwErrorCode setStockNumber (BSTR strStockNumber)
 Set the stock number of the current manufacturer part. More...
 
BSTR getDescription (BSTR strLanguageCode, EwErrorCode *errorCode)
 Get the manufacturer part description. More...
 
EwErrorCode setDescription (BSTR strLanguageCode, BSTR strDescription)
 Set the manufacturer part description. More...
 
LONG getClassificationID ()
 Deprecated use getClassId. 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 in millimeters of the current manufacturer part. More...
 
EwErrorCode setWidth (DOUBLE dWidth)
 Set the width in millimeters of the current manufacturer part. More...
 
DOUBLE getHeight (EwErrorCode *errorCode)
 Get the height in millimeters of the current manufacturer part. More...
 
EwErrorCode setHeight (DOUBLE dHeight)
 Set the height in millimeters of the current manufacturer part. More...
 
DOUBLE getDepth (EwErrorCode *errorCode)
 Get the depth in millimeters of the manufacturer part. More...
 
EwErrorCode setDepth (DOUBLE dDepth)
 Set the depth in millimeters of the current manufacturer part. More...
 
DOUBLE getLength (EwErrorCode *errorCode)
 Get the length in millimeters of the manufacturer part. More...
 
EwErrorCode setLength (DOUBLE dLength)
 Set the length in millimeters of the current 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 current manufacturer part. More...
 
LONG getEwProjectManufacturerPartTerminalCount (EwErrorCode *errorCode)
 Get the number of terminals associated to the current manufacturer part. More...
 
IEwProjectComponentX getEwProjectComponent (EwErrorCode *errorCode)
 Get the component to which the current manufacturer part is associated. More...
 
IEwProjectLocationX getEwProjectLocation (EwErrorCode *errorCode)
 Get the location to which the manufacturer part is associated. More...
 
BSTR getArticleNumber (EwErrorCode *errorCode)
 Get article number of the object. More...
 
EwErrorCode setArticleNumber (BSTR strArticleNumber)
 Set article number of the object. More...
 
BSTR getExternalID (EwErrorCode *errorCode)
 Get external identifier. More...
 
EwErrorCode setExternalID (BSTR strExternalID)
 Set the external identifier. More...
 
VARIANT_BOOL getExcludeFromBillOfMaterials (EwErrorCode *errorCode)
 Check if current manufacturer part is to exclude from bill of materials. More...
 
EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM)
 Set if current manufacturer part is to exclude from bill of materials. More...
 
long getObjectID (EwErrorCode *errorCode)
 Return the Object ID associated with the manufacturer part. More...
 
EwErrorCode setObjectID (long lID)
 Sets the ID of the object to associate with the manufacturer part. More...
 
EwErrorCode setHarnessID (long lHarnessID)
 Set the Harness ID of this manufacturer part. More...
 
LONG getHarnessID (EwErrorCode *errorCode)
 Get the Harness ID associated with the manufacturer part. More...
 
IEwClassificationX getClassification (EwErrorCode *errorCode)
 Get the classification of the current manufacturer part. More...
 
EwErrorCode setClassificationID (long lClassificationID)
 Set the setClassification of the current manufacturer part by classification id. More...
 
EwErrorCode setWeight (DOUBLE dWeight)
 Set the weight of the current manufacturer part. More...
 
DOUBLE getWeight (EwErrorCode *errorCode)
 Get the weight in grams of the current manufacturer part. More...
 
LONG getClassID (EwErrorCode *errorCode)
 Get the class ID of the manufacturer part. More...
 
EwErrorCode setClassID (LONG lID)
 Set the class ID of this manufacturer part. More...
 
EwManufacturerPartType getEwManufacturerPartType (EwErrorCode *errorCode)
 Get the base type (EwManufacturerPartType enum) of the current manufacturer part. More...
 
EwErrorCode setEwManufacturerPartType (EwManufacturerPartType eManufacturerPartType)
 Set the base type (EwManufacturerPartType enum) of the current manufacturer part. More...
 
long getLineDiagramSymbolID (EwErrorCode *errorCode)
 Get the line diagram symbol ID of the current manufacturer part. More...
 
EwErrorCode setLineDiagramSymbolID (long lID)
 Set the line diagram symbol ID of the current manufacturer part. More...
 
long getSchemeSymbolID (EwErrorCode *errorCode)
 Get the schematic symbol ID of the current manufacturer part. More...
 
EwErrorCode setSchemeSymbolID (long lID)
 Set the schematic symbol ID of the current manufacturer part. More...
 
long getConnectionLabelSymbolID (EwErrorCode *errorCode)
 Get the connection label symbol ID of the current manufacturer part. More...
 
EwErrorCode setConnectionLabelSymbolID (long lID)
 Set the connection label symbol ID of the current manufacturer part. More...
 
long get2DFootPrintSymbolID (EwErrorCode *errorCode)
 Get the 2D foot print symbol ID of the current manufacturer part. More...
 
EwErrorCode set2DFootPrintSymbolID (long lID)
 Set the 2D foot print symbol ID of the current manufacturer part. More...
 
long getTerminalStripSymbolID (EwErrorCode *errorCode)
 Get the terminal strip symbol ID of the current manufacturer part. More...
 
EwErrorCode setTerminalStripSymbolID (long lID)
 Set the terminal strip symbol ID of the current manufacturer part. More...
 
long getTerminalTypeID (EwErrorCode *errorCode)
 Get the terminal type ID of the current manufacturer part. More...
 
EwErrorCode setTerminalTypeID (long lID)
 Set the terminal type ID of the current manufacturer part. More...
 
BSTR getUseVoltage (EwErrorCode *errorCode)
 Get the use voltage of the current manufacturer part. More...
 
EwErrorCode setUseVoltage (BSTR strUseVoltage)
 Set the use voltage of the current manufacturer part. More...
 
BSTR getUseFrequency (EwErrorCode *errorCode)
 Get the use frequency of the current manufacturer part. More...
 
EwErrorCode setUseFrequency (BSTR strUseFrequency)
 Set the use frequency of the current manufacturer part. More...
 
BSTR getControlVoltage (EwErrorCode *errorCode)
 Get the control voltage of the current manufacturer part. More...
 
EwErrorCode setControlVoltage (BSTR strControlVoltage)
 Set the control voltage of the current manufacturer part. More...
 
BSTR getControlFrequency (EwErrorCode *errorCode)
 Get the control frequency of the current manufacturer part. More...
 
EwErrorCode setControlFrequency (BSTR strControlFrequency)
 Set the control frequency of the current manufacturer part. More...
 
BSTR getManufacturerDataValue (EwManufacturerDataIndex eIndexValue, EwErrorCode *errorCode)
 Get a manufacturer data value associated to the current manufacturer part. More...
 
EwErrorCode setManufacturerDataValue (EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue)
 Set a manufacturer data value associated to the current manufacturer part. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

Detailed Description

Use this interface to manage manufacturer part inside a project.

Since
2018 SP0

Member Function Documentation

◆ get2DFootPrintSymbolID()

long IEwProjectManufacturerPartX::get2DFootPrintSymbolID ( EwErrorCode errorCode)

Get the 2D foot print symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if 2D foot print symbol was not found
Returns
the 2D foot print symbol of the current manufacturer part.

◆ 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
  • EW_INVALID_OBJECT if object is not initialized
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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the adjustable length value of the current manufacturer part.

◆ getArticleNumber()

BSTR IEwProjectManufacturerPartX::getArticleNumber ( EwErrorCode errorCode)

Get article number of the object.

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

◆ getClassID()

LONG IEwProjectManufacturerPartX::getClassID ( EwErrorCode errorCode)

Get the class ID of the manufacturer part.

Since
2023 SP0 -1 Unknown class, not initialized. -2 Unclassified elements, Minimum valid value.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the ID of manufacturer part.

◆ getClassification()

IEwClassificationX IEwProjectManufacturerPartX::getClassification ( EwErrorCode errorCode)

Get the classification of the current manufacturer part.

Since
2022 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if manufacturer part is invalid
  • EW_OBJECT_NOT_FOUND classification not found
  • EW_NO_ERROR if no error detected
Returns
EwAdClassification of project manufacturer part

◆ getClassificationID()

LONG IEwProjectManufacturerPartX::getClassificationID ( )

Deprecated use getClassId.

Get the classification ID of the manufacturer part.

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

◆ getConnectionLabelSymbolID()

long IEwProjectManufacturerPartX::getConnectionLabelSymbolID ( EwErrorCode errorCode)

Get the connection label symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if connection label symbol was not found
Returns
the connection label symbol of the current manufacturer part.

◆ getControlFrequency()

BSTR IEwProjectManufacturerPartX::getControlFrequency ( EwErrorCode errorCode)

Get the control frequency of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the control voltage

◆ getControlVoltage()

BSTR IEwProjectManufacturerPartX::getControlVoltage ( EwErrorCode errorCode)

Get the control voltage of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the control voltage

◆ getDataSheetFilePath()

BSTR IEwProjectManufacturerPartX::getDataSheetFilePath ( EwErrorCode errorCode)

Get the data sheet file path of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the data sheet file path string of the current manufacturer part

◆ getDepth()

DOUBLE IEwProjectManufacturerPartX::getDepth ( EwErrorCode errorCode)

Get the depth in millimeters 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
  • EW_INVALID_OBJECT if object is not initialized
Returns
the depth value of the current manufacturer part.

◆ getDescription()

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

Get the manufacturer part description.

Parameters
[in]strLanguageCodeThe language of the description you want to set (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if strLanguageCode is not valid
  • EW_NO_ERROR if no error detected
Returns
Description

◆ getEwManufacturerPartType()

EwManufacturerPartType IEwProjectManufacturerPartX::getEwManufacturerPartType ( EwErrorCode errorCode)

Get the base type (EwManufacturerPartType enum) of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the EwManufacturerPartType enum value for the base type of this object.

◆ getEwProjectComponent()

IEwProjectComponentX IEwProjectManufacturerPartX::getEwProjectComponent ( EwErrorCode errorCode)

Get the component to which the current manufacturer part is associated.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the pointer to the component. NULL if the current 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if no object with the Objected ID related to this manufacturer Part.
  • EW_NO_ERROR if no error detected
Returns
the 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 current manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the number of circuits of the current manufacturer part.

◆ getEwProjectManufacturerPartTerminalCount()

LONG IEwProjectManufacturerPartX::getEwProjectManufacturerPartTerminalCount ( EwErrorCode errorCode)

Get the number of terminals associated to the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the number of terminals of the current manufacturer part.

◆ getExcludeFromBillOfMaterials()

VARIANT_BOOL IEwProjectManufacturerPartX::getExcludeFromBillOfMaterials ( EwErrorCode errorCode)

Check if current manufacturer part is to exclude from bill of materials.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
True if the manufacturer is exclude from bill of materials else false

◆ getExternalID()

BSTR IEwProjectManufacturerPartX::getExternalID ( EwErrorCode errorCode)

Get external identifier.

Since
2019
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the string external identifier

◆ getHarnessID()

LONG IEwProjectManufacturerPartX::getHarnessID ( EwErrorCode errorCode)

Get the Harness ID associated with the manufacturer part.

Return -1 if the current manufacturer part is not associated to a harness.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the Harness ID associated at the current cable.

◆ getHeight()

DOUBLE IEwProjectManufacturerPartX::getHeight ( EwErrorCode errorCode)

Get the height in millimeters of the current manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the height value of the current manufacturer part.

◆ getLength()

DOUBLE IEwProjectManufacturerPartX::getLength ( EwErrorCode errorCode)

Get the length in millimeters of the manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the length value of the current manufacturer part.

◆ getLineDiagramSymbolID()

long IEwProjectManufacturerPartX::getLineDiagramSymbolID ( EwErrorCode errorCode)

Get the line diagram symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if line diagram Symbol not found
Returns
the line diagram symbol ID of the current manufacturer part.

◆ getManufacturer()

BSTR IEwProjectManufacturerPartX::getManufacturer ( EwErrorCode errorCode)

Get the manufacturer name of the current manufacturer part.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the manufacturer name of the current manufacturer part

◆ getManufacturerDataValue()

BSTR IEwProjectManufacturerPartX::getManufacturerDataValue ( EwManufacturerDataIndex  eIndexValue,
EwErrorCode errorCode 
)

Get a manufacturer data value associated to the current manufacturer part.

Since
2023 SP0
Parameters
[in]eIndexValueEwManufacturerDataIndex enum type corresponding to the index of the manufacturer data to get the value from.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT wrong manufacturer part is called, or manufacturer part doesn't belong to a specific class
  • EW_FILE_NOT_FOUND unable to find the user data description file
  • EW_INVALID_INDEX unavailable field for this manufacturer part (on the given index eIndexValue)
  • EW_NO_ERROR if no error detected
Returns
a manufacturer data value associated to the current manufacturer part.

◆ getObjectID()

long IEwProjectManufacturerPartX::getObjectID ( EwErrorCode errorCode)

Return the Object ID associated with the manufacturer part.

Could be Component, Location or Harness.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the Object ID associated with the manufacturer part.

◆ 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
  • EW_INVALID_OBJECT if object is not initialized
Returns
Reference name

◆ getSchemeSymbolID()

long IEwProjectManufacturerPartX::getSchemeSymbolID ( EwErrorCode errorCode)

Get the schematic symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if scheme symbol was not found
Returns
the schematic symbol ID of the current manufacturer part.

◆ getSeries()

BSTR IEwProjectManufacturerPartX::getSeries ( EwErrorCode errorCode)

Get the series of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the series of the current manufacturer part

◆ getStockNumber()

BSTR IEwProjectManufacturerPartX::getStockNumber ( EwErrorCode errorCode)

Get the stock number of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the stock number of the current manufacturer part

◆ getSupplierName()

BSTR IEwProjectManufacturerPartX::getSupplierName ( EwErrorCode errorCode)

Get the supplier name of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the supplier name of the current manufacturer part

◆ getTerminalStripSymbolID()

long IEwProjectManufacturerPartX::getTerminalStripSymbolID ( EwErrorCode errorCode)

Get the terminal strip symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if terminal strip symbol was not found
Returns
the terminal strip symbol ID of the current manufacturer part.

◆ getTerminalTypeID()

long IEwProjectManufacturerPartX::getTerminalTypeID ( EwErrorCode errorCode)

Get the terminal type ID of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if terminal type does not exist
Returns
the terminal type ID of the current manufacturer part.

◆ 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

◆ getUseFrequency()

BSTR IEwProjectManufacturerPartX::getUseFrequency ( EwErrorCode errorCode)

Get the use frequency of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the use frequency

◆ getUserData()

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

Get user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[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
Returns
value of the user data requested

◆ getUseVoltage()

BSTR IEwProjectManufacturerPartX::getUseVoltage ( EwErrorCode errorCode)

Get the use voltage of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected
Returns
the use voltage

◆ getWeight()

DOUBLE IEwProjectManufacturerPartX::getWeight ( EwErrorCode errorCode)

Get the weight in grams of the current manufacturer part.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
The weight

◆ getWidth()

DOUBLE IEwProjectManufacturerPartX::getWidth ( EwErrorCode errorCode)

Get the width in millimeters of the current manufacturer part.

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

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
True if the manufacturer part is a rail or a duct

◆ set2DFootPrintSymbolID()

EwErrorCode IEwProjectManufacturerPartX::set2DFootPrintSymbolID ( long  lID)

Set the 2D foot print symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDID of the 2D foot print symbol you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if symbol was not found by lID

◆ setArticleNumber()

EwErrorCode IEwProjectManufacturerPartX::setArticleNumber ( BSTR  strArticleNumber)

Set article number of the object.

Parameters
[in]strArticleNumberstring to set on the article number
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strArticleNumber exceeds the size limit 255
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setClassID()

EwErrorCode IEwProjectManufacturerPartX::setClassID ( LONG  lID)

Set the class ID of this manufacturer part.

Since
2023 SP0
Parameters
[in]lIDnew class you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS no class found
  • EW_NO_ERROR if no error detected

◆ setClassificationID()

EwErrorCode IEwProjectManufacturerPartX::setClassificationID ( long  lClassificationID)

Set the setClassification of the current manufacturer part by classification id.

Since
2022 SP0
Parameters
[in]lClassificationIDID of new project manufacturer part for component .
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if project manufacturer part is invalid
  • EW_BAD_INPUTS classification not found
  • EW_NO_ERROR if no error detected

◆ setConnectionLabelSymbolID()

EwErrorCode IEwProjectManufacturerPartX::setConnectionLabelSymbolID ( long  lID)

Set the connection label symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDthe connection label symbol ID you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if symbol was not found by lID

◆ setControlFrequency()

EwErrorCode IEwProjectManufacturerPartX::setControlFrequency ( BSTR  strControlFrequency)

Set the control frequency of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strControlFrequencyThe control frequency you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strControlFrequency exceeds the defined size limit 70
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected

◆ setControlVoltage()

EwErrorCode IEwProjectManufacturerPartX::setControlVoltage ( BSTR  strControlVoltage)

Set the control voltage of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strControlVoltageThe control voltage you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strControlVoltage exceeds the defined size limit 70
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected

◆ setDataSheetFilePath()

EwErrorCode IEwProjectManufacturerPartX::setDataSheetFilePath ( BSTR  strDataSheetFilePath)

Set the data sheet file path of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strDataSheetFilePaththe data sheet file path you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the number of characters or strDataSheetFilePath exceeds the size limit 1024
  • EW_FILE_NOT_FOUND if strDataSheetFilePath file not found
  • EW_NO_ERROR No error detected

◆ setDepth()

EwErrorCode IEwProjectManufacturerPartX::setDepth ( DOUBLE  dDepth)

Set the depth in millimeters of the current manufacturer part.

Since
2023 SP0
Parameters
[in]dDepththe new depth you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the dDepth is negative
  • EW_NO_ERROR No error detected

◆ setDescription()

EwErrorCode IEwProjectManufacturerPartX::setDescription ( BSTR  strLanguageCode,
BSTR  strDescription 
)

Set the manufacturer part description.

Since
2023 SP0
Parameters
[in]strLanguageCodeThe language of the description you want to set (like 'en' for english or 'fr' for french )
[in]strDescriptionThe description you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if strLanguageCode is not valid, or strDescription exceeds the size limit 255
  • EW_NO_ERROR if no error detected

◆ setEwManufacturerPartType()

EwErrorCode IEwProjectManufacturerPartX::setEwManufacturerPartType ( EwManufacturerPartType  eManufacturerPartType)

Set the base type (EwManufacturerPartType enum) of the current manufacturer part.

Since
2023 SP0
Parameters
[in]eManufacturerPartTypethe EwManufacturerPartType enum value for the base type you want to assign to this manufacturer part.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setExcludeFromBillOfMaterials()

EwErrorCode IEwProjectManufacturerPartX::setExcludeFromBillOfMaterials ( VARIANT_BOOL  bIsExcludeFromBOM)

Set if current manufacturer part is to exclude from bill of materials.

Since
2021 SP0
Parameters
[in]bIsExcludeFromBOMTrue if it is to exclude from bill of materials else false
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected

◆ 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_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected

◆ setHarnessID()

EwErrorCode IEwProjectManufacturerPartX::setHarnessID ( long  lHarnessID)

Set the Harness ID of this manufacturer part.

manufacturer part will be added to the harness after calling update or insert. Harness must exists to be able to set the ID. Setting the ID to -1 will remove the manufacturer part from the harness.

Since
2021 SP0
Parameters
[in]lHarnessIDThe Harness ID to set.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid
  • EW_BAD_INPUTS if the lHarnessID is not found
  • EW_NO_ERROR if no error detected

◆ setHeight()

EwErrorCode IEwProjectManufacturerPartX::setHeight ( DOUBLE  dHeight)

Set the height in millimeters of the current manufacturer part.

Since
2023 SP0
Parameters
[in]dHeightthe new height you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the dHeight is negative
  • EW_NO_ERROR No error detected

◆ setLength()

EwErrorCode IEwProjectManufacturerPartX::setLength ( DOUBLE  dLength)

Set the length in millimeters of the current manufacturer part.

Since
2023 SP0
Parameters
[in]dLengththe new length you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the dLength is negative
  • EW_NO_ERROR No error detected

◆ setLineDiagramSymbolID()

EwErrorCode IEwProjectManufacturerPartX::setLineDiagramSymbolID ( long  lID)

Set the line diagram symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDthe line diagram symbol ID you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if symbol was not found by lID

◆ setManufacturer()

EwErrorCode IEwProjectManufacturerPartX::setManufacturer ( BSTR  strManufacturerName)

Set the manufacturer name of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strManufacturerNameThe manufacturer name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if the number of characters of strManufacturerName exceeds the size limit 70
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setManufacturerDataValue()

EwErrorCode IEwProjectManufacturerPartX::setManufacturerDataValue ( EwManufacturerDataIndex  eIndexValue,
BSTR  strManufacturerDataValue 
)

Set a manufacturer data value associated to the current manufacturer part.

Since
2023 SP0
Parameters
[in]eIndexValueEwManufacturerDataIndex enum type corresponding to the index of manufacturer data to apply the value to.
[in]strManufacturerDataValueis the manufacturer data value to apply.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT wrong manufacturer part is called, or manufacturer part doesn't belong to a specific class
  • EW_FILE_NOT_FOUND unable to find the user data description file
  • EW_INVALID_INDEX unavailable field for this manufacturer part (on the given index eIndexValue)
  • EW_NO_ERROR if no error detected

◆ setObjectID()

EwErrorCode IEwProjectManufacturerPartX::setObjectID ( long  lID)

Sets the ID of the object to associate with the manufacturer part.

Object associated with the ID must exists. Can only be done before inserting the manufacturer part. Could be Component, Location or Harness.

Parameters
[in]lIDID of the Object
Returns
EwErrorCode enum type, can be:
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected

◆ setReference()

EwErrorCode IEwProjectManufacturerPartX::setReference ( BSTR  strReference)

Set the reference name of this manufacturer part.

Since
2023 SP0
Parameters
[in]strReferenceThe reference name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if the number of characters of strReference exceeds the size limit 150
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setSchemeSymbolID()

EwErrorCode IEwProjectManufacturerPartX::setSchemeSymbolID ( long  lID)

Set the schematic symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDthe schematic symbol ID you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if symbol was not found by lID

◆ setSeries()

EwErrorCode IEwProjectManufacturerPartX::setSeries ( BSTR  strSeries)

Set the series of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strSeriesthe series you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if the number of characters of strSeries exceeds the size limit 255
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setStockNumber()

EwErrorCode IEwProjectManufacturerPartX::setStockNumber ( BSTR  strStockNumber)

Set the stock number of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strStockNumberthe stock number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the number of characters of strStockNumber exceeds the size limit 150
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR No error detected

◆ setSupplierName()

EwErrorCode IEwProjectManufacturerPartX::setSupplierName ( BSTR  strSupplierName)

Set the supplier name of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strSupplierNamethe supplier name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the number of characters of strSupplierName exceeds the size limit 70
  • EW_NO_ERROR No error detected

◆ setTerminalStripSymbolID()

EwErrorCode IEwProjectManufacturerPartX::setTerminalStripSymbolID ( long  lID)

Set the terminal strip symbol ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDID of the terminal strip symbol you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if symbol was not found by lID

◆ setTerminalTypeID()

EwErrorCode IEwProjectManufacturerPartX::setTerminalTypeID ( long  lID)

Set the terminal type ID of the current manufacturer part.

Since
2023 SP0
Parameters
[in]lIDID of the terminal type you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if lID is negative
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
  • EW_OBJECT_NOT_FOUND if terminal type was not found by lID

◆ setTranslatedData()

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

Set the value of a translated text.

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

◆ setUseFrequency()

EwErrorCode IEwProjectManufacturerPartX::setUseFrequency ( BSTR  strUseFrequency)

Set the use frequency of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strUseFrequencyThe use frequency you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strUseFrequency exceeds the defined size limit 70
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected

◆ setUserData()

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

Set user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
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

◆ setUseVoltage()

EwErrorCode IEwProjectManufacturerPartX::setUseVoltage ( BSTR  strUseVoltage)

Set the use voltage of the current manufacturer part.

Since
2023 SP0
Parameters
[in]strUseVoltageThe use voltage you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strUseVoltage exceeds the defined size limit 70
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_NO_ERROR if no error detected

◆ setWeight()

EwErrorCode IEwProjectManufacturerPartX::setWeight ( DOUBLE  dWeight)

Set the weight of the current manufacturer part.

Since
2023 SP0
Parameters
[in]dWeightThe weight in grams
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if weight is negative
  • EW_NO_ERROR if no error detected

◆ setWidth()

EwErrorCode IEwProjectManufacturerPartX::setWidth ( DOUBLE  dWidth)

Set the width in millimeters of the current manufacturer part.

Since
2023 SP0
Parameters
[in]dWidthThe new width you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the dWidth is negative
  • EW_NO_ERROR No error detected


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) 2024 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.