Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

LogSetTarget Function

Overview

The LogSetTarget function sets the target file for subsequent messages added to the specified log using the AddMessage function.

Syntax/Parameters

Syntax

int = LogSetTarget ( handle hLogObject, [string target] );

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.

target

An optional string specifying the qualified filename and path for the target. If omitted, the target is cleared and messages added will either have no target or revert to the default target. When using this parameter, hLogObject must be specified, even if it is NULL_HANDLE. The target is limited to the Windows MAX_PATH or 260 characters.

Return Value

Returns an int as ERROR_NONE or a formatted code on failure.

Remarks

The target applies to the next message added to the log using the AddMessage function. If multiple files are referenced as targets, this function allows those targets to be added.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic