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

Inheritance diagram for IEwManufacturerPartX:

Public Member Functions
IEwManufacturerPartCircuitX	addEwManufacturerPartCircuit (BSTR strCircuitCode, EwErrorCode *errorCode)
	Create and add a circuit for this manufacturer part. More...

EwErrorCode	deleteEwManufacturerPartCircuitAt (LONG index)
	Delete a circuit from this manufacturer part. More...

LONG	getEwManufacturerPartCircuitCount ()
	Count the number of circuit in this manufacturer part. More...

IEwManufacturerPartCircuitX	getEwManufacturerPartCircuitAt (LONG index, EwErrorCode *errorCode)
	Get an object inside this manufacturer part. More...

BSTR	getDescription (BSTR lgCode, EwErrorCode *errorCode)
	Get a description of this manufacturer parts. More...

EwErrorCode	setDescription (BSTR lgCode, BSTR strValue)
	Set a description of this manufacturer part. More...

BSTR	getCommercialReference (BSTR lgCode, EwErrorCode *errorCode)
	Get a commercial reference of this manufacturer part. More...

EwErrorCode	setCommercialReference (BSTR lgCode, BSTR strValue)
	Set a commercial reference of this manufacturer part. More...

BSTR	getReference (EwErrorCode *errorCode)
	Get the reference of this manufacturer part. More...

EwErrorCode	setReference (BSTR strReference)
	Set the reference of this manufacturer part. More...

BSTR	getManufacturer (EwErrorCode *errorCode)
	Get the manufacturer of this manufacturer part. More...

EwErrorCode	setManufacturer (BSTR strManufacturer)
	Set the manufacturer of this manufacturer part. More...

LONG	getClassNodeID (EwErrorCode *errorCode)

EwErrorCode	setClassNodeID (LONG lNodeId)

BSTR	getLibraryCode (EwErrorCode *errorCode)
	Get the library code of this manufacturer part. More...

EwErrorCode	setLibraryCode (BSTR strLibraryCode)
	Set the library code of this manufacturer part. More...

BSTR	getArticleNumber (EwErrorCode *errorCode)
	Get the article number of this manufacturer part. More...

EwErrorCode	setArticleNumber (BSTR strArticleNumber)
	Set the article number of this manufacturer part. More...

BSTR	getRootMark (EwErrorCode *errorCode)
	Get the root mark of this manufacturer part. More...

EwErrorCode	setRootMark (BSTR strRootMark)
	Set the root mark of this manufacturer part. More...

BSTR	getSerie (EwErrorCode *errorCode)
	Get the series of this manufacturer part. More...

BSTR	getSupplierName (EwErrorCode *errorCode)
	Get the supplier name of this manufacturer part. More...

EwErrorCode	setSupplierName (BSTR strSupplierName)
	Set the supplier name of this manufacturer part. More...

BSTR	getStockNumber (EwErrorCode *errorCode)
	Get the stock number of this manufacturer part. More...

EwErrorCode	setStockNumber (BSTR strStockNumber)
	Set the stock number of this manufacturer part. More...

BSTR	getLineDiagramSymbolName (EwErrorCode *errorCode)
	Get the line diagram symbol name. More...

EwErrorCode	setLineDiagramSymbolName (BSTR strLineDiagramSymbolName)
	Set the line diagram symbol name. More...

BSTR	getSchemeSymbolName (EwErrorCode *errorCode)
	Get the scheme symbol name. More...

EwErrorCode	setSchemeSymbolName (BSTR strSchemeSymbolName)
	Set the scheme symbol name. More...

BSTR	get3DPartPath (EwErrorCode *errorCode)
	Get the 3D part associated with this manufacturer part. More...

EwErrorCode	set3DPartPath (BSTR str3DPartPath)
	Set the 3D part associated with this manufacturer part. More...

BSTR	get2DFootprintSymbolName (EwErrorCode *errorCode)
	Get the 2D Footprint Symbol Name. More...

EwErrorCode	set2DFootprintSymbolName (BSTR str2DFootprintSymbolName)
	Set the 2D Footprint Symbol Name. More...

BSTR	get2DConnectionLabelSymbolName (EwErrorCode *errorCode)
	Get the 2D Connection label Symbol Name. More...

