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]
進行状況ダイアログ ボックスに表示されるorganization名へのポインター。 値は、 _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の呼び出しでは、uActionExecStep パラメーターと uActionExecMaxStep パラメーターを使用して、アクションの完了率を指定する必要があります。 たとえば、 uActionExecStep が値 2 を指定し、値 10 を指定 uActionExecMaxStep 場合、アクションの完了率は 20% です。