[This is preliminary documentation and is subject to change.]
Convert a buffer to a printable string
Namespace: NFXAssembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)
public static string ToDumpString(
this byte[] buf,
DumpFormat fmt,
int offset = 0,
int count = -1,
bool eol = false,
Encoding encoding = null,
int maxLen = 0
)
public static string ToDumpString(
this byte[] buf,
DumpFormat fmt,
int offset = 0,
int count = -1,
bool eol = false,
Encoding encoding = null,
int maxLen = 0
)
<ExtensionAttribute>
Public Shared Function ToDumpString (
buf As Byte(),
fmt As DumpFormat,
Optional offset As Integer = 0,
Optional count As Integer = -1,
Optional eol As Boolean = false,
Optional encoding As Encoding = Nothing,
Optional maxLen As Integer = 0
) As String
<ExtensionAttribute>
Public Shared Function ToDumpString (
buf As Byte(),
fmt As DumpFormat,
Optional offset As Integer = 0,
Optional count As Integer = -1,
Optional eol As Boolean = false,
Optional encoding As Encoding = Nothing,
Optional maxLen As Integer = 0
) As String
public:
[ExtensionAttribute]
static String^ ToDumpString(
array<unsigned char>^ buf,
DumpFormat fmt,
int offset = 0,
int count = -1,
bool eol = false,
Encoding^ encoding = nullptr,
int maxLen = 0
)
public:
[ExtensionAttribute]
static String^ ToDumpString(
array<unsigned char>^ buf,
DumpFormat fmt,
int offset = 0,
int count = -1,
bool eol = false,
Encoding^ encoding = nullptr,
int maxLen = 0
)
static member ToDumpString :
buf : byte[] *
fmt : DumpFormat *
?offset : int *
?count : int *
?eol : bool *
?encoding : Encoding *
?maxLen : int
(* Defaults:
let _offset = defaultArg offset 0
let _count = defaultArg count -1
let _eol = defaultArg eol false
let _encoding = defaultArg encoding null
let _maxLen = defaultArg maxLen 0
*)
-> string
static member ToDumpString :
buf : byte[] *
fmt : DumpFormat *
?offset : int *
?count : int *
?eol : bool *
?encoding : Encoding *
?maxLen : int
(* Defaults:
let _offset = defaultArg offset 0
let _count = defaultArg count -1
let _eol = defaultArg eol false
let _encoding = defaultArg encoding null
let _maxLen = defaultArg maxLen 0
*)
-> string
Parameters
- buf
- Type:
System Byte
Buffer to convert
- fmt
- Type: NFX DumpFormat
Dumping format
- offset (Optional)
- Type:
System Int32
Starting index
- count (Optional)
- Type:
System Int32
Number of bytes to process (-1 means all bytes in the buffer)
- eol (Optional)
- Type:
System Boolean
If true, terminate with end-of-line
- encoding (Optional)
- Type:
System.Text Encoding
Encoding to use for writing data in Binary format
- maxLen (Optional)
- Type:
System Int32
Max length of the returned string. Pass 0 for unlimited length
Return Value
Type:
StringUsage 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).