UpdateDevice Method

In This Topic

Updates a given device or a connection with data from the referenced article(s).

Syntax

C#
C++/CLI

public bool UpdateDevice( 
   StorableObject oObject
)

public:
bool UpdateDevice( 
   StorableObject^ oObject
)

Parameters

oObject: Main function of the device or a connection.

Return Value

FALSE, if the object given as parameter doesn't have any article references.

Exceptions

Exception	Description
ArgumentNullException	NULL was passed as a parameter.
ArgumentException	Invalid object passed as a parameter.
ApplicationException	The internal interface could not be created.
BaseException	An error occurred while performing the action. Please refer to the exception message.

Remarks

Component-specific data will be transfered from article to main-function, function template-data from article will be transfered to all functions of device, modules will be transfered to functions of device, when article is a module and main-function is a blackbox or plcbox, the referenced articles will be stored to project (if they were not before).

Example

//create main cable
Cable oCable = new Cable();
oCable.Create(oPage, m_oCableSymbolVariant);
oCable.Properties.FUNC_CABLETYPE = "Unknown type";
oCable.Location = new PointD(60.00, 70.00);

//structure part of cable name can't be empty
oCable.Name = "=EB3+ET1-W1";

//add part to cable
ArticleReference oArticleReference = oCable.AddArticleReference(strPartName);

//update the cable with properties from new part
new DeviceService().UpdateDevice(oCable);

//oCable.Properties.FUNC_CABLETYPE == 'ZB3200'

Reference

DeviceService Class
DeviceService Members

Send Feedback