RenameFunction Method

In This Topic

Changes the full names of the function and its children.

Syntax

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

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

Parameter Name	Description
pFunctionBase	Function3D or Plane which name will be changed.
pNewName	Name that will be set to function and its children.
bKeepDescribingProps	if `true` then describing properties of function 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

Method changes name only for given Eplan.EplApi.DataModel.E3D.Function3D and its children, not whole device. To change name of whole device use RenameDevice instead.