GetGlobalParameter

Gets a value of global parameter.

Compatibility

Available as of IDEA version 12.0

Syntax

GetGlobalParameter(paramName As String, paramLocation As Integer, optionalData As String, recursive As Boolean)

Parameters

paramName

Extended parameter name

paramLocation

Location of the parameter (Machine = 0, Workflow = 1, File = 2, Folder = 3, Project = 4)

optionalData

Ignored for Machine and Project location;

Workflow id for Workflow;

File/folder path for File/Folder location;

recursive

If set to True, recursively searches parameter name up the chain from current location

Return values

Returns the parameter value as a string. If the parameter cannot be found, an empty string is returned.

Remarks

The parameter value is returned as a string. If the parameter cannot be found, an empty string is returned.
Numerical values are returned according to the current globalization settings.
Date values are returned as "YYYY-MM-DDThh:mm:ss". Example: "2008-06-15T21:15:07".
Period values are returned as "Date-Date". Example: "2008-06-15T21:15:07-""2008-07-15T21:15:07"

Example

Sub Main()
	Dim ac As Object 
	Dim value As String 
	Set ac = CreateObject("SmartAnalyzer.AutomationClient") 
	ac.SetGlobalParameter("IntValue", 100, 3, "2015_0603") 
	Set value = ac.GetGlobalParameter("IntValue", 3, "2015_0603", False)
	. . .
End Sub