  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFileLockMetaData function retrieves available file lock meta information from an Application File Control (AFC) cookie. This function only works with files managed by Novaworks applications.
Syntax/Parameters
Syntax
string [] = GetFileLockMetaData ( string filename );
Parameters
file
A string containing a qualified file name and path. This parameter supports UTF encoding for filenames with Unicode characters.
Return Value
Returns a string array containing the meta information or an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
The GetFileLockMetaData function attempts to locate an AFC cookie corresponding to the file specified by the filename parameter.
Note that this function does not check file access status, it is possible to have orphan AFC cookies left behind as the result of an abnormal application edit. Use the GetFileOpenStatus function to verify the file is locked.
The key names are as follows:
| Key Name | Description | |||
| app_name | Name of application that has the file open. The name doe snot have the version. | |||
| filename | Fully qualified file name. | |||
| last_modified | Local date and time last modified as: dd/mm/yy hh:mm:ss. | |||
| opened_at | Local date and time file was opened as: dd/mm/yy hh:mm:ss. | |||
| user_short_name | Short name (user login ID). | |||
| user_full_name | Full name (if setup in the local systems user profile). | |||
| domain | Domain the computer belongs to with the file open. | |||
| workstation | The workstation name. | |||
| notes | Any notes, most views do not fill this field out. | |||
| editing_view | Primary view name, most views do not fill this field out. |
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.