SET.STRUCTURE_GET Function

Syntax

String as C = Structure_Get(C setname[,C format])

Arguments

setname

The name of a set. The extension ".set" is assumed.

format

Defines the information to return about the set. The Format_String can have the following codes in it. Other characters are interpreted literally. For example, to get a list of filenames in a CR-LF delimited list, specify "N" + chr(13) + chr(10) (or "N" + CRLF() ). To get a comma-delimited list of filenames, specify "N,".

Option Flag

Meaning

N

Filename

A

Alias (Runtime name - for example, if a table is included in a set more than once, each instance has its own runtime name).

D

Parent table's alias

P

Parent linking expression

C

Child linking expression

L

Show long filenames

I

Index flags

R

Referential integrity

T

Link type

H

Tree diagram

G

Tree diagram with 'linktype'

Description

Retrieve the structure for a named set (format N=name,A=Alias,D=Dad,P=Parent Eqn,C=Child Eqn,F=Filter,I=Index flags,E=restrict parent Exist/Not_Exist/None flags).

Discussion

SET.STRUCTURE_GET()returns a string with information about the format of a set. The information returned depends on the Format_String.

 Example

SET.STRUCTURE_GET()requires that you enter a delimiter, which is not CRLF()by default. Here is how you would typically use it:

? set.structure_get("invoice", "n" + CRLF()) ->
"INVOICE_HEADER.DBF
CUSTOMER.DBF
INVOICE_ITEMS.DBF
PRODUCT.DBF
VENDOR.DBF
"
? set.STRUCTURE_GET("invoice", "h" + CRLF()) ->
"INVOICE_HEADER
INVOICE_HEADER.CUSTOMER
INVOICE_HEADER.INVOICE_ITEMS
INVOICE_HEADER.INVOICE_ITEMS.PRODUCT
INVOICE_HEADER.INVOICE_ITEMS.PRODUCT.VENDOR"

See Also