RenFieldAt

Renames an IDEA field at a given position and returns the actual new name of the renamed field (as a string).

Compatibility

Available as of IDEA version 10.0

Syntax

RenFieldAt(database as Object, position as Integer, newFieldName as String, Optional description as String) As String

Parameters

database

Object containing the currently open database.

position

Position of the field that needs to be renamed.

newFieldName

New name of the field.

description

Only one optional argument: Description.

Remarks

Error is raised if:

• database is null
• newFieldName is null or empty.

Return value

Returns the actual new name of the renamed field.

Example

Dim SimpleCommands As Object 
Dim db As Object 
Dim fileName As String 
Dim newFieldName As String 

Sub Main 
	Set SimpleCommands = SmartContext.MacroCommands.SimpleCommands 

	'Get the name of the database. 
	fileName = SmartContext.PrimaryInputFile 

	'Open the database. 
	Set db = Client.OpenDatabase(fileName) 

	'Rename the field at position 2. 
	newFieldName = SimpleCommands.RenFieldAt db,2, "NEWNAME", "My new field description" 

	'Close the database. 
	db.Close 
	Set db = Nothing 

	'Release object. 
	Set SimpleCommands = Nothing 
End Sub

Copy example