EwErrorCode	set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName)
	Set the 2D Connection label Symbol Name. More...

EwErrorCode	setWidth (DOUBLE dWidth)
	Set the width in millimeters of this manufacturer part. More...

EwErrorCode	setHeight (DOUBLE dHeight)
	Set the height in millimeters of this manufacturer part. More...

EwErrorCode	setDepth (DOUBLE dDepth)
	Set the depth in millimeters of this manufacturer part. More...

EwErrorCode	setUseVoltage (BSTR strUseVoltage)
	Set the use voltage of this manufacturer part. More...

EwErrorCode	setUseFrequency (BSTR strUseFrequency)
	Set the use frequency of this manufacturer part. More...

EwErrorCode	setControlVoltage (BSTR strControlVoltage)
	Set the control voltage of this manufacturer part. More...

EwErrorCode	setControlFrequency (BSTR strControlFrequency)
	Set the control frequency of this manufacturer part. More...

BSTR	getValue (LONG lValueId, EwErrorCode *errorCode)
	Get manufacturer value according to part classification. More...

EwErrorCode	setValue (LONG lValueId, BSTR strValue)
	Set manufacturer value according to part classification. More...

EwManufacturerPartType	getEwManufacturerPartType (EwErrorCode *errorCode)
	Get the base type of this manufacturer part. More...

EwErrorCode	setEwManufacturerPartType (EwManufacturerPartType eManufacturerPartType)
	Set the base type of this manufacturer part. More...

EwErrorCode	setSerie (BSTR strSeries)
	Set the series of this manufacturer part. More...

DOUBLE	getWidth (EwErrorCode *ewErrorCode)
	Get the width in millimeters of this manufacturer part. More...

DOUBLE	getHeight (EwErrorCode *errorCode)
	Get the Height in millimeters of this manufacturer part. More...

DOUBLE	getDepth (EwErrorCode *errorCode)
	Get the Depth in millimeters of this manufacturer part. More...

BSTR	getUseVoltage (EwErrorCode *ewErrorCode)
	Get the UseVoltage of this manufacturer part. More...

BSTR	getUseFrequency (EwErrorCode *ewErrorCode)
	Get the UseFrequency of this manufacturer part. More...

BSTR	getControlVoltage (EwErrorCode *errorCode)
	Get the ControlVoltage of this manufacturer part. More...

BSTR	getControlFrequency (EwErrorCode *ewErrorCode)
	Get the ControlFrequency of this manufacturer part. More...

BSTR	getExternalID (EwErrorCode *errorCode)
	Get external identifier of this manufacturer part. More...

EwErrorCode	setExternalID (BSTR strExternalID)
	Set the external identifier of this manufacturer part. More...

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

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

IEwClassificationX	getClassification (EwErrorCode *errorCode)
	Get the classification of the current manufacturer part. More...

VARIANT	getManufacturerPartArray (EwErrorCode *errorCode)
	Return array of manufacturer parts from a Electrical Assembly. More...

EwErrorCode	addEwManufacturerPart (IEwManufacturerPartX *iManufacturerPartX)
	Add a new manufacturer parts from the current Electrical Assembly. More...

EwErrorCode	addEwManufacturerPartAt (int iIndex, IEwManufacturerPartX *iManufacturerPartX)
	Add a new manufacturer parts from the current Electrical Assembly at the specified position. More...

IEwManufacturerPartX	getEwManufacturerPartAt (int iIndex, EwErrorCode *errorCode)
	Return the specified manufacturer parts from the current Electrical Assembly. More...

int	getEwManufacturerPartCount (EwErrorCode *errorCode)
	Return the number of manufacturer parts from the current Electrical Assembly. More...

EwErrorCode	deleteEwManufacturerPartAt (int iIndex)
	Remove a manufacturer parts specified by the index from the current Electrical Assembly. More...

EwErrorCode	deleteAllEwManufacturerPart ()
	Remove all manufacturer parts from the current Electrical Assembly. More...

EwErrorCode	setWeight (DOUBLE dWeight)
	Set the weight of this manufacturer part. More...

DOUBLE	getWeight (EwErrorCode *errorCode)
	Get the weight in grams of this manufacturer part. More...

LONG	getClassID (EwErrorCode *errorCode)
	Get the class ID of manufacturer part. More...

