Changes between Version 4 and Version 5 of FdoTextReaderEnhancements

Timestamp:

Oct 18, 2007, 2:12:59 PM (17 years ago)

Author:

gregboone

Comment:

--

FdoTextReaderEnhancements

@@ -58 +58 @@
 }}}
 
-''Parameters'':
-
-outString: the string that was read
-
-leftDelimiters: list of left delimiter characters; defaults to empty string (L"").
-
-rightDelimiters: list of right delimiter characters; defaults to empty string (L""). Position is important: 1st left delimiter corresponds to 1st right delimiter and so on. If a right delimiter is not explicitly specified for a particular left delimiter then the right delimiter is the same as the left.
-
-skipChars: list of characters that can be skipped while looking for the left delimiter; defaults to blank character plus end-of line (L" \n").
-
-separators: list of separator characters. These are similar to skip characters except that a separator can only occur once between each string that is read; defaults to empty string (L"").
-
-''Description'':
-
-!ReadLine() Reads the current line (from the current position to the next end-of-line character or end-of-stream).
-
-Read() provides the ability to read delimited strings. 
+'''''Parameters''''':
+
+''outString'': the string that was read
+
+''leftDelimiters'': list of left delimiter characters; defaults to empty string (L"").
+
+''rightDelimiters'': list of right delimiter characters; defaults to empty string (L""). Position is important: 1st left delimiter corresponds to 1st right delimiter and so on. If a right delimiter is not explicitly specified for a particular left delimiter then the right delimiter is the same as the left.
+
+''skipChars'': list of characters that can be skipped while looking for the left delimiter; defaults to blank character plus end-of line (L" \n").
+
+''separators'': list of separator characters. These are similar to skip characters except that a separator can only occur once between each string that is read; defaults to empty string (L"").
+
+'''''Description''''':
+
+''!ReadLine()'' Reads the current line (from the current position to the next end-of-line character or end-of-stream).
+
+''Read()'' provides the ability to read delimited strings. 
 
 Reading is done according to the following steps:
@@ -83 +83 @@
 • Any subsequent skipChars or separators are skipped. However, Read() stops if a second separator character is encountered.  In this case, the 2nd separator is not skipped but the current position is set to it.[[br]]
 
-''Returns'':
-
-!ReadLine() returns true if a line was read and false if at the end of the underlying stream.
-
-Read() returns true if a string was read and false otherwise. false is returned if the end of the stream is reached before a string can be extracted. 
+'''''Returns''''':
+
+''!ReadLine()'' returns true if a line was read and false if at the end of the underlying stream.
+
+''Read()'' returns true if a string was read and false otherwise. false is returned if the end of the stream is reached before a string can be extracted. 
 
 It is possible for both of the above to return true with outString being an empty string. For !ReadLine(), this happens when the character at the current position is the end-of-line character. For Read() this can happen when there are no characters between the left and right delimeters.
 
-''Exceptions'':
-
-Read() throws an !FdoException if a left delimiter is encountered but end-of-stream is reached before the right delimiter is found.
-
-''Example 1'': 
+'''''Exceptions''''':
+
+''Read()'' throws an !FdoException if a left delimiter is encountered but end-of-stream is reached before the right delimiter is found.
+
+'''''Example 1''''': 
 
 if the data at and after the input stream’s current position looks like this:
@@ -114 +114 @@
 (**) – the 2nd ("{"} leftDelimiter is encountered before "'", so read is done until the 2nd right delimiter ("}") is reached[[br]]
 
-''Example 2'':
+'''''Example 2''''':
 
 If a stream contains comma separated values where:
@@ -142 +142 @@
 "9876"[[br]]
 
-''Example 3'':
+'''''Example 3''''':
 
 !ReadLine is actually just a convenience function. It is equivalent to:
@@ -174 +174 @@
 
 
-''Parameters'':
-
-baseSteam: underlying stream where data will ultimately be read from or written to.
-
-bufferSize: size in bytes of data cache. The cache is used to provide better read/write performance
-
-''Description'':
-
-!GetStream() returns the underlying stream.
-
-Flush()  if the cache contains data to write, this function writes it to the underlying stream.
+'''''Parameters''''':
+
+''baseSteam'': underlying stream where data will ultimately be read from or written to.
+
+''bufferSize'': size in bytes of data cache. The cache is used to provide better read/write performance
+
+'''''Description''''':
+
+''!GetStream()'' returns the underlying stream.
+
+''Flush()''  if the cache contains data to write, this function writes it to the underlying stream.
 
 This class provides buffered reads and writes from and to an FdoIStream by adding an in-memory cache.
@@ -193 +193 @@
 
 The following class will be added for convenience:
-
 
 {{{