company logo

DataSource :: accessKey - ACCESS_KEY option

Special object instances can be referred to by setting an access key value in the data source. This information is provided for the application and not directly used by the data source. In order to locate a specific instance when opening the data source, an access key value or position should be set in accessKey.

Usually, this value is set in the configuration or ini-file in the INSTANCE option for the data source definition.

INSTANCE=P12345

Return value:  Key value ( ::Key  )

The key is provided in the internal key format. When necessary the key value can be converted from a string into the internal format using the StringToKey() function.

Implementation overview

Implementation details

  1. Get access key value
    odaba::Key DataSource  :: accessKey (  )

    The function returns the access key value or position currently set for the data source.

    2. to list
  2. Set access key value
    odaba::Key DataSource  :: accessKey ( odaba::Key vSortKey )

    The function changes the settings for the access key value. The access key value passed in vSortKey is set, only. It will not affect the current selection in the property opened for the data source.
    • 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
    3. to list
to top upper table of contents Comment