Interface IJobVariableDictionary

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

A collection of Job Variables keyed by name.

public interface IJobVariableDictionary

Properties

Count

Gets the number of items in the collection

int Count { get; }

Property Value

int

this[object]

Gets the item with the specified string or integer index.

string this[object index] { get; set; }

Parameters

Name	Type	Description
index	object

Property Value

string

Remarks

If index is an integer value, returns the item at the specified ordinal index in the collection. If index is a string value, returns the item with the specified key. If the no variable exists with the specified key, returns an empty string.

Methods

Add(IJobVariable)

Adds a variable.

IJobVariable Add(IJobVariable item)

Parameters

Name	Type	Description
item	IJobVariable	The variable to add.

Returns

IJobVariable

Remarks

Adding or updating variables in this collection only affects the job instance in which the script is running.

Add(string)

Creates a new Job Variable with the specified key and adds it to the collection

IJobVariable Add(string Key)

Parameters

Name	Type	Description
Key	string	The name of the variable

Returns

IJobVariable

The newly-added JobVariable.

Remarks

This method throws an ArgumentException if the collection already contains a variable with the specified key.

Adding or updating variables in this collection only affects the job instance in which the script is running.

Exceptions

ArgumentException

Thrown if the collection already contains a variable with the specified key.

Add(string, string)

Adds or updates the variable with the specified key.

[ComVisible(false)]
IJobVariable Add(string Key, string value)

Parameters

Name	Type	Description
Key	string	The name of the variable to add or update
value	string	The new value for the variable

Returns

IJobVariable

The newly-added JobVariable.

Remarks

Adding or updating variables in this collection only affects the job instance in which the script is running.

Add(string, string, bool)

Adds or updates the variable with the specified key.

IJobVariable Add(string Key, string value, bool addToEnvironment)

Parameters

Name	Type	Description
Key	string	The name of the variable to add or update
value	string	The new value for the variable
addToEnvironment	bool	If true, the variable is also exposed as a Windows environment variable for programs run by the job

Returns

IJobVariable

The newly-added JobVariable.

Remarks

Adding or updating variables in this collection only affects the job instance in which the script is running.

ContainsKey(string)

Determines whether the collection contains a variable with the specified name.

bool ContainsKey(string Key)

Parameters

Name	Type	Description
Key	string	The name of the variable to find. Case-insensitive

Returns

bool

GetVariable(int)

Gets the variable at the specified index;

IJobVariable GetVariable(int index)

Parameters

Name	Type	Description
index	int	The zero-based index of the variable to get.

Returns

IJobVariable

The variable at the requested index. Throws an exception if the index is not valid.

Remarks

Adding or updating variables in this collection only affects the job instance in which the script is running.

GetVariable(string)

Gets the variable at the specified index;

IJobVariable GetVariable(string index)

Parameters

Name	Type	Description
index	string	The name (case-insensitive) of the variable to get.

Returns

IJobVariable

The requested variable, or null if no variable exists with that name.

Remarks

Adding or updating variables in this collection only affects the job instance in which the script is running.

Extension Methods

• StringUtil.ListToString<T>(IEnumerable<T>, string)