Skip to main content

TURL_SetProgressText (function reference)

By October 1, 2021October 13th, 2021Online Help, Troi URL plug-in
Troi URL Plug-in > Functions reference > TURL_SetProgressText
Troi URL Plug-in for FileMaker Pro

TURL_SetProgressText

Sets a custom text to be used for the progress dialog.

SyntaxFunction badge

TURL_SetProgressText( switches ; messageText ; buttonText )

Parameters

switches not used, reserved for future use. Leave blank or put "-unused"
messageText the text of the progress dialog
buttonText (optional) the text of the stop button

Returned Result

Data type returned

Error code

Result

If successful this function returns 0. If unsuccessful it returns an error code starting with $$ followed by the error code.

At the moment this function does not return errors.

Originated in

Troi URL Plug-in 1.2

Compatibility

FileMaker Pro 16 to 19

Considerations

Starting with v6.0 he plug-in no longer shows a progress bar. This function is still included for backward compatibility.
For earlier versions the plug-in shows a Progress Dialog only on macOS.
The text is remembered until you specify a different text. The text is also removed when you quit FileMaker Pro.

The maximum length of the message text is 255 characters. The maximum length of the button text is 20 characters.

Example

TURL_SetProgressText ( "-unused" ; "Getting your data..." ; "Stop" )

Example 2

This will get a web page with a custom text. We assume that in your FileMaker file the following fields are defined:

urlField       	  	text
gErrorCode        	Global, text

urlField should contain the URL you are getting, for example “www.troi.com” . Add the following script steps:

Set Field [ gErrorCode ; TURL_SetProgressText ( "-unused" ; "Getting data from: " 
		& urlField ; "Halt" ) ]
Set Field [ resultText ; TURL_Get ( "-unused " ; urlField ) ]

Related topics

Troi URL Plug-in online help (overview)


Online Help Page for Troi URL Plug-in for 16 to 19 –> TURL_SetProgressText (urlp4404) 2021-1013 16:35:50