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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

BinaryPutSegment Function

Overview

The BinaryPutSegment function directly places a binary image of data into a specified area of a variable (memory).

Syntax/Parameters

Syntax

int = BinaryPutSegment ( param target, param source, [int position], [int size] );

Parameters

target

A parameter as variable data. The binary content of which will be altered. If a string type is supplied, the zero terminating byte is not included in the size.

source

A parameter as literal, variable data or handle. The binary content of which will be placed into data. If a string type (or literal) is supplied, the zero terminating byte is not included in the size.

position

An int specifying the zero-based position in bytes to put the new information within data.

size

An optional int specifying the size of source in bytes. If omitted, the default size of source is used. For string types, the size of the string less the zero terminator will be used, for other arrays, the entire allocated array is used.

Return Value

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

Remarks

The entirety or specified size of the source data is placed into the data memory at the specified position.

Put segment is meant to copy data from a source and place it into a destination target buffer. The source and target parameters cannot be the same variable,

Source information can be a variable or a Data Object.

Related Functions

BinaryCompare — Compares two variables (or literals) as binary memory.

BinaryCompareNoCase — Compares two variables (or literals) as binary characters without regard to case.

BinaryCopySegment — Copies data from a source segment of data and places it into a target buffer using optional specified position and number of bytes.

BinaryReadRecord — Reads a series of variables from a specified source.

BinaryScan — Scans a segment of binary data for a specific pattern.

BinaryWriteRecord — Writes a series of variables to a specified target.

LayerStringSegment — Layers one string on top of another string 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 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.