Property :: accessKey - Access key property
The access key property provides the key value for the currently selected index(changeAccessKey(sKeyName)). When the collection is unordered, the primary key is considered to be the current access key. When no access key is available, the function throws an exception.
When the property is located, but not positioned, the function tries to read the located instance before providing the key value.
The sort or access key value is provided as typed string in ESDF or CSV format. Key components can be separated by '|' or ';'.
// key: name;first_name
Miller;Paul // simple positioned CSV key
"Miller";"Paul Mary" // special characters must be quoted
Implementation overview
- Provide access key value
Property :: accessKey ( ) - Store sort key value to instance
Property :: accessKey ( vSortKey )
Implementation details
-
Provide access key value
odaba::Key Property :: accessKey ( )
The function extracts the access key from the currently selected instance. When an instance is located in the property handle but no instance has been selected, the function will select the instance located before extracting the key value.
When no instance could be selected, the function throws an exception.
to list
-
Store sort key value to instance
odaba::Key Property :: accessKey ( odaba::Key vSortKey )
The passed key value is stored to the component attributes of the current access key in the currently selected instance of the property handle.
When no instance is selected or when no access key is defined for the structure the function throws an exception.
- vSortKey
- Access key
The sort or access key value is provided as typed string in ESDF or CSV format. Key components can be separated by '|' or ';'.
// key: name;first_name
Miller;Paul // simple positioned CSV key
"Miller";"Paul Mary" // special characters must be quoted
to list
- vSortKey
- Access key