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