EwErrorCode	setClassID (LONG lID)
	Set the class ID of this manufacturer part. More...

IEwManufacturerPartX	duplicate (EwErrorCode *errorCode)
	Duplicate current manufacturer part. More...

Public Member Functions inherited from IEwEnvironmentObjectX
DATE	getCreationDate (EwErrorCode *errorCode)
	Get the creation date of the current object. More...

DATE	getModificationDate (EwErrorCode *errorCode)
	Get the last modification date of the current object. More...

EwCreatorType	getEwCreatorType (EwErrorCode *errorCode)
	Get the creator of the current object. More...

BSTR	getModifiedBy (EwErrorCode *eErrorCode)
	Get the last user name that modified the current object. More...

BSTR	getCreatedBy (EwErrorCode *eErrorCode)
	Get the user name that created the current 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...

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 a manufacturer part.

Since: 2018 SP0

Member Function Documentation

◆ addEwManufacturerPart()

EwErrorCode IEwManufacturerPartX::addEwManufacturerPart ( IEwManufacturerPartX * iManufacturerPartX )

Add a new manufacturer parts from the current Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Parameters

[in] iManufacturerPartX the IEwManufacturerPartX class object to insert.

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized or is not an inserted Electrical Assembly.
EW_BAD_INPUTS if the iManufacturerPartX is an Electrical Assembly or EwManufacturerPartX to add is not inserted.
EW_UNDEFINED_ERROR if another error occurred

◆ addEwManufacturerPartAt()

EwErrorCode IEwManufacturerPartX::addEwManufacturerPartAt	(	int	iIndex,
		IEwManufacturerPartX *	iManufacturerPartX
	)

Add a new manufacturer parts from the current Electrical Assembly at the specified position.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Parameters

[in]	iIndex	Position where the manufacturer parts will be insert.
[in]	iManufacturerPartX	the IEwManufacturerPartX class object to insert.

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized or is not an inserted Electrical Assembly.
EW_BAD_INPUTS if the index is greater than the number of manufacturer parts or negative.
EW_BAD_INPUTS if the iManufacturerPartX is an Electrical Assembly.
EW_UNDEFINED_ERROR if another error occurred

◆ addEwManufacturerPartCircuit()

IEwManufacturerPartCircuitX IEwManufacturerPartX::addEwManufacturerPartCircuit	(	BSTR	strCircuitCode,
		EwErrorCode *	errorCode
	)

Create and add a circuit for this manufacturer part.

Parameters

[in]	strCircuitCode	The type of circuit (like TA0 for NO contact)
[out]	errorCode	EwErrorCode 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 circuit created and added

◆ deleteAllEwManufacturerPart()

EwErrorCode IEwManufacturerPartX::deleteAllEwManufacturerPart ( )

Remove all manufacturer parts from the current Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized or is not an Electrical Assembly.
EW_UNDEFINED_ERROR if another error occurred

◆ deleteEwManufacturerPartAt()

EwErrorCode IEwManufacturerPartX::deleteEwManufacturerPartAt ( int iIndex )

Remove a manufacturer parts specified by the index from the current Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Parameters

[in] iIndex the index of the manufacturer parts to remove.

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized or is not an Electrical Assembly.
EW_BAD_INPUTS if the index is greater than the number of manufacturer parts or negative.
EW_UNDEFINED_ERROR if another error occurred

◆ deleteEwManufacturerPartCircuitAt()

EwErrorCode IEwManufacturerPartX::deleteEwManufacturerPartCircuitAt ( LONG index )

Delete a circuit from this manufacturer part.

Parameters

[in] index The index of circuit you want to delete

Returns

EwErrorCode 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
EW_BAD_INPUTS if index is not valid

◆ duplicate()

IEwManufacturerPartX IEwManufacturerPartX::duplicate ( EwErrorCode * errorCode )

Duplicate current manufacturer part.

Warning: The duplicate object must call insert to be save.

Since: 2023 SP1

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if object is not initialized
EW_OBJECT_NOT_FOUND impossible to duplicate
EW_NO_ERROR if no error detected

Returns: a copy of current manufacturer part.

◆ get2DConnectionLabelSymbolName()

BSTR IEwManufacturerPartX::get2DConnectionLabelSymbolName ( EwErrorCode * errorCode )

