RenumberCables(Function[],String,Boolean,Int32,Int32) Method

In This Topic

Method for numbering cables in a project.

Syntax

C#
C++/CLI

public void RenumberCables( 
   Function[] oCables,
   string strNumberingSchemeName,
   bool bKeepOldNames,
   int nStartValue,
   int nStepValue
)

public:
void RenumberCables( 
   array<Function^>^ oCables,
   String^ strNumberingSchemeName,
   bool bKeepOldNames,
   int nStartValue,
   int nStepValue
)

Parameters

oCables: An array of functions (cables, shildings) to number.
strNumberingSchemeName: Name of the scheme used for cable numbering.
bKeepOldNames: If set to true, already existing cable names will not be changed.
nStartValue: Start value for the device tag counter.
nStepValue: The device tag counter will be incremented by this value.

Exceptions

Exception	Description
ArgumentException	Invalid parameters found.
ApplicationException	The internal interface necessary for numbering could not be created.
BaseException	An error occurred during numbering. Please read the exception message..
InvalidScheme	An error occurred when used scheme name doesn't exist

Remarks

If the user scheme given in strNumberingSchemeName does not exist, an ArgumentException will be thrown. If you pass an empty string to strCreateSchemeName, the last-used scheme will be used which is currently set in GUI.

Reference

CableService Class
CableService Members
Overload List

Send Feedback