  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
SetFileCloudProperties Function
Overview
The SetFileCloudProperties function allows certain properties to be changed within a cloud connection.
Syntax/Parameters
Syntax
int = SetFileCloudProperties ( string name | int index, string params | string params [] );
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.
params
A string or string array of the connection parameters. If a simple string is provided, the string must be in property: value; format. In array mode, the key names must match the property names listed below in the Remarks. Note that certain parameters are ignored.
Return Value
An int containing the index of the added connection or a formatted error code on failure.
Remarks
The SetFileCloudProperties function allows certain properties within a connection to be altered. The key or property names are as follows:
| Key/Property Name | Description | ||
| CloudName | Ignored. | ||
| Scheme | Ignored. | ||
| DisplayName | An optional display name. This can be used to provide a friendly name for the connection. | ||
| Description | An optional general description of the connection. | ||
| ServerDomain | Ignored. | ||
| ServletPath | Ignored. | ||
| UseSecureLink | Ignored. | ||
| Port | Ignored. | ||
| Owner | An optional owner of the connection. | ||
| Key | Ignored. | ||
| UserID | Ignored. | ||
| UserPW | Ignored. | ||
| CallerWordA | Translated to a 32-bit value from hex or decimal. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. | ||
| CallerWordB | Translated to a 32-bit value from hex or decimal. This value is specifically related to script or other non-specific application data. It is not used by the cloud connection manager. | ||
| 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. |
Any parameters not set are ignored and the value will not be changed.
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.