AF SDK Reference

AFAdjustments.Clear Method (String, String)

Save PDF

AFAdjustments.Clear Method (String, String)

Save PDF

Last UpdatedNov 18, 2025
3 minute read

The Clear method does not delete any previous adjustments to the value of an attribute, it clears the adjustment so that it does not have any effect on the attribute value.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFAdjustment Clear(
	string creator,
	string comment
)

Public Function Clear ( 
	creator As String,
	comment As String
) As AFAdjustment

Dim instance As AFAdjustments
Dim creator As String
Dim comment As String
Dim returnValue As AFAdjustment

returnValue = instance.Clear(creator, 
	comment)

public:
AFAdjustment^ Clear(
	String^ creator, 
	String^ comment
)

member Clear : 
        creator : string * 
        comment : string -> AFAdjustment

Parameters

creator: Type: SystemString
The name of the user clearing the adjustment. If this parameter is or an empty string, then it defaults to the user name of the person that started the current thread. The maximum length of this parameter is 50 characters.
comment: Type: SystemString
The user's descriptive comment describing the adjustment. The maximum length of this parameter is 1000 characters.

Return Value

Type: AFAdjustment
Returns the newly created object that was added.

Exceptions

Exception	Condition
InvalidCastException	Thrown when the conversion to the configured AFAttribute.Type cannot be performed.

Remarks

This method is usually called after adjustments have been made to an attribute's value that are no longer wanted. The attribute's value reverts back to the its original value before the first adjustment. If an adjustment for the attribute has already been created but the changes have not been saved to the server by calling CheckIn or ApplyChanges, then the existing adjustment is deleted. If the adjustment for the attribute has already been saved to the server, then a new adjustment is created with an adjusted value set to .

AF SDK Reference