IComponentInfoGetDescriptionOrErrors Method

Note: This API is now obsolete.

If the Errors collection is empty then returns Description, otherwise returns the error messages joined by errorSeparator.

Definition

Namespace: SMath.Extensibility
Assembly: SMath.Manager (in SMath.Manager.dll) Version: 1.74.9654.0

C#

[ObsoleteAttribute("This member should be removed in the new implementation of the plug-in engine")]
string GetDescriptionOrErrors(
	string errorSeparator = null
)

VB

<ObsoleteAttribute("This member should be removed in the new implementation of the plug-in engine")>
Function GetDescriptionOrErrors ( 
	Optional errorSeparator As String = Nothing
) As String

C++

[ObsoleteAttribute(L"This member should be removed in the new implementation of the plug-in engine")]
String^ GetDescriptionOrErrors(
	String^ errorSeparator = nullptr
)

F#

[<ObsoleteAttribute("This member should be removed in the new implementation of the plug-in engine")>]
abstract GetDescriptionOrErrors : 
        ?errorSeparator : string 
(* Defaults:
        let _errorSeparator = defaultArg errorSeparator null
*)
-> string

Parameters

errorSeparator String (Optional): Separator to insert between error messages or to use NewLine.

Return Value

String
Error messages joined by errorSeparator if they are present or Description if error messages are absent.

IComponentInfoGetDescriptionOrErrors Method

Definition

Parameters

Return Value

See Also

Reference