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

coordinate(writingItemAt:options:error:byAccessor:)

Initiates a write operation on a single file or directory using the specified options. 書き込み演算をある単一のファイルまたはディレクトリ上でこの指定されたオプションを使って開始します。

Declaration 宣言

func coordinate(writingItemAt url: URL, 
        options: NSFileCoordinator.WritingOptions = [], 
          error outError: NSErrorPointer, 
     byAccessor writer: (URL) -> Void)

Parameters パラメータ

url

A URL identifying the file or directory to write to. If other objects or processes are acting on the item at the URL, the actual URL passed to writer parameter may be different from the one in this parameter. それへと書き込みをするファイルまたはディレクトリを識別するURL。他のオブジェクトまたはプロセスがそのURLでの項目上で行動しているならば、writerパラメータに渡される実際のURLは、このパラメータのものと異なるかもしれません。

options オプション

One of the writing options described in NSFileCoordinator.WritingOptions. The options you specify partially determine how file presenters are notified and how this file coordinator object waits to execute your block. NSFileCoordinator.WritingOptionsで記述される書き込みオプションの1つ。どのようにファイルプレゼンタが通知されるかそしてどのようにこのファイルコーディネータオブジェクトがあなたのブロックの実行に対して待機するかを、あなたがある程度決定するオプション。

outError

On input, a pointer to a pointer for an error object. If a file presenter encounters an error while preparing for this write operation, that error is returned in this parameter and the block in the writer parameter is not executed. If you cancel this operation before the writer block is executed, this parameter contains an error object on output. 入力において、エラーオブジェクトに対するポインタへのポインタ。この書き込み演算に対して準備している間にファイルプレゼンタがエラーに出くわすならば、そのエラーはこのパラメータにおいて返されます、そしてwriterパラメータの中のブロックは実行されません。あなたがこの演算をwriterブロックが実行される前にキャンセルするならば、このパラメータは出力においてエラーオブジェクトを含みます。

writer

A Block object containing the file operations you want to perform in a coordinated manner. This block receives an NSURL object containing the URL of the item and returns no value. Always use the URL passed into the block instead of the value in the url parameter. あなたが協調流儀で実行することを望むファイル演算を含んでいるBlockオブジェクト。このブロックは、その項目のURLを含んでいるNSURLオブジェクトを受け取ります、そして値を返しません。常にブロックへと渡されるURLを使ってください、urlパラメータの中の値ではなく。

Discussion 議論

When invoking these methods, declare a __block variable before the accessor block and initialize it to a value that signals failure, and then inside the accessor block set it to a value that indicates success. If the coordinated operation fails, then the accessor block never runs. The sentinel variable still holds a value that indicates failure, and the NSError out parameter contains a reference that describes the error. これらのメソッドを発動する場合、__block変数をアクセッサブロックの前に宣言してそれを失敗を合図するある値に初期化してください、それからアクセッサブロックの内部でそれを成功を指し示すある値に設定してください。協調演算が失敗するならば、そのときアクセッサブロックは決して実行されません。この見張りの変数は、依然として失敗を指し示すある値を保持します、そしてNSError outパラメータは、エラーを記述するある参照を含みます。

