KGy SOFT

StringSegmentExtensionsRead Method

KGy SOFT Core Libraries Help
Advances the specified rest parameter consuming up to maxLength characters and returns the consumed part. If rest started with a new line before the call, then an empty segment is returned. If the whole StringSegment has been processed, then rest will be StringSegment.Null after returning.

Namespace:  KGySoft.CoreLibraries
Assembly:  KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 5.5.0-rc.1
Syntax

public static StringSegment Read(
	this ref StringSegment rest,
	int maxLength
)

Parameters

rest
Type: KGySoft.CoreLibrariesStringSegment
Represents the rest of the string to process. When this method returns, the value of this parameter will be the remaining unprocessed part, or StringSegment.Null if the whole segment has been processed.
maxLength
Type: SystemInt32
The maximum number of characters to read.

Return Value

Type: StringSegment
A StringSegment that contains the first line of the original value of the rest parameter, or the complete original value of rest if it contained no more than maxLength characters.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type . When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also

Reference