i
This is not the latest version of this document; to access the latest version, click here.

Properties Data Type

Official Content
This documentation is valid for:

This type represents a key-value list and it can be used for many purposes. For example, it can be used as a filter in the GetAttribute method of LDAPClient Data Type. It can also be used with the Queue data type.

Methods 

Clear
Get
Remove
Set

Set

Adds an attribute to be used as a filter.

Syntax

Set( id, value ) 

Where:
id
Is a character

value
Is a character

Clear

Clears all the key-value pairs added.

Syntax

Clear() 

Get

Returns the value of a given key.

Syntax

Get(key) 

Where
key
Is a character

 E.g.: &value = &prop.get(&myKey)

Remove

Removes the specified key.

Syntax

Remove(key) 

Where
Key
Is a character
 

Iterating properties

In order to read all the properties stored in a Properties variable, the Property Data Type must be used.

E.g.

for &property in &myProperties
  msg( &property.Key)
  msg( &property.Value)
endfor

where &Property is Property Data Type.

Scope

Objects: Procedures, Transactions, Web Panels
Languages: Java, .NET, Ruby
Interfaces: Web