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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogSetPosition Function

Overview

The LogSetPosition function sets the position of the event (such as the event that produced the error) in the target file for a corresponding message added to a log using the AddMessage function. This information is added as a Log Object type.

Syntax/Parameters

Syntax

int = LogSetPosition ( [handle hLogObject], [int sx, int sy, [int ex, int ey]] );

Parameters

hLogObject‡

A handle to a Log Object created with the LogCreate function. If this handle is omitted or NULL_HANDLE is specified, the function will apply the error summary to the default log.

sx   sy

Optional int values specifying the starting position (column, row). All values are zero-based positions. If omitted, the value will be set to -1 (invalid position).

ex  ey

Optional int values specifying the ending position (column, row). All values are zero-based positions. If omitted, the value will be set to -1 (invalid position). In order to specify ex and ey, sx and sy must also be specified.

Return Value

Returns an int as ERROR_NONE.

[bad handle error]

Remarks

The LogSetPosition function can provide information in the log file or Log Object about where in the target the message (such as an error or warning) occurred. The sx, sy, ex, and ey parameters can delineate this location. If the log is displayed in the Information View, this information can be used to position the target file display and caret for the user. The validity of the position are not checked against the target file.

Related Functions

AddMessage — Adds a formatted message to the default or a specified log, or other object.

LogDisplay — Displays the specified log as a tab in the Information View window.

LogSetFileType — Sets an optional override file type for the target associated with the log.

LogSetMessageType — Sets the message type for the next message added.

LogSetTarget — Sets a target filename for the next message added (links message to file).

LogSetWindow — Sets an optional window handle associated with the log.

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.