WSMGR for Web V9 使用手引書

34.3.16 WsmgrHttpStreamオブジェクト

HTTPを使用して、エミュレータから取得したデータを、ファイルとしてクライアントへデータ転送（ダウンロード）するためのオブジェクトです。WsmgrHtmlStreamオブジェクトで使用可能なメソッドの一覧を示します。

メソッド	機能
Set	転送するデータを指定します。
Resp	クライアントへデータ転送を実行します。
GetError	エラー番号を取得します。

■Set

クライアントに転送するデータを指定します。

●呼び出し形式

Set(stringData)
Set(listData)
Set(tableData)
Set(byteData)

●パラメータ

プロパティ	説明	省略時の初期値
stringData	文字列データをファイルとして転送します。 データ型：文字列(string)	省略できません
listData	リストデータをファイルとして転送します。 データ型：文字列リスト(List<string>)
tableData	テーブルデータをファイルとして転送します。 データ型：文字列リストのリスト (List<List<string>>)
byteData	バイトデータをファイルとして転送します。 データ型：バイト配列(byte[])

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。エラーの詳細は、GetErrorメソッドにより取得できます。

●C#を用いて記述した例

RespメソッドのC#を用いて記述した例を参照してください。

■Resp

クライアントへのデータ転送を実行します。

実行が成功すると、ブラウザよりファイルダウンロード画面が表示されます。

●呼び出し形式

Resp(page, saveFileName[, mimeType]) 

●パラメータ

パラメータ	説明	省略時の初期値
page	アプリケーションで保持しているSystem.WebHttpContextのPageを指定	省略できません
saveFileName	ブラウザに表示されるファイル名を指定	省略できません
mimeType	ファイルのMIMEタイプを指定 システムで有効な値を指定してください。	自動判定します

参考

mimeTypeパラメータを省略した場合に、設定された転送データによって自動判定します。

文字列："text/plain"
リスト："text/plain"
テーブル："text/plain"
バイト配列："application/octet-stream"
mimeTypeが"text/plain"の場合は、charset属性を指定することでエンコーディングタイプが設定できます。
例）text/plain;charset="Shift-JIS"
charset属性が指定されていない場合は"Unicode"が指定されます。

●リターン値

本関数は正常/失敗に関わらず常に例外をスローします。関数呼び出し時は例外処理用のtry-catchブロックを使用し、成功/失敗はGetErrorメソッドを使用して判定してください。

本メソッドはファイルダウンロードの完了を待ち合わせません。また、ダウンロードはクライアントのブラウザに依存するため、転送結果を取得することはできません。

●C#を用いて記述した例

// 2行1桁 から 23行60桁 までをテーブル化します
string[][] arrays = dspemu.Screen.GetTextArrays(2, 1, 23, 60);

// List型式へ変換
List<List<string>> table = new List<List<string>>();
foreach(string[] array in arrays)
{
    table.Add(new List<string>(array));
}

WsmgrHttpStream httpStream = new WsmgrHttpStream();
httpStream.Set(table);
try 
{
    httpStream.Resp(page, "zaiko.csv","text/plain");
}
catch(Exception) 
{
    if(httpStream.GetError() == 0) 
    {
        // 成功時の処理
    }
    else 
    {
        // 失敗時の処理
    }
}

注意

本メソッドを使用する場合、アップデートパネル内では使用できません。

■GetError

関数がエラー終了した時の最新のエラー番号を取得します。エラーが発生していない場合は、0を返します。

●呼び出し形式

GetError()

●パラメータ

ありません

●リターン値

エラーが発生していない場合は0を、エラーが発生している場合はそのエラー番号を返します。
エラーの詳細を求める前に別のメソッドが実行されると、直前に失敗したメソッドが設定したエラー番号に上書きされます。
このため、各メソッドの復帰値が失敗した値で返ってきた場合は、すぐにGetErrorメソッドを用いてエラーの詳細を求めてください。

●C#を用いて記述した例

RespメソッドのC#を用いて記述した例を参照してください。