IBufferProgress.OnStageBegin Method

Called at the beginning of the next buffering stage within an operation.

[Visual Basic .NET]
Public Function OnStageBegin ( _
    ByVal currentStage As Integer, _
    ByVal currentNumStages As Integer _
) As Boolean

[C#]
public bool OnStageBegin (
    int currentStage,
    int currentNumStages
);

[C++]
HRESULT OnStageBegin(
  long currentStage,
  long currentNumStages,
  VARIANT_BOOL* pbContinue
);

[C++]

Parameters
currentStage 
  currentStage is a parameter of type long
currentNumStages 
  currentNumStages is a parameter of type long
pbContinue [out, retval]
  pbContinue is a parameter of type VARIANT_BOOL

Product Availability

Remarks

This method is called by the BufferConstruction object at the beginning of each buffering stage. Refer to IBufferProgress for an overview of progress reporting and definitions of the terms 'operation', 'stage' and 'step'. You can return true to indicate that buffering should continue or false to terminate the call to ConstructBuffers, ConstructBuffersByDistances, or ConstructBuffersByDistances2.

See Also