GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

Put8Word Function

Overview

The Put8Word function puts a 8-bit word or short into a buffer at a specified byte position.

Syntax/Parameters

Syntax

int = Put8Word ( buffer data, int position, word value );

Parameters

data

A buffer as bytes, chars, string or a handle to a Data Object. This is referenced on a byte by byte position to write two bytes to create the 16-bit word.

position

An int specifying a zero-based position in bytes. This should point to the start of the data for the word. If the position plus the size of the data element is outside of the scope of the buffer, a range error will be returned.

value

A word value to place in the buffer. The order will be little-endian. If a larger value (greater than 16 bits) is provided, it will be truncated.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The Put8Word function allows a script to reach into a buffer and place a 8-bit value.

When adding to a single-dimension array, the axis depth is adjusted if the placement exceeds the last position. For other types or multiple dimensions, the axis depth is not adjusted. For automatically allocated arrays, the array size is not adjusted using this function.

The last position of the Data Object is also adjusted if the end position if the size of the value placed exceeds the last position.

Related Functions

Get8Word — Gets an 8-bit byte from a string, char buffer or Data Object by offset with optional swap.

Get16Word — Gets a 16-bit word from string, char buffer or Data Object by offset with optional swap.

Get32Word — Gets a 32-bit dword from a string, char buffer or Data Object by offset with optional swap.

Get64Word — Gets a 64-bit qword from a string, char buffer or Data Object offset with optional swap.

Get32Float — Gets a 32-bit float from a string, char buffer or Data Object offset. Conversion is to 64-bit float.

Get64Float — Gets a 64-bit float from a string, char buffer or Data Object by offset.

Put32Word — Sets a 32-bit dword into a buffer or Data Object at a specified position.

Put64Word — Sets a 64-bit qword into a buffer or Data Object at a specified position.

Put32Float — Sets a 32-bit float into a buffer or Data Object at a specified position.

Put64Float — Sets a 64-bit float into a buffer or Data Object at a specified position.

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 12/16/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.