Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAnalysisRule.GetLocalizedError Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAnalysisRule.GetLocalizedError Method
This method gets a localized string for errors associated with the AFAnalysisRule.

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

Syntax

public string GetLocalizedError(
	IFormatProvider formatProvider,
	int errorCode,
	bool isSdkError,
	params Object[] args
)
Public Function GetLocalizedError ( 
	formatProvider As IFormatProvider,
	errorCode As Integer,
	isSdkError As Boolean,
	ParamArray args As Object()
) As String

Dim instance As AFAnalysisRule
Dim formatProvider As IFormatProvider
Dim errorCode As Integer
Dim isSdkError As Boolean
Dim args As Object()
Dim returnValue As String

returnValue = instance.GetLocalizedError(formatProvider, 
	errorCode, isSdkError, args)
public:
virtual String^ GetLocalizedError(
	IFormatProvider^ formatProvider, 
	int errorCode, 
	bool isSdkError, 
	... array<Object^>^ args
) sealed
abstract GetLocalizedError : 
        formatProvider : IFormatProvider * 
        errorCode : int * 
        isSdkError : bool * 
        args : Object[] -> string 
override GetLocalizedError : 
        formatProvider : IFormatProvider * 
        errorCode : int * 
        isSdkError : bool * 
        args : Object[] -> string 

Parameters

formatProvider
Type: SystemIFormatProvider
Specifies the format provider used to generate the error message.
errorCode
Type: SystemInt32
The error code that a localized message should be generated for.
isSdkError
Type: SystemBoolean
if the error is from the AF SDK.
args
Type: SystemObject
A collection of arguments to be used in generating the message.

Return Value

Type: String
A localized error message string suitable for displaying to a user.

Implements

IAFLocalizedErrorProviderGetLocalizedError(IFormatProvider, Int32, Boolean, Object)

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in