API version 5

- ‐

setDownloadPath

レスポンスボディの保存先ファイルパスを指定します。


このメソッドを呼び出した場合、このリクエストに対するレスポンスボディは逐次ファイルに書き出されるようになります。

そのため、巨大なレスポンスすべてをメモリ上に確保することを避ける必要があるような場合に有用です。


保存先に既にファイルが存在する場合、通信時に上書きされます。 また、保存先ファイルが生成出来ない場合、通信エラーとなります。


なお、このメソッドを呼び出した場合、HttpResponse.body プロパティは空バイト列となります。

HttpResponse.read メソッドや HttpResponse.readLine メソッドなどレスポンスボディにアクセスするメソッドは空のレスポンスボディが返った場合と同じ動作となります。

レスポンスボディにアクセスする場合、FileSystem オブジェクトなどを用いて保存先ファイルへアクセスして下さい。

呼出形式一覧

呼出形式

説明

void setDownloadPath(CRS::Common::Core::FileSystem fs, CRS::Common::Core::String path)

レスポンスボディの保存先ファイルパスを指定します。

戻り値一覧

戻り値

説明

void

なし

引数一覧

引数

説明

fs

仮想パスを解決するためのFileSystemオブジェクト

path

仮想パス

例外

なし

関連項目

FileSystem クラス

HttpSession クラス