  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFileOpenStatus function determines if a file is opened and its open attributes, if applicable.
Syntax/Parameters
Syntax
int = GetFileOpenStatus ( string file, [dword mode] );
Parameters
file
A string containing a qualified file name and path. This parameter supports UTF encoding for filenames with Unicode characters.
mode
An optional dword containing optional bitwise flags with which to test the opening of the file. See Section 6.2 File Access Modes for more information about file sharing and access flags. The default mode is FO_READ.
Return Value
Returns an int containing ERROR_NONE if the file was opened or an error code if the file could not be opened. Use the GetLastError or GetLastErrorMessage functions to retrieve error information.
Remarks
The GetFileOpenStatus attempts to open the file with the requested permissions. If the function is able to open the file, it then closes the file and returns no error.
If the file is open in a Novaworks application and the AFC cookies are turned on, meta file data may be available specifying the locking user and device.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.