You use this method to perform write-related operations on a file or directory in a coordinated manner. This method executes synchronously, blocking the current thread until the writer block finishes executing. Before executing the block, though, the file coordinator waits until other relevant file presenter objects finish in-progress actions. Similarly, your write operation may cause pending actions for other file presenters to wait until your operations are complete. Whether or not the file coordinator waits depends on whether the item being written is a file or directory and also depends on other related operations. あなたはこのメソッドを使って、書き込み関連演算をファイルまたはディレクトリ上で協調的流儀で実行します。このメソッドは同期的に実行します、現在のスレッドをwriterブロックが実行をやり終えるまで遮断します。ブロックの実行前に、ファイルコーディネータは、他の関連ファイルプレゼンタオブジェクトが現在進行中のアクションを終えるまで待機します。同様に、あなたの書き込み演算は、他のファイルプレゼンタにとっての懸案の動作があなたの演算が完了するまで待機することを引き起こすかもしれません。ファイルコーディタが待機するかどうかは、書き込まれている項目が、ファイルかディレクトリかに依存します、そしてまた他の関連演算に依存します。

  • If the url parameter specifies a file: urlパラメータがファイルを指定するならば:

    • This method waits for other readers and writers of the exact same file to finish in-progress actions. このメソッドは、正確に同じファイルの他の読み出し手および書き込み手に対して現在進行中の動作を完了するまで、待機します。

    • This method waits if the file is a file package or any item inside a file package and other writers are reading or writing to other items inside the package directory. このメソッドは、ファイルがファイルパッケージまたはファイルパッケージ内の何らかの項目でありそして他の書き込み手が他の項目にそのパッケージディレクトリ内で読み出しまたは書き込みしているならば、待機します。

    • This method does not wait for readers or writers that are manipulating the parent directory of the file, unless one of those writers specified the forDeleting or forMoving option. このメソッドは、そのファイルの親ディレクトリに手を入れている読み出し手や書き込み手に対しては、それらの書き込み手の1つがforDeletingまたはforMovingオプションを指定した場合を除いて、待機しません。

  • If the url parameter specifies a directory: urlパラメータがディレクトリを指定するならば:

    • This method waits if other read or write operations are occurring on the exact same directory. このメソッドは、他の読み出しまたは書き込み演算が正確に同じディレクトリ上で起こっているならば、待機します。

    • This method does not wait if read or write operations are occurring on items inside the directory (but not on the directory itself). このメソッドは、読み出しまたは書き込み演算がディレクトリ内の項目上で起こっている(しかしそのディレクトリ自身でない)ならば、待機しません。

    • This method does not wait for readers or writers that are manipulating the parent directory of the directory, unless one of those writers specified the forDeleting or forMoving option. このメソッドは、そのディレクトリの親ディレクトリに手を入れている読み出し手や書き込み手に対しては、それらの書き込み手の1つがforDeletingまたはforMovingオプションを指定した場合を除いて、待機しません。

This method calls the relinquishPresentedItem(toWriter:) method of any relevant file presenters. This method is called for file presenters in the current process and in other processes. Depending on the options you specify, other methods of the file presenters may also be called. When writing a file package directory, file presenter objects that are currently reading or writing the contents of that file package also receive these notifications. All of the called methods must return successfully before the file coordinator executes your block. If multiple file presenters are operating on the item, the order in which those presenters are notified is undefined. このメソッドは、あらゆる関連するファイルプレゼンタそれらのrelinquishPresentedItem(toWriter:)メソッドを呼び出します。このメソッドは、現在のプロセスにおいてそして他のプロセスにおいてそれらファイルプレゼンタを呼び出します。あなたが指定するオプションに依存して、それらファイルプレゼンタの他のメソッドもまた呼び出されるかもしれません。ファイルパッケージディレクトリを書き込んでいる場合、現在そのファイルパッケージの内容を読みだしまたは書き込みしているファイルプレゼンタオブジェクトもまた、これらの通知を受け取ります。呼び出されたメソッドの全ては、ファイルコーディネータがあなたのブロックを実行する前に、うまく返らなければなりません。複数のファイルプレゼンタがその項目上で演算を行っているならば、それらプレゼンタが通知を受ける順番は未定義です。

With one exception, do not nest calls to file coordinator methods inside the block you pass to this method. You may call the coordinate(readingItemAt:options:error:byAccessor:) method to read the file if you discover through modification-date checking that the contents of the file have changed. However, if you call this method from inside your block, the file coordinator object throws an exception. 1つ例外として、ファイルコーディネータメソッドへの呼び出しを、あなたがこのメソッドに渡すブロック内で入れ子にしないでください。あなたは、coordinate(readingItemAt:options:error:byAccessor:)メソッドを呼び出してファイルを読み出すかもしれません、あなたが修正日の検査を通してファイルの内容が変更されたことを発見するならば。しかしながら、あなたがこのメソッドをあなたのブロック内から呼び出すならば、ファイルコーディネータオブジェクトは例外をスローします。

See Also 参照

Coordinating File Operations Synchronously ファイル操作を同期的に協調させる(コーディネートする)