Get the 2D Connection label Symbol Name.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain a symbol name

◆ get2DFootprintSymbolName()

BSTR IEwManufacturerPartX::get2DFootprintSymbolName ( EwErrorCode * errorCode )

Get the 2D Footprint Symbol Name.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain a symbol name

◆ get3DPartPath()

BSTR IEwManufacturerPartX::get3DPartPath ( EwErrorCode * errorCode )

Get the 3D part associated with this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the path to the 3D part (can by empty)

◆ getArticleNumber()

BSTR IEwManufacturerPartX::getArticleNumber ( EwErrorCode * errorCode )

Get the article number of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the article number

◆ getClassID()

LONG IEwManufacturerPartX::getClassID ( EwErrorCode * errorCode )

Get the class ID of manufacturer part.

Since: 2023 SP0 -1 Unknown class, not initialized. -2 Unclassified elements, Minimum valid value.

Parameters

[out]

errorCode

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

Returns: the ID of manufacturer part.

◆ getClassification()

IEwClassificationX IEwManufacturerPartX::getClassification ( EwErrorCode * errorCode )

Get the classification of the current manufacturer part.

Since

2022 SP0 param[out] errorCode EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if another error occurred
EW_OBJECT_NOT_FOUND classification not found
EW_INVALID_OBJECT if manufacturer part is invalid

Returns: EwAdClassification object of manufacturer part

◆ getClassNodeID()

LONG IEwManufacturerPartX::getClassNodeID ( EwErrorCode * errorCode )

Warning: This interface is deprecated, use getClassID instead. Get the classification node ID of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the classification node id

◆ getCommercialReference()

BSTR IEwManufacturerPartX::getCommercialReference	(	BSTR	lgCode,
		EwErrorCode *	errorCode
	)

Get a commercial reference of this manufacturer part.

Parameters

[in]	lgCode	The language of the commercial reference you want to get (like 'en' for english or 'fr' for french )
[out]	errorCode	EwErrorCode 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 EW_BAD_INPUTS if lgCode is not valid

Returns: The commercial reference contained in this manufacturer parts

◆ getControlFrequency()

BSTR IEwManufacturerPartX::getControlFrequency ( EwErrorCode * ewErrorCode )

Get the ControlFrequency of this manufacturer part.

Parameters

[out]

ewErrorCode

EwErrorCode 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: BSTR ControlFrequency

◆ getControlVoltage()

BSTR IEwManufacturerPartX::getControlVoltage ( EwErrorCode * errorCode )

Get the ControlVoltage of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode 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: BSTR ControlVoltage

◆ getDepth()

DOUBLE IEwManufacturerPartX::getDepth ( EwErrorCode * errorCode )

Get the Depth in millimeters of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode 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

◆ getDescription()

BSTR IEwManufacturerPartX::getDescription	(	BSTR	lgCode,
		EwErrorCode *	errorCode
	)

Get a description of this manufacturer parts.

Parameters

[in]	lgCode	The language of the description you want to get (like 'en' for english or 'fr' for french )
[out]	errorCode	EwErrorCode 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 EW_BAD_INPUTS if lgCode is not valid

Returns: The description contained in this manufacturer parts

◆ getEwManufacturerPartAt()

IEwManufacturerPartX IEwManufacturerPartX::getEwManufacturerPartAt	(	int	iIndex,
		EwErrorCode *	errorCode
	)

Return the specified manufacturer parts from the current Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Parameters

[in]	iIndex	Position of the manufacturer parts.
[out]	errorCode	EwErrorCode enum type, can be: EW_NO_ERROR if no error detected EW_INVALID_OBJECT if object is not initialized or is not an Electrical Assembly. EW_BAD_INPUTS if if the index is greater than the number of manufacturer parts or negative. EW_OBJECT_NOT_FOUND no reference found. EW_UNDEFINED_ERROR if another error occurred

Returns: An IEwManufacturerPartX specified or null if the current manufacturer part is not an Electrical Assembly.

◆ getEwManufacturerPartCircuitAt()

IEwManufacturerPartCircuitX IEwManufacturerPartX::getEwManufacturerPartCircuitAt	(	LONG	index,
		EwErrorCode *	errorCode
	)

Get an object inside this manufacturer part.

Parameters

[in]	index	The index of circuit you want to get
[out]	errorCode	EwErrorCode 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 EW_BAD_INPUTS if index is not valid

Returns: The circuit

◆ getEwManufacturerPartCircuitCount()

LONG IEwManufacturerPartX::getEwManufacturerPartCircuitCount ( )

Count the number of circuit in this manufacturer part.

Returns: The number of circuit or -1 if this object was not initialized

◆ getEwManufacturerPartCount()

int IEwManufacturerPartX::getEwManufacturerPartCount ( EwErrorCode * errorCode )

Return the number of manufacturer parts from the current Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized or is not an Electrical Assembly.
EW_UNDEFINED_ERROR if another error occurred

the number of manufacturer parts from the current Electrical Assembly.

◆ getEwManufacturerPartType()

EwManufacturerPartType IEwManufacturerPartX::getEwManufacturerPartType ( EwErrorCode * errorCode )

Get the base type of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode 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 type id of this object

◆ getExcludeFromBillOfMaterials()

VARIANT_BOOL IEwManufacturerPartX::getExcludeFromBillOfMaterials ( EwErrorCode * errorCode )

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

Since: 2021 SP0

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if manufacturer part is invalid

Returns: True if the manufacturer is exclude from bill of materials else false

◆ getExternalID()

BSTR IEwManufacturerPartX::getExternalID ( EwErrorCode * errorCode )

Get external identifier of this manufacturer part.

Since: 2019

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the external identifier in this manufacturer part

◆ getHeight()

DOUBLE IEwManufacturerPartX::getHeight ( EwErrorCode * errorCode )

Get the Height in millimeters of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode 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 Height

◆ getLibraryCode()

BSTR IEwManufacturerPartX::getLibraryCode ( EwErrorCode * errorCode )

Get the library code of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the library code

◆ getLineDiagramSymbolName()

BSTR IEwManufacturerPartX::getLineDiagramSymbolName ( EwErrorCode * errorCode )

Get the line diagram symbol name.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the symbol name

◆ getManufacturer()

BSTR IEwManufacturerPartX::getManufacturer ( EwErrorCode * errorCode )

Get the manufacturer of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the manufacturer

◆ getManufacturerPartArray()

VARIANT IEwManufacturerPartX::getManufacturerPartArray ( EwErrorCode * errorCode )

Return array of manufacturer parts from a Electrical Assembly.

Since: 2022 SP0 Only available if this manufacturer part is an Electrical Assembly.

Parameters

[out]

errorCode

EwErrorCode 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 or is not an Electrical Assembly.

Returns: pXArray array of manufacturer parts or null if the current manufacturer part is not an Electrical Assembly.

◆ getReference()

BSTR IEwManufacturerPartX::getReference ( EwErrorCode * errorCode )

Get the reference of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the reference

◆ getRootMark()

BSTR IEwManufacturerPartX::getRootMark ( EwErrorCode * errorCode )

Get the root mark of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the root mark

◆ getSchemeSymbolName()

BSTR IEwManufacturerPartX::getSchemeSymbolName ( EwErrorCode * errorCode )

Get the scheme symbol name.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the symbol name

◆ getSerie()

BSTR IEwManufacturerPartX::getSerie ( EwErrorCode * errorCode )

Get the series of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the series

◆ getStockNumber()

BSTR IEwManufacturerPartX::getStockNumber ( EwErrorCode * errorCode )

Get the stock number of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the stock number

◆ getSupplierName()

BSTR IEwManufacturerPartX::getSupplierName ( EwErrorCode * errorCode )

Get the supplier name of this manufacturer part.

Parameters

[out]

errorCode

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if an error occurred

Returns: will contain the supplier name

◆ getUseFrequency()

BSTR IEwManufacturerPartX::getUseFrequency ( EwErrorCode * ewErrorCode )

Get the UseFrequency of this manufacturer part.

Parameters

[out]

ewErrorCode

EwErrorCode 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: BSTR UseFrequency

◆ getUserData()

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

Get user data of the object.

Parameters

[in]	nUserDataNumber	number of the user data
[out]	errorCode	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 another error occurred EW_INVALID_OBJECT if object is not initialized

Returns: value of the user data requested

◆ getUseVoltage()

BSTR IEwManufacturerPartX::getUseVoltage ( EwErrorCode * ewErrorCode )

Get the UseVoltage of this manufacturer part.

Parameters

[out]

ewErrorCode

EwErrorCode 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: BSTR UseVoltage

◆ getValue()

BSTR IEwManufacturerPartX::getValue	(	LONG	lValueId,
		EwErrorCode *	errorCode
	)

Get manufacturer value according to part classification.

Parameters

[in]	lValueId	Index of value, must be between 0 and 6
[out]	errorCode	EwErrorCode 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 EW_BAD_INPUTS if lValueId not between 0 and 6

Returns: will contain the value of this field

◆ getWeight()

DOUBLE IEwManufacturerPartX::getWeight ( EwErrorCode * errorCode )

Get the weight in grams of this manufacturer part.

Since: 2023 SP0

Parameters

[out]

errorCode

EwErrorCode 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 weight

◆ getWidth()

DOUBLE IEwManufacturerPartX::getWidth ( EwErrorCode * ewErrorCode )

Get the width in millimeters of this manufacturer part.

Parameters

[out]

ewErrorCode

EwErrorCode 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 width

◆ set2DConnectionLabelSymbolName()

EwErrorCode IEwManufacturerPartX::set2DConnectionLabelSymbolName ( BSTR str2DConnectionLabelSymbolName )

Set the 2D Connection label Symbol Name.

Parameters

[in] str2DConnectionLabelSymbolName The symbol name you want to set

Returns

EwErrorCode 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

◆ set2DFootprintSymbolName()

EwErrorCode IEwManufacturerPartX::set2DFootprintSymbolName ( BSTR str2DFootprintSymbolName )

Set the 2D Footprint Symbol Name.

Parameters

[in] str2DFootprintSymbolName The symbol name you want to set

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized
EW_UNDEFINED_ERROR if another error occurred

◆ set3DPartPath()

EwErrorCode IEwManufacturerPartX::set3DPartPath ( BSTR str3DPartPath )

Set the 3D part associated with this manufacturer part.

Parameters

[in] str3DPartPath The 3D part you want to associate (absolute)

Returns

EwErrorCode 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
EW_BAD_INPUTS if path not exist

◆ setArticleNumber()

EwErrorCode IEwManufacturerPartX::setArticleNumber ( BSTR strArticleNumber )

Set the article number of this manufacturer part.

Parameters

[in] strArticleNumber The article number you want to set

Returns

EwErrorCode 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

◆ setClassID()

EwErrorCode IEwManufacturerPartX::setClassID ( LONG lID )

Set the class ID of this manufacturer part.

Since: 2023 SP0

Parameters

[in] lID new 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

◆ setClassNodeID()

EwErrorCode IEwManufacturerPartX::setClassNodeID ( LONG lNodeId )

Warning: This interface is deprecated, use setClassID instead. Set the classification node ID of this manufacturer part.

Parameters

[in] lNodeId The classification node id you want to set

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_INVALID_OBJECT if object is not initialized
EW_UNDEFINED_ERROR if another error occurred

◆ setCommercialReference()

EwErrorCode IEwManufacturerPartX::setCommercialReference	(	BSTR	lgCode,
		BSTR	strValue
	)

Set a commercial reference of this manufacturer part.

Parameters

[in]	lgCode	The language of the commercial reference you want to set (like 'en' for english or 'fr' for french )
[in]	strValue	The commercial reference

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_BAD_INPUTS if lgCode is not valid
EW_INVALID_OBJECT if object is not initialized
EW_UNDEFINED_ERROR if another error occurred

◆ setControlFrequency()

EwErrorCode IEwManufacturerPartX::setControlFrequency ( BSTR strControlFrequency )

Set the control frequency of this manufacturer part.

Parameters

[in] strControlFrequency The frequency

Returns

EwErrorCode 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

◆ setControlVoltage()

EwErrorCode IEwManufacturerPartX::setControlVoltage ( BSTR strControlVoltage )

Set the control voltage of this manufacturer part.

Parameters

[in] strControlVoltage The voltage

Returns

EwErrorCode 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

◆ setDepth()

EwErrorCode IEwManufacturerPartX::setDepth ( DOUBLE dDepth )

Set the depth in millimeters of this manufacturer part.

Parameters

[in] dDepth The depth in millimeters

Returns

EwErrorCode 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

◆ setDescription()

EwErrorCode IEwManufacturerPartX::setDescription	(	BSTR	lgCode,
		BSTR	strValue
	)

Set a description of this manufacturer part.

Parameters

[in]	lgCode	The language of the description you want to set (like 'en' for english or 'fr' for french )
[in]	strValue	The description

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_BAD_INPUTS if lgCode is not valid
EW_INVALID_OBJECT if object is not initialized
EW_UNDEFINED_ERROR if another error occurred

◆ setEwManufacturerPartType()

EwErrorCode IEwManufacturerPartX::setEwManufacturerPartType ( EwManufacturerPartType eManufacturerPartType )

Set the base type of this manufacturer part.

Parameters

[in] eManufacturerPartType The type id you want to assign to this manufacturer part

Returns

EwErrorCode 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 or is an electrical assembly

◆ setExcludeFromBillOfMaterials()

EwErrorCode IEwManufacturerPartX::setExcludeFromBillOfMaterials ( VARIANT_BOOL bIsExcludeFromBOM )

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

Since: 2021 SP0

Parameters

[in] bIsExcludeFromBOM True if it is to exclude from bill of materials else false

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if manufacturer part is invalid

◆ setExternalID()

EwErrorCode IEwManufacturerPartX::setExternalID ( BSTR strExternalID )

Set the external identifier of this manufacturer part.

Since: 2019

Parameters

[in] strExternalID The external identifier you want to set

Returns

EwErrorCode 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

◆ setHeight()

EwErrorCode IEwManufacturerPartX::setHeight ( DOUBLE dHeight )

Set the height in millimeters of this manufacturer part.

Parameters

[in] dHeight The height in millimeters

Returns

EwErrorCode 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

◆ setLibraryCode()

EwErrorCode IEwManufacturerPartX::setLibraryCode ( BSTR strLibraryCode )

Set the library code of this manufacturer part.

Parameters

[in] strLibraryCode The library code you want to set

Returns

EwErrorCode 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

◆ setLineDiagramSymbolName()

EwErrorCode IEwManufacturerPartX::setLineDiagramSymbolName ( BSTR strLineDiagramSymbolName )

Set the line diagram symbol name.

Parameters

[in] strLineDiagramSymbolName The symbol name you want to set

Returns

EwErrorCode 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

◆ setManufacturer()

EwErrorCode IEwManufacturerPartX::setManufacturer ( BSTR strManufacturer )

Set the manufacturer of this manufacturer part.

Parameters

[in] strManufacturer The manufacturer 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 manufacturer is Empty
EW_NO_ERROR if no error detected

◆ setReference()

EwErrorCode IEwManufacturerPartX::setReference ( BSTR strReference )

Set the reference of this manufacturer part.

Parameters

[in] strReference The reference 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 reference is Empty
EW_NO_ERROR if no error detected

◆ setRootMark()

EwErrorCode IEwManufacturerPartX::setRootMark ( BSTR strRootMark )

Set the root mark of this manufacturer part.

Parameters

[in] strRootMark The root mark you want to set

Returns

EwErrorCode 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

◆ setSchemeSymbolName()

EwErrorCode IEwManufacturerPartX::setSchemeSymbolName ( BSTR strSchemeSymbolName )

Set the scheme symbol name.

Parameters

[in] strSchemeSymbolName The symbol name you want to set

Returns

EwErrorCode 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

◆ setSerie()

EwErrorCode IEwManufacturerPartX::setSerie ( BSTR strSeries )

Set the series of this manufacturer part.

Parameters

[in] strSeries series do you want to assign to this manufacturer part

Returns

EwErrorCode 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

◆ setStockNumber()

EwErrorCode IEwManufacturerPartX::setStockNumber ( BSTR strStockNumber )

Set the stock number of this manufacturer part.

Parameters

[in] strStockNumber The stock number you want to set

Returns

EwErrorCode 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

◆ setSupplierName()

EwErrorCode IEwManufacturerPartX::setSupplierName ( BSTR strSupplierName )

Set the supplier name of this manufacturer part.

Parameters

[in] strSupplierName The supplier name you want to set

Returns

EwErrorCode 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

◆ setUseFrequency()

EwErrorCode IEwManufacturerPartX::setUseFrequency ( BSTR strUseFrequency )

Set the use frequency of this manufacturer part.

Parameters

[in] strUseFrequency The frequency

Returns

EwErrorCode 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

◆ setUserData()

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

Set user data of the object.

Parameters

[in]	nUserDataNumber	number of the user data
[in]	strValue	value 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 another error occurred
EW_INVALID_OBJECT if object is not initialized

◆ setUseVoltage()

EwErrorCode IEwManufacturerPartX::setUseVoltage ( BSTR strUseVoltage )

Set the use voltage of this manufacturer part.

Parameters

[in] strUseVoltage The voltage

Returns

EwErrorCode 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

◆ setValue()

EwErrorCode IEwManufacturerPartX::setValue	(	LONG	lValueId,
		BSTR	strValue
	)

Set manufacturer value according to part classification.

Parameters

[in]	lValueId	Index of value, must be between 0 and 6
[in]	strValue	The value you want to set

Returns

EwErrorCode 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
EW_BAD_INPUTS if lValueId not between 0 and 6

◆ setWeight()

EwErrorCode IEwManufacturerPartX::setWeight ( DOUBLE dWeight )

Set the weight of this manufacturer part.

Since: 2023 SP0

Parameters

[in] dWeight The weight in grams

Returns

EwErrorCode enum type, can be:

EW_NO_ERROR if no error detected
EW_BAD_INPUTS if weight is negative
EW_UNDEFINED_ERROR if another error occurred
EW_INVALID_OBJECT if object is not initialized

◆ setWidth()

EwErrorCode IEwManufacturerPartX::setWidth ( DOUBLE dWidth )

Set the width in millimeters of this manufacturer part.

Parameters

[in] dWidth The width in millimeters

Returns

EwErrorCode 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


*Email:
Subject:		Feedback on Help Topics
Page:		SOLIDWORKS Electrical API: IEwManufacturerPartX 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

Public Member Functions

Detailed Description

Member Function Documentation

◆ addEwManufacturerPart()

◆ addEwManufacturerPartAt()

◆ addEwManufacturerPartCircuit()

◆ deleteAllEwManufacturerPart()

◆ deleteEwManufacturerPartAt()

◆ deleteEwManufacturerPartCircuitAt()

◆ duplicate()

◆ get2DConnectionLabelSymbolName()

◆ get2DFootprintSymbolName()

◆ get3DPartPath()

◆ getArticleNumber()

◆ getClassID()

◆ getClassification()

◆ getClassNodeID()

◆ getCommercialReference()

◆ getControlFrequency()

◆ getControlVoltage()

◆ getDepth()

◆ getDescription()

◆ getEwManufacturerPartAt()

◆ getEwManufacturerPartCircuitAt()

◆ getEwManufacturerPartCircuitCount()

◆ getEwManufacturerPartCount()

◆ getEwManufacturerPartType()

◆ getExcludeFromBillOfMaterials()

◆ getExternalID()

◆ getHeight()

◆ getLibraryCode()

◆ getLineDiagramSymbolName()

◆ getManufacturer()

◆ getManufacturerPartArray()

◆ getReference()

◆ getRootMark()

◆ getSchemeSymbolName()

◆ getSerie()

◆ getStockNumber()

◆ getSupplierName()

◆ getUseFrequency()

◆ getUserData()

◆ getUseVoltage()

◆ getValue()

◆ getWeight()

◆ getWidth()

◆ set2DConnectionLabelSymbolName()

◆ set2DFootprintSymbolName()

◆ set3DPartPath()

◆ setArticleNumber()

◆ setClassID()

◆ setClassNodeID()

◆ setCommercialReference()

◆ setControlFrequency()

◆ setControlVoltage()

◆ setDepth()

◆ setDescription()

◆ setEwManufacturerPartType()

◆ setExcludeFromBillOfMaterials()

◆ setExternalID()

◆ setHeight()

◆ setLibraryCode()

◆ setLineDiagramSymbolName()

◆ setManufacturer()

◆ setReference()

◆ setRootMark()

◆ setSchemeSymbolName()

◆ setSerie()

◆ setStockNumber()

◆ setSupplierName()

◆ setUseFrequency()

◆ setUserData()

◆ setUseVoltage()

◆ setValue()

◆ setWeight()

◆ setWidth()