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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

LogGetMessageCount Function

Overview

The LogGetMessageCount function retrieves the number of messages in the log by the requested type.

Syntax/Parameters

Syntax

int = LogGetMessageCount ( [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 optional int that specifies the type of message to count. The following values are possible:

	Code		Value		Comment
	LOG_NONE		0		Returns the count of all messages
	LOG_INFO		1		Not supported
	LOG_ADVISORY		2		Returns advisory message count
	LOG_WARNING		3		Returns warning message count
	LOG_ERROR		4		Returns error and fatal message count
	LOG_FATAL		5		Returns error and fatal message count
	LOG_STRING_ONLY		6		Not supported
	(default)		-1		Returns errors plus fatal plus warning messages

 

Return Value

Returns an int containing the message count or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

If the type parameter is omitted, the function retrieves the sum of the combination of errors and warnings.

Related Functions

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

LogCreate — Creates a general log object with an optional log name and target filename base.

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

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.