Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

DataObjectDeleteSection Function

Overview

The DataObjectDeleteSection function deletes a specified section of memory from a Data Object.

Syntax/Parameters

Syntax

int = DataObjectDeleteSection ( handle hData, int position, int size );

Parameters

hData

A handle specifying the Data Object.

position

An int specifying the zero-based position to delete from in bytes.

size

An int specifying the size of the area to delete in bytes.

Return Value

Returns an int specifying the revised size of the Data Object or zero on failure. Use the GetLastError function to retrieve a formatted error code. Note that the delete operation can delete all the data and return zero without an error.

Remarks

Memory is shifted to the left (or up) to delete the area. The end position, or size, is adjusted to reflect the shift and the discarded area at the end of the data is zeroed. The delete operation does not change the allocated size of the Data Object.

Related Functions

Platform Support

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

Legato IDE, Legato Basic