-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookUtility.Sagui.html
328 lines (321 loc) · 16.1 KB
/
BrookUtility.Sagui.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookUtility: Record Sagui</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="Sagui"></span><h1 class="cio">Record Sagui</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section">Hierarchy</div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section">Properties</div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookUtility.html">BrookUtility</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type Sagui = record</code></p>
<h2 class="description">Description</h2>
<p>
Global <code>Sagui</code> object containing general purpose functions.</p>
<h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#Version">Version</a></strong>: Cardinal; overload; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#Version">Version</a></strong>(out AMajor, AMinor: Byte; out APatch: SmallInt): Cardinal; overload; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#VersionStr">VersionStr</a></strong>: string; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#Malloc">Malloc</a></strong>(ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#Alloc">Alloc</a></strong>(ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#Realloc">Realloc</a></strong>(APointer: Pointer; ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class procedure <strong><a href="BrookUtility.Sagui.html#Free">Free</a></strong>(APointer: Pointer); static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class procedure <strong><a href="BrookUtility.Sagui.html#StrError">StrError</a></strong>(AErrorNum: Integer; out AErrorMsg: string; AErrorLen: Integer); overload; static; inline;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#StrError">StrError</a></strong>(AErrorNum: Integer): string; overload; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#IsPost">IsPost</a></strong>(const AMethod: string): Boolean; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#ExtractEntryPoint">ExtractEntryPoint</a></strong>(const APath: string): string; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#TmpDir">TmpDir</a></strong>: string; static;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#EOR">EOR</a></strong>(AError: Boolean): NativeInt; static;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <strong><a href="BrookUtility.Sagui.html#IP">IP</a></strong>(ASocket: Pointer): string; static;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Version"></span><code>class function <strong>Version</strong>: Cardinal; overload; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the library <a class="normal" href="BrookUtility.Sagui.html#Version">version</a> number. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Library <a class="normal" href="BrookUtility.Sagui.html#Version">version</a> packed into a single integer.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Version"></span><code>class function <strong>Version</strong>(out AMajor, AMinor: Byte; out APatch: SmallInt): Cardinal; overload; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the library <code>version</code> number. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AMajor[out]</dt>
<dd>Major number.</dd>
<dt>AMinor[out]</dt>
<dd>Minor number.</dd>
<dt>APatch[out]</dt>
<dd>Patch number.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Library <code>version</code> packed into a single integer.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="VersionStr"></span><code>class function <strong>VersionStr</strong>: string; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the library <a class="normal" href="BrookUtility.Sagui.html#Version">version</a> number as string in the format <code><MAJOR>.<MINOR>.<PATCH></code>. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Library <a class="normal" href="BrookUtility.Sagui.html#Version">version</a> packed into a static string.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Malloc"></span><code>class function <strong>Malloc</strong>(ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Allocates a new memory space. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASize[in]</dt>
<dd>Memory size to be allocated.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Pointer of the allocated zero-initialized memory.
<p><strong>Returns values:</strong> </p>
<dl class="paragraph_spacing">
<dt><code>nil</code></dt>
<dd><p>If size is <code>0</code> or no memory space.</p></dd>
</dl>
<p> </p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Alloc"></span><code>class function <strong>Alloc</strong>(ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Allocates a new zero-initialized memory space. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASize[in]</dt>
<dd>Memory size to be allocated.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Pointer of the allocated zero-initialized memory.
<p><strong>Returns values:</strong> </p>
<dl class="paragraph_spacing">
<dt><code>nil</code></dt>
<dd><p>If size is <code>0</code> or no memory space.</p></dd>
</dl>
<p> </p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Realloc"></span><code>class function <strong>Realloc</strong>(APointer: Pointer; ASize: NativeUInt): Pointer; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Reallocates an existing memory block. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APointer[in]</dt>
<dd>Pointer of the memory to be reallocated.</dd>
<dt>ASize[in]</dt>
<dd>Memory size to be allocated.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Pointer of the reallocated memory.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Free"></span><code>class procedure <strong>Free</strong>(APointer: Pointer); static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees a memory space previous allocated by <code><a class="normal" href="BrookUtility.Sagui.html#Malloc">Sagui.Malloc</a></code>, <a class="normal" href="BrookUtility.Sagui.html#Alloc">Sagui.Alloc</a> or <code><a class="normal" href="BrookUtility.Sagui.html#Realloc">Sagui.Realloc</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APointer[in]</dt>
<dd>Pointer of the memory to be freed.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="StrError"></span><code>class procedure <strong>StrError</strong>(AErrorNum: Integer; out AErrorMsg: string; AErrorLen: Integer); overload; static; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns string describing an error number. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AErrorNum[in]</dt>
<dd>Error number.</dd>
<dt>AErrorMsg[out]</dt>
<dd>Referenced string to store the error message.</dd>
<dt>AErrorLen[in]</dt>
<dd>Length of the error message.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="StrError"></span><code>class function <strong>StrError</strong>(AErrorNum: Integer): string; overload; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns string describing an error number. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AErrorNum[in]</dt>
<dd>Error number.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Static string describing the error.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IsPost"></span><code>class function <strong>IsPost</strong>(const AMethod: string): Boolean; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks if a string is an HTTP post method. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AMethod[in]</dt>
<dd>HTTP verb.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">True if given method is POST, PUT, DELETE or OPTIONS.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="ExtractEntryPoint"></span><code>class function <strong>ExtractEntryPoint</strong>(const APath: string): string; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Extracts the entry-point of a path or resource. For example, given a path <code>/api1/customer</code>, the part considered as entry-point is <code>/api1</code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>APath[in]</dt>
<dd>Path as static string.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Entry-point as static string.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="TmpDir"></span><code>class function <strong>TmpDir</strong>: string; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the system temporary directory. </p>
<h6 class="description_section">Returns</h6>
<p class="return">Temporary directory as static string.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="EOR"></span><code>class function <strong>EOR</strong>(AError: Boolean): NativeInt; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Indicates the end-of-read processed in <code><a class="normal" href="BrookHTTPResponse.TBrookHTTPResponse.html#SendStream">TBrookHTTPResponse.SendStream</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AError[in]</dt>
<dd><code>True</code> to return a value indicating a stream reading error.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Value to end a stream reading.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="IP"></span><code>class function <strong>IP</strong>(ASocket: Pointer): string; static;</code></td>
</tr>
<tr><td colspan="2">
<p>
Obtains the <code>IP</code> of a socket handle into a string. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASocket[in]</dt>
<dd>Socket handle.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">Formatted <code>IP</code> into a string.</p></td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>