GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

HexBufferToByteString Function

Overview

The HexBufferToByteString function converts a variable or literal value to a formatted list of hexadecimal bytes.

Syntax/Parameters

Syntax

string = HexBufferToByteString ( parameter data, [int break], [int size] );

Parameters

data

A variable, handle, literal, or calculated value. If a variable is supplied, it can be an array or a complex object. If it is an object or array, it must be structured as contiguous memory. If a handle is supplied, it must be to a Data Object.

break

An optional int specifying the function should add a space every break bytes. If omitted, there will be no additional spacing.

size

An optional int containing a requested size, which must be less than or equal to the actual size. When used, the break parameter must also be used.

Return Value

Returns a string containing a translation of the binary form of data or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The formatting of the resultant string is: byte space byte space, with optional grouping. The resultant string cannot be larger than 1 MB.

When referencing a Data Object, the last position, not the allocated size, is used to moderate the size parameter.

Related Functions

HexBufferToBlock — Converts a variable to a multiple-line formatted string as a hex array with optional size, flags and base information.

HexBufferToString — Converts a variable to a string hex array with optional break position and size with padding.

HexToBuffer — Converts a string of hex characters into a variable or array and returns the number of bytes.

HexToInteger — Converts a hex string to a 64-bit integer or quad word.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.