TURL_Put (function reference)

By June 1, 2017 September 26th, 2017 Online Help, Troi URL plug-in
Troi URL Plug-in > Functions reference > TURL_Put
Troi URL Plug-in for FileMaker Pro

TURL_Put

Sends data to the server or transfers a file to the server, using the PUT method.

SyntaxFunction badge

TURL_Put( switches ; theURL ; theData )

Parameters

switchesthis determines the behaviour of the plug-in
theURLthe url of the server
theDatathe data to be sent with the PUT method. This can also be a file or image in a container field

Switches

Switches can be one or more of these:

-NoDialogdon’t display a progress dialog
-TimeoutTicks=xspecify the connect timeout time in x ticks (1/60th of a second)
-ReturnHeaderinclude the header in the returned text (at the beginning)
-ReturnDataAfterErrorreturn the error code followed by the data
-Portnumber=yspecify the port number to use
-DontAutoRedirectthe 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
-AlwaysSendUserPasswordwill directly send the username + password, even when this might not be necessary
-DontTryWithUserPassworddon’t send username + password when the web server requests authorization

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:

$$-1user cancelled
$$-4230the connection timed out
$$-3242this protocol is not supported (use only http and https)
$$-30776authentication error, you need to supply a correct user name and password
$$-92servername part of the url is too long
$$-2110path 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 12 to 16

Considerations

Not every web server supports the PUT method.
Note that theData is UTF8 Encoded by default.
Secure connections (HTTPS) using SSL are also supported.
If you don’t specify a timeout, a default timeout of 15 seconds is used.

On Mac OS a progress dialog is displayed. On this platform you can also cancel a long operation with an ESC or a Command-Period.

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.

Example

TURL_Put ( "-Unused" ; "http://www.example.com/data/user123/mydata.txt" ; "color=blue" )

This will send the data “color=blue” to be put at the location /data/user123/mydata.txt on the web server.

Example 2

We assume that in your FileMaker file the following fields are defined:

MyContainer         		Container
ImageName         		Text

The field MyContainer can contain a file or an image. ImageName should contain the name of the image, for example “img123.jpg”.

Add the following script steps:

Set Variable [ $thebaseURL ; "http://www.photos.com/images/" ]
Set Field [ resultText ; TURL_Put ( "-noDialog" ; $thebaseURL & ImageName ; MyContainer ) ]

This will transfer the imagefile in the container to the web server, to be put in the specified location on the web server: “http://www.photos.com/images/img123.jpg”. Note that web servers might not support the PUT method or refuse this PUT request.

Related functionsFunction badge

TURL_Delete
TURL_Get
TURL_Post
TURL_SetCookies
TURL_SetProxy

Online Help Page for Troi URL Plug-in for 12 to 16 –> TURL_Put (urlp4418) 2017-0623 12:33:02