  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The MakePathRelative 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 = MakePathRelative ( 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 base and target are the same string. Use the GetLastError function to determine if an error occurred.
Remarks
This function differs from CreateRelativePath in that no attempt is made to create tree navigation by inserting leading ‘..’ connectors. Paths can be URI or Windows style and may be drive-path, UNC, or URI style. The base parameter is generally a qualified path but can also be relative so long as the start of the target parameter matches. Any leading data on the target parameter is trimmed to make it relative.
The base and target parameters are compared on a case-insensitive basis. Take note of this when working with URIs since UNIX based servers are case-sensitive.
If the function cannot create a relative path, the GetLastError function will return ERROR_EOD for a 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.