Click or drag to resize

DesktopSystemgetEnvironmentVariable Method (String, AckCallback, AckCallback)

Expands an environment variable.

Namespace:  Openfin.Desktop
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.4.0
Syntax
C#
public void getEnvironmentVariable(
	string varToExpand,
	AckCallback callback,
	AckCallback errorCallback = null
)

Parameters

varToExpand
Type: SystemString
The variable to be expanded.
callback
Type: Openfin.DesktopAckCallback
A function that is called and passed a unique identifier of the device.
errorCallback (Optional)
Type: Openfin.DesktopAckCallback
(Optional) A function that is called if the method fails. The reason for failure is passed as an argument.
Remarks
The resulting payload is an object mapping the passed variable to its expanded value. Invalid/unknown environment variables are returned as value null
See Also