8.7.10 ファイル一覧書き込みオペレーション
ここでは,ファイル一覧書き込みオペレーションでサポートする機能やファイル形式について説明します。
- 〈この項の構成〉
(1) ファイル一覧書き込みオペレーションの機能概要
ファイル一覧書き込みオペレーションは,共通フォルダからファイル一覧情報を取得し,一覧情報をファイルに書き込みます。一覧取得元にファイルが指定された場合は,指定されたファイルだけを返します。一覧取得元にディレクトリが指定された場合は,指定されたディレクトリの直下のファイル・ディレクトリだけを返します。
ファイル一覧書き込みオペレーションの処理の概要について,次の図に示します。
(2) 一覧取得元に指定可能な対象
ファイル一覧書き込みオペレーションで一覧取得元に指定可能な対象を次に示します。
一覧取得元に指定可能な対象 |
サポート |
|
---|---|---|
作業フォルダ |
ファイル |
× |
作業フォルダ自体 |
× |
|
共通フォルダ |
ファイル |
○ |
共通フォルダ自体 |
○ |
|
サブフォルダ |
○ |
(3) 一覧取得で取得可能な対象
一覧取得元の共通フォルダで取得可能な対象を次に示します。
一覧取得で取得可能な対象 |
サポート |
|
---|---|---|
直下のファイル |
通常ファイル |
○ |
隠しファイル |
○ |
|
シンボリックリンク |
○ |
|
直下のサブフォルダ※1 |
通常ディレクトリ |
○ |
隠しディレクトリ※2 |
○ |
|
シンボリックリンク |
○ |
(4) 出力するファイル形式
出力するファイルの文字コードは,UTF-16(ビッグエンディアン,BOMあり)です。取得したファイル一覧が空の場合は,BOMだけを出力します。
全項目を出力する場合(要求電文list-optionでlが指定された場合)のファイル出力形式を次に示します。
列順 |
列名 |
列サイズ (バイト) |
出力形式※1 |
左右寄せ |
---|---|---|---|---|
1 |
ファイル種別 |
2※2 |
fもしくはd※3 |
左 |
2 |
ファイルサイズ |
40※2 |
ファイルサイズの数値文字列※4 |
右 |
3 |
最終更新日時 |
出力形式のバイト※2 |
ユーザ指定形式 |
左 |
4 |
ファイル名 |
可変長※5 |
ファイル名文字列 |
左 |
ファイル名だけを出力する場合(要求電文list-optionでlが指定された場合)のファイル出力形式を次に示します。
列順 |
列名 |
列サイズ (バイト) |
出力形式 |
左右寄せ |
---|---|---|---|---|
1 |
ファイル名 |
可変長※ |
ファイル名文字列 |
左 |
(5) ファイル一覧書き込みオペレーションの注意事項
ファイル一覧書き込みオペレーションの注意事項を次に示します。
-
一覧取得元がディレクトリの場合,一覧取得元ディレクトリとその直下のファイル・ディレクトリのロックは取得しません。
-
ファイル一覧の最終更新日時はローカルタイムとなります。
-
一覧取得元が存在しない場合,空の一覧情報を出力します。
-
最終更新日時の列サイズは要求電文date-time-pattern要素で指定したパターン文字列とサーバロケールに依存します。そのため,長さが可変になるパターン文字列を指定した場合(H,EEEE,d,Dなど),ファイルごとに列サイズが異なる可能性があります。