LocalDataCollection class | QSYS API Reference Guide
Estimated reading time: 3 minutes
Represents a versioned collection of name/value pairs.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| LocalDataCollection() | Initializes a new, empty instance of the LocalDataCollection class. |
LocalDataCollection()
Initializes a new, empty instance of the LocalDataCollection class.
LocalDataCollection()
Properties
| Type | Name | Description |
|---|---|---|
| Int32 | Count | Gets the number of key/value pairs contained in the LocalDataCollection. |
| Object | Item | Gets or sets the value associated with the specified name. Setting a value increments the LocalDataCollection version. |
| ICollection | Names | Gets an ICollection containing the names in the LocalDataCollection. |
| ICollection | Values | Gets an ICollection containing the values in the LocalDataCollection. |
| Int64 | Version | Gets the version of the LocalDataCollection. |
Methods
| Signature | Description |
|---|---|
| Add(String, Object) | Adds an element with the specified key and value into the LocalDataCollection. Adding an element increments the LocalDataCollection version. |
| Clear() | Removes all elements from the LocalDataCollection. Clearing the LocalDataCollection increments its version. |
| Contains(String) | Determines whether the LocalDataCollection contains a specific name. |
| GetEnumerator() | Returns an IDictionaryEnumerator that iterates through the LocalDataCollection. |
| Remove(String) | Removes the element with the specified key from the LocalDataCollection. Removing an element increments the version of the LocalDataCollection. |
| RemoveAll() | Removes all elements from the LocalDataCollection. Clearing the LocalDataCollection increments its version. |
void Add(string name, object value)
Adds an element with the specified key and value into the LocalDataCollection. Adding an element increments the LocalDataCollection version.
void Add(string name, object value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | The name whose value to get or set. |
| Object | value | The value of the element to add. |
void Clear()
Removes all elements from the LocalDataCollection. Clearing the LocalDataCollection increments its version.
void Clear()
bool Contains(string name)
Determines whether the LocalDataCollection contains a specific name.
bool Contains(string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | The key to locate in the LocalDataCollection. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the LocalDataCollection contains |
IDictionaryEnumerator GetEnumerator()
Returns an IDictionaryEnumerator that iterates through the LocalDataCollection.
IDictionaryEnumerator GetEnumerator()
void Remove(string name)
Removes the element with the specified key from the LocalDataCollection. Removing an element increments the version of the LocalDataCollection.
void Remove(string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | The name of the element to remove. |
void RemoveAll()
Removes all elements from the LocalDataCollection. Clearing the LocalDataCollection increments its version.
void RemoveAll()