Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
Creates a bookmark from a file path.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
Files | 3.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
Parameter | Description | Example | Flags |
---|---|---|---|
Path | The native path to file or folder where the bookmark refers to. | $path | |
RelativePath | Optional the path of a file/folder being the relative path. This can be the native path to your database. This way you can later find the file again if database and target file moved together. | "/Data/ImageFiles" | Optional |
PreferFileIDResolution | Optional, whether you prefer FileID resolution later over path resolution. Can be 1 or 0. Default is 0. | 1 | Optional |
MinimalBookmark | Optional, whether to request a minimal bookmark. Creates bookmark data with "less" information, which may be smaller but still be able to resolve in certain ways. |
1 | Optional |
Returns bookmark data text or error message.
This function checks for a license.
Created 18th August 2014, last changed 28th November 2019