RenameDevice Method (NameService3D)

In This Topic

Changes the full names of the found device.

Syntax

C#
C++/CLI

public static void RenameDevice( 
   IFunctionBase pFunctionBase,
   FunctionBasePropertyList pNewName,
   bool bRenameCDPsAlso,
   bool bKeepDescribingProps
)

public:
static void RenameDevice( 
   IFunctionBase^ pFunctionBase,
   FunctionBasePropertyList^ pNewName,
   bool bRenameCDPsAlso,
   bool bKeepDescribingProps
)

Parameters

Parameter Name	Description
pFunctionBase	Function3D or Plane from device which name will be changed.
pNewName	Name that will be set to functions of device.
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	Invalid parameters were found.
System.ArgumentNullException	Thrown if `NULL` was passed as a required parameter.

Remarks

As device we understand not only given Eplan.EplApi.DataModel.E3D.Function3D but also other objects with the same full name. To change only function name use RenameFunction instead.

Reference

NameService3D Class
NameService3D Members

Use the Eplan Global Support Portal for feedback and support