AF SDK Reference

AFNotification.ErrorMessage Property

Save PDF

TABLE OF CONTENTS

AFNotification.ErrorMessage Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The last error message associated with an error status.

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

Syntax

public string ErrorMessage { get; set; }

Public Property ErrorMessage As String
	Get
	Set

Dim instance As AFNotification
Dim value As String

value = instance.ErrorMessage

instance.ErrorMessage = value

public:
property String^ ErrorMessage {
	String^ get ();
	void set (String^ value);
}

member ErrorMessage : string with get, set

Property Value

Type: String
Returns the last error message associated with an error status.

Remarks

The error message is normally set to the reason that the notification was set to an error status. Changing the error message using this property will not set the value in the PI AF Server immediately like the SetStatus(AFStatus, String) method. The notification must be checked in to save the change to the server. Calling the SetStatus(AFStatus, String) method is more efficient since it does not require the notification to be checked out or checked in.

Important
When setting the Status or the ErrorMessage, it is more efficient to call the SetStatus(AFStatus, String) method to reduce the number of calls to the PI AF Server.

Caution
If the message is longer than 128 characters, it will be truncated.

AF SDK Reference