Ewa.AsyncResult.getDescription()
**適用対象:**apps for SharePoint | Excel Services | SharePoint Server 2013
この記事の内容
戻り値
注釈
例
ローカライズされたエラー メッセージを取得します。
var value = Ewa.AsyncResult.getDescription();
戻り値
型: String
注釈
**[AsyncResult]**オブジェクトは、非同期メソッドの呼び出しで指定されたメソッド コールバックに引数として渡されます。非同期操作中にエラーが発生した場合、 **[AsyncResult]オブジェクト エラーに関する情報が含まれます。[AsyncResult.getDescription]**方法では、エラーに関連付けられているローカライズされたエラー メッセージの文字列を返します。
注意
[AsyncResult.getDescription]では、エラー条件でのみエラー メッセージが返されます。警告メッセージが返さおよび実行関数に関する情報を提供されません。
例
次の例では、非同期操作から発生するエラーに関連付けられているローカライズされたエラー メッセージを取得する方法を示します。コードの例をExcel Web Access Web パーツでSharePoint Server 2013で作業していることを前提としています。
<script type="text/javascript">
var ewa = null;
// Add event handler for onload event.
if (window.attachEvent)
{
window.attachEvent("onload", ewaOnPageLoad);
}
else
{
window.addEventListener("DOMContentLoaded", ewaOnPageLoad, false);
}
// Add event handler for applicationReady event.
function ewaOnPageLoad()
{
Ewa.EwaControl.add_applicationReady(getEwa);
}
function getEwa()
{
// Get a reference to the Ewa object.
ewa = Ewa.EwaControl.getInstances().getItem(0);
getRangeAsync();
}
function getRangeAsync()
{
// Get a range asynchronously using A1 notation.
ewa.getActiveWorkbook().getRangeA1Async("Sheet3!B2", getRangeComplete, null);
}
function getRangeComplete(asyncResult)
{
// If getRangeA1Async failed, get localized error message.
if (!asyncResult.getSucceeded())
{
asyncResult.getDescription();
} // End if.
// Get the range object from the getRangeA1Async call.
var range = asyncResult.getReturnValue();
// Display the range address in A1 format.
window.status = range.getAddressA1();
}
</script>