STD.File.FileRelationshipList( primary, secondary [ , primaryfields ] [ , secondaryfields ] [ , relationship ]);
| primary | A null-terminated string containing the logical filename of the primary file. |
| secondary | A null-terminated string containing the logical filename of the secondary file. |
| primaryfields | A null-terminated string containing the name of the primary key field for the primary file. The value "__fileposition__" indicates the secondary is an INDEX that must use FETCH to access non-keyed fields. If omitted, the default is an empty string. |
| secondaryfields | A null-terminated string containing the name of the foreign key field relating to the primary file. If omitted, the default is an empty string. |
| relationship | A null-terminated string containing either "link" or "view" indicating the type of relationship between the primary and secondary files. If omitted, the default is "link." |
| Return: | FileRelationshipList returns a dataset in the FsFileRelationshipRecord format. |
The FileRelationshipList function returns a list file relationships between the primary and secondary files. The return records are structured in the FsFileRelationshipRecord format:
EXPORT FsFileRelationshipRecord := RECORD
STRING primaryfile {MAXLENGTH(1023)};
STRING secondaryfile {MAXLENGTH(1023)};
STRING primaryflds {MAXLENGTH(1023)};
STRING secondaryflds {MAXLENGTH(1023)};
STRING kind {MAXLENGTH(16)};
STRING cardinality {MAXLENGTH(16)};
BOOLEAN payload;
STRING description {MAXLENGTH(1023)};
END;Example:
OUTPUT(STD.File.FileRelationshipList('names', 'inquiries'));
See Also: AddFileRelationship