  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The CreateRelativePath function takes a path and optional filename, compares it to a base path, and then, if possible, creates a relative path.
Syntax/Parameters
Syntax
string = CreateRelativePath ( string base, string target );
Parameters
base
A string representing the base path. The maximum size of the string is 1024 characters.
target
A string that is to be compared to base. The maximum size of the string is 1024 characters.
Return Value
Returns a string value representing the adjusted relative string or an empty string on failure. The value can also be empty if the base and target are the same string. Use the GetLastError function to determine if an error occurred.
Remarks
This function differs from MakePathRelative in that an attempt is made to create tree navigation if required by inserting leading ‘..’ connectors. This function automatically converts to MS style path delimiters. It is not meant to work with URIs. If the path has a root component, both paths must have the same drive or UNC or the GetLastError function will return ERROR_RANGE for a root mismatch.
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.