IGPMAsyncProgress::Status method (gpmgmt.h)

Article
02/22/2024

The server calls this method to notify the client about the status of a Group Policy Management Console (GPMC) operation.

Syntax

HRESULT Status(
  [in] long                    lProgressNumerator,
  [in] long                    lProgressDenominator,
  [in] HRESULT                 hrStatus,
  [in] VARIANT                 *pResult,
  [in] IGPMStatusMsgCollection *ppIGPMStatusMsgCollection
);

Parameters

[in] lProgressNumerator

Numerator of a fraction that represents the percent of the GPMC operation that is complete.

[in] lProgressDenominator

Denominator of a fraction that represents the percent of the GPMC operation that is complete. The value of this parameter is proportional to the number of extensions in the Group Policy object (GPO), whether the GPO is a "live" GPO or a backed-up GPO. This value can be used to display the progress bar to the user.

In the GPMC user interface, the progress bar is divided into lProgressDenominator intervals. When lProgressNumerator==lProgressDenominator the operation is complete.

[in] hrStatus

Status of the operation. If no error occurred, the value of the parameter is S_OK.

[in] pResult

Result of the operation. This parameter is an interface pointer to the object that resulted from the GPMC operation. For example, it may be a pointer to a GPMGPO object or to a GPMBackup object. This object is only returned when the operation is complete.

[in] ppIGPMStatusMsgCollection

A pointer to the IGPMStatusMsgCollection interface that contains detailed status information about the operation. In cases where there are no errors, or if there are no detailed messages, Status passes in a null collection.

Return value

This method has no return values.

Remarks

This method must be implemented by the client.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	gpmgmt.h
DLL	Gpmgmt.dll