RenameDevice(Project,FunctionBasePropertyList,FunctionBasePropertyList,Boolean,Boolean) Method

In This Topic

Rename all functions of device.

Syntax

C#
C++/CLI

public void RenameDevice( 
   Project pProject,
   FunctionBasePropertyList pOldName,
   FunctionBasePropertyList pNewName,
   bool bRenameCDPsAlso,
   bool bKeepDescribingProps
)

public:
void RenameDevice( 
   Project^ pProject,
   FunctionBasePropertyList^ pOldName,
   FunctionBasePropertyList^ pNewName,
   bool bRenameCDPsAlso,
   bool bKeepDescribingProps
)

Parameters

Parameter Name	Description
pProject	Project for which functions of device will be renamed.
pOldName	List of name properties of device that functions will be renamed. Device without DT cannot be renamed so this list cannot be empty. Device must exist otherwise method throws exception.
pNewName	List of name properties that will be set to functions of device, can be empty.
bRenameCDPsAlso	If `true` then connection of this device (example: wires of cable) also will be renamed.
bKeepDescribingProps	IF `true` then describing properties of functions will not be changed.

Exceptions

Exception	Description
System.ArgumentException	Thrown when cannot find device from pOldName or trying to rename device without DT.
System.ArgumentNullException	Thrown if `NULL` was passed as a required parameter.

Reference

NameService Class
NameService Members
Overload List

Use the Eplan Global Support Portal for feedback and support