Instance Method インスタンスメソッド

bookmarkDataWithOptions:includingResourceValuesForKeys:relativeToURL:error:

Returns a bookmark for the URL, created with specified options and resource values. URLに対するブックマークを返します、指定されたオプションとリソース値で作成されます。

Declaration 宣言

- (NSData *)bookmarkDataWithOptions:(NSURLBookmarkCreationOptions)options 
     includingResourceValuesForKeys:(NSArray<NSURLResourceKey> *)keys 
                      relativeToURL:(NSURL *)relativeURL 
                              error:(NSError * _Nullable *)error;

Parameters パラメータ

options オプション

Options taken into account when creating the bookmark for the URL. The possible flags (which can be combined with bitwise OR operations) are described in NSURLBookmarkCreationOptions. URLに対するブックマークを作成している時に考慮に入れるオプション。可能なフラグ（それはビット単位OR演算で結合されることができます）は、NSURLBookmarkCreationOptionsで記述されます。

To create a security-scoped bookmark to support App Sandbox, include the NSURLBookmarkCreationWithSecurityScope flag. When you later resolve the bookmark, you can use the resulting security-scoped URL to obtain read/write access to the file-system resource pointed to by the URL. 保安作用域ブックマークをApp Sandboxをサポートするように作成するには、NSURLBookmarkCreationWithSecurityScopeフラグを含めて下さい。あなたが後でブックマークを解決する時、あなたは結果の保安作用域URLを使用することで、URLによって指し示されるファイルシステムリソースへの読み出し／書き込みアクセスを取得できます。

If you instead want to create a security-scoped bookmark that, when resolved, enables you to obtain read-only access to a file-system resource, bitwise OR this parameter’s value with both the NSURLBookmarkCreationWithSecurityScope option and the NSURLBookmarkCreationSecurityScopeAllowOnlyReadAccess option. そうではなくてあなたが作成するのを望む保安作用域ブックマークが、解決される時にあなたに読み出し専用アクセスをファイルシステムリソースに獲得させるものならば、このパラメータの持つ値をNSURLBookmarkCreationWithSecurityScopeオプションとNSURLBookmarkCreationSecurityScopeAllowOnlyReadAccessオプションの両方とビット単位ORしてください。

keys

An array of names of URL resource properties to store as part of the bookmark. You can later access these values (without resolving the bookmark) by calling the resourceValuesForKeys:fromBookmarkData: method. ブックマークの一部として格納するURLリソースプロパティの名前それらからなるある配列。あなたは、後でこれらの値にアクセスすることが（ブックマークを解決することなしに）resourceValuesForKeys:fromBookmarkData:メソッドを呼び出すことで可能です。

The values of these properties must be of a type that the bookmark generation code can serialize. Specifically, the values can contain any of the following primitive types: これらのプロパティの値は、ブックマーク生成コードがシリアライズできる型のものでなければなりません。具体的には、値は以下の基本の型のどれでも含むことができます：

NSString or CFString NSStringまたはCFString
NSData or CFData NSDataまたはCFData
NSDate or CFDate NSDateまたはCFDate
NSNumber or CFNumber NSNumberまたはCFNumber
CFBoolean
NSURL or CFURL NSURLまたはCFURL
kCFNull or NSNull
CFUUID

In addition, the properties can contain the following collection classes: 加えて、プロパティは以下のコレクションクラスを含むことができます：

NSArray or CFArray containing only the above primitive types 上の基本の型のみを含んでいるNSArrayまたはCFArray
NSDictionary or CFDictionary with NSString or CFString keys, in which all values contain only the above primitive types NSDictionaryまたはCFDictionaryでNSStringまたはCFStringキーを持つもの、それにおいてすべての値は上の基本の型のみを含む

relativeURL

The URL that the bookmark data will be relative to. それに対してブックマークデータが相対的であるURL。

If you are creating a security-scoped bookmark to support App Sandbox, use this parameter as follows: あなたが保安作用域ブックマークをApp Sandboxをサポートするように作成しているならば、このパラメータを以下のように使ってください：

To create an app-scoped bookmark, use a value of nil. あるアプリ作用域ブックマークを作成するには、nilの値を使ってください。
To create a document-scoped bookmark, use the absolute path (despite this parameter’s name) to the document file that is to own the new security-scoped bookmark. ある書類作用域ブックマークを作成するには、その書類ファイルへの絶対パスを（このパラメータの名前にもかかわらず）使ってください、すなわち新しい保安作用域ブックマークを所有してください。

App Sandbox does not restrict which URL values may be passed to this parameter. App Sandboxは、どのURL値がこのパラメータに渡されるかを制限しません。

error

The error that occurred in the case that the bookmark data cannot be created. ブックマークデータが作成されることができないという事情で発生したエラー。

Return Value 戻り値

A bookmark for the URL. そのURLに対するブックマーク。

Discussion 議論

This method returns bookmark data that can later be resolved into a URL object for a file even if the user moves or renames it (if the volume format on which the file resides supports doing so). このメソッドは、ブックマークデータを返します、それは後であるファイルへのURLオブジェクトへと解決されることができます、たとえユーザがそれを移動または改名するとしてもです（それの上でファイルが存在するボリュームフォーマットがそうすることをサポートするならば）。

You can also use this method to create a security-scoped bookmark to support App Sandbox. Before you do so, you must first enable the appropriate entitlements for your app, as described in Enabling Security-Scoped Bookmark and URL Access. In addition, be sure to understand the behavior of the options and relativeURL parameters. あなたはまた、このメソッドを使って保安作用域ブックマークをApp Sandboxをサポートするように作成できます。あなたがそうする前に、あなたは最初にあなたのアプリに対する適切な資格付与を作動させなければなりません、Enabling Security-Scoped Bookmark and URL Accessで記述されるように。加えて、optionsとrelativeURLパラメータの挙動を理解することを確実にしてください。

For an app-scoped bookmark, no sandboxed app other than the one that created the bookmark can obtain access to the file-system resource that the URL (obtained from the bookmark) points to. Specifically, a bookmark created with security scope fails to resolve if the caller does not have the same code signing identity as the caller that created the bookmark. アプリ作用域ブックマークに対して、ブックマークを作成したものとは異なるサンドボックスアプリは、URL（ブックマークから得られた）が指し示すファイルシステムリソースに対するアクセスを獲得できません。具体的には、保安作用域で作成されたブックマークは解決するのを失敗します、もしこの呼び出し側がブックマークを作成した呼び出し側と同じコードサインを持たないならば。

For a document-scoped bookmark, any sandboxed app that has access to the bookmark data itself, and has access to the document that owns the bookmark, can obtain access to the resource. 書類作用域ブックマークに対して、ブックマークデータへのアクセスを持つ、そしてブックマークを所有する書類へのアクセスを持つあらゆるサンドボックスアプリは、リソースへのアクセスを獲得できます。

Handling Errors in Swift: Swiftでのエラー処理：

In Swift, this method returns a nonoptional result and is marked with the throws keyword to indicate that it throws an error in cases of failure. Swiftでは、このメソッドは非オプショナルの結果を返します、そしてthrowsキーワードで印されて失敗の場合にそれがエラーをスローすることを指し示します。

You call this method in a try expression and handle any errors in the catch clauses of a do statement, as described in Error Handling in The Swift Programming Language and About Imported Cocoa Error Parameters. あなたはこのメソッドをtry式の中で呼び出して、あらゆるエラーをdo文のcatch節で取り扱います、The Swift Programming Languageのエラー処理そしてインポートされるCocoaエラーパラメータについてで記述されるように。