CommonGetValidLabel Method

Removes control characters and null from a string.

Definition

Namespace: Gemstone.PhasorProtocols
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.176 -- Release Build+535b860f5637725955cf0152c13c09fb6e0e87dc

C#View Source Request Example

public static string GetValidLabel(
	this string value
)

VBView Source Request Example

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

C++View Source Request Example

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

JavaScriptView Source Request Example

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

Parameters

value String: Source String to validate.

Return Value

String
value with control characters and nulls removed.

Usage Note

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.