SystemOptionRepositoryTryGetByName Method

Attempts to retrieve a system option by name, which may or may not actually exist

Namespace: Ignition.Framework.Metadata
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.28229

Syntax

C++

Copy

public bool TryGetByName(
	string optionName,
	out SystemOption systemOption
)

Public Function TryGetByName ( 
	optionName As String,
	<OutAttribute> ByRef systemOption As SystemOption
) As Boolean

public:
virtual bool TryGetByName(
	String^ optionName, 
	[OutAttribute] SystemOption^% systemOption
) sealed

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

Boolean
True if the retrieval was successful; otherwise false

Reference

SystemOptionRepository Class

Ignition.Framework.Metadata Namespace