Skip to content

Entity_Relation_Segment_Foreign_Entity - cEntity

Include: Use Db\cEntity.pkg

Returns the related entity metadata handle for a relation segment.

Type: Function

Return data type: Handle

Parameters

Parameter Type Description
iIndex Integer Zero-based relation number.
iPartOfRelation Integer Zero-based relation segment number.

Syntax

Function Entity_Relation_Segment_Foreign_Entity Integer iIndex Integer iPartOfRelation Returns Handle

Signature: Function Entity_Relation_Segment_Foreign_Entity Integer iIndex Integer iPartOfRelation Returns Handle

Call

Get Entity_Relation_Segment_Foreign_Entity of hoObj iIndex iPartOfRelation to hForeignEntity

Description

Returns the related entity metadata handle for a relation segment. Out-of-range relation or relation segment arguments raise a DataFlex error.