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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogSetMessageType Function

Overview

The LogSetMessageType function sets the type of message as part of the data to be added to the next log entry using the AddMessage function. The type is added as a Log Object type.

Syntax/Parameters

Syntax

int = LogSetMessageType ( [handle hLogObject], int type );

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.

type

An int specifying the type of message. The following are possible values:

	Code		Value		Comment
	LOG_NONE		0		No meaning
	LOG_INFO		1		Informational message
	LOG_ADVISORY		2		Message that is advisory in nature
	LOG_WARNING		3		A Warning
	LOG_ERROR		4		An error
	LOG_FATAL		5		An error but considered FATAL to the process
	LOG_STRING_ONLY		6		General string (no attributes)

 

Return Value

Returns an int as as the previous type value.

Remarks

Log message properties are useful attributes that can allow the user to better interact with log information. If the log is displayed in the Information View, the message type changes the colors and appearance of the message. The types are also counted as messages and are added to give the user a better idea of how many errors and warnings have occurred. See the LogDisplay and LogGetMessageCount functions for more information.

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.

LogGetMessageCount — Returns a count of specific message types.

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.