Sys.Services の ProfileService の defaultSaveCompletedCallback プロパティ
更新 : 2007 年 11 月
既定の保存完了コールバック関数の名前を取得または設定します。
.gif "メモ") メモ : |
|---|
クライアント API プロパティのプロパティ値を取得または設定するには、名前のプレフィックスが get_ および set_ のプロパティ アクセサ メソッドを呼び出す必要があります。たとえば、cancel のプロパティの値を取得または設定するには、get_cancel メソッドまたは set_cancel メソッドを呼び出します。 |
Sys.Services.ProfileService.set_defaultSaveCompletedCallback(value);
var defaultSaveCompletedCallback =
Sys.Services.ProfileService.get_defaultSaveCompletedCallback();
パラメータ
パラメータ |
説明 |
|---|---|
value |
既定の保存完了コールバック関数の名前を含む文字列。 |
解説
このプロパティに指定された関数は、プロファイルが正常に保存されたときの既定のコールバック関数として使用されます。この既定のコールバック関数をオーバーライドするには、別の関数の名前を save メソッドに渡します。
このコールバック関数を実装するには、次のシグネチャを使用する必要があります。
function SaveComplete(numPropertiesSaved, userContext, methodName)
コールバック関数に渡されるパラメータは次のとおりです。
numPropertiesSaved。プロファイル サービスによって保存されるプロパティの数を示します。
userContext。save メソッドに渡すユーザー コンテキスト情報です。
methodName。呼び出し元メソッドの名前です。
プロファイル サービスが正常終了すると、コールバック関数が非同期に呼び出されます。
使用例
defaultSaveCompletedCallback プロパティを使用する方法の例を次に示します。このコードは、Sys.Services.ProfileService クラスの概要で説明しているコード例の一部です。
// Set default load completed callback function.
Sys.Services.ProfileService.set_defaultSaveCompletedCallback(SaveCompletedCallback);
// Get default save completed callback function.
var defaultSaveCompletedCallback =
Sys.Services.ProfileService.get_defaultSaveCompletedCallback();