BufferGetString

This Buffer tool retrieves an integer from the binary buffer.

Inputs

Buffer Handle

The buffer handle that contains the integer.

Offset

The integer value for the offset in the buffer. Offsets are in bytes and 0 based.

Read Mode

This selection is how the length is stored. It can be:

• Prepended Length

• Read until a zero

• Custom

Length

If the Read Mode is "Custom", this integer value is the number of characters to read.

Encoding

This parameter selects the custom encoding to be used.

• UCS-2

• UTF-8

• EBCDIC

Codepage

This integer is the EBCDIC code page to use. This field is only available if the EBCDIC custom encoding is selected. Currently, only the code page 290 is supported.

Outputs

String

The string value from the buffer.

Updated Offset

This integer contains the original offset, updated by the size of what was read. Offsets are in bytes and 0 based.

Exit Paths

Success

This step takes this path on success.

Invalid Handle

The tool takes this path, if the buffer handles was invalid.

Invalid Codepage

The tool takes this path if the codepage value specified is not valid.

Invalid Offset

This step takes this path if the offset did not point inside the buffer.