SettingsBaseGetSettingName Method

Gets setting name to use for specified field or property.

Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.253-beta+ffb7163c9e3b771705bc5b9aa3f09870f2cb9e2c

Syntax

C++

JavaScript

Copy

public string GetSettingName(
	string name
)

Public Function GetSettingName ( 
	name As String
) As String

public:
String^ GetSettingName(
	String^ name
)

member GetSettingName : 
        name : string -> string

function GetSettingName(name);

View Source

Parameters

name String: Field or property name.

Return Value

String
Name applied to specified field or property; or name if attribute does not exist.

Exceptions

Exception	Condition
ArgumentException	name cannot be null or empty.

Remarks

Field or property name will be used for setting name unless user applied a SettingNameAttribute on the field or property to override name used to serialize value in configuration file.

Reference

SettingsBase Class

GSF.Configuration Namespace