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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogGetMessageProperties Function

Overview

The LogGetMessageProperties function retrieves all the properties associated with a message at a specific index within a log.

Syntax/Parameters

Syntax

string [] = LogGetMessageProperties ( [handle hLogObject], int index );

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 obtain the error summary to the default log.

index

An int that specifies the zero-based index of the message. The LogGetMessageCount function with a parameter of LOG_NONE can be used to retrieve the total number of messages, which is the upper limit of the index.

Return Value

Returns a string array with named items for each property or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The key names are as follows:

	Key Name		Description
	Message		Raw message text. Text or simple HTML.
	Flags		Hex string of 32-bit raw flags.
	Type		Decimal string for message type.
	SX		Zero-based decimal string for start X target position.
	SY		Zero-based decimal string for start Y target position.
	EX		Zero-based decimal string for end X target position.
	EY		Zero-based decimal string for end Y target position.
	Page		Decimal string for target page position.
	ID		Message ID string.
	FieldName		Field name (if appropriate) for message.
	OffendingValue		Offending or related value (if appropriate) for message.
	Target		Target filename and path for message.
	CallerOffset		Hex string of 32-bit raw flags.
	CallerString1		Caller string.
	CallerString2		Caller string.
	CallerString3		Caller string.
	CallerString4		Caller string.
	CallerData1		Hex string of 32-bit raw flags.
	CallerData2		Hex string of 32-bit raw flags.
	CallerData3		Hex string of 32-bit raw flags.
	CallerData4		Hex string of 32-bit raw flags.

 

Related Functions

LogGetMessageCount — Returns a count of specific message types.

LogGetMessage — Returns the string message associated with an index position within the specified log.

LogGetMessageType — Returns the type of message at the specified positions.

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

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.