CommonGetValidLabel Method

Removes control characters and null from a string.

Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-beta

Syntax

public static string GetValidLabel(
	this string value
)

<ExtensionAttribute>
Public Shared Function GetValidLabel ( 
	value As String
) As String

public:
[ExtensionAttribute]
static String^ GetValidLabel(
	String^ value
)

[<ExtensionAttribute>]
static member GetValidLabel : 
        value : string -> string

GSF.PhasorProtocols.Common.GetValidLabel = function(value);

String
value with control characters and nulls removed.

In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Strings reported from field devices can be full of inconsistencies, this function helps clean-up the strings.