Share via


DictType.relationObject Method

Provides information about relations that are defined for an extended data type or a specified array element by returning a DictRelation object.

Syntax

public DictRelation relationObject([int arrayIndex])

Run On

Called

Parameters

  • arrayIndex
    Type: int

Return Value

Type: DictRelation Class
A DictRelation object that provides information about relations.

Remarks

If no relations are defined for the extended data type and array elements, subsequent use of the DictRelation instance will cause a run-time error.

Examples

In the following example, the relationObject method returns the DictRelation object for the XMLMapDimension extended data type.

    DictType dicttype; 
    DictRelation dictrelation; 
 
    dicttype = new DictType(extendedTypeNum(XMLMapDimension)); 
    dictrelation = dicttype.relationObject(); 
    if(dictrelation) 
    { 
        print "Relation lines: " + int2str(dictrelation.lines()); 
    } 
 
    else 
    { 
        print "No relations defined."; 
     }

See Also

Reference

DictType Class