Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FourteenProject Functions (continued)

ProjectGetName Function

Overview

The ProjectGetName function returns the name of the currently open project.

Syntax/Parameters

Syntax

string = ProjectGetName ( );

Parameters

(none) 

 

Return Value

Returns a string containing the fully qualified name of the project file or an empty string on error. An empty string will be returned if an unsaved project is open on the application desktop. Use the GetLastError function to retrieve error information or IsError to determine if a project is open.

If a project is not open, the last error will be ERROR_CONTEXT.

Remarks 

The most common source of an error is that a project is not open. The project name is not set until a project file is opened or a new project is saved.

To test if a project is open, even if untitled, check the last error condition or use the GetProjectMDIWindow function.

See Also

Platform Support

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