company logo

Property :: instanceLoid - Get local instance identity (LOID)

The function returns the local object identity for the requested instance. When no instance could be located the function returns 0. When calling the function for a share base property handle, the function returns the identity for the shared base instance, but not the identity for the derived instance.

When the property handle is not accessible (invalid or parent not selected), the function throws an exception.

Return value:  Local instance identity ( int64  )

The object or instance identity is a unique identity within a database.

Implementation overview

Implementation details

  1. Get LOID for located instance
    int64 Property  :: instanceLoid (  )

    The function returns the local object identity for the the instance currently located in the property handle. When no instance is located, the function throws an exception.

    2. to list
  2. Get LOID by key
    int64 Property  :: instanceLoid ( odaba::Key &cKey )

    The function returns the local object identity for the the instance with the key value cKey according to the access key selected for the property handle.

    When no instance could be located for the key value passed, the function returns 0. When the property handle is not valid, the function throws an exception.

    Notes:

    In contrast to locateKey() , the function allows checking, whether an instance with the passed key value exists in a collection, without changing the selected or located state of the property handle.

    • cKey - Key value

      A key value is the key definition and a value for the key. The key value is typically provided in ESDF format. Other formats might be set (OIF, XML)

    3. to list
  3. Get LOID by position
    int64 Property  :: instanceLoid ( int32 iPosition )

    The function returns the local object identity for the the instance at position iPosition according to the access key (index) selected for the property handle. The function does not check filter conditions. The value passed in iPosition must be a value greater or equal to 0 .

    When no instance could be located at the position passed, the function returns 0. When iPosition is invalid (less than 0 or greater than count), the function throws an exception.

    • iPosition - Position in collection

      The position of an element in a collection is beginning with 0 for the first element.

    4. to list
to top previous next upper table of contents Comment