company logo

Region :: id - Region identifier

Each region has got a unique identifier, which is either the resource identity when being defined in a resource database or an internal identifier set by the system. Regions with 0 as identifier are invalid and restricted access is possible, only.
Return value:  Region identification ( int64  )

The region identifier is either the resource identity for the region definition (in case the region has been created from an external resource defined in a resource database) or the internal column identifier returned from the ControlContext::addRegion() function.

Implementation overview

Implementation details

  1. Get region identifier
    int64 Region  :: id (  )

    The function returns the region identifier for the region. When thr region is not valid, the function returns 0.
    2. to list
  2. Change region identifier
    int64 Region  :: id ( int64 iRegionID )

    Changing the region identifier will change the region in the list (table or tree). Thus, setting the region identifier will also reset the region name.

    Passing an invalid region identifier will cause an exception.
    • iRegionID - Region identification

      The region identifier is either the resource identity for the region definition (in case the region has been created from an external resource defined in a resource database) or the internal column identifier returned from the ControlContext::addRegion() function.
    3. to list
to top previous next upper table of contents Comment