Configuration Managerでは、ShowErrorDialog メソッドはダイアログ ボックスにカスタマイズ可能なエラー情報を表示します。
構文
[IDL]
HRESULT ShowErrorDialog(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszErrorMessage,
ULONG uErrorCode,
ULONG uTimeoutInSeconds,
ULONG uWillReboot,
BSTR pszTaskSequenceStepName
);
パラメーター
pszOrgName
データ型: BSTR
修飾子: [in]
進行状況ダイアログ ボックスに表示されるorganization名へのポインター。 値は、 _SMSTSOrgName 環境変数から取得できます。
pszTaskSequenceName
データ型: BSTR
修飾子: [in]
現在実行中のタスク シーケンスの名前へのポインター。 値は、 _SMSTSPackageName 環境変数から取得できます。
pszCustomTitle
データ型: BSTR
修飾子: [in]
エラー ダイアログ ボックスに表示される既定のタイトル テキストを置き換えるカスタム メッセージのテキストへのポインター。 表示するカスタム メッセージがない場合は、空の文字列を渡します。 値は、 _SMSTSCustomProgressDialogMessage 環境変数から取得できます。
pszErrorMessage
データ型: BSTR
修飾子: [in]
エラー ダイアログ ボックスに表示されるカスタム メッセージのテキストへのポインター。 表示するカスタム メッセージがない場合は、空の文字列を渡します。 既定のテキストには、 pszTaskSequenceName、 pszTaskSequenceStepName、 uErrorCodeのテキストが含まれます。 指定された値に応じて変更されます。
uErrorCode
データ型: ULONG
修飾子: [in]
失敗した最後のステップの戻りコードへのポインター。 値は、 _SMSTSLastActionRetCode 環境変数から取得できます。
pszErrorMessageのカスタム テキストが指定されていない場合、uErrorCodeは Microsoft のシステム エラー コード形式で表示されます。
uTimeoutInSeconds
データ型: ULONG
修飾子: [in]
ダイアログ ボックスが閉じる前に表示される秒数の値へのポインター。 この値は、既定ではタスク シーケンスで構成されていない SMSTSErrorDialogTimeout 環境変数から取得できます。
uTimeoutInSecondsに空の文字列を指定し、SMSTSErrorDialogTimeoutが指定されていない場合は、既定値の 900 秒が使用されます。
bWillReboot
データ型: ULONG
修飾子: [in]
ブール型 (Boolean) の値 ダイアログが閉じられたときにタスク シーケンスがコンピューターを再起動するか、タイムアウトの有効期限が切れるかを示します。
pszTaskSequenceStepName
データ型: BSTR
修飾子: [in]
既定の pszErrorMessage テキストに表示されるステップ名の名前のテキストへのポインター。 値は、 _SMSTSLastActionName 環境変数から取得できます。
戻り値
HRESULT コード。 指定できる値には、次の値が含まれますが、これらに限定されません。 このメソッドに固有の HRESULT 値は返されません。
S_OK メソッドが成功しました。