GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogSetProperty Function

Overview

The LogSetProperty function sets a specified property as part of the data to be added to a subsequent log entry using the AddMessage function as a Log Object type.

Syntax/Parameters

Syntax

int = LogSetProperty ( [handle hLogObject], int property, mixed data );

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.

property

An int that specifies the type of data to set. The property values are as follows:

	Code		Value		Comment/Caller Field
	LOG_PROP_OFFSET		0		General int – Caller Offset (c_offset)
	LOG_PROP_STRING_1		1		General string – The value can be the as target filename, 260 max bytes (c_s1)
	LOG_PROP_STRING_2		2		General string – Max 64 bytes (c_s2)
	LOG_PROP_STRING_3		3		General string – Max 64 bytes (c_s3)
	LOG_PROP_STRING_4		4		General string – Max 64 bytes (c_s4)
	LOG_PROP_DWORD_1		5		General dword (c_d1)
	LOG_PROP_DWORD_2		6		General dword (c_d2)
	LOG_PROP_DWORD_3		7		General dword (c_d3)
	LOG_PROP_DWORD_4		8		General dword (c_d4)

 

data

An int or string value to set in the log field.

Return Value

Returns an int as ERROR_NONE or a formatted code on failure. Common errors include: ERROR_OVERFLOW if data contains a string that is too large for the buffer and ERROR_RANGE if property is incorrect.

Remarks

Log properties can aid in organizing the log for better display and to allow the user easier interaction with error and warning information. There are a number of user fields that can be addressed and later referenced as part of the log process.

Related Functions

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

LogClearProperties — Clears the current properties for adding the next message.

LogGetMessageProperties — Returns the properties for a message associated with an index position within the specified 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 04/22/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.