  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The ReportFileOpenStatus checks for a Application File Control (AFC) cookie and reports its information in a user-friendly manner.
Syntax/Parameters
Syntax
int = ReportFileOpenStatus ( string name );
Parameters
name
A string containing the filename and path. This parameter supports UTF encoding for filenames with Unicode characters.
Return Value
Returns an int as ERROR_NONE on success and non-zero if there was an error. Use the GetLastError function to retrieve error information.
Remarks
The ReportFileOpenStatus function attempts to locate an AFC cookie corresponding to the file specified by the name parameter. Because the function does not check file access status, it should be called to display information to the user if a file access function, such as the OpenFile function, returns ERROR_SHARING_VIOLATION. If the file specified in the name parameter is open in another application, a more generalized sharing violation message may appear.
The message box may contain extended information in an expansion section, which can be accessed via an arrow button.
Example:
More information is shown when the message window is expanded:
If an AFC cookie for the file cannot be found, the GetLastError function will return ERROR_EOD.
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.