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

contentsOfDirectoryAtURL:includingPropertiesForKeys:options:error:

Performs a shallow search of the specified directory and returns URLs for the contained items. 指定されたディレクトリの浅い検索を実行して、含まれる項目に対するURLを返します。

Declaration 宣言

- (NSArray<NSURL *> *)contentsOfDirectoryAtURL:(NSURL *)url 
                    includingPropertiesForKeys:(NSArray<NSURLResourceKey> *)keys 
                                       options:(NSDirectoryEnumerationOptions)mask 
                                         error:(NSError * _Nullable *)error;

Parameters パラメータ

url

The URL for the directory whose contents you want to enumerate. それの内容をあなたが列挙するのを望むディレクトリに対するURL。

keys

An array of keys that identify the file properties that you want pre-fetched for each item in the directory. For each returned URL, the specified properties are fetched and cached in the NSURL object. For a list of keys you can specify, see Common File System Resource Keys. そのディレクトリにおいて各項目に対して事前読込みをあなたが望むファイルプロパティを識別するキーからなる配列。返されるURLそれぞれに対して、指定されたプロパティは取ってこられてNSURLオブジェクトにキャッシュされます。あなたが指定できるキーの一覧として、Common File System Resource Keysを見てください。

If you want directory contents to have no pre-fetched file properties, pass an empty array to this parameter. If you want directory contents to have default set of pre-fetched file properties, pass nil to this parameter. あなたがディレクトリ内容にファイルプロパティの事前読込みを望まないならば、空の配列をこのパラメータに渡してください。あなたがディレクトリ内容に省略時の一揃いの事前読込みファイルプロパティを望むならば、nilをこのパラメータに渡してください。

mask

Options for the enumeration. Because this method performs only shallow enumerations, options that prevent descending into subdirectories or packages are not allowed; the only supported option is NSDirectoryEnumerationSkipsHiddenFiles. 列挙に対するオプション。このメソッドは浅い列挙のみを実行することから、下位ディレクトリまたはパッケージを下っていくのを防止するオプションは利用可能ではありません;ただ1つのサポートされるオプションはNSDirectoryEnumerationSkipsHiddenFilesです。

error

On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information. 入力では、エラーオブジェクトへのポインタ。エラーが発生するならば、このポインタはエラー情報を含んでいる実際のエラーオブジェクトへと設定されます。あなたは、nilをこのパラメータに対して指定するかもしれません、もしあなたがエラー情報を望まないならば。

Return Value 戻り値

An array of NSURL objects, each of which identifies a file, directory, or symbolic link contained in url. If the directory contains no entries, this method returns an empty array. If an error occurs, this method returns nil and assigns an appropriate error object to the error parameter. NSURLオブジェクトからなる配列、そのそれぞれはurlに含まれるファイル、ディレクトリ、またはシンボリックリンクを識別します。ディレクトリが登録項目を含まないならば、このメソッドは空の配列を返します。エラーが発生するならば、このメソッドはnilを返して、適切なエラーオブジェクトをerrorパラメータに割り当てます。

Discussion 議論

This method performs a shallow search of the directory and therefore does not traverse symbolic links or return the contents of any subdirectories. This method also does not return URLs for the current directory (“.”), parent directory (“..”), or resource forks (files that begin with “._”) but it does return other hidden files. If you need to perform a deep enumeration, use the enumeratorAtURL:includingPropertiesForKeys:options:errorHandler: method instead. このメソッドは、ディレクトリの浅い検索を実行します、そしてそれゆえにシンボリックリンクを辿りません、またあらゆる下位ディレクトリの内容を返しません。このメソッドはまた、現在のディレクトリ(“.”)、親ディレクトリ(“..”)、またはリソークフォーク(“._” で始まるファイル)のURLを返しません、しかしそれは他の不可視ファイルを返します。深い列挙の実行を必要とするならば、enumeratorAtURL:includingPropertiesForKeys:options:errorHandler:メソッドを代わりに使ってください。

The order of the files in the returned array is undefined. 返される配列の中のファイルの順番は、未定義です。

See Also 参照

Discovering Directory Contents ディレクトリ内容を発見する