Sys.Net.WebRequest の userContext プロパティ
更新 : 2007 年 11 月
Sys.Net.WebRequest インスタンスに関連付けられているユーザー コンテキストを取得または設定します。
.gif "メモ") メモ : |
|---|
クライアント API プロパティのプロパティ値を取得または設定するには、名前のプレフィックスが get_ および set_ のプロパティ アクセサ メソッドを呼び出す必要があります。たとえば、cancel のプロパティの値を取得または設定するには、get_cancel メソッドまたは set_cancel メソッドを呼び出します。 |
var userContext = MyWebRequest.get_userContext();
MyWebRequest.set_userContext(value);
パラメータ
パラメータ |
説明 |
|---|---|
Value |
要求に関連付けられているユーザー コンテキスト情報。value に指定できるのは、null、任意のプリミティブ型、または JavaScript オブジェクトです。 |
戻り値
現在の Web 要求ユーザー コンテキスト。
解説
userContext プロパティは、invoke メソッドを呼び出す前に、WebRequest インスタンスで設定できます。同じ userContext プロパティは、Web 要求の完了ハンドラ内からアクセスできます。これにより、イベント ハンドラの呼び出し元を区別したり、返されたデータの処理における状態やコンテキストを回復したりできます。
| メモ : |
|---|
userContext をイベント ハンドラ内から取得するには、Sys.Net.WebRequestExecutor の webRequest プロパティの userContext を使用します。 |
使用例
Web 要求のユーザー コンテキストを設定する方法を次の例に示します。このコードは、WebRequest クラスの概要で説明しているコード例の一部分です。
// Set user's context
wRequest.set_userContext("user's context");