InstanceDefinitionTable.GetUnusedInstanceDefinitionName Method (String, UInt32)

InstanceDefinitionTableGetUnusedInstanceDefinitionName Method (String, UInt32)

Gets unsed instance definition name used as default when creating new instance definitions.

Namespace:  Rhino.DocObjects.Tables
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public string GetUnusedInstanceDefinitionName(
	string root,
	uint defaultSuffix
)
Public Function GetUnusedInstanceDefinitionName ( 
	root As String,
	defaultSuffix As UInteger
) As String

Parameters

root
Type: SystemString
The returned name is 'root nn' If root is empty, then 'Block' (localized) is used.
defaultSuffix
Type: SystemUInt32
Unique names are created by appending a decimal number to the localized term for "Block" as in "Block 01", "Block 02", and so on. When defaultSuffix is supplied, the search for an unused name begins at "Block suffix".

Return Value

Type: String
An unused instance definition name string.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Obsolete (compiler warning) in 6.14
See Also

M:Rhino.DocObjects.Tables.InstanceDefinitionTable.GetUnusedInstanceDefinitionName(System.String,System.UInt32)