company logo

PropertyHandle :: Export - Export data to file

The function exports data from the current collection. Data can be exported in XML, CSV (ESDF) or OIF format. The export format type will be derived from the file extension. The extension .xml causes export to an XML file. .csv and .esdf will export data to extended self delimiter format (ESDF). All other extensions will produce an object interchange format (OIF) file.

When a filter condition has been set, only filtered instances are exported. Owned collections (references) will export complete instances, not owning collections (references) will export instance references by main key.

The amount of data exported can be reduced by the copy option passed to the function (copy_type). For copying all data, COPY_deep or COPY_all (default) should be passed. Passing COPY_local will copy all instance data without links to instances not owned by the instance copied. COPY_instance will copy instance data far all instances without copying referenced (owned) instances. COPY_depend copies data as defined in the copy model.

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: Export ( NPath &cpath, COPY_Options copy_type=COPY_all )
  • cpath - Complete file or directory path
  • copy_type - Copy type

    The copy type determines the way of copying instances. Depending on import, export or copy processes, the meaning differs slightly.

    Default: COPY_all