[IDL]
HRESULT ShowActionProgress(
	 BSTR pszOrgName,
	 BSTR pszTaskSequenceName,
	 BSTR pszCustomTitle,
	 BSTR pszCurrentAction,
	 ULONG uStep,
	 ULONG uMaxStep,
	 BSTR pszActionExecInfo,
	 ULONG uActionExecStep,
	 ULONG uActionExecMaxStep
);

Parameters

pszOrgName

Data type: BSTRQualifiers: [in]Pointer to the organization name that is shown in the progress dialog box. The value can be retrieved from the _SMSTSOrgName environment variable.

pszTaskSequenceName

Data type: BSTRQualifiers: [in]Pointer to the name of the task sequence that is currently running. The value can be retrieved from the _SMSTSPackageName environment variable.

pszCustomTitle

Data type: BSTRQualifiers: [in]Pointer to the text for a custom message that replaces the default title text displayed in the progress dialog box. Pass an empty string if there is no custom message to show. The value can be obtained from the _SMSTSCustomProgressDialogMessage environment variable.

pszCurrentAction

Data type: BSTRQualifiers: [in]Pointer to the name of the current task sequence step. The value can be obtained from the _SMSTSCurrentActionName environment variable.

uStep

Data type: ULONGQualifiers: [in]The current task sequence step number. The value can be obtained from the SMSTSNextInstructionPointer environment variable.

uMaxStep

Data type: ULONGQualifiers: [in]The total number of steps in the task sequence. The value can be obtained from the _SMSTSInstructionTableSize environment variable.

pszActionExecInfo

Data type: BSTRQualifiers: [in]Pointer to user-defined, action-specific progress information to be shown in the progress dialog box.

uActionExecStep

Data type: ULONGQualifiers: [in]The numerical step, within the total number of numerical steps, on which the action is currently working. Use this parameter to determine the percentage of the action that has been completed so far. For more information, see Remarks.

uActionExecMaxStep

Data type: ULONGQualifiers: [in]The total number of numerical steps that the action performs. Use this parameter to determine the percentage of the action that has been completed so far. For more information, see Remarks.

An HRESULT code. Possible values include, but are not limited to, the following value. There are no HRESULT values returned that are specific to this method.

S_OK

The method succeeded.

The only required information for this method is for the pszActionExecInfo, uActionExecStep, and uActionExecMaxStep parameters. The other parameters can be obtained from the referenced environment variables.

A call to ShowActionProgress should specify the percentage completion of the action using the uActionExecStep and uActionExecMaxStep parameters. For example, if uActionExecStep specifies the value 2 and uActionExecMaxStep specifies the value 10, the percentage completion of the action is 20 percent.

Tasks

Concepts

Other Resources