company logo

Property :: locateLoid - Locate object by identity

The function is searching for an instance with the given local identity (LOID) in the collection managed by the property handle. In order to optimize searching, a start position in the index (iPosition) can be passed.

Usually, the instance is located, but not positioned, and might be read with get() later on. In order to position the located instance immediately, true might be passed in bRead.

The function returns true, when an instance has been located successfully and false otherwise. The function throws an exception, when the given local identity exists in the database, but does not belong to an instance. After terminating successfully, an instance is located in the property handle.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation overview

Implementation details

  1. Locate instance without reading
    bool Property  :: locateLoid ( int64 iObjectID )

    The function tries to locate the instance with the object identity passed in i64ObjectID without reading the data. In order to optimize searching, the functions starts at the currently located instance (position) or on top, when no instance is located in the property handle.

    When terminating successfully, the property handle is located.
    • iObjectID - Local instance identity

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

    2. to list
  2. Locate instance near position
    bool Property  :: locateLoid ( int64 iObjectID, int32 iPosition )

    The function tries to locate the instance with the object identity passed in i64ObjectID without reading the data. In order to optimize searching, the functions starts at position passed in iPosition.

    When terminating successfully, the property handle is located.
    • iObjectID - Local instance identity

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

    • iPosition - Position in collection

      The position of an element in a collection is beginning with 0 for the first element.
    3. to list
  3. Locate and read instance near position
    bool Property  :: locateLoid ( int64 iObjectID, int32 iPosition, bool bRead )

    The function tries to locate the instance with the object identity passed in i64ObjectID. When the instance could be located it will be read immediately. In order to optimize searching, the functions starts at position passed in iPosition.

    When terminating successfully, the property handle is selected.
    • iObjectID - Local instance identity

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

    • iPosition - Position in collection

      The position of an element in a collection is beginning with 0 for the first element.
    • bRead - Read option

      The option forces the function to read the instance when it could be located.
    4. to list
  4. Locate and read instance
    bool Property  :: locateLoid ( int64 iObjectID, bool bRead )

    The function tries to locate the instance with the object identity passed in i64ObjectID. When the instance could be located it will be read immediately. In order to optimize searching, the functions starts at the currently located instance (position) or on top, when no instance is located in the property handle.

    When terminating successfully, the property handle is selected.
    • iObjectID - Local instance identity

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

    • bRead - Read option

      The option forces the function to read the instance when it could be located.
    5. to list
to top previous next upper table of contents Comment