COM object EvVariablesCollection

EvApplication>EvFileCollection > EvFile > EvVariablesCollection

- OR -

EvApplication> EvFileCollection > EvFile > EvFilesetsCollection > EvFileset > EvVariablesCollection

 

View the COM map and the COM summary.

The EvVariablesCollection object allows you access to the set of variables in an EV file. A variable is an item in the EvVariablesCollection, which is accessed via the:

  • EvFile.Variables[] property that lists all variables in an EV file and is an EvVariablesCollection.
  • EvFileset.Variables[] property that lists all raw variables in a fileset in an EV file and is an EvVariablesCollection.

The EvVariableBase object gives access to specific information and modifications for a variable.

EvVariablesCollection methods and properties:

Count
FindByDynamicName
FindByName

Item

 

Description

Count

(read-only) integer Count

Summary

Get the number of variables in this collection.

FindByDynamicName

FindByDynamicName(string DynamicName)

Summary

Searches for a variable by its dynamic name, and if found returns the EvVariableBase object for it.

Parameters
  • DynamicName
  • The dynamic name as a string.
Return

The return is a EvVariableBase object. Null if DynamicName can't be found.

Example

The following code snippet should return the first variable object with a dynamic name that equals "Fileset 1: Sv raw pings T1 {ColorDisplayMinimum}: Color min".

Dim vObj: Set vObj = vEvFile.Variables.FindByDynamicName("Fileset 1: Sv raw pings T1 {ColorDisplayMinimum}: Color min")

FindByName

FindByName(string Name)

Summary

Searches for a variable by its name, and if found returns the EvVariableBase object for it.

Parameters
  • Name
  • The name to search for.
Return

If found, the EvVariableBase object for the variable.

Notes:

  • When a variable does not have data, FindByName fails.
  • The FindByName search for names can consider names with or without the name of the fileset.
  • FindByShortName(string Name) is deprecated, because a variable short name is no longer supported. The Return is the same as for FindByName(string Name).

Item

(read-only) Item[]

Summary

Gives access to a specific variable by index. Indexes are zero-based, so valid indexes are from 0 to Count-1. The result is an EvFile object.

Item is the default property for this interface. The examples on the EvFileCollection page show several ways to use the Item property.

 

See also

Scripting with COM objects
COM object hierarchy
EvVariableBase