Catalyst Fire Ignition Documentation
System
Attempts to retrieve a system option by name, which may or may not actually exist
Definition
Namespace: Ignition.Framework.Metadata
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
True if the retrieval was successful; otherwise false
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public bool TryGetByName(
string optionName,
out SystemOption systemOption
)VB
Public Function TryGetByName (
optionName As String,
<OutAttribute> ByRef systemOption As SystemOption
) As BooleanC++
public:
virtual bool TryGetByName(
String^ optionName,
[OutAttribute] SystemOption^% systemOption
) sealedF#
abstract TryGetByName :
optionName : string *
systemOption : SystemOption byref -> bool
override TryGetByName :
optionName : string *
systemOption : SystemOption byref -> bool Parameters
- optionName String
- The name of the system option to retrieve
- systemOption SystemOption
- If the retrieval is successful, the requested system option; otherwise null
Return Value
BooleanTrue if the retrieval was successful; otherwise false