  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
GetFileCloudProperties Function
Overview
The GetFileCloudProperties function returns the properties for a specific file cloud connection.
Syntax/Parameters
Syntax
string [] = GetFileCloudProperties ( string name | int index );
Parameters
name
A string containing the cloud name to retrieve the properties. Or,
index
An int specifying a zero-based index to the file connector array.
Return Value
A string array containing key named position and data pairs or an empty array on error. Use the GetLastError function to retrieve error information.
Remarks
Assuming the function is successful, the following list items are returned:
| Key Name | Description | ||
| CloudType | A string as a decimal value indicating the cloud interface type. | ||
| CloudName | The name of the cloud connection. This is the reference name when accessing files as part of the scheme and path. It will also be the same as the name parameter if the name is used to reference the properties. | ||
| Scheme | The scheme being used (always ‘vfc’). | ||
| DisplayName | The display name. This generally the friendly or more verbose name for the connection. | ||
| Description | A general description of the connection. | ||
| ServerDomain | The domain address (or IP address in string form) of the server connection. | ||
| ServletPath | The servlet file that is the interface for the cloud connection. | ||
| UseSecureLink | If ‘1’, requires an HTTPS, this should be the norm. | ||
| Port | A string as a decimal value indicating the port number. If non-zero, specifies the TCP port number for the connection. | ||
| Owner | An optional owner of the connection. | ||
| CallerWordA | A string in hexadecimal form containing user 32-bit word ‘A’. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. If the value was saved as a signed integer, it will be returned as an unsigned. | ||
| CallerWordB | A string in hexadecimal form containing user 32-bit word ‘B’. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. If the value was saved as a signed integer, it will be returned as an unsigned. | ||
| CallerStringA | A string of up to 512 characters. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. | ||
| CallerStringB | A string of up to 512 characters. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. | ||
| Status | A string in hexadecimal form containing current status bits of the connection. | ||
| OpenHandleCount | A string as a decimal value indicating the number of handles presently open on the connection. This does not count other applications with connections to the same server. | ||
| OpenFileCount | A string as a decimal value indicating the number of files presently open on the connection. This does not count other applications with connections to the same server. | ||
| OpenedAt | The local date and time, in ISO-8601 syntax, that the connection was first used (connected). If this is blank, the connection has not been used. | ||
| UploadDuration | A string as a decimal value indicating the total time in milliseconds that the connection has been uploading data. | ||
| DownloadDuration | A string as a decimal value indicating the total time in milliseconds that the connection has been downloading data. | ||
| UploadBytes | A string as a decimal value indicating the total bytes, including control overhead, of data uploaded. This is a 64-bit value. | ||
| DownloadBytes | A string as a decimal value indicating the total bytes, including control overhead, of data uploaded. This is a 64-bit value. |
Related Function
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.