-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookString.TBrookString.html
224 lines (223 loc) · 12.8 KB
/
BrookString.TBrookString.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookString: Class TBrookString</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="TBrookString"></span><h1 class="cio">Class TBrookString</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookString.html">BrookString</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookString = class(<a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
String buffer class and its related methods.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html">TBrookHandledPersistent</a></li>
<li class="thisitem">TBrookString</li></ul><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>constructor <strong><a href="BrookString.TBrookString.html#Create">Create</a></strong>(AHandle: Pointer); virtual;</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>destructor <strong><a href="BrookString.TBrookString.html#Destroy">Destroy</a></strong>; override;</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>function <strong><a href="BrookString.TBrookString.html#WriteBytes">WriteBytes</a></strong>(const ASource: TBytes; ALength: NativeUInt): NativeUInt; virtual;</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>procedure <strong><a href="BrookString.TBrookString.html#Write">Write</a></strong>(const ASource: string; AEncoding: TEncoding); overload; virtual;</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>procedure <strong><a href="BrookString.TBrookString.html#Write">Write</a></strong>(const ASource: string); overload; virtual;</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>function <strong><a href="BrookString.TBrookString.html#ToString">ToString</a></strong>: string; override;</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>procedure <strong><a href="BrookString.TBrookString.html#Clear">Clear</a></strong>; virtual;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</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>property <strong><a href="BrookString.TBrookString.html#OwnsHandle">OwnsHandle</a></strong>: Boolean read FOwnsHandle <a href="BrookString.TBrookString.html#Write">write</a> FOwnsHandle;</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>property <strong><a href="BrookString.TBrookString.html#Content">Content</a></strong>: TBytes read GetContent;</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>property <strong><a href="BrookString.TBrookString.html#Length">Length</a></strong>: NativeUInt read GetLength;</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>property <strong><a href="BrookString.TBrookString.html#Text">Text</a></strong>: string read GetText <a href="BrookString.TBrookString.html#Write">write</a> SetText;</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="Create"></span><code>constructor <strong>Create</strong>(AHandle: Pointer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookString.TBrookString.html">TBrookString</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>AHandle[in]</dt>
<dd>String <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</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="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees an instance of <code><a class="normal" href="BrookString.TBrookString.html">TBrookString</a></code>.</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="WriteBytes"></span><code>function <strong>WriteBytes</strong>(const ASource: TBytes; ALength: NativeUInt): NativeUInt; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
<a class="normal" href="BrookString.TBrookString.html#Write">Write</a> a string buffer to the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>. All strings previously written are kept. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASource[in]</dt>
<dd>String buffer source to be written.</dd>
<dt>ALength[in]</dt>
<dd><a class="normal" href="BrookString.TBrookString.html#Length">Length</a> of the string buffer being written.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><a class="normal" href="BrookString.TBrookString.html#Length">Length</a> of the written string buffer.</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="Write"></span><code>procedure <strong>Write</strong>(const ASource: string; AEncoding: TEncoding); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Writes a string to the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>. All strings previously written are kept. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASource[in]</dt>
<dd>String to be written.</dd>
<dt>AEncoding[in]</dt>
<dd>Determines the encoding of the string being written.</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="Write"></span><code>procedure <strong>Write</strong>(const ASource: string); overload; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Writes a string to the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>. All strings previously written are kept. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ASource[in]</dt>
<dd>String to be written.</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="ToString"></span><code>function <strong>ToString</strong>: string; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the string from the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</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="Clear"></span><code>procedure <strong>Clear</strong>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears all the <a class="normal" href="BrookString.TBrookString.html#Content">content</a> present in the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</p>
</td></tr>
</table>
<h3 class="detail">Properties</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="OwnsHandle"></span><code>property <strong>OwnsHandle</strong>: Boolean read FOwnsHandle <a href="BrookString.TBrookString.html#Write">write</a> FOwnsHandle;</code></td>
</tr>
<tr><td colspan="2">
<p>
Determines if the <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a> is freed on the class destruction.</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="Content"></span><code>property <strong>Content</strong>: TBytes read GetContent;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the <code>content</code> buffer from the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</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="Length"></span><code>property <strong>Length</strong>: NativeUInt read GetLength;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the <a class="normal" href="BrookString.TBrookString.html#Content">content</a> <code>length</code> from the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</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="Text"></span><code>property <strong>Text</strong>: string read GetText <a href="BrookString.TBrookString.html#Write">write</a> SetText;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets or sets a string from or to the string <a class="normal" href="BrookHandledClasses.TBrookHandledPersistent.html#Handle">handle</a>.</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>