IProgressUI::ShowActionProgress メソッド
Configuration Managerでは、カスタム アクションのShowActionProgress
実行中に、カスタム アクションの進行状況情報がダイアログ ボックスに表示されます。
構文
[IDL]
HRESULT ShowActionProgress(
BSTR pszOrgName,
BSTR pszTaskSequenceName,
BSTR pszCustomTitle,
BSTR pszCurrentAction,
ULONG uStep,
ULONG uMaxStep,
BSTR pszActionExecInfo,
ULONG uActionExecStep,
ULONG uActionExecMaxStep
);
パラメーター
pszOrgName
データ型: BSTR
修飾子: [in]
[進行状況] ダイアログ ボックスに表示される組織名へのポインター。 値は環境変数から _SMSTSOrgName
取得できます。
pszTaskSequenceName
データ型: BSTR
修飾子: [in]
現在実行中のタスク シーケンスの名前へのポインター。 値は環境変数から _SMSTSPackageName
取得できます。
pszCustomTitle
データ型: BSTR
修飾子: [in]
進行状況ダイアログ ボックスに表示される既定のタイトル テキストを置き換えるカスタム メッセージのテキストへのポインター。 表示するカスタム メッセージがない場合は、空の文字列を渡します。 値は環境変数から _SMSTSCustomProgressDialogMessage
取得できます。
pszCurrentAction
データ型: BSTR
修飾子: [in]
現在のタスク シーケンス ステップの名前へのポインター。 値は環境変数から _SMSTSCurrentActionName
取得できます。
uStep
データ型: ULONG
修飾子: [in]
現在のタスク シーケンス ステップ番号。 値は環境変数から SMSTSNextInstructionPointer
取得できます。
uMaxStep
データ型: ULONG
修飾子: [in]
タスク シーケンス内のステップの合計数。 値は環境変数から _SMSTSInstructionTableSize
取得できます。
pszActionExecInfo
データ型: BSTR
修飾子: [in]
[進行状況] ダイアログ ボックスに表示されるユーザー定義のアクション固有の進行状況情報へのポインター。
uActionExecStep
データ型: ULONG
修飾子: [in]
アクションが現在動作している数値ステップの合計数内の数値ステップ。
このパラメーターを使用して、これまでに完了したアクションの割合を決定します。 詳細については、「解説」を参照してください。
uActionExecMaxStep
データ型: ULONG
修飾子: [in]
アクションが実行する数値ステップの合計数。
このパラメーターを使用して、これまでに完了したアクションの割合を決定します。 詳細については、「解説」を参照してください。
戻り値
HRESULT
コード。 指定できる値には、次の値が含まれますが、これらに限定されません。 このメソッドに固有の値は返されません HRESULT
。
S_OK
メソッドは成功しました。
注釈
このメソッドに必要な情報は、 pszActionExecInfo
、 uActionExecStep
、および uActionExecMaxStep
パラメーターのみです。 他のパラメーターは、参照先の環境変数から取得できます。
のShowActionProgress
呼び出しでは、 パラメーターと uActionExecMaxStep
パラメーターを使用して、アクションの完了率を指定するuActionExecStep
必要があります。 たとえば、値 2 を指定し、uActionExecMaxStep
値 10 を指定した場合uActionExecStep
、アクションの完了率は 20% です。