MiscUtils ToDumpString Method NFX Class Library

[This is preliminary documentation and is subject to change.]

Convert a buffer to a printable string

Namespace: NFX
Assembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
Syntax

public static string ToDumpString(
	this byte[] buf,
	DumpFormat fmt,
	int offset = 0,
	int count = -1,
	bool eol = false,
	Encoding encoding = null,
	int maxLen = 0
)

Parameters

buf
Type:  OnlineSystem Byte 
Buffer to convert
fmt
Type: NFX DumpFormat
Dumping format
offset (Optional)
Type: OnlineSystem Int32
Starting index
count (Optional)
Type: OnlineSystem Int32
Number of bytes to process (-1 means all bytes in the buffer)
eol (Optional)
Type: OnlineSystem Boolean
If true, terminate with end-of-line
encoding (Optional)
Type: OnlineSystem.Text Encoding
Encoding to use for writing data in Binary format
maxLen (Optional)
Type: OnlineSystem Int32
Max length of the returned string. Pass 0 for unlimited length

Return Value

Type: OnlineString

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 OnlineExtension Methods (Visual Basic) or OnlineExtension Methods (C# Programming Guide).
See Also