MFGS Environment

MFGSEnvironment `Public interface`

Description

Describes methods and properties available on the static instance object MFGS.Environment

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSEnvironment[[IExMFGSEnvironment]]
  class VGWWCoreIEx.IExMFGSEnvironment interfaceStyle;
  end

Members

Methods

Public methods

Returns	Name
`string`	`Get`(`string` name, `string` defaultValue, `string` category) Gets the value of a variable defined in the Environment section of MFGStream Configuration.
`IExMFGSEnvironmentVariable`	`GetVariable`(`string` name, `string` category) Gets a variable defined in the Environment section of MFGStream Configuration.
`IExMFGSEnvironmentVariableCollection`	`GetVariableCollection`(`string` category) Gets a collection of variables defined in the Environment section of MFGStream Configuration.

Details

Summary

Describes methods and properties available on the static instance object MFGS.Environment

Methods

Get

public string Get(string name, string defaultValue, string category)

Arguments

Type	Name	Description
`string`	name	The name of the variable.
`string`	defaultValue	The value to return if name cannot be found.
`string`	category	The category of the variable.

Summary

Gets the value of a variable defined in the Environment section of MFGStream Configuration.

Remarks

name and category are not case-sensitive. In WinWrap, if defaultValue is not specified an empty string will be returned if name cannot be found. If category is not specifed then all categories will be searched, and if there are more than one variables with the same name, then first variable in the MFGStream Configuration list which matches will be returned.

Returns

The value of the variable which matches the name, and category if specified.

GetVariable

public IExMFGSEnvironmentVariable GetVariable(string name, string category)

Arguments

Type	Name	Description
`string`	name	The name of the variable.
`string`	category	The value to return if name cannot be found.

Summary

Gets a variable defined in the Environment section of MFGStream Configuration.

Remarks

name and category are not case-sensitive. If category is not specifed then all categories will be searched, and if there are more than one variables with the same name, then first variable in the MFGStream Configuration list which matches will be returned. NOTE: The IExMFGSEnvironmentVariable object returned by this method is the base variable for the session. Meaning changes to the values of the IExMFGSEnvironmentVariable properties are persistent, and will be present in the variables copied by the GetVariableCollection() method. Regardless of how the IExMFGSEnvironmentVariable object is obtained, changes to property values will not affect the values stored in the Environment section of MFGStream Configuration.

Returns

An IExMFGSEnvironmentVariable object which matches the name, and category if specified. null (or Nothing in VBA) if not found.

GetVariableCollection

public IExMFGSEnvironmentVariableCollection GetVariableCollection(string category)

Arguments

Type	Name	Description
`string`	category	The category of the variables.

Summary

Gets a collection of variables defined in the Environment section of MFGStream Configuration.

Remarks

category is not case-sensitive. To return all variables regardless of category, a string with a single hyphen (”-”) can be passed in for category. NOTE: The IExMFGSEnvironmentVariable objects contained in the collection returned by this method are copies of the base variables for the session. Meaning changes to the values of the IExMFGSEnvironmentVariable properties are local to the collecion object and will not affect the base variables. Regardless of how the IExMFGSEnvironmentVariable object is obtained, changes to property values will not affect the values stored in the Environment section of MFGStream Configuration.

Returns

An IExMFGSEnvironmentVariableCollection object containing all variables which match the category. An empty collection if not found.

Generated with ModularDoc

MFGS Environment