-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathFunction Documentation.html
200 lines (195 loc) · 5.18 KB
/
Function Documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE html>
<html>
<title>Dev_Documentation Exported</title>
<head>
<style>
table, td, th {border: 1px solid #ddd;text-align: left;}
table {border-collapse: collapse; width: 100%;}
th,td {padding: 15px;}
tr:hover{background-color:#f5f5f5}
th,td#Main {background-color: #4CAF50;color: white;font-size:120%;border:0px;text-align:center}
body {counter-reset: section;}
td#ID::before {counter-increment:section;content: counters(section,".");}
</style>
<meta charset = "UTF-8">
<meta name="generator" content="DBM v1116">
<!-- DMB is developed by Abhishek Sathiabalan. LINK: https://docs.google.com/uc?id=0B2v4xbFnpKvRNUg5UmVzeGxOcGs&export=download -->
</head>
<body>
<div style="overflow-x:auto;">
<table>
<thead>
<tr>
<td id = "Main" + colspan = "9">Dev Documentation</td>
</tr>
</thead>
<tr>
<th>ID</th>
<th>NAME</th>
<th>DESCRIPTION</th>
<th>Arguments</th>
<th>Return</th>
<th>Function</th>
<th>Function Name 1</th>
<th>Function Name 2</th>
<th>Parameter # Mismatch Check </th>
</tr>
<tr>
<td id="ID"> </td>
<td>Log</td>
<td>Logs Events handed to it to LOG.db and LOG.CSV </td>
<td>( Log Event , Type of Error )</td>
<td>NA</td>
<td>Yes</td>
<td>logfunction</td>
<td>Function_Log</td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Query</td>
<td>Querys the current user defined db </td>
<td>( Query , Listview , GetRecords , User ,Reason for Query )</td>
<td>Records if applicable</td>
<td>Yes</td>
<td>QueryFunction</td>
<td>Function_Query</td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Command</td>
<td>Inserts data into define db with the defined SQL code. Parses the code first.</td>
<td>(DB ,SQL , User , Reason for command )</td>
<td># Rows Updated</td>
<td>Yes</td>
<td>CommandFunction</td>
<td>Function_Command</td>
<td>✓</td>
</tr>
<tr>
<td id="ID"> </td>
<td>TransactionRecord</td>
<td>Keeps a record of all transactions</td>
<td>(User , DB , SQL , Type , Reason )</td>
<td>NA</td>
<td>Yes</td>
<td>TransactionFunction</td>
<td>Function_Transaction</td>
<td>✓</td>
</tr>
<tr>
<td id="ID"> </td>
<td>MOD_RUN_Parser</td>
<td>Runs external precomipled SB program</td>
<td>(ModName.SubName) OR (Modname , SubName) </td>
<td>NA</td>
<td>Yes</td>
<td>RunModParserFunction</td>
<td>Function_RunMod_Parser</td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>XML_Fetch_All</td>
<td>Fetches XML Attributes</td>
<td>None</td>
<td>Array of Attributes</td>
<td>Yes</td>
<td>Function_XML_Attributes</td>
<td> </td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>MainMenuHandler</td>
<td>Passes Events to the Main Menu UI Handler</td>
<td>( LastClickedButton)</td>
<td>NA</td>
<td>Yes</td>
<td>Function_MainMenu_Handler</td>
<td> </td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Add_UI_Controls</td>
<td>Adds a UI Control</td>
<td>
1= Type ( Menu , Register) <br>
2 = Caption | Name <br>
3 = Handler | Handler <br>
4 = Previous Menu Node | ToolTip <br>
5 = Action <br>
You should only register controls that already exist. Argument 5 Can be a null value if no argument is to be passed.
</td>
<td>1 for success or a error message</td>
<td>Yes</td>
<td>Function_UI_Add</td>
<td> </td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Load_DB</td>
<td>Loads a database</td>
<td>
<p> 1 = Engine Mode | Integer ONLY </p>
<p> 2 = URI or Array of Data </p>
</td>
<td>None</td>
<td>Yes</td>
<td>Function_Load_DB </td>
<td> </td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>GetPath</td>
<td>Gets the URI of a Database by getting the user to select a Database file to load in.</td>
<td>
No Arguments.
</td>
<td>URI of the Database file if one is given. Otherwise returns null.</td>
<td>Yes</td>
<td>Function_Get_DB</td>
<td> </td>
<td>✕</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Create Statistics Page</td>
<td>Creates a Statistics Table based on arguments</td>
<td>(Table,Schema)</td>
<td>Table Name that was created</td>
<td>Yes</td>
<td>Function_Handler_CreateStatistics</td>
<td> </td>
<td>✓</td>
</tr>
<tr>
<td id="ID"> </td>
<td>File Read</td>
<td>Reads a file and ignore files starting with # or that only contain " "</td>
<td>($Path)</td>
<td>Parsed Data in Array Format</td>
<td>Yes</td>
<td>Function_FileRead</td>
<td> </td>
<td>✓</td>
</tr>
<tr>
<td id="ID"> </td>
<td>Query_SQLITE_Emulator</td>
<td>Attempts to Emulate a SQLITE CLI Query</td>
<td>($Query)</td>
<td>Data</td>
<td>Yes</td>
<td>Function_Query_Emulator</td>
<td> </td>
<td>✕</td>
</tr>
</table>
</div>
</body>
</html>