 |
TURL_Delete |
Sends request to delete an item at a specified place on the web server, using the DELETE method.
Syntax
TURL_Delete ( switches ; theURL )
Parameters
| switches | this determines the behaviour of the plug-in |
| theURL | the url of the resource to delete (on the server) |
Switches
Switches can be one or more of these:
| -TimeoutTicks=x | specify the connect timeout time in x ticks (1/60th of a second) |
| -ReturnHeader | include the header in the returned text (at the beginning) |
| -Portnumber=y | specify the port number to use |
| -DontAutoRedirect | the plug-in will not go to a redirected page but return the original page |
| -AllowAnyRootCertificate | (for HTTPS) allow root certificates from unrecognized certification authorities. Note that this is less secure! |
| -AlwaysSendUserPassword | will directly send the username + password, even when this might not be necessary |
| -DontTryWithUserPassword | don’t send username + password when the web server requests authorization |
| -NoDialog | (obsolete) don’t display a progress dialog |
Returned Result
Data type returned
Text
Result
If successful it returns the data of the URL. If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:
| $$-1 | genericErr | the user cancelled |
| $$-4230 | timeoutErr | the connection timed out |
| $$-3242 | protocolErr | this protocol is not supported (use only http and https) |
| $$-30776 | authnErr | authentication error, you need to supply a correct user name and password |
| $$-92 | ddpLenErr | servername part of the url is too long |
| $$-2110 | pathTooLongErr | path part of the url is too long |
Other errors may be returned, specifically errors in the range 300 to 599, which are HTTP Status Codes.
Originated in
Troi URL Plug-in 3.0
Compatibility
FileMaker Pro 16 to 19
Considerations
Not every web server supports the DELETE method.
Secure connections (HTTPS) using SSL are also supported.
If you don’t specify a timeout, a default timeout of 15 seconds is used.
The length of the URL is limited, by both the plug-in and receiving web servers. A lot of web servers don’t support URLs longer than 2048 characters. Note that the plug-in has higher limits of 32867 characters for the URL.
Note that starting with v6.0 the plug-in no longer shows a progress dialog on nacOS.
Example
TURL_Delete ( "-Unused" ; "http://www.example.com/data/user123/mydata.txt" )This will send the request to the web server to delete the file at the location /data/user123/mydata.txt.
Example 2
We assume that in your FileMaker file the following field is defined:
ImageName TextThe field ImageName should contain the name of the image, for example “img123.jpg”.
In a script add the following script steps:
Set Variable [ $thebaseURL ; "http://www.photos.com/images/" ]
Set Field[ resultText ; TURL_Delete ( "-noDialog" ; $thebaseURL & ImageName ) ]This will ask the web server to delete the image at the specified location on the web server: “http://www.photos.com/images/img123.jpg”. Note that web servers might not support the DELETE method or refuse this DELETE request.
Related functions
| TURL_Get |
| TURL_Post |
| TURL_Put |
| TURL_SetProxy |
Related script step
| Delete URL |
Related topics
Troi URL Plug-in online help (overview)