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