Platforms to show: All Mac Windows Linux Cross-Platform
The module CFBookmarkMBS
module CFBookmarkMBS| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| module | Alias | MBS MacCF Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Bookmark data strings have no text encoding. If you use ConvertEncoding on them, you destroy them.
Available with Mac OS X 10.6 or newer.
For older systems, please use MacAliasMBS class.
- method Available as boolean
- method CreateBookmarkData(file as folderitem, options as UInt32 = 1024, relativeToURL as folderitem = nil) as string
- method CreateBookmarkData(file as folderitem, options as UInt32, resourcePropertiesToInclude() as string, relativeToURL as folderitem = nil) as string
- method CreateBookmarkData(URL as CFURLMBS, options as UInt32 = 1024, relativeToURL as CFURLMBS = nil) as string
- method CreateBookmarkData(URL as CFURLMBS, options as UInt32 = 1024, relativeToURL as folderitem = nil) as string
- method CreateBookmarkData(URL as CFURLMBS, options as UInt32, resourcePropertiesToInclude() as string, relativeToURL as CFURLMBS = nil) as string
- method CreateBookmarkData(URL as CFURLMBS, options as UInt32, resourcePropertiesToInclude() as string, relativeToURL as folderitem = nil) as string
- method CreateBookmarkData(URL as string, options as UInt32 = 1024, relativeToURL as string = "") as string
- method CreateBookmarkData(URL as string, options as UInt32, resourcePropertiesToInclude() as string, relativeToURL as string = "") as string
- method CreateBookmarkDataFromAliasRecord(AliasRecordData as string) as string
- method LastError as CFErrorMBS
- method ReadBookmarkDataFromFile(file as folderitem) as string
- method ResolveBookmarkData(bookmark as string, options as UInt32, relativeToURL as folderitem, byref isStale as boolean) as folderitem
- method ResolveBookmarkData(bookmark as string, options as UInt32, relativeToURL as folderitem, resourcePropertiesToInclude() as string, byref isStale as boolean) as folderitem
- method ResolveBookmarkData(bookmark as string, options as UInt32, relativeToURL as string, byref isStale as boolean) as string
- method ResolveBookmarkData(bookmark as string, options as UInt32, relativeToURL as string, resourcePropertiesToInclude() as string, byref isStale as boolean) as string
- method ResolveBookmarkDataToCFURLMBS(bookmark as string, options as UInt32, relativeToURL as CFURLMBS, byref isStale as boolean) as CFURLMBS
- method ResolveBookmarkDataToCFURLMBS(bookmark as string, options as UInt32, relativeToURL as CFURLMBS, resourcePropertiesToInclude() as string, byref isStale as boolean) as CFURLMBS
- method ResolveBookmarkDataToCFURLMBS(bookmark as string, options as UInt32, relativeToURL as folderitem, byref isStale as boolean) as CFURLMBS
- method ResolveBookmarkDataToCFURLMBS(bookmark as string, options as UInt32, relativeToURL as folderitem, resourcePropertiesToInclude() as string, byref isStale as boolean) as CFURLMBS
- method ResourcePropertiesForKeysFromBookmarkData(BookmarkData as string) as dictionary
- method ResourcePropertiesForKeysFromBookmarkData(BookmarkData as string, resourcePropertiesToReturn() as string) as dictionary
- method ResourcePropertyForKeyFromBookmarkData(BookmarkData as string, resourcePropertyKey as string) as Variant
- method StartAccessingSecurityScopedResource(URL as CFURLMBS) as boolean
- method StopAccessingSecurityScopedResource(URL as CFURLMBS)
- method WriteBookmarkDataToFile(BookmarkData as string, file as folderitem, options as UInt32) as boolean
- 8 constants
Creation options.
| Constant | Value | Description |
|---|---|---|
| kCreationMinimalBookmarkMask | 512 |
Creates a bookmark with "less" information, which may be smaller but still be able to resolve in certain ways. |
| kCreationPreferFileIDResolutionMask | 256 |
At resolution time, this alias will prefer resolving by the embedded fileID to the path. |
| kCreationSecurityScopeAllowOnlyReadAccess | 4096 |
Mac OS X 10.7.3 and later, if used with kCFURLBookmarkCreationWithSecurityScope, at resolution time only read access to the resource will be granted. |
| kCreationSuitableForBookmarkFile | 1024 |
Includes in the created bookmark those properties which are needed for a bookmark/alias file. |
| kCreationWithSecurityScope | 2048 |
Mac OS X 10.7.3 and later, include information in the bookmark data which allows the same sandboxed process to access the resource after being relaunched. |
Resolving options.
| Constant | Value | Description |
|---|---|---|
| kResolutionWithoutMountingMask | 512 |
Don't mount a volume during bookmark resolution. |
| kResolutionWithoutUIMask | 256 |
Don't perform any UI during bookmark resolution. |
| kResolutionWithSecurityScope | 1024 |
Mac OS X 10.7.3 and later, extract the security scope included at creation time to provide the ability to access the resource. |
Some examples which use this module:
Blog Entries
- MBS Xojo Plugins, version 20.6pr3
- MBS Xojo Plugins, version 17.1pr3
- MBS Xojo / Real Studio Plugins, version 14.2pr4
- MBS Xojo / Real Studio Plugins, version 14.1pr2
- MBS Real Studio Plugins, version 11.3pr12
- MBS Real Studio Plugins, version 11.3pr10
Release notes
- Version 21.0
- Deprecated AliasInfoMBS and MacAliasMBS classes in favor of CFBookmarkMBS module.
- Version 17.1
- Fixed CFBookmarkMBS.ResourcePropertiesForKeysFromBookmarkData to know keys.
The items on this page are in the following plugins: MBS MacCF Plugin.
