bbvcommon 6.268.0.20100803
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/NET35/bbv.Common.AsyncModule.dll +0 -0
- data/lib/NET35/bbv.Common.AsyncModule.xml +893 -0
- data/lib/NET35/bbv.Common.Data.XML +245 -0
- data/lib/NET35/bbv.Common.Data.dll +0 -0
- data/lib/NET35/bbv.Common.Diagnostics.XML +102 -0
- data/lib/NET35/bbv.Common.Diagnostics.dll +0 -0
- data/lib/NET35/bbv.Common.EvaluationEngine.dll +0 -0
- data/lib/NET35/bbv.Common.EventBroker.XML +3100 -0
- data/lib/NET35/bbv.Common.EventBroker.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.xml +74 -0
- data/lib/NET35/bbv.Common.IO.dll +0 -0
- data/lib/NET35/bbv.Common.IO.xml +1354 -0
- data/lib/NET35/bbv.Common.RuleEngine.dll +0 -0
- data/lib/NET35/bbv.Common.RuleEngine.xml +659 -0
- data/lib/NET35/bbv.Common.Security.XML +339 -0
- data/lib/NET35/bbv.Common.Security.dll +0 -0
- data/lib/NET35/bbv.Common.StateMachine.XML +2559 -0
- data/lib/NET35/bbv.Common.StateMachine.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.xml +696 -0
- data/lib/NET35/bbv.Common.Threading.XML +401 -0
- data/lib/NET35/bbv.Common.Threading.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.xml +114 -0
- data/lib/NET35/bbv.Common.XML +831 -0
- data/lib/NET35/bbv.Common.dll +0 -0
- metadata +118 -0
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>bbv.Common.Formatters</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:bbv.Common.Formatters.FormatHelper">
|
|
8
|
+
<summary>
|
|
9
|
+
Provides functionality for formatting strings.
|
|
10
|
+
</summary>
|
|
11
|
+
</member>
|
|
12
|
+
<member name="M:bbv.Common.Formatters.FormatHelper.SecureFormat(System.String,System.Object[])">
|
|
13
|
+
<summary>
|
|
14
|
+
Replacement for the String.Format method, that throws an exception
|
|
15
|
+
when the count of arguments does not match the count of placeholders.
|
|
16
|
+
<para>
|
|
17
|
+
If format and/or args are null then still a string is returned.
|
|
18
|
+
</para>
|
|
19
|
+
</summary>
|
|
20
|
+
<param name="format">The format string.</param>
|
|
21
|
+
<param name="args">The arguments to the format string..</param>
|
|
22
|
+
<returns>
|
|
23
|
+
Returns the fully formatted string, if successful In case of
|
|
24
|
+
an error, the format string and all parameters added in a list
|
|
25
|
+
will be returned.
|
|
26
|
+
</returns>
|
|
27
|
+
<remarks>
|
|
28
|
+
Tries to format with String.Format. In case of an Exception the
|
|
29
|
+
original format string and all parameters added in a list will
|
|
30
|
+
be returned.
|
|
31
|
+
</remarks>
|
|
32
|
+
</member>
|
|
33
|
+
<member name="M:bbv.Common.Formatters.FormatHelper.ConvertToString(System.Collections.IEnumerable,System.String)">
|
|
34
|
+
<summary>
|
|
35
|
+
Converts a collection of objects to a string representation.
|
|
36
|
+
</summary>
|
|
37
|
+
<param name="collection">Collection of objects.</param>
|
|
38
|
+
<param name="separator">Separator to separate objects.</param>
|
|
39
|
+
<returns>String representation of the collection.</returns>
|
|
40
|
+
</member>
|
|
41
|
+
<member name="M:bbv.Common.Formatters.FormatHelper.ConvertToString(System.Collections.Generic.IDictionary{System.Object,System.Object},System.String)">
|
|
42
|
+
<summary>
|
|
43
|
+
Converts a dictionary of object, object to a string representation in the form of Key=Value<paramref name="separator"/>.
|
|
44
|
+
</summary>
|
|
45
|
+
<param name="dictionary">The dictionary.</param>
|
|
46
|
+
<param name="separator">The separator to separate key value pairs.</param>
|
|
47
|
+
<returns>String representation of the dictionary</returns>
|
|
48
|
+
</member>
|
|
49
|
+
<member name="T:bbv.Common.Formatters.StringTruncationFormatter">
|
|
50
|
+
<summary>
|
|
51
|
+
Allows to define the maximal length of an string. A string longer than the given value will be truncated.
|
|
52
|
+
Use: Format("{0,-5:L5}", "123456") -> "12345"
|
|
53
|
+
Use: Format("{0,5:L5}", "123") -> " 123"
|
|
54
|
+
Use: Format("{0,-5:L10}", "1234567890123") -> "1234567890"
|
|
55
|
+
</summary>
|
|
56
|
+
</member>
|
|
57
|
+
<member name="M:bbv.Common.Formatters.StringTruncationFormatter.GetFormat(System.Type)">
|
|
58
|
+
<summary>
|
|
59
|
+
String.Format calls this method to get an instance of an ICustomFormatter to handle the formatting.
|
|
60
|
+
</summary>
|
|
61
|
+
<param name="service">The requested service.</param>
|
|
62
|
+
<returns>An ICustomFormatter.</returns>
|
|
63
|
+
</member>
|
|
64
|
+
<member name="M:bbv.Common.Formatters.StringTruncationFormatter.Format(System.String,System.Object,System.IFormatProvider)">
|
|
65
|
+
<summary>
|
|
66
|
+
After String.Format gets the ICustomFormatter, it calls this format method on each argument.
|
|
67
|
+
</summary>
|
|
68
|
+
<param name="format">The format string.</param>
|
|
69
|
+
<param name="arg">The arguments for the format string.</param>
|
|
70
|
+
<param name="provider">The provider.</param>
|
|
71
|
+
<returns>Formatted string.</returns>
|
|
72
|
+
</member>
|
|
73
|
+
</members>
|
|
74
|
+
</doc>
|
|
Binary file
|
|
@@ -0,0 +1,1354 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>bbv.Common.IO</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:bbv.Common.IO.DriveUtilities">
|
|
8
|
+
<summary>
|
|
9
|
+
Provides functionality to get drive information.
|
|
10
|
+
</summary>
|
|
11
|
+
</member>
|
|
12
|
+
<member name="M:bbv.Common.IO.DriveUtilities.GetDriveFreeSpace(System.String)">
|
|
13
|
+
<summary>
|
|
14
|
+
Gets the drive free space.
|
|
15
|
+
</summary>
|
|
16
|
+
<param name="driveName">Name of the drive.</param>
|
|
17
|
+
<returns>free space in Byte</returns>
|
|
18
|
+
</member>
|
|
19
|
+
<member name="M:bbv.Common.IO.DriveUtilities.GetTotalDriveSpace(System.String)">
|
|
20
|
+
<summary>
|
|
21
|
+
Gets the total drive space.
|
|
22
|
+
</summary>
|
|
23
|
+
<param name="driveName">Name of the drive.</param>
|
|
24
|
+
<returns>total drive space in Byte</returns>
|
|
25
|
+
</member>
|
|
26
|
+
<member name="M:bbv.Common.IO.DriveUtilities.GetFolderSize(System.String,System.Boolean)">
|
|
27
|
+
<summary>
|
|
28
|
+
Gets the size of the folder.
|
|
29
|
+
</summary>
|
|
30
|
+
<param name="path">The path of the folder</param>
|
|
31
|
+
<param name="recursive">if set to <c>true</c> [recursive].</param>
|
|
32
|
+
<returns>folder size in Byte</returns>
|
|
33
|
+
</member>
|
|
34
|
+
<member name="M:bbv.Common.IO.DriveUtilities.FormatByteSize(System.Double)">
|
|
35
|
+
<summary>
|
|
36
|
+
Transforms the space in Bytes into more Readable form.
|
|
37
|
+
</summary>
|
|
38
|
+
<param name="bytes">The bytes.</param>
|
|
39
|
+
<returns>Transformed Size.</returns>
|
|
40
|
+
</member>
|
|
41
|
+
<member name="M:bbv.Common.IO.DriveUtilities.GetFolderSizeFlat(System.String)">
|
|
42
|
+
<summary>
|
|
43
|
+
Gets the folder size flat.
|
|
44
|
+
</summary>
|
|
45
|
+
<param name="path">The path of the folder.</param>
|
|
46
|
+
<returns>The flat size of the folder.</returns>
|
|
47
|
+
</member>
|
|
48
|
+
<member name="T:bbv.Common.IO.FileActionCommand">
|
|
49
|
+
<summary>
|
|
50
|
+
Base class for recursive file actions. The action is executed for each file in the source path.
|
|
51
|
+
</summary>
|
|
52
|
+
</member>
|
|
53
|
+
<member name="M:bbv.Common.IO.FileActionCommand.MoveRecursiv(System.String,System.String)">
|
|
54
|
+
<summary>
|
|
55
|
+
Moves files recursively.
|
|
56
|
+
</summary>
|
|
57
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
58
|
+
<param name="destinationPath">Destination Path</param>
|
|
59
|
+
</member>
|
|
60
|
+
<member name="M:bbv.Common.IO.FileActionCommand.MoveRecursiv(System.String,System.String,System.String)">
|
|
61
|
+
<summary>
|
|
62
|
+
Moves files recursively.
|
|
63
|
+
</summary>
|
|
64
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
65
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
66
|
+
<param name="destinationPath">Destination Path</param>
|
|
67
|
+
</member>
|
|
68
|
+
<member name="M:bbv.Common.IO.FileActionCommand.MoveRecursiv(System.String,System.Collections.ArrayList,System.String)">
|
|
69
|
+
<summary>
|
|
70
|
+
Moves files recursively.
|
|
71
|
+
</summary>
|
|
72
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
73
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
74
|
+
<param name="destinationPath">Destination Path</param>
|
|
75
|
+
</member>
|
|
76
|
+
<member name="M:bbv.Common.IO.FileActionCommand.MoveRecursiv(System.String,System.String,System.Collections.ArrayList,System.String)">
|
|
77
|
+
<summary>
|
|
78
|
+
Moves files recursively.
|
|
79
|
+
</summary>
|
|
80
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
81
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
82
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
83
|
+
<param name="destinationPath">Destination Path</param>
|
|
84
|
+
</member>
|
|
85
|
+
<member name="M:bbv.Common.IO.FileActionCommand.CopyRecursiv(System.String,System.String,System.Boolean)">
|
|
86
|
+
<summary>
|
|
87
|
+
Copy files recursively.
|
|
88
|
+
</summary>
|
|
89
|
+
<param name="sourcePath">Source Path at which to start to copy.</param>
|
|
90
|
+
<param name="destinationPath">Destination Path</param>
|
|
91
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
92
|
+
</member>
|
|
93
|
+
<member name="M:bbv.Common.IO.FileActionCommand.CopyRecursiv(System.String,System.String,System.String,System.Boolean)">
|
|
94
|
+
<summary>
|
|
95
|
+
Copy files recursively.
|
|
96
|
+
</summary>
|
|
97
|
+
<param name="sourcePath">Source Path at which to start to copy.</param>
|
|
98
|
+
<param name="searchPattern">Only files that match this pattern are copied.</param>
|
|
99
|
+
<param name="destinationPath">Destination Path</param>
|
|
100
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
101
|
+
</member>
|
|
102
|
+
<member name="M:bbv.Common.IO.FileActionCommand.CopyRecursiv(System.String,System.Collections.ArrayList,System.String,System.Boolean)">
|
|
103
|
+
<summary>
|
|
104
|
+
Copy files recursively.
|
|
105
|
+
</summary>
|
|
106
|
+
<param name="sourcePath">Source Path at which to start to copy.</param>
|
|
107
|
+
<param name="excludeDirs">Directories to exclude from copy.</param>
|
|
108
|
+
<param name="destinationPath">Destination Path</param>
|
|
109
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
110
|
+
</member>
|
|
111
|
+
<member name="M:bbv.Common.IO.FileActionCommand.CopyRecursiv(System.String,System.String,System.Collections.ArrayList,System.String,System.Boolean)">
|
|
112
|
+
<summary>
|
|
113
|
+
Copy files recursively.
|
|
114
|
+
</summary>
|
|
115
|
+
<param name="sourcePath">Source Path at which to start to copy.</param>
|
|
116
|
+
<param name="searchPattern">Only files that match this pattern are copied.</param>
|
|
117
|
+
<param name="excludeDirs">Directories to exclude from copy.</param>
|
|
118
|
+
<param name="destinationPath">Destination Path</param>
|
|
119
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
120
|
+
</member>
|
|
121
|
+
<member name="M:bbv.Common.IO.FileActionCommand.NumberOfDirsAndFiles(System.String)">
|
|
122
|
+
<summary>
|
|
123
|
+
Count files and directories recursively.
|
|
124
|
+
</summary>
|
|
125
|
+
<param name="sourcePath">Source Path at which to start to count.</param>
|
|
126
|
+
<returns>Returns number of files an directories in directory tree.</returns>
|
|
127
|
+
</member>
|
|
128
|
+
<member name="M:bbv.Common.IO.FileActionCommand.NumberOfDirsAndFiles(System.String,System.String)">
|
|
129
|
+
<summary>
|
|
130
|
+
Count files and directories recursively.
|
|
131
|
+
</summary>
|
|
132
|
+
<param name="sourcePath">Source Path at which to start to count.</param>
|
|
133
|
+
<param name="searchPattern">Only files that match this pattern are counted.</param>
|
|
134
|
+
<returns>Returns number of files an directories in directory tree.</returns>
|
|
135
|
+
</member>
|
|
136
|
+
<member name="M:bbv.Common.IO.FileActionCommand.NumberOfDirsAndFiles(System.String,System.Collections.ArrayList)">
|
|
137
|
+
<summary>
|
|
138
|
+
Count files and directories recursively.
|
|
139
|
+
</summary>
|
|
140
|
+
<param name="sourcePath">Source Path at which to start to count.</param>
|
|
141
|
+
<param name="excludeDirs">Directories to exclude from count.</param>
|
|
142
|
+
<returns>Returns number of files an directories in directory tree.</returns>
|
|
143
|
+
</member>
|
|
144
|
+
<member name="M:bbv.Common.IO.FileActionCommand.NumberOfDirsAndFiles(System.String,System.String,System.Collections.ArrayList)">
|
|
145
|
+
<summary>
|
|
146
|
+
Count files and directories recursively.
|
|
147
|
+
</summary>
|
|
148
|
+
<param name="sourcePath">Source Path at which to start to count.</param>
|
|
149
|
+
<param name="searchPattern">Only files that match this pattern are counted.</param>
|
|
150
|
+
<param name="excludeDirs">Directories to exclude from count.</param>
|
|
151
|
+
<returns>Returns number of files an directories in directory tree.</returns>
|
|
152
|
+
</member>
|
|
153
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetFilesRecursiv(System.String)">
|
|
154
|
+
<summary>
|
|
155
|
+
Gets files recursively.
|
|
156
|
+
</summary>
|
|
157
|
+
<param name="sourcePath">Source Path at which to start to get.</param>
|
|
158
|
+
<returns>Returns an arraylist of filenames.</returns>
|
|
159
|
+
</member>
|
|
160
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetFilesRecursiv(System.String,System.String)">
|
|
161
|
+
<summary>
|
|
162
|
+
Gets files recursively.
|
|
163
|
+
</summary>
|
|
164
|
+
<param name="sourcePath">Source Path at which to start to get.</param>
|
|
165
|
+
<param name="searchPattern">Only files that match this pattern are getted.</param>
|
|
166
|
+
<returns>Returns an arraylist of filenames.</returns>
|
|
167
|
+
</member>
|
|
168
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetFilesRecursiv(System.String,System.Collections.ArrayList)">
|
|
169
|
+
<summary>
|
|
170
|
+
Gets files recursively.
|
|
171
|
+
</summary>
|
|
172
|
+
<param name="sourcePath">Source Path at which to start to get.</param>
|
|
173
|
+
<param name="excludeDirs">Directories to exclude from get.</param>
|
|
174
|
+
<returns>Returns an arraylist of filenames.</returns>
|
|
175
|
+
</member>
|
|
176
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetFilesRecursiv(System.String,System.String,System.Collections.ArrayList)">
|
|
177
|
+
<summary>
|
|
178
|
+
Gets files recursively.
|
|
179
|
+
</summary>
|
|
180
|
+
<param name="sourcePath">Source Path at which to start to get.</param>
|
|
181
|
+
<param name="searchPattern">Only files that match this pattern are getted.</param>
|
|
182
|
+
<param name="excludeDirs">Directories to exclude from get.</param>
|
|
183
|
+
<returns>Returns an arraylist of filenames.</returns>
|
|
184
|
+
</member>
|
|
185
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetSizeRecursiv(System.String)">
|
|
186
|
+
<summary>
|
|
187
|
+
Gets file size recursively.
|
|
188
|
+
</summary>
|
|
189
|
+
<param name="sourcePath">Source Path at which to start to calculate filesize.</param>
|
|
190
|
+
<returns>Returns size of directory tree.</returns>
|
|
191
|
+
</member>
|
|
192
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetSizeRecursiv(System.String,System.String)">
|
|
193
|
+
<summary>
|
|
194
|
+
Gets file size recursively.
|
|
195
|
+
</summary>
|
|
196
|
+
<param name="sourcePath">Source Path at which to start to calculate filesize.</param>
|
|
197
|
+
<param name="searchPattern">Only files that match this pattern are counted.</param>
|
|
198
|
+
<returns>Returns size of directory tree.</returns>
|
|
199
|
+
</member>
|
|
200
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetSizeRecursiv(System.String,System.Collections.ArrayList)">
|
|
201
|
+
<summary>
|
|
202
|
+
Gets file size recursively.
|
|
203
|
+
</summary>
|
|
204
|
+
<param name="sourcePath">Source Path at which to start to calculate filesize.</param>
|
|
205
|
+
<param name="excludeDirs">Directories to exclude from filesize.</param>
|
|
206
|
+
<returns>Returns size of directory tree.</returns>
|
|
207
|
+
</member>
|
|
208
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetSizeRecursiv(System.String,System.String,System.Collections.ArrayList)">
|
|
209
|
+
<summary>
|
|
210
|
+
Gets file size recursively.
|
|
211
|
+
</summary>
|
|
212
|
+
<param name="sourcePath">Source Path at which to start to calculate filesize.</param>
|
|
213
|
+
<param name="searchPattern">Only files that match this pattern are counted.</param>
|
|
214
|
+
<param name="excludeDirs">Directories to exclude from filesize.</param>
|
|
215
|
+
<returns>Returns size of directory tree.</returns>
|
|
216
|
+
</member>
|
|
217
|
+
<member name="F:bbv.Common.IO.FileActionCommand.sourcePath">
|
|
218
|
+
<summary>
|
|
219
|
+
Source Path at which to start the action.
|
|
220
|
+
</summary>
|
|
221
|
+
</member>
|
|
222
|
+
<member name="M:bbv.Common.IO.FileActionCommand.#ctor(System.String)">
|
|
223
|
+
<summary>
|
|
224
|
+
Constructor
|
|
225
|
+
</summary>
|
|
226
|
+
<param name="sourcePath">Source Path at which to start the action.</param>
|
|
227
|
+
</member>
|
|
228
|
+
<member name="M:bbv.Common.IO.FileActionCommand.#ctor(System.String,System.Collections.ArrayList)">
|
|
229
|
+
<summary>
|
|
230
|
+
Constructor
|
|
231
|
+
</summary>
|
|
232
|
+
<param name="sourcePath">Source Path at which to start the action.</param>
|
|
233
|
+
<param name="excludeDirs">Directories to exclude from action.</param>
|
|
234
|
+
</member>
|
|
235
|
+
<member name="M:bbv.Common.IO.FileActionCommand.#ctor(System.String,System.String)">
|
|
236
|
+
<summary>
|
|
237
|
+
Constructor
|
|
238
|
+
</summary>
|
|
239
|
+
<param name="sourcePath">Source Path at which to start the action.</param>
|
|
240
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
241
|
+
</member>
|
|
242
|
+
<member name="M:bbv.Common.IO.FileActionCommand.#ctor(System.String,System.String,System.Collections.ArrayList)">
|
|
243
|
+
<summary>
|
|
244
|
+
Constructor
|
|
245
|
+
</summary>
|
|
246
|
+
<param name="sourcePath">Source Path at which to start the action.</param>
|
|
247
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
248
|
+
<param name="excludeDirs">Directories to exclude from action.</param>
|
|
249
|
+
</member>
|
|
250
|
+
<member name="M:bbv.Common.IO.FileActionCommand.FileAction(System.String)">
|
|
251
|
+
<summary>
|
|
252
|
+
Override this method to execute the action.
|
|
253
|
+
</summary>
|
|
254
|
+
<param name="fileName"></param>
|
|
255
|
+
</member>
|
|
256
|
+
<member name="M:bbv.Common.IO.FileActionCommand.ExecuteRecursiv(System.String)">
|
|
257
|
+
<summary>
|
|
258
|
+
Called for each file in the source path and each underling directory <see cref="M:bbv.Common.IO.FileActionCommand.FileAction(System.String)"/>.
|
|
259
|
+
This i sthe recursive method.
|
|
260
|
+
</summary>
|
|
261
|
+
<param name="path"></param>
|
|
262
|
+
</member>
|
|
263
|
+
<member name="M:bbv.Common.IO.FileActionCommand.OnFileActionExecuted(System.String)">
|
|
264
|
+
<summary>
|
|
265
|
+
Fires <see cref="E:bbv.Common.IO.FileActionCommand.FileActionExecuted"/> event.
|
|
266
|
+
</summary>
|
|
267
|
+
<param name="fileName">Name of the file that has been processed.</param>
|
|
268
|
+
</member>
|
|
269
|
+
<member name="M:bbv.Common.IO.FileActionCommand.GetDiffPath(System.String,System.String)">
|
|
270
|
+
<summary>
|
|
271
|
+
Returns the difference between the to given path.
|
|
272
|
+
</summary>
|
|
273
|
+
<param name="path"></param>
|
|
274
|
+
<param name="filename"></param>
|
|
275
|
+
<returns></returns>
|
|
276
|
+
</member>
|
|
277
|
+
<member name="E:bbv.Common.IO.FileActionCommand.FileActionExecuted">
|
|
278
|
+
<summary>
|
|
279
|
+
This event is fired after FileAction has completed a file.
|
|
280
|
+
</summary>
|
|
281
|
+
</member>
|
|
282
|
+
<member name="P:bbv.Common.IO.FileActionCommand.IgnoreLockedFiles">
|
|
283
|
+
<summary>
|
|
284
|
+
Indicates whether to ignore locked files or not. If locked files are not ignored, an exception is thrown.
|
|
285
|
+
</summary>
|
|
286
|
+
</member>
|
|
287
|
+
<member name="T:bbv.Common.IO.FileActionExecutedEventHandler">
|
|
288
|
+
<summary>
|
|
289
|
+
Delegate for <see cref="E:bbv.Common.IO.FileActionCommand.FileActionExecuted"/> event.
|
|
290
|
+
</summary>
|
|
291
|
+
</member>
|
|
292
|
+
<member name="T:bbv.Common.IO.FileActionExecutedEventArgs">
|
|
293
|
+
<summary>
|
|
294
|
+
Defines the EventArgs used fro event <see cref="E:bbv.Common.IO.FileActionCommand.FileActionExecuted"/>
|
|
295
|
+
</summary>
|
|
296
|
+
</member>
|
|
297
|
+
<member name="F:bbv.Common.IO.FileActionExecutedEventArgs.FileName">
|
|
298
|
+
<summary>
|
|
299
|
+
Name of the file tha has bee processed.
|
|
300
|
+
</summary>
|
|
301
|
+
</member>
|
|
302
|
+
<member name="M:bbv.Common.IO.FileActionExecutedEventArgs.#ctor(System.String)">
|
|
303
|
+
<summary>
|
|
304
|
+
Constructor.
|
|
305
|
+
</summary>
|
|
306
|
+
<param name="fileName"></param>
|
|
307
|
+
</member>
|
|
308
|
+
<member name="T:bbv.Common.IO.FileMove">
|
|
309
|
+
<summary>
|
|
310
|
+
Moves files recursivly
|
|
311
|
+
</summary>
|
|
312
|
+
<example>
|
|
313
|
+
Normally use static method on <see cref="M:bbv.Common.IO.FileActionCommand.MoveRecursiv(System.String,System.String)"/>:
|
|
314
|
+
<code>
|
|
315
|
+
FileActionCommand.FileMove(sourcePath, searchPattern, excludeDirs, destinationPath);
|
|
316
|
+
</code>
|
|
317
|
+
In special cases you may use:
|
|
318
|
+
<code>
|
|
319
|
+
FileMove fm = new FileMove(sourcePath, searchPattern, excludeDirs, destinationPath);
|
|
320
|
+
fm.ExecuteRecursiv(sourcePath);
|
|
321
|
+
</code>
|
|
322
|
+
</example>
|
|
323
|
+
</member>
|
|
324
|
+
<member name="F:bbv.Common.IO.FileMove.destinationPath">
|
|
325
|
+
<summary>
|
|
326
|
+
Destination path
|
|
327
|
+
</summary>
|
|
328
|
+
</member>
|
|
329
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.String,System.Boolean)">
|
|
330
|
+
<summary>
|
|
331
|
+
Constructor
|
|
332
|
+
</summary>
|
|
333
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
334
|
+
<param name="destinationPath">Destination Path</param>
|
|
335
|
+
<param name="overwrite">True if existing files should be overriden. Default is false.</param>
|
|
336
|
+
</member>
|
|
337
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.String)">
|
|
338
|
+
<summary>
|
|
339
|
+
Constructor
|
|
340
|
+
</summary>
|
|
341
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
342
|
+
<param name="destinationPath">Destination Path</param>
|
|
343
|
+
</member>
|
|
344
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.String,System.String)">
|
|
345
|
+
<summary>
|
|
346
|
+
Constructor
|
|
347
|
+
</summary>
|
|
348
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
349
|
+
<param name="searchPattern">Only files that match this pattern are moved.</param>
|
|
350
|
+
<param name="destinationPath">Destination Path</param>
|
|
351
|
+
</member>
|
|
352
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.Collections.ArrayList,System.String)">
|
|
353
|
+
<summary>
|
|
354
|
+
Constructor
|
|
355
|
+
</summary>
|
|
356
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
357
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
358
|
+
<param name="destinationPath">Destination Path</param>
|
|
359
|
+
</member>
|
|
360
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.Collections.ArrayList,System.String,System.Boolean)">
|
|
361
|
+
<summary>
|
|
362
|
+
Constructor
|
|
363
|
+
</summary>
|
|
364
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
365
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
366
|
+
<param name="destinationPath">Destination Path</param>
|
|
367
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
368
|
+
</member>
|
|
369
|
+
<member name="M:bbv.Common.IO.FileMove.#ctor(System.String,System.String,System.Collections.ArrayList,System.String)">
|
|
370
|
+
<summary>
|
|
371
|
+
Constructor
|
|
372
|
+
</summary>
|
|
373
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
374
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
375
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
376
|
+
<param name="destinationPath">Destination Path</param>
|
|
377
|
+
</member>
|
|
378
|
+
<member name="M:bbv.Common.IO.FileMove.FileAction(System.String)">
|
|
379
|
+
<summary>
|
|
380
|
+
Moves the given file to destination path.
|
|
381
|
+
</summary>
|
|
382
|
+
<param name="fileName">File to move.</param>
|
|
383
|
+
</member>
|
|
384
|
+
<member name="M:bbv.Common.IO.FileMove.FileAction(System.String,System.String@)">
|
|
385
|
+
<summary>
|
|
386
|
+
Moves the given file to destination path.
|
|
387
|
+
</summary>
|
|
388
|
+
<param name="fileName">File to move.</param>
|
|
389
|
+
<param name="destinationFilePath">Path of the moved file (new).</param>
|
|
390
|
+
</member>
|
|
391
|
+
<member name="T:bbv.Common.IO.FileCopy">
|
|
392
|
+
<summary>
|
|
393
|
+
Copies files recursivly
|
|
394
|
+
</summary>
|
|
395
|
+
<example>
|
|
396
|
+
Normally use static method on <see cref="M:bbv.Common.IO.FileActionCommand.CopyRecursiv(System.String,System.String,System.Boolean)"/>:
|
|
397
|
+
<code>
|
|
398
|
+
FileActionCommand.FileCopy(sourcePath, searchPattern, excludeDirs, destinationPath, overwrite);
|
|
399
|
+
</code>
|
|
400
|
+
In special cases you may use:
|
|
401
|
+
<code>
|
|
402
|
+
FileCopy fc = new FileCopy(sourcePath, searchPattern, excludeDirs, destinationPath, overwrite);
|
|
403
|
+
fc.ExecuteRecursiv(sourcePath);
|
|
404
|
+
</code>
|
|
405
|
+
</example>
|
|
406
|
+
</member>
|
|
407
|
+
<member name="M:bbv.Common.IO.FileCopy.#ctor(System.String,System.String,System.Boolean)">
|
|
408
|
+
<summary>
|
|
409
|
+
Constructor
|
|
410
|
+
</summary>
|
|
411
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
412
|
+
<param name="destinationPath">Destination Path</param>
|
|
413
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
414
|
+
</member>
|
|
415
|
+
<member name="M:bbv.Common.IO.FileCopy.#ctor(System.String,System.String,System.String,System.Boolean)">
|
|
416
|
+
<summary>
|
|
417
|
+
Constructor
|
|
418
|
+
</summary>
|
|
419
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
420
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
421
|
+
<param name="destinationPath">Destination Path</param>
|
|
422
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
423
|
+
</member>
|
|
424
|
+
<member name="M:bbv.Common.IO.FileCopy.#ctor(System.String,System.Collections.ArrayList,System.String,System.Boolean)">
|
|
425
|
+
<summary>
|
|
426
|
+
Constructor
|
|
427
|
+
</summary>
|
|
428
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
429
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
430
|
+
<param name="destinationPath">Destination Path</param>
|
|
431
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
432
|
+
</member>
|
|
433
|
+
<member name="M:bbv.Common.IO.FileCopy.#ctor(System.String,System.String,System.Collections.ArrayList,System.String,System.Boolean)">
|
|
434
|
+
<summary>
|
|
435
|
+
Constructor
|
|
436
|
+
</summary>
|
|
437
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
438
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
439
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
440
|
+
<param name="destinationPath">Destination Path</param>
|
|
441
|
+
<param name="overwrite">True if existing files should be overriden.</param>
|
|
442
|
+
</member>
|
|
443
|
+
<member name="M:bbv.Common.IO.FileCopy.FileAction(System.String)">
|
|
444
|
+
<summary>
|
|
445
|
+
Copies the given file to destination path.
|
|
446
|
+
</summary>
|
|
447
|
+
<param name="fileName">File to copy.</param>
|
|
448
|
+
</member>
|
|
449
|
+
<member name="T:bbv.Common.IO.FileSize">
|
|
450
|
+
<summary>
|
|
451
|
+
Calculates size of a directory tree.
|
|
452
|
+
</summary>
|
|
453
|
+
<example>
|
|
454
|
+
Normally use static method on <see cref="M:bbv.Common.IO.FileActionCommand.GetSizeRecursiv(System.String)"/>:
|
|
455
|
+
<code>
|
|
456
|
+
int size = FileActionCommand.FileSize(sourcePath, searchPattern, excludeDirs);
|
|
457
|
+
</code>
|
|
458
|
+
In special cases you may use:
|
|
459
|
+
<code>
|
|
460
|
+
FileSize fs = new FileSize(sourcePath, searchPattern, excludeDirs);
|
|
461
|
+
fs.ExecuteRecursiv(sourcePath);
|
|
462
|
+
int size = fs.Size;
|
|
463
|
+
</code>
|
|
464
|
+
</example>
|
|
465
|
+
</member>
|
|
466
|
+
<member name="M:bbv.Common.IO.FileSize.#ctor(System.String)">
|
|
467
|
+
<summary>
|
|
468
|
+
Constructor
|
|
469
|
+
</summary>
|
|
470
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
471
|
+
</member>
|
|
472
|
+
<member name="M:bbv.Common.IO.FileSize.#ctor(System.String,System.String)">
|
|
473
|
+
<summary>
|
|
474
|
+
Constructor
|
|
475
|
+
</summary>
|
|
476
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
477
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
478
|
+
</member>
|
|
479
|
+
<member name="M:bbv.Common.IO.FileSize.#ctor(System.String,System.Collections.ArrayList)">
|
|
480
|
+
<summary>
|
|
481
|
+
Constructor
|
|
482
|
+
</summary>
|
|
483
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
484
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
485
|
+
</member>
|
|
486
|
+
<member name="M:bbv.Common.IO.FileSize.#ctor(System.String,System.String,System.Collections.ArrayList)">
|
|
487
|
+
<summary>
|
|
488
|
+
Constructor
|
|
489
|
+
</summary>
|
|
490
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
491
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
492
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
493
|
+
</member>
|
|
494
|
+
<member name="M:bbv.Common.IO.FileSize.FileAction(System.String)">
|
|
495
|
+
<summary>
|
|
496
|
+
Adds size the given file.
|
|
497
|
+
</summary>
|
|
498
|
+
<param name="fileName">Found file</param>
|
|
499
|
+
</member>
|
|
500
|
+
<member name="P:bbv.Common.IO.FileSize.Size">
|
|
501
|
+
<summary>
|
|
502
|
+
Gets size of the directory tree.
|
|
503
|
+
</summary>
|
|
504
|
+
</member>
|
|
505
|
+
<member name="T:bbv.Common.IO.NumberOfDirsAndFiles">
|
|
506
|
+
<summary>
|
|
507
|
+
Calculates how many files and directories are in the tree.
|
|
508
|
+
</summary>
|
|
509
|
+
<example>
|
|
510
|
+
Normally use static method on <see cref="M:bbv.Common.IO.FileActionCommand.NumberOfDirsAndFiles(System.String)"/>:
|
|
511
|
+
<code>
|
|
512
|
+
int nrOfFilesAndDirectories = FileActionCommand.NumberOfDirsAndFiles(sourcePath, searchPattern, excludeDirs);
|
|
513
|
+
</code>
|
|
514
|
+
In special cases you may use:
|
|
515
|
+
<code>
|
|
516
|
+
NumberOfDirsAndFiles nof = new NumberOfDirsAndFiles(sourcePath, searchPattern, excludeDirs);
|
|
517
|
+
nof.ExecuteRecursiv(sourcePath);
|
|
518
|
+
int nrOfFilesAndDirectories = nof.Count;
|
|
519
|
+
</code>
|
|
520
|
+
</example>
|
|
521
|
+
</member>
|
|
522
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.#ctor(System.String)">
|
|
523
|
+
<summary>
|
|
524
|
+
Constructor
|
|
525
|
+
</summary>
|
|
526
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
527
|
+
</member>
|
|
528
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.#ctor(System.String,System.String)">
|
|
529
|
+
<summary>
|
|
530
|
+
Constructor
|
|
531
|
+
</summary>
|
|
532
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
533
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
534
|
+
</member>
|
|
535
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.#ctor(System.String,System.Collections.ArrayList)">
|
|
536
|
+
<summary>
|
|
537
|
+
Constructor
|
|
538
|
+
</summary>
|
|
539
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
540
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
541
|
+
</member>
|
|
542
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.#ctor(System.String,System.String,System.Collections.ArrayList)">
|
|
543
|
+
<summary>
|
|
544
|
+
Constructor
|
|
545
|
+
</summary>
|
|
546
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
547
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
548
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
549
|
+
</member>
|
|
550
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.ExecuteRecursiv(System.String)">
|
|
551
|
+
<summary>
|
|
552
|
+
Called for each directory in the source path -> Count + 1
|
|
553
|
+
</summary>
|
|
554
|
+
<param name="path"></param>
|
|
555
|
+
</member>
|
|
556
|
+
<member name="M:bbv.Common.IO.NumberOfDirsAndFiles.FileAction(System.String)">
|
|
557
|
+
<summary>
|
|
558
|
+
Called each time a file is found -> Count + 1
|
|
559
|
+
</summary>
|
|
560
|
+
<param name="fileName">Found file</param>
|
|
561
|
+
</member>
|
|
562
|
+
<member name="P:bbv.Common.IO.NumberOfDirsAndFiles.Count">
|
|
563
|
+
<summary>
|
|
564
|
+
Gets number of files and directories in tree.
|
|
565
|
+
</summary>
|
|
566
|
+
</member>
|
|
567
|
+
<member name="T:bbv.Common.IO.FileGetter">
|
|
568
|
+
<summary>
|
|
569
|
+
Gets all files inside a directory tree.
|
|
570
|
+
</summary>
|
|
571
|
+
<example>
|
|
572
|
+
Normally use static method <see cref="M:bbv.Common.IO.FileActionCommand.GetFilesRecursiv(System.String)"/>:
|
|
573
|
+
<code>
|
|
574
|
+
ArrayList files = FileActionCommand.GetFilesRecursiv(sourcePath, searchPattern, excludeDirs);
|
|
575
|
+
</code>
|
|
576
|
+
In special cases you may use:
|
|
577
|
+
<code>
|
|
578
|
+
FileGetter fg = new FileGetter(sourcePath, searchPattern, excludeDirs);
|
|
579
|
+
fg.ExecuteRecursiv(sourcePath);
|
|
580
|
+
ArrayList files = fg.Files;
|
|
581
|
+
</code>
|
|
582
|
+
</example>
|
|
583
|
+
</member>
|
|
584
|
+
<member name="M:bbv.Common.IO.FileGetter.#ctor(System.String)">
|
|
585
|
+
<summary>
|
|
586
|
+
Constructor
|
|
587
|
+
</summary>
|
|
588
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
589
|
+
</member>
|
|
590
|
+
<member name="M:bbv.Common.IO.FileGetter.#ctor(System.String,System.String)">
|
|
591
|
+
<summary>
|
|
592
|
+
Constructor
|
|
593
|
+
</summary>
|
|
594
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
595
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
596
|
+
</member>
|
|
597
|
+
<member name="M:bbv.Common.IO.FileGetter.#ctor(System.String,System.Collections.ArrayList)">
|
|
598
|
+
<summary>
|
|
599
|
+
Constructor
|
|
600
|
+
</summary>
|
|
601
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
602
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
603
|
+
</member>
|
|
604
|
+
<member name="M:bbv.Common.IO.FileGetter.#ctor(System.String,System.String,System.Collections.ArrayList)">
|
|
605
|
+
<summary>
|
|
606
|
+
Constructor
|
|
607
|
+
</summary>
|
|
608
|
+
<param name="sourcePath">Source Path at which to start to move.</param>
|
|
609
|
+
<param name="searchPattern">Only files that match this pattern are taken for the command.</param>
|
|
610
|
+
<param name="excludeDirs">Directories to exclude from move.</param>
|
|
611
|
+
</member>
|
|
612
|
+
<member name="M:bbv.Common.IO.FileGetter.FileAction(System.String)">
|
|
613
|
+
<summary>
|
|
614
|
+
Called each time a file is found.
|
|
615
|
+
</summary>
|
|
616
|
+
<param name="fileName">Found file</param>
|
|
617
|
+
</member>
|
|
618
|
+
<member name="P:bbv.Common.IO.FileGetter.Files">
|
|
619
|
+
<summary>
|
|
620
|
+
Gets all fiels in the tree.
|
|
621
|
+
</summary>
|
|
622
|
+
</member>
|
|
623
|
+
<member name="T:bbv.Common.IO.FilesystemHelper">
|
|
624
|
+
<summary>
|
|
625
|
+
Contains static methods to get informations about Filesystem.
|
|
626
|
+
</summary>
|
|
627
|
+
</member>
|
|
628
|
+
<member name="M:bbv.Common.IO.FilesystemHelper.ConvertBytes(System.Double,bbv.Common.IO.FilesystemHelper.ByteUnit)">
|
|
629
|
+
<summary>
|
|
630
|
+
Converts a byte value into the requested <see cref="T:bbv.Common.IO.FilesystemHelper.ByteUnit"/>.
|
|
631
|
+
</summary>
|
|
632
|
+
<param name="bytes">The byte value to convert.</param>
|
|
633
|
+
<param name="unit">The <see cref="T:bbv.Common.IO.FilesystemHelper.ByteUnit"/> to convert into.</param>
|
|
634
|
+
<returns>
|
|
635
|
+
Returns a double value in the <see cref="T:bbv.Common.IO.FilesystemHelper.ByteUnit"/> requested by the caller.
|
|
636
|
+
</returns>
|
|
637
|
+
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
638
|
+
Exception will be thrown if the <see cref="T:bbv.Common.IO.FilesystemHelper.ByteUnit"/> enumeration
|
|
639
|
+
was out of the defined range.
|
|
640
|
+
</exception>
|
|
641
|
+
</member>
|
|
642
|
+
<member name="M:bbv.Common.IO.FilesystemHelper.GetDiskFreeSpace(System.String)">
|
|
643
|
+
<summary>
|
|
644
|
+
Gets the free space left on the disk given by a directory.
|
|
645
|
+
</summary>
|
|
646
|
+
<param name="directory">Directory where the free disk space should be counted.</param>
|
|
647
|
+
<returns>
|
|
648
|
+
Returns the free disk space in bytes, that can be converted by the
|
|
649
|
+
<see cref="M:bbv.Common.IO.FilesystemHelper.ConvertBytes(System.Double,bbv.Common.IO.FilesystemHelper.ByteUnit)"/> method or by calling the overloaded
|
|
650
|
+
version of this method.
|
|
651
|
+
</returns>
|
|
652
|
+
</member>
|
|
653
|
+
<member name="M:bbv.Common.IO.FilesystemHelper.GetDiskFreeSpace(System.String,bbv.Common.IO.FilesystemHelper.ByteUnit)">
|
|
654
|
+
<summary>
|
|
655
|
+
Overloaded method that gets the free space left on the disk given by a directory.
|
|
656
|
+
</summary>
|
|
657
|
+
<param name="directory">Directory where the free disk space should be counted.</param>
|
|
658
|
+
<param name="unit">The <see cref="T:bbv.Common.IO.FilesystemHelper.ByteUnit"/> in which the result should be returned.</param>
|
|
659
|
+
<returns>
|
|
660
|
+
Returns the free disk space in the requested unit, i.e. MegaBytes / GigaBytes and so on.
|
|
661
|
+
</returns>
|
|
662
|
+
</member>
|
|
663
|
+
<member name="M:bbv.Common.IO.FilesystemHelper.NormalizeDirectory(System.String)">
|
|
664
|
+
<summary>
|
|
665
|
+
Adds a "\" to the directory if there is none.
|
|
666
|
+
</summary>
|
|
667
|
+
<param name="directory">The directory to normalize.</param>
|
|
668
|
+
<returns>
|
|
669
|
+
Returns the normalized directory always ending with a "\".
|
|
670
|
+
</returns>
|
|
671
|
+
</member>
|
|
672
|
+
<member name="T:bbv.Common.IO.FilesystemHelper.ByteUnit">
|
|
673
|
+
<summary>
|
|
674
|
+
Specifies the unit for converting from i.e. Bytes to MegaBytes.
|
|
675
|
+
</summary>
|
|
676
|
+
<remarks>
|
|
677
|
+
The values are tightly coupled to the <see cref="M:bbv.Common.IO.FilesystemHelper.ConvertBytes(System.Double,bbv.Common.IO.FilesystemHelper.ByteUnit)"/> method!
|
|
678
|
+
</remarks>
|
|
679
|
+
</member>
|
|
680
|
+
<member name="F:bbv.Common.IO.FilesystemHelper.ByteUnit.Bytes">
|
|
681
|
+
<summary>
|
|
682
|
+
Unit is byte
|
|
683
|
+
</summary>
|
|
684
|
+
</member>
|
|
685
|
+
<member name="F:bbv.Common.IO.FilesystemHelper.ByteUnit.Kilobytes">
|
|
686
|
+
<summary>
|
|
687
|
+
Unit is Kilobytes
|
|
688
|
+
</summary>
|
|
689
|
+
</member>
|
|
690
|
+
<member name="F:bbv.Common.IO.FilesystemHelper.ByteUnit.Megabytes">
|
|
691
|
+
<summary>
|
|
692
|
+
Unit is Megabytes
|
|
693
|
+
</summary>
|
|
694
|
+
</member>
|
|
695
|
+
<member name="F:bbv.Common.IO.FilesystemHelper.ByteUnit.Gigabytes">
|
|
696
|
+
<summary>
|
|
697
|
+
Unit is Gigabytes
|
|
698
|
+
</summary>
|
|
699
|
+
</member>
|
|
700
|
+
<member name="T:bbv.Common.IO.FolderWatcher">
|
|
701
|
+
<summary>
|
|
702
|
+
Implements the FolderWatcher class. Offers function to observe folders for file changes.
|
|
703
|
+
</summary>
|
|
704
|
+
</member>
|
|
705
|
+
<member name="T:bbv.Common.IO.IFolderWatcher">
|
|
706
|
+
<summary>
|
|
707
|
+
Interface for the Folder Watcher class. Offers function to observe folders for file changes.
|
|
708
|
+
</summary>
|
|
709
|
+
</member>
|
|
710
|
+
<member name="M:bbv.Common.IO.IFolderWatcher.StartObservation">
|
|
711
|
+
<summary>
|
|
712
|
+
Initialize the file watcher who are observing the given directory for new files
|
|
713
|
+
</summary>
|
|
714
|
+
</member>
|
|
715
|
+
<member name="M:bbv.Common.IO.IFolderWatcher.StopObservation">
|
|
716
|
+
<summary>
|
|
717
|
+
Stops the observation.
|
|
718
|
+
</summary>
|
|
719
|
+
</member>
|
|
720
|
+
<member name="M:bbv.Common.IO.IFolderWatcher.GetCurrentAvailableFiles">
|
|
721
|
+
<summary>
|
|
722
|
+
Gets the current available files stored in the defined folder and matching to the filter criteria.
|
|
723
|
+
</summary>
|
|
724
|
+
<returns>A list of all available files in the monitored folder and matching to the given filter</returns>
|
|
725
|
+
</member>
|
|
726
|
+
<member name="E:bbv.Common.IO.IFolderWatcher.FileChanged">
|
|
727
|
+
<summary>
|
|
728
|
+
Occurs when a new file is recognized or a file is changed. The event arguments contains the found path.
|
|
729
|
+
</summary>
|
|
730
|
+
</member>
|
|
731
|
+
<member name="P:bbv.Common.IO.IFolderWatcher.Folder">
|
|
732
|
+
<summary>
|
|
733
|
+
Gets or sets the folder which will be observed.
|
|
734
|
+
</summary>
|
|
735
|
+
<value>The folder.</value>
|
|
736
|
+
</member>
|
|
737
|
+
<member name="P:bbv.Common.IO.IFolderWatcher.Filter">
|
|
738
|
+
<summary>
|
|
739
|
+
Gets or sets the filter it is a normal file system filter string like "*.txt".
|
|
740
|
+
</summary>
|
|
741
|
+
<value>The filter.</value>
|
|
742
|
+
</member>
|
|
743
|
+
<member name="F:bbv.Common.IO.FolderWatcher.FilterTimeWindow">
|
|
744
|
+
<summary>
|
|
745
|
+
The <see cref="T:bbv.Common.Events.EventFilter`1"/> timeout.
|
|
746
|
+
</summary>
|
|
747
|
+
</member>
|
|
748
|
+
<member name="F:bbv.Common.IO.FolderWatcher.eventFilter">
|
|
749
|
+
<summary>
|
|
750
|
+
Filters the original <see cref="T:System.IO.FileSystemWatcher"/> events to prevent to much events for the user of the <see cref="T:bbv.Common.IO.FolderWatcher"/>.
|
|
751
|
+
</summary>
|
|
752
|
+
</member>
|
|
753
|
+
<member name="F:bbv.Common.IO.FolderWatcher.log">
|
|
754
|
+
<summary>
|
|
755
|
+
log4net Logger
|
|
756
|
+
</summary>
|
|
757
|
+
</member>
|
|
758
|
+
<member name="F:bbv.Common.IO.FolderWatcher.filesystemwatcher">
|
|
759
|
+
<summary>
|
|
760
|
+
.NET file system watcher
|
|
761
|
+
</summary>
|
|
762
|
+
</member>
|
|
763
|
+
<member name="F:bbv.Common.IO.FolderWatcher.filter">
|
|
764
|
+
<summary>
|
|
765
|
+
File filter - it is a file system filter string like "*.txt".
|
|
766
|
+
</summary>
|
|
767
|
+
</member>
|
|
768
|
+
<member name="F:bbv.Common.IO.FolderWatcher.watchedFolder">
|
|
769
|
+
<summary>
|
|
770
|
+
The folder who is monitored from the <see cref="T:System.IO.FileSystemWatcher"/>
|
|
771
|
+
</summary>
|
|
772
|
+
</member>
|
|
773
|
+
<member name="M:bbv.Common.IO.FolderWatcher.#ctor(System.String,System.String)">
|
|
774
|
+
<summary>
|
|
775
|
+
Initializes a new instance of the <see cref="T:bbv.Common.IO.FolderWatcher"/> class.
|
|
776
|
+
</summary>
|
|
777
|
+
<param name="folder">The folder.</param>
|
|
778
|
+
<param name="filter">The filter.</param>
|
|
779
|
+
</member>
|
|
780
|
+
<member name="M:bbv.Common.IO.FolderWatcher.StartObservation">
|
|
781
|
+
<summary>
|
|
782
|
+
Initialize the file watcher who are observing the given directory for new files
|
|
783
|
+
</summary>
|
|
784
|
+
</member>
|
|
785
|
+
<member name="M:bbv.Common.IO.FolderWatcher.StopObservation">
|
|
786
|
+
<summary>
|
|
787
|
+
Stops the observation.
|
|
788
|
+
</summary>
|
|
789
|
+
</member>
|
|
790
|
+
<member name="M:bbv.Common.IO.FolderWatcher.GetCurrentAvailableFiles">
|
|
791
|
+
<summary>
|
|
792
|
+
Gets the current available files stored in the defined folder and matching to the filter criteria.
|
|
793
|
+
</summary>
|
|
794
|
+
<returns>A list of all available files in the monitored folder and matching to the given filter</returns>
|
|
795
|
+
</member>
|
|
796
|
+
<member name="M:bbv.Common.IO.FolderWatcher.EventFilterOnFilteredEventRaised(System.Object,System.IO.FileSystemEventArgs)">
|
|
797
|
+
<summary>
|
|
798
|
+
Handles events raised from the Event filter. The event is the last original event.
|
|
799
|
+
</summary>
|
|
800
|
+
<param name="sender">The original sender of the event</param>
|
|
801
|
+
<param name="e">Event arguments in this case the <see cref="T:System.IO.FileSystemEventArgs"/></param>
|
|
802
|
+
</member>
|
|
803
|
+
<member name="E:bbv.Common.IO.FolderWatcher.FileChanged">
|
|
804
|
+
<summary>
|
|
805
|
+
Occurs when a new file is recognized. The event arguments contains the found filename.
|
|
806
|
+
</summary>
|
|
807
|
+
</member>
|
|
808
|
+
<member name="P:bbv.Common.IO.FolderWatcher.Folder">
|
|
809
|
+
<summary>
|
|
810
|
+
Gets or sets the folder which will be observed.
|
|
811
|
+
</summary>
|
|
812
|
+
<value>The folder.</value>
|
|
813
|
+
</member>
|
|
814
|
+
<member name="P:bbv.Common.IO.FolderWatcher.Filter">
|
|
815
|
+
<summary>
|
|
816
|
+
Gets or sets the filter it is a file system filter string like "*.txt".
|
|
817
|
+
</summary>
|
|
818
|
+
<value>The filter.</value>
|
|
819
|
+
</member>
|
|
820
|
+
<member name="T:bbv.Common.IO.ITextReader">
|
|
821
|
+
<summary>
|
|
822
|
+
Contains methods to read input data into a string or a stream.
|
|
823
|
+
</summary>
|
|
824
|
+
</member>
|
|
825
|
+
<member name="M:bbv.Common.IO.ITextReader.GetString">
|
|
826
|
+
<summary>
|
|
827
|
+
Reads the complete input data as string.
|
|
828
|
+
</summary>
|
|
829
|
+
<returns>The data as a string.</returns>
|
|
830
|
+
</member>
|
|
831
|
+
<member name="M:bbv.Common.IO.ITextReader.GetStream">
|
|
832
|
+
<summary>
|
|
833
|
+
Gets the stream of the input data.
|
|
834
|
+
</summary>
|
|
835
|
+
<returns>The data as a stream.</returns>
|
|
836
|
+
</member>
|
|
837
|
+
<member name="T:bbv.Common.IO.ITextWriter">
|
|
838
|
+
<summary>
|
|
839
|
+
Contains methods to write text to the specified output.
|
|
840
|
+
</summary>
|
|
841
|
+
</member>
|
|
842
|
+
<member name="M:bbv.Common.IO.ITextWriter.Write(System.String)">
|
|
843
|
+
<summary>
|
|
844
|
+
Writes the text to the specified output.
|
|
845
|
+
</summary>
|
|
846
|
+
<param name="content">The filecontent.</param>
|
|
847
|
+
</member>
|
|
848
|
+
<member name="M:bbv.Common.IO.ITextWriter.Write(System.IO.Stream,System.Int32)">
|
|
849
|
+
<summary>
|
|
850
|
+
Writes the stream to the specified output.
|
|
851
|
+
</summary>
|
|
852
|
+
<param name="stream">The stream.</param>
|
|
853
|
+
<param name="bufferSize">The size of the buffer.</param>
|
|
854
|
+
</member>
|
|
855
|
+
<member name="T:bbv.Common.IO.StreamDecoratorStream">
|
|
856
|
+
<summary>
|
|
857
|
+
Abstract decorator class for a Stream
|
|
858
|
+
</summary>
|
|
859
|
+
<remarks>
|
|
860
|
+
<para>
|
|
861
|
+
This class is used to implement stream decorator classes.
|
|
862
|
+
For creating a new stream decorator derive a new class from this one and override
|
|
863
|
+
the methods that you want to decorate. All methods that are not overwritten
|
|
864
|
+
are passed to the decorated stream.
|
|
865
|
+
</para>
|
|
866
|
+
<para>
|
|
867
|
+
All methods throw a NoStreamException when no stream is assigned to this class
|
|
868
|
+
at the time a method is called.
|
|
869
|
+
</para>
|
|
870
|
+
</remarks>
|
|
871
|
+
</member>
|
|
872
|
+
<member name="F:bbv.Common.IO.StreamDecoratorStream.decoratedStream">
|
|
873
|
+
<summary>
|
|
874
|
+
The decorated stream
|
|
875
|
+
</summary>
|
|
876
|
+
</member>
|
|
877
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.#ctor(System.IO.Stream)">
|
|
878
|
+
<summary>
|
|
879
|
+
Initializes a new instance of the <see cref="T:bbv.Common.IO.StreamDecoratorStream"/> class.
|
|
880
|
+
</summary>
|
|
881
|
+
<param name="decoratedStream">The decorated stream.</param>
|
|
882
|
+
</member>
|
|
883
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
|
884
|
+
<summary>
|
|
885
|
+
Begins an asynchronous read operation.
|
|
886
|
+
</summary>
|
|
887
|
+
<param name="buffer">The buffer to read the data into.</param>
|
|
888
|
+
<param name="offset">The byte offset in buffer at which to begin writing data read from the stream.</param>
|
|
889
|
+
<param name="count">The maximum number of bytes to read.</param>
|
|
890
|
+
<param name="callback">An optional asynchronous callback, to be called when the read is complete.</param>
|
|
891
|
+
<param name="state">A user-provided object that distinguishes this particular asynchronous read request
|
|
892
|
+
from other requests.</param>
|
|
893
|
+
<returns>
|
|
894
|
+
An <see cref="T:System.IAsyncResult"></see> that represents the asynchronous read, which could still be
|
|
895
|
+
pending.
|
|
896
|
+
</returns>
|
|
897
|
+
<exception cref="T:System.IO.IOException">Attempted an asynchronous read past the end of the stream, or a disk error
|
|
898
|
+
occurs. </exception>
|
|
899
|
+
<exception cref="T:System.NotSupportedException">The current Stream implementation does not support the read
|
|
900
|
+
operation. </exception>
|
|
901
|
+
<exception cref="T:System.ArgumentException">One or more of the arguments is invalid. </exception>
|
|
902
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
903
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
904
|
+
</exception>
|
|
905
|
+
</member>
|
|
906
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.EndRead(System.IAsyncResult)">
|
|
907
|
+
<summary>
|
|
908
|
+
Waits for the pending asynchronous read to complete.
|
|
909
|
+
</summary>
|
|
910
|
+
<param name="asyncResult">The reference to the pending asynchronous request to finish.</param>
|
|
911
|
+
<returns>
|
|
912
|
+
The number of bytes read from the stream, between zero (0) and the number of bytes you requested.
|
|
913
|
+
Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one
|
|
914
|
+
byte is available.
|
|
915
|
+
</returns>
|
|
916
|
+
<exception cref="T:System.ArgumentException">asyncResult did not originate from a
|
|
917
|
+
<see cref="M:bbv.Common.IO.StreamDecoratorStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
|
918
|
+
</see> method on the current stream.</exception>
|
|
919
|
+
<exception cref="T:System.ArgumentNullException">asyncResult is null. </exception>
|
|
920
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
921
|
+
</exception>
|
|
922
|
+
</member>
|
|
923
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
924
|
+
<summary>
|
|
925
|
+
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the
|
|
926
|
+
position within the stream by the number of bytes read.
|
|
927
|
+
</summary>
|
|
928
|
+
<param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte
|
|
929
|
+
array with the values between offset and (offset + count - 1) replaced by the bytes read from the current
|
|
930
|
+
source.</param>
|
|
931
|
+
<param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from
|
|
932
|
+
the current stream.</param>
|
|
933
|
+
<param name="count">The maximum number of bytes to be read from the current stream.</param>
|
|
934
|
+
<returns>
|
|
935
|
+
The total number of bytes read into the buffer. This can be less than the number of bytes requested if
|
|
936
|
+
that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
|
|
937
|
+
</returns>
|
|
938
|
+
<exception cref="T:System.ArgumentException">The sum of offset and count is larger than the buffer length.
|
|
939
|
+
</exception>
|
|
940
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
941
|
+
<exception cref="T:System.NotSupportedException">The stream does not support reading.</exception>
|
|
942
|
+
<exception cref="T:System.ArgumentNullException">buffer is null. </exception>
|
|
943
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
944
|
+
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
|
|
945
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
946
|
+
</exception>
|
|
947
|
+
</member>
|
|
948
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.ReadByte">
|
|
949
|
+
<summary>
|
|
950
|
+
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at
|
|
951
|
+
the end of the stream.
|
|
952
|
+
</summary>
|
|
953
|
+
<returns>
|
|
954
|
+
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
|
|
955
|
+
</returns>
|
|
956
|
+
<exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
|
|
957
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
958
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
959
|
+
</exception>
|
|
960
|
+
</member>
|
|
961
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
|
|
962
|
+
<summary>
|
|
963
|
+
Begins an asynchronous write operation.
|
|
964
|
+
</summary>
|
|
965
|
+
<param name="buffer">The buffer to write data from.</param>
|
|
966
|
+
<param name="offset">The byte offset in buffer from which to begin writing.</param>
|
|
967
|
+
<param name="count">The maximum number of bytes to write.</param>
|
|
968
|
+
<param name="callback">An optional asynchronous callback, to be called when the write is complete.</param>
|
|
969
|
+
<param name="state">A user-provided object that distinguishes this particular asynchronous write request
|
|
970
|
+
from other requests.</param>
|
|
971
|
+
<returns> An IAsyncResult that represents the asynchronous write, which could still be pending.</returns>
|
|
972
|
+
<exception cref="T:System.NotSupportedException">The current Stream implementation does not support the write
|
|
973
|
+
operation. </exception>
|
|
974
|
+
<exception cref="T:System.IO.IOException">Attempted an asynchronous write past the end of the stream,
|
|
975
|
+
or a disk error occurs. </exception>
|
|
976
|
+
<exception cref="T:System.ArgumentException">One or more of the arguments is invalid. </exception>
|
|
977
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
978
|
+
</member>
|
|
979
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.EndWrite(System.IAsyncResult)">
|
|
980
|
+
<summary>
|
|
981
|
+
Ends an asynchronous write operation.
|
|
982
|
+
</summary>
|
|
983
|
+
<param name="asyncResult">A reference to the outstanding asynchronous I/O request.</param>
|
|
984
|
+
<exception cref="T:System.ArgumentNullException">asyncResult is null. </exception>
|
|
985
|
+
<exception cref="T:System.ArgumentException">asyncResult did not originate from a
|
|
986
|
+
<see cref="M:bbv.Common.IO.StreamDecoratorStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"/>
|
|
987
|
+
method on the current stream. </exception>
|
|
988
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
989
|
+
</exception>
|
|
990
|
+
</member>
|
|
991
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
992
|
+
<summary>
|
|
993
|
+
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the
|
|
994
|
+
current position within this stream by the number of bytes written.
|
|
995
|
+
</summary>
|
|
996
|
+
<param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.
|
|
997
|
+
</param>
|
|
998
|
+
<param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current
|
|
999
|
+
stream.</param>
|
|
1000
|
+
<param name="count">The number of bytes to be written to the current stream.</param>
|
|
1001
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1002
|
+
<exception cref="T:System.NotSupportedException">The stream does not support writing. </exception>
|
|
1003
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
|
|
1004
|
+
<exception cref="T:System.ArgumentNullException">buffer is null. </exception>
|
|
1005
|
+
<exception cref="T:System.ArgumentException">The sum of offset and count is greater than the buffer length.
|
|
1006
|
+
</exception>
|
|
1007
|
+
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
|
|
1008
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1009
|
+
</exception>
|
|
1010
|
+
</member>
|
|
1011
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.WriteByte(System.Byte)">
|
|
1012
|
+
<summary>
|
|
1013
|
+
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
|
|
1014
|
+
</summary>
|
|
1015
|
+
<param name="value">The byte to write to the stream.</param>
|
|
1016
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1017
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
|
|
1018
|
+
<exception cref="T:System.NotSupportedException">The stream does not support writing, or the stream is already
|
|
1019
|
+
closed. </exception>
|
|
1020
|
+
</member>
|
|
1021
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.Close">
|
|
1022
|
+
<summary>
|
|
1023
|
+
Closes the current stream and releases any resources (such as sockets and file handles) associated with
|
|
1024
|
+
the current stream.
|
|
1025
|
+
</summary>
|
|
1026
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1027
|
+
</exception>
|
|
1028
|
+
</member>
|
|
1029
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.Flush">
|
|
1030
|
+
<summary>
|
|
1031
|
+
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to
|
|
1032
|
+
be written to the underlying device.
|
|
1033
|
+
</summary>
|
|
1034
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1035
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1036
|
+
</exception>
|
|
1037
|
+
</member>
|
|
1038
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
|
1039
|
+
<summary>
|
|
1040
|
+
When overridden in a derived class, sets the position within the current stream.
|
|
1041
|
+
</summary>
|
|
1042
|
+
<param name="offset">A byte offset relative to the origin parameter.</param>
|
|
1043
|
+
<param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"></see> indicating the reference
|
|
1044
|
+
point used to obtain the new position.</param>
|
|
1045
|
+
<returns>
|
|
1046
|
+
The new position within the current stream.
|
|
1047
|
+
</returns>
|
|
1048
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1049
|
+
<exception cref="T:System.NotSupportedException">The stream does not support seeking, such as if the stream
|
|
1050
|
+
is constructed from a pipe or console output. </exception>
|
|
1051
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.
|
|
1052
|
+
</exception>
|
|
1053
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1054
|
+
</exception>
|
|
1055
|
+
</member>
|
|
1056
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.SetLength(System.Int64)">
|
|
1057
|
+
<summary>
|
|
1058
|
+
When overridden in a derived class, sets the length of the current stream.
|
|
1059
|
+
</summary>
|
|
1060
|
+
<param name="value">The desired length of the current stream in bytes.</param>
|
|
1061
|
+
<exception cref="T:System.NotSupportedException">The stream does not support both writing and seeking,
|
|
1062
|
+
such as if the stream is constructed from a pipe or console output. </exception>
|
|
1063
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1064
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
|
|
1065
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1066
|
+
</exception>
|
|
1067
|
+
</member>
|
|
1068
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.ToString">
|
|
1069
|
+
<summary>
|
|
1070
|
+
Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
1071
|
+
</summary>
|
|
1072
|
+
<returns>
|
|
1073
|
+
A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
|
|
1074
|
+
</returns>
|
|
1075
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1076
|
+
</exception>
|
|
1077
|
+
</member>
|
|
1078
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.ThrowNoStreamException">
|
|
1079
|
+
<summary>
|
|
1080
|
+
Derived classes can override this method to handle cases where a method is called while the decorated
|
|
1081
|
+
device is not assigned.
|
|
1082
|
+
</summary>
|
|
1083
|
+
</member>
|
|
1084
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.SetStream(System.IO.Stream)">
|
|
1085
|
+
<summary>
|
|
1086
|
+
Sets the stream that shall be decorated.
|
|
1087
|
+
</summary>
|
|
1088
|
+
<param name="stream">The stream that shall be decorated.</param>
|
|
1089
|
+
</member>
|
|
1090
|
+
<member name="M:bbv.Common.IO.StreamDecoratorStream.AssertStreamNotNull">
|
|
1091
|
+
<summary>
|
|
1092
|
+
Asserts the stream is not null.
|
|
1093
|
+
</summary>
|
|
1094
|
+
</member>
|
|
1095
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.CanRead">
|
|
1096
|
+
<summary>
|
|
1097
|
+
Gets a value indicating whether the current stream supports reading.
|
|
1098
|
+
</summary>
|
|
1099
|
+
<value></value>
|
|
1100
|
+
<returns>true if the stream supports reading; otherwise, false.</returns>
|
|
1101
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1102
|
+
</exception>
|
|
1103
|
+
</member>
|
|
1104
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.CanSeek">
|
|
1105
|
+
<summary>
|
|
1106
|
+
Gets a value indicating whether the current stream supports seeking.
|
|
1107
|
+
</summary>
|
|
1108
|
+
<value></value>
|
|
1109
|
+
<returns>true if the stream supports seeking; otherwise, false.</returns>
|
|
1110
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1111
|
+
</exception>
|
|
1112
|
+
</member>
|
|
1113
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.CanWrite">
|
|
1114
|
+
<summary>
|
|
1115
|
+
Gets a value indicating whether the current stream supports writing.
|
|
1116
|
+
</summary>
|
|
1117
|
+
<value></value>
|
|
1118
|
+
<returns>true if the stream supports writing; otherwise, false.</returns>
|
|
1119
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1120
|
+
</exception>
|
|
1121
|
+
</member>
|
|
1122
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.Length">
|
|
1123
|
+
<summary>
|
|
1124
|
+
Gets the length in bytes of the stream.
|
|
1125
|
+
</summary>
|
|
1126
|
+
<value></value>
|
|
1127
|
+
<returns>A long value representing the length of the stream in bytes.</returns>
|
|
1128
|
+
<exception cref="T:System.NotSupportedException">The stream does not support seeking.</exception>
|
|
1129
|
+
<exception cref="T:System.ObjectDisposedException">Property was called after the stream was closed.</exception>
|
|
1130
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1131
|
+
</exception>
|
|
1132
|
+
</member>
|
|
1133
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.Position">
|
|
1134
|
+
<summary>
|
|
1135
|
+
Gets or sets the position within the current stream.
|
|
1136
|
+
</summary>
|
|
1137
|
+
<value></value>
|
|
1138
|
+
<returns>The current position within the stream.</returns>
|
|
1139
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1140
|
+
<exception cref="T:System.NotSupportedException">The stream does not support seeking. </exception>
|
|
1141
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
1142
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1143
|
+
</exception>
|
|
1144
|
+
</member>
|
|
1145
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.ReadTimeout">
|
|
1146
|
+
<summary>
|
|
1147
|
+
Gets or sets a value that determines how long the stream will attempt to read before timing out.
|
|
1148
|
+
</summary>
|
|
1149
|
+
<value></value>
|
|
1150
|
+
<returns>A value that determines how long the stream will attempt to read before timing out.</returns>
|
|
1151
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1152
|
+
</exception>
|
|
1153
|
+
</member>
|
|
1154
|
+
<member name="P:bbv.Common.IO.StreamDecoratorStream.WriteTimeout">
|
|
1155
|
+
<summary>
|
|
1156
|
+
Gets or sets a value that determines how long the stream will attempt to write before timing out.
|
|
1157
|
+
</summary>
|
|
1158
|
+
<value></value>
|
|
1159
|
+
<returns>A value that determines how long the stream will attempt to write before timing out.</returns>
|
|
1160
|
+
<exception cref="T:System.InvalidOperationException">Thrown when no stream is assigned as decorated stream.
|
|
1161
|
+
</exception>
|
|
1162
|
+
</member>
|
|
1163
|
+
<member name="T:bbv.Common.IO.StreamLoggerStream">
|
|
1164
|
+
<summary>
|
|
1165
|
+
Logs the data that is written to and read from a stream.
|
|
1166
|
+
</summary>
|
|
1167
|
+
</member>
|
|
1168
|
+
<member name="F:bbv.Common.IO.StreamLoggerStream.bytesPerLine">
|
|
1169
|
+
<summary>
|
|
1170
|
+
The number of bytes that are written per line in the log.
|
|
1171
|
+
</summary>
|
|
1172
|
+
</member>
|
|
1173
|
+
<member name="F:bbv.Common.IO.StreamLoggerStream.blockLength">
|
|
1174
|
+
<summary>
|
|
1175
|
+
The number of bytes that are written as a block. After a block a space is written.
|
|
1176
|
+
</summary>
|
|
1177
|
+
</member>
|
|
1178
|
+
<member name="F:bbv.Common.IO.StreamLoggerStream.log">
|
|
1179
|
+
<summary>
|
|
1180
|
+
The logger that is used for writing the log output.
|
|
1181
|
+
</summary>
|
|
1182
|
+
</member>
|
|
1183
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.#ctor(System.IO.Stream,log4net.ILog,System.Int32,System.Int32)">
|
|
1184
|
+
<summary>
|
|
1185
|
+
Initializes a new instance of the <see cref="T:bbv.Common.IO.StreamLoggerStream"/> class.
|
|
1186
|
+
</summary>
|
|
1187
|
+
<param name="stream">The stream that is logged.</param>
|
|
1188
|
+
<param name="logger">The logger that is used for logging.</param>
|
|
1189
|
+
<param name="bytesPerLine">The number of bytes that are written per line in the log.</param>
|
|
1190
|
+
<param name="blockLength">The number of bytes that are written as a block. After a block a
|
|
1191
|
+
space is written.</param>
|
|
1192
|
+
<exception cref="T:System.ArgumentNullException">stream or logger is null.</exception>
|
|
1193
|
+
</member>
|
|
1194
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
1195
|
+
<summary>
|
|
1196
|
+
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the
|
|
1197
|
+
position within the stream by the number of bytes read.
|
|
1198
|
+
</summary>
|
|
1199
|
+
<param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte
|
|
1200
|
+
array with the values between offset and (offset + count - 1) replaced by the bytes read from the current
|
|
1201
|
+
source.</param>
|
|
1202
|
+
<param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from the
|
|
1203
|
+
current stream.</param>
|
|
1204
|
+
<param name="count">The maximum number of bytes to be read from the current stream.</param>
|
|
1205
|
+
<returns>
|
|
1206
|
+
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that
|
|
1207
|
+
many bytes are not currently available, or zero (0) if the end of the stream has been reached.
|
|
1208
|
+
</returns>
|
|
1209
|
+
<exception cref="T:System.ArgumentException">The sum of offset and count is larger than the buffer length.
|
|
1210
|
+
</exception>
|
|
1211
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
1212
|
+
<exception cref="T:System.NotSupportedException">The stream does not support reading.</exception>
|
|
1213
|
+
<exception cref="T:System.ArgumentNullException">buffer is null. </exception>
|
|
1214
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
|
|
1215
|
+
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative.</exception>
|
|
1216
|
+
</member>
|
|
1217
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.ReadByte">
|
|
1218
|
+
<summary>
|
|
1219
|
+
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at
|
|
1220
|
+
the end of the stream.
|
|
1221
|
+
</summary>
|
|
1222
|
+
<returns>
|
|
1223
|
+
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
|
|
1224
|
+
</returns>
|
|
1225
|
+
<exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
|
|
1226
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.
|
|
1227
|
+
</exception>
|
|
1228
|
+
</member>
|
|
1229
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
1230
|
+
<summary>
|
|
1231
|
+
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the
|
|
1232
|
+
current position within this stream by the number of bytes written.
|
|
1233
|
+
</summary>
|
|
1234
|
+
<param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.
|
|
1235
|
+
</param>
|
|
1236
|
+
<param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current
|
|
1237
|
+
stream.</param>
|
|
1238
|
+
<param name="count">The number of bytes to be written to the current stream.</param>
|
|
1239
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1240
|
+
<exception cref="T:System.NotSupportedException">The stream does not support writing. </exception>
|
|
1241
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.
|
|
1242
|
+
</exception>
|
|
1243
|
+
<exception cref="T:System.ArgumentNullException">buffer is null. </exception>
|
|
1244
|
+
<exception cref="T:System.ArgumentException">The sum of offset and count is greater than the buffer length.
|
|
1245
|
+
</exception>
|
|
1246
|
+
<exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative.</exception>
|
|
1247
|
+
</member>
|
|
1248
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.WriteByte(System.Byte)">
|
|
1249
|
+
<summary>
|
|
1250
|
+
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
|
|
1251
|
+
</summary>
|
|
1252
|
+
<param name="value">The byte to write to the stream.</param>
|
|
1253
|
+
<exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
|
|
1254
|
+
<exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed.</exception>
|
|
1255
|
+
<exception cref="T:System.NotSupportedException">The stream does not support writing, or the stream is already
|
|
1256
|
+
closed. </exception>
|
|
1257
|
+
</member>
|
|
1258
|
+
<member name="T:bbv.Common.IO.StreamLoggerStream.LogHelper">
|
|
1259
|
+
<summary>
|
|
1260
|
+
Helper class for logging data with log4net
|
|
1261
|
+
</summary>
|
|
1262
|
+
</member>
|
|
1263
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.LogHelper.Debug(log4net.ILog,System.String,System.Byte[],System.Int64,System.Int64,System.Int32,System.Int32)">
|
|
1264
|
+
<summary>
|
|
1265
|
+
Logs a byte array for debugging
|
|
1266
|
+
</summary>
|
|
1267
|
+
<param name="log">The logger to which the data is logged.</param>
|
|
1268
|
+
<param name="msg">A message that is displayed before the data.</param>
|
|
1269
|
+
<param name="buffer">The byte array that is logged</param>
|
|
1270
|
+
<param name="offset">The index of the first byte that is logged.</param>
|
|
1271
|
+
<param name="count">The number of bytes that are logged.</param>
|
|
1272
|
+
<param name="lineLength">Number of bytes that are displayedPerLine</param>
|
|
1273
|
+
<param name="blockLength">Defines how many bytes are in a block. A space is inserted after each block
|
|
1274
|
+
</param>
|
|
1275
|
+
</member>
|
|
1276
|
+
<member name="M:bbv.Common.IO.StreamLoggerStream.LogHelper.LogBuffer(bbv.Common.IO.StreamLoggerStream.LogHelper.LogMethod,System.String,System.Byte[],System.Int64,System.Int64,System.Int32,System.Int32)">
|
|
1277
|
+
<summary>
|
|
1278
|
+
Logs a byte array
|
|
1279
|
+
</summary>
|
|
1280
|
+
<param name="logMethod">The method that is used for logging.</param>
|
|
1281
|
+
<param name="msg">A message that is displayed before the data.</param>
|
|
1282
|
+
<param name="buffer">The byte array that is logged</param>
|
|
1283
|
+
<param name="offset">The index of the first byte that is logged.</param>
|
|
1284
|
+
<param name="count">The number of bytes that are logged.</param>
|
|
1285
|
+
<param name="lineLength">Number of bytes that are displayedPerLine</param>
|
|
1286
|
+
<param name="blockLength">Defines how many bytes are in a block. A space is inserted after each block
|
|
1287
|
+
</param>
|
|
1288
|
+
</member>
|
|
1289
|
+
<member name="T:bbv.Common.IO.StreamLoggerStream.LogHelper.LogMethod">
|
|
1290
|
+
<summary>
|
|
1291
|
+
This delegate is internally used to pass the log method of the <see cref="T:log4net.ILog"/> to the shared
|
|
1292
|
+
<see cref="M:bbv.Common.IO.StreamLoggerStream.LogHelper.LogBuffer(bbv.Common.IO.StreamLoggerStream.LogHelper.LogMethod,System.String,System.Byte[],System.Int64,System.Int64,System.Int32,System.Int32)"/> method
|
|
1293
|
+
</summary>
|
|
1294
|
+
<param name="message">The message that is logged.</param>
|
|
1295
|
+
</member>
|
|
1296
|
+
<member name="T:bbv.Common.IO.TextFileReader">
|
|
1297
|
+
<summary>
|
|
1298
|
+
Contains methods to read a file into a string or into a stream.
|
|
1299
|
+
</summary>
|
|
1300
|
+
</member>
|
|
1301
|
+
<member name="M:bbv.Common.IO.TextFileReader.#ctor(System.String)">
|
|
1302
|
+
<summary>
|
|
1303
|
+
Initializes a new instance of the <see cref="T:bbv.Common.IO.TextFileReader"/> class.
|
|
1304
|
+
</summary>
|
|
1305
|
+
<param name="path">The path of the file.</param>
|
|
1306
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="path"/>is null</exception>
|
|
1307
|
+
</member>
|
|
1308
|
+
<member name="M:bbv.Common.IO.TextFileReader.GetString">
|
|
1309
|
+
<summary>
|
|
1310
|
+
Gets the content of the file as string.
|
|
1311
|
+
</summary>
|
|
1312
|
+
<returns>The file as a string.</returns>
|
|
1313
|
+
</member>
|
|
1314
|
+
<member name="M:bbv.Common.IO.TextFileReader.GetStream">
|
|
1315
|
+
<summary>
|
|
1316
|
+
Gets the stream of the file.
|
|
1317
|
+
</summary>
|
|
1318
|
+
<returns>The file as a stream.</returns>
|
|
1319
|
+
</member>
|
|
1320
|
+
<member name="T:bbv.Common.IO.TextFileWriter">
|
|
1321
|
+
<summary>
|
|
1322
|
+
Contains methods to write a text to the specified file.
|
|
1323
|
+
</summary>
|
|
1324
|
+
</member>
|
|
1325
|
+
<member name="M:bbv.Common.IO.TextFileWriter.#ctor(System.String)">
|
|
1326
|
+
<summary>
|
|
1327
|
+
Initializes a new instance of the <see cref="T:bbv.Common.IO.TextFileWriter"/> class.
|
|
1328
|
+
</summary>
|
|
1329
|
+
<param name="path">The path.</param>
|
|
1330
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="path"/>is null</exception>
|
|
1331
|
+
</member>
|
|
1332
|
+
<member name="M:bbv.Common.IO.TextFileWriter.Write(System.String)">
|
|
1333
|
+
<summary>
|
|
1334
|
+
Writes the the to a specified file.
|
|
1335
|
+
</summary>
|
|
1336
|
+
<param name="content">The filecontent.</param>
|
|
1337
|
+
</member>
|
|
1338
|
+
<member name="M:bbv.Common.IO.TextFileWriter.Write(System.IO.Stream,System.Int32)">
|
|
1339
|
+
<summary>
|
|
1340
|
+
Writes the stream to the specified output.
|
|
1341
|
+
</summary>
|
|
1342
|
+
<param name="stream">The stream.</param>
|
|
1343
|
+
<param name="bufferSize">The size of the buffer.</param>
|
|
1344
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/>is null</exception>
|
|
1345
|
+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="bufferSize"/>If not greater than 0.</exception>
|
|
1346
|
+
</member>
|
|
1347
|
+
<member name="P:bbv.Common.IO.TextFileWriter.Encoding">
|
|
1348
|
+
<summary>
|
|
1349
|
+
Gets or sets the encoding.
|
|
1350
|
+
</summary>
|
|
1351
|
+
<value>The encoding.</value>
|
|
1352
|
+
</member>
|
|
1353
|
+
</members>
|
|
1354
|
+
</doc>
|