company logo

PropertyHandle :: GetDescription - Get property definition

The function returns the field definition for the property handle. The field definition described the structure of the instance area for the property handle.

If the property handle is a collection the field definition describes one instance of the collection according to the defined structure. This is different from the field definition of the property handle itself.

Return value:  Property definition ( DBFieldDef * )

The property definition contains the metadata for the referenced property instance.

Implementation details

DBFieldDef * PropertyHandle  :: GetDescription ( char chkopt=AUTO )
  • chkopt - Check option

    The option forces the function to check the property handle before running executing the function. You can pass NO to avoid unnecessary checking.

    Default: AUTO