Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral 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

Platform Support

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

Legato IDE, Legato Basic