project_path

project_path(system_path: wchar_t) → unicode

Converts a file system path to a project-relative path.

This function serves as the inverse of system_path(). It attempts to make the provided path relative to the project’s directory, simplifying it to its most basic form. If the path cannot be made relative to the current project directory, the function will instead try to make it relative to the longest registered path variable.

A simplified, project-relative path as a wide character string.

It is recommended to use project_path for converting all file system paths that are added to the document to ensure consistency.

Return type

unicode