Skip to main content
View as Markdown

IEDMS_SettingsService interface

No description yet.

public interface IEDMS_SettingsService

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
GetSettingbool
GetSettingsbool
SetSettingbool
SetSettingsbool

GetSetting​

No description yet.

bool GetSetting(string argSettingName, out string argSettingValue, out string argErrorMsg);
ParameterTypePassing
argSettingNamestringvalue
argSettingValuestringout
argErrorMsgstringout

Returns: bool

GetSettings​

No description yet.

bool GetSettings(IWideStrings argSettingsNames, out IEDMS_DictionaryWideString argSettings, out string argErrorMsg);
bool GetSettings(object argSettingsNames, out IEDMS_DictionaryWideString argSettings, out string argErrorMsg);
ParameterTypePassing
argSettingsNamesIWideStringsvalue
argSettingsIEDMS_DictionaryWideStringout
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SettingsServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

SetSetting​

No description yet.

bool SetSetting(string argSettingName, string argSettingValue, out string argErrorMsg);
ParameterTypePassing
argSettingNamestringvalue
argSettingValuestringvalue
argErrorMsgstringout

Returns: bool

SetSettings​

No description yet.

bool SetSettings(IEDMS_DictionaryWideString argSettings, out string argErrorMsg);
bool SetSettings(object argSettings, out string argErrorMsg);
ParameterTypePassing
argSettingsIEDMS_DictionaryWideStringvalue
argErrorMsgstringout

Returns: bool

The first overload is an extension method of IEDMS_SettingsServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

Returned by​

IEDMS_DXPServerManager.GetSettingsService