CategorizedSettingsBaseGetFieldDescription Method

Gets the description specified by DescriptionAttribute, if any, applied to the specified field or property.

Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.264-beta+d1c3a754a4d50e5c740e530e6875e878ac32de9a

Syntax

public string GetFieldDescription(
	string name
)

Public Function GetFieldDescription ( 
	name As String
) As String

public:
String^ GetFieldDescription(
	String^ name
)

member GetFieldDescription : 
        name : string -> string

function GetFieldDescription(name);

String
Description applied to specified field or property; or null if one does not exist.

Exceptions

Exception	Condition
ArgumentException	name cannot be null or empty.