|
GetRuleProperty retrieves property of the specified rule.
C/C++
char* GetRuleProperty(RULE_HANDLE handle,int PropertyID)
C#
string GetRuleProperty(int handle,int PropertyID)
returns property value or empty string for incorrect parameters.
SetRuleProperty set value for the specified property of the rule.
C/C++
int GetRuleProperty(RULE_HANDLE handle,int PropertyID,char *value)
C#
int GetRuleProperty(int handle,int PropertyID,string value)
returns
0 for success
-1 for invalid rule handle
-2 for unknown or unsupported property ID.
COM object offers "RuleProperty" string property for described functions.
You should not use "SetRuleProperty" and "GetRuleProperty" functions directly in this case.
Rule Property Definitions
| Name | Property ID | Description |
|---|
| RP_tabName | 1 | Table name to be populated by the rule. |
| RP_sqlBefore | 2 | SQL script that will be executed before the rule. ';'
or 'go' separator required for complex scripts. |
| RP_sqlAfter | 3 | SQL script that will be executed after the rule. ';'
or 'go' separator required for complex scripts. |
| RP_note | 4 | Rule note (comment) |
| RP_UpdWhere | 5 | Where clause for Update mode |
| RP_sOutFileSQL | 6 | File name for individual rule SQL output |
| RP_sOutFileTXT | 7 | File name for individual rule text output |
| RP_sTarget | 8 | Target table name for Scramble Mode |
| RP_Records | 9 | Number of rows to be generated by the rule |
| RP_PerTrans | 10 | Transaction size or 0 for auto commit |
| RP_mode | 11 | Rule type: 0 for Data Rule, 1 for Table Rule, 2 for Object Rule, 3 for File Rule and 4 for Clear Rule |
| RP_insMode | 12 | Insert mode: 0 for append, 1 for replace, 2 for Update and 3 for scramble |
|
