PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
HTTPProgressBar (Function)
In French: HTTPJauge
Displays a progress bar when:
  • receiving the response to an HTTP request.
  • Versions 20 and later
    sending an HTTP form (HTTPSendForm) or an HTTP query.
    New in version 20
    sending an HTTP form (HTTPSendForm) or an HTTP query.
    sending an HTTP form (HTTPSendForm) or an HTTP query.
Use conditions: The progress of the response progress bar will be possible only if the Web server that processes the HTTP request indicates the length of data to return in its response.
This can be checked by seeing the HTTP header of the response with HTTPGetResult associated with the httpHeader constant.
If the HTTP header contains "Content-Length:" with the length of the response, HTTPProgressBar will be used to follow the progress.
Versions 17 and later
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
New in version 17
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
WINDEVJava This function is now available for the Java applications.
Android This function is now available for the Android applications.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Versions 19 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 19
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
// Display the receive progress bar in PROGBAR_ProgBar
HTTPProgressBar(PROGBAR_ProgBar)
...
// Cancel this progress bar
HTTPProgressBar("")
// The receive progress bar is managed by the ManageProgress procedure
HTTPProgressBar("ReceiveProgress")
PROCEDURE ReceiveProgress(TotalByte, TotalTransmitted)
Message("Transfer in progress: " + TotalTransmitted + " / " + TotalByte)
PROGBAR_ProgBar = TotalTransmitted/TotalByte
// The receive progress bar is managed by the HTTPProgress event
HTTPProgressBar("HTTPProgress")
// -- Initialization code of window
Event(ManageBar, "*.*", "HTTPProgress")
PROCEDURE ManageBar(TotalByte, TotalTransmitted)
Trace("Transfer in progress: " + TotalTransmitted + " / " + TotalByte)
Syntax

Displaying the progress bar in a Progress Bar control Hide the details

HTTPProgressBar(<Receive Progress Bar> [, <Frequency of Receive Progress Bar> [, <Send Progress Bar> [, <Frequency of Send Progress Bar>]]])
<Receive Progress Bar>: Character string (with or without quotes)
Name of the Progress Bar control where the receive progress bar will be displayed. This control must exist in the current window.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
<Frequency of Receive Progress Bar>: Optional integer
Frequency for refreshing the receive progress bar (in bytes). The default frequency is set to 10.000 (the progress bar is refreshed every 10 KB). Caution: this frequency is given for information only.
<Send Progress Bar>: Optional character string (with or without quotes)
Versions 20 and later
Name of the Progress Bar control where the progress bar for sending data will be displayed. This control must exist in the current window.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Name of the Progress Bar control where the progress bar for sending data will be displayed. This control must exist in the current window.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
Name of the Progress Bar control where the progress bar for sending data will be displayed. This control must exist in the current window.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
<Frequency of Send Progress Bar>: Optional integer
Versions 20 and later
Frequency for refreshing the progress bar used to send data (in bytes). The default frequency is set to 10.000 (the progress bar is refreshed every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Frequency for refreshing the progress bar used to send data (in bytes). The default frequency is set to 10.000 (the progress bar is refreshed every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
Frequency for refreshing the progress bar used to send data (in bytes). The default frequency is set to 10.000 (the progress bar is refreshed every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.

Managing the progress bar via a procedure Hide the details

HTTPProgressBar(<Name of Receive Procedure> [, <Frequency of Receive Progress Bar> [, <Name of Send Procedure> [, <Frequency of Send Progress Bar>]]])
<Name of Receive Procedure>: Character string (with quotes)
Name of the WLanguage procedure that will manage the progress bar for receiving data.
This procedure has the following format:
PROCEDURE <Procedure Name> (<Total>, <Progress>)
where:
  • <Total> is the number of bytes to receive.
  • <Progress> is the number of bytes already received.
    Note: If the server does not return the total expected size, <Total> will be equal to <Progress>.
These parameters can be used in the procedure at any time.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
<Frequency of Receive Progress Bar>: Optional integer
Frequency for refreshing the receive progress bar (in bytes). The default frequency is set to 10,000 (the procedure is called every 10 KB). Caution: this frequency is given for information only.
<Name of Send Procedure>: Optional character string (with quotes)
Versions 20 and later
Name of the WLanguage procedure that will manage the progress bar for sending data.
This procedure has the following format:
PROCEDURE <Procedure Name> (<Total>, <Progress>)
where:
  • <Total> is the number of bytes to send.
  • <Progress> is the number of bytes already sent.
    Note: If the server does not return the total expected size, <Total> will be equal to <Progress>.
These parameters can be used in the procedure at any time.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Name of the WLanguage procedure that will manage the progress bar for sending data.
This procedure has the following format:
PROCEDURE <Procedure Name> (<Total>, <Progress>)
where:
  • <Total> is the number of bytes to send.
  • <Progress> is the number of bytes already sent.
    Note: If the server does not return the total expected size, <Total> will be equal to <Progress>.
These parameters can be used in the procedure at any time.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
Name of the WLanguage procedure that will manage the progress bar for sending data.
This procedure has the following format:
PROCEDURE <Procedure Name> (<Total>, <Progress>)
where:
  • <Total> is the number of bytes to send.
  • <Progress> is the number of bytes already sent.
    Note: If the server does not return the total expected size, <Total> will be equal to <Progress>.
These parameters can be used in the procedure at any time.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
<Frequency of Send Progress Bar>: Optional integer
Versions 20 and later
Frequency for refreshing the send progress bar (in bytes). The default frequency is set to 10,000 (the procedure is called every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Frequency for refreshing the send progress bar (in bytes). The default frequency is set to 10,000 (the procedure is called every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
Frequency for refreshing the send progress bar (in bytes). The default frequency is set to 10,000 (the procedure is called every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.

Managing the progress bar via an event Hide the details

HTTPProgressBar(<Name of Event for Receiving> [, <Frequency of Receive Progress Bar> [, <Name of Event for Sending> [, <Frequency of Send Progress Bar>]]])
<Name of Event for Receiving>: Character string (with quotes)
Name of the event that will be run during the progress of the receive progress bar. This event must be processed by Event. In this case, the wParam parameter (1st parameter of the event) will correspond to the quantity of bytes to transmit and the lParam parameter (second parameter of the event) will correspond to the quantity of bytes already transmitted.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
<Frequency of Receive Progress Bar>: Optional integer
Frequency for refreshing the receive progress bar (in bytes). The default frequency is set to 10,000 (the event is triggered every 10 KB). Caution: this frequency is given for information only.
<Name of Event for Sending>: Optional character string (with quotes)
Versions 20 and later
Name of the event that will be run during the progress of the send progress bar. This event must be processed by Event. In this case, the wParam parameter (1st parameter of the event) will correspond to the quantity of bytes to transmit and the lParam parameter (second parameter of the event) will correspond to the quantity of bytes already transmitted.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Name of the event that will be run during the progress of the send progress bar. This event must be processed by Event. In this case, the wParam parameter (1st parameter of the event) will correspond to the quantity of bytes to transmit and the lParam parameter (second parameter of the event) will correspond to the quantity of bytes already transmitted.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
Name of the event that will be run during the progress of the send progress bar. This event must be processed by Event. In this case, the wParam parameter (1st parameter of the event) will correspond to the quantity of bytes to transmit and the lParam parameter (second parameter of the event) will correspond to the quantity of bytes already transmitted.
If this parameter corresponds to an empty string (""), the current progress bar is canceled.
AndroidAndroid Widget Java This parameter is not available.
<Frequency of Send Progress Bar>: Optional integer
Versions 20 and later
Frequency for refreshing the progress bar (in bytes). The default frequency is set to 10,000 (the event is triggered every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
New in version 20
Frequency for refreshing the progress bar (in bytes). The default frequency is set to 10,000 (the event is triggered every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
Frequency for refreshing the progress bar (in bytes). The default frequency is set to 10,000 (the event is triggered every 10 KB). Caution: this frequency is given for information only.
AndroidAndroid Widget Java This parameter is not available.
Components
WINDEVReports and Queries wd230com.dll
Java wd230java.jar
Linux wd230com.so
Android wd230android.jar
See also
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment