Preferences.GetEnvironmentVariable(String, String) Method

Top

Description

Retrieves the environment variable for the key represented by environmentVariable and stores it into returnString.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

Preferences.GetEnvironmentVariable(	String environmentVariable,
	String returnString)

Arguments

environmentVariable
Description:	Environment variable name to retrieve.

returnString
Description:	String to store retrieved value.

Return Value

Type:

number

If a value for environmentVariable is found then the value of 1 is returned, otherwise, 0.

Syntax

myVariable1 = FF_Preferences.GetEnvironmentVariable(myString1, myString2);