AFTable.RenameExtendedPropertyColumn Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Renames the column for all extended properties associated with the old column name.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void RenameExtendedPropertyColumn( string oldName, string newName )
Public Sub RenameExtendedPropertyColumn ( oldName As String, newName As String ) Dim instance As AFTable Dim oldName As String Dim newName As String instance.RenameExtendedPropertyColumn(oldName, newName)
public: void RenameExtendedPropertyColumn( String^ oldName, String^ newName )
member RenameExtendedPropertyColumn : oldName : string * newName : string -> unit
Parameters
- oldName
- Type: SystemString
The old name of the DataColumn being renamed. - newName
- Type: SystemString
The new name of the DataColumn being renamed.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | This exception is thrown if the oldName parameter is or an empty string. |
| ArgumentException | This exception is thrown if the newName is an invalid name for the new column. |
Remarks
This method should be called when renaming a column name to make sure that all
extended properties associated with the column are also updated.