table.RULES_GET Function

Syntax

Field_Rules as P = Rules_Get()

Returns

Field_RulesPointer: Returns a pointer to a Field Rules object.

Description

Provides access to the tables field rules.

Discussion

The <TBL>.RULES_GET() method returns a pointer to a Fields Rules object that contains field rule information for the selected table.

Example

dim tbl as P
dim fr as P
tbl = table.open("invoice_header")
fr = tbl.rules_get()

? fr
= candidate_key as C()  'Returns a cr-lf delimited list columns that make up the best candidate for 'key column'.
V Change_Begin()  'Begin changes to the field rules.
V Change_End([L Commit])  'End changes to the field rules.
C Class()  'Get the class name.
Dependencies_Get as C(tableName as c,fieldName as c)  'Returns a cr-lf delimited list of dependencies in the field rules on a column on a foriegn table - list generate in format <tablename>|<fieldname>|<reason>.
Field_Rule_Get as P(fieldName as c[,variableFrame as p])  'Get (or add) a rule for a field - includes variables of calc fields.
V Mode_Get()  'Get change/view mode of field rules.
Table_Dependencies_Get as C()  'Returns a cr-lf delimited list of all the external tables that are referenced by field rules for tables - of the form <tablename>|<reason>.
L Tag_Add(C table,C order_expre,C filter_expr,L unique)  'Add a tag if it doesn't already exist.
+CC_EXPIRATION.
+CC_NUMBER.
+Code.
+CUSTOMER_ID.
+DATE.
+DELIVERY_BY.
+DISCOUNT.
+INVOICE_NUMBER.
+PAY_METHOD.
+SALES_REP.
+SALES_TAX.

? fr.DATE
= C Class()  'Get the class name.
constraints_get()
constraints_types()
data_type_get()
from_string()
fullname_get()
generate_script()
name_get()
table_name_get()
to_string()
Auto_Advance = .F.
Case_Convert = "None"
Case_Lookup_Word = "Entire"
Check_Case_Exceptions = .F.
+Code.
+Cross_File.
Cursor_Pos = "End Of Selected"
Data_Type = "User"
+Default.
Description = "Invoice date"
+Double_Entry.
Long_Name = "Invoice Date"
+Lookup.
+Mask.
Maximum = ""
Minimum = ""
+Post.
+Required.
Skip = ""
Template_Not_Stored = .F.
+Unique.
+Validation.