STD.File.PlaneLogicalFileName( planeName, path, abspath=TRUE )
| planeName | A null-terminated string containing the storage plane name. The plane must exist and currently must be an lz category plane. |
| path | A null-terminated string containing a relative or absolute path. Absolute paths must be within the selected plane prefix. |
| abspath | A BOOLEAN value that specifies whether to prepend ~ to the returned logical filename. Defaults to TRUE. |
| Return: | PlaneLogicalFileName returns a VARSTRING (null-terminated) value. |
The PlaneLogicalFileName function returns an encoded plane-scoped logical filename using ~plane::<planeName>::... syntax. Use this when constructing logical names for files addressed by storage plane and path instead of host/IP addressing.
Example:
OUTPUT(STD.File.PlaneLogicalFileName('mylz1', 'subdir1/subdir2/somefile.txt'));
//returns:
//~plane::mylz1::subdir1::subdir2::somefile.txt
OUTPUT(STD.File.PlaneLogicalFileName('mylz2', '/var/lib/HPCCSystems/thelz2prefix/subdir2/subdir3/somefile.txt'));
//returns:
//~plane::mylz2::subdir2::subdir3::somefile.txt