IGlobals

class IGlobals

Bases: ImpactCOMWrapperBase, Iterable

Summary:

A collection of IGlobal objects, each representing a global variable.

Remarks:

There are a several different purposes for global variables and therefore several ways to obtain an IGlobals object: IApplication.globals returns a collection representing application variables valid for the lifetime of the application. IDatabase.globals returns a collection representing session variables valid for the lifetime of the database connection. IDatabaseSettings.persisted_globals returns a collection representing a named group of variables stored within the database.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property count

Gets Count.

Summary:

The number of items in the collection.

Returns:

The value of Count.

Return type:

count (int)

property read_only

Gets read_only.

Summary:

Indicates whether this collection of variables are read-only.

Remarks:

Introduced in Impact 12.0.0.157

Returns:

The value of read_only.

Return type:

read_only (bool)

add(name, value)
Summary:

Adds an IGlobal to the collection.

Remarks:

If a global exists with the specified name the value is modified.

Parameters:
  • name (str) – Specifies the name for the new global.

  • value (any) – Specifies the value for the new global.

clear()
Summary:

Clears the collection.

delete(index)
Summary:

Deletes an IGlobal with the specified name or index.

Parameters:

index (any) – Specifies the name or index of the IGlobal to delete.

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

item(index)
Summary:

Gets an IGlobal with the specified name or index.

Parameters:

index (any) – Specifies the name or index of the IGlobal to get.