GetProgress method

Overview

Gives information about the progress of the DoReload and DoSave calls.

For more information on DoReload and DoSave, see the DoReload method and DoSave method.

Parameters

Name	Description	Type
qRequestId	Identifier of the DoReload or DoSave request or 0. Complete information is returned if the identifier of the request is given. If the identifier is 0, less information is given. Progress messages and error messages are returned but information like when the request started and finished is not returned.	Integer

Name

Description

Type

qRequestId

Identifier of the DoReload or DoSave request or 0.

Complete information is returned if the identifier of the request is given.

If the identifier is 0, less information is given. Progress messages and error messages are returned but information like when the request started and finished is not returned.

Integer

Outputs

The following is returned in the output:

Name	Description	Type
qProgressData	Information about the progress of the request.	ProgressData

Name	Description	Type
qStarted	This property is st to true if the request is started.	Boolean
qFinished	This property is st to true if the request is finished.	Boolean
qCompleted	This property is not used.	Integer
qTotal	This property is not used.	Integer
qKB	This property is not used.	Integer
qMillisecs	Request duration in milliseconds.	Integer
qUserInteractionWanted	This property is set to true when the engine pauses the script execution and waits for a user interaction.	Boolean
qPersistentProgress	A progress message is persistent when it informs about the start or end of a statement. For example, it can inform about the total number of lines fetched from a data source, tells that the app was saved. All persistent progress messages between two GetProgress calls are summarized in this string. Contrarily to qPersistentProgressMessages, the content of the localized message string is displayed (not its message code).	String
qTransientProgress	A progress message is transient when it informs about the progress of an ongoing statement. For example, it can tell how many lines are currently fetched from a data source. All transient progress messages between two GetProgress calls are summarized in this string. Contrarily to qTransientProgressMessage, the content of the localized message string is displayed (not its message code).	String
qErrorData	Information about the error messages that occur during the script execution.	Array of ErrorData
qPersistentProgressMessages	List of persistent progress messages.	Array of ProgressMessage
qTransientProgressMessage	Transient progress message.	ProgressMessage

Name	Description	Type
qErrorString	Detailed information about the error message.	String
qLineEnd	Line termination characters.	String
qLine	Script statement where the error occurs.	String
qErrorDataCode	Type of the error messages.	One of: 0 for EDC_ERROR 1 for EDC_WARNING 2 for EDC_CIRCULAR_REFERENCE (Warning related to circular references)

Name	Description	Type
qMessageCode	Code number to the corresponding localized message string.	Integer
qMessageParameters	Parameters to be inserted in the localized message string.	Array of String

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here