MFGS Environment Variable Collection

MFGSEnvironmentVariableCollection Public interface

Description

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

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
string	Category Gets the category as defined when the MFGS.Environment.GetVariableCollection() method was called.	get
int	Count Gets the number of variables in the collection.	get
IExMFGSEnvironmentVariable	Item	get

Methods

Public methods

Returns	Name
bool	Contains(object indexOrName) Indicates whether the collection contains a variable at the specified index or with a matching name.

Details

Summary

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

Methods

Contains

public bool Contains(object indexOrName)

Arguments

Type	Name	Description
object	indexOrName	If a numeric value is passed in, this will be used to search for the variable by index. If a string value is passed in, this will be used to search for the variable by name.

Summary

Indicates whether the collection contains a variable at the specified index or with a matching name.

Returns

true if the index is valid or if the name was found; otherwise false.

Properties

Category

public string Category { get; }

Summary

Gets the category as defined when the MFGS.Environment.GetVariableCollection() method was called.

Count

public int Count { get; }

Summary

Gets the number of variables in the collection.

Item

public IExMFGSEnvironmentVariable Item { get; }

Generated with ModularDoc