APIIo_​SetNextProcessPhaseID

Starts the next process phase in the process window.

    GSErrCode ACAPI_Interface (
        APIIo_SetNextProcessPhaseID,
        const GS::UniString*    subtitle,
        Int32*                  maxval,
        bool*                   showPercent
    );

 

Parameters

subtitle API version 19
[in] Description of the process phase.
maxval
[in] Maximum value of the progress bar.
showPercent API 19 feature
[in] Show phase percentage. (optional)

 

Return Values

NoError
The function has completed with success.
APIERR_BADPARS
maxval is nullptr

For other common API errors see the API Errors document.

 

Remarks

This function is used to reinitialize the process window for the next process phase during a long operation. Set some description about the process phase in the subtitle parameter. The progress bar will be divided up according to the value of the maxval parameter.

 

Example

See APIIo_InitProcessWindowID for example of using process windows.

 

Requirements

Version: API 2.1 or later
Header: APIdefs_Interface.h

 

See Also

APIIo_InitProcessWindowID,
ACAPI_Interface, API Functions