/DEFORM Parameters and Qualifiers!

DEFORM Scripting Utility

Z [next] [previous][contents]
-

6 - DEFORM Parameters and Qualifiers




DEFORM [qualifiers]



I A symbol for a foreign command should be first assigned, then the image activated."

  $ DEFORM = "$HT_EXE:DEFORM"  $ DEFORM [qualifiers]


6.1 - Parameters




 None. 

6.2 - Qualifiers

"/AUTHENTICATE= realm
IThe utility checks for the presence of an authenticated remote user name ;(DCL symbol WWW_REMOTE_USER. If not detected the Lutility send an authentication failure header to the browser, causing it to Gprovide authentication dialog, then exits with an error status. If an Jauthenticated user name exists any other functionality is performed. The Jvalue supplied specifies the authentication realm. Currently only HFRD is defined. 

/FILE
BFor the HTTP POST method the request body is parsed into Hplain text contained within a temporary file specified by the DCL symbolDEFORM_FILE.

/GET
=If the HTTP method is not GET then just exit with a Jsuccess status. That is, only perform any specified functionality if the %method is the same as the qualifier. 

/HTML
OThe utility outputs an HTTP response header specifying to the browser that the Mfollowing document will be HyperText Markup Language. The document supplied :should not include embedded HTTP carriage-control (i.e. no%carriage-return/line-feed sequences).

/LOCATION= URL
LThe utility will output a redirection response resulting in the document of Kthe specified URL begin returned to the browser. The URL must be either a )full URL (scheme//host/path, e.g. B``http://host.domain/dir1/dir2/doc.type''), or the full path of a Fdocument accessable by the same server (e.g. ``/dir1/dir2/doc.type'').#Relative paths cannot be processed.

&/TYPE= MIME-Content-Type
OThe utility outputs an HTTP response header specifying to the browser that the Ifollowing document will be of the specified type. The document supplied :should not include embedded HTTP carriage-control (i.e. no%carriage-return/line-feed sequences).

/POST
>If the HTTP method is not POST then just exit with a Jsuccess status. That is, only perform any specified functionality if the %method is the same as the qualifier. 

/SCRATCH
JAssigns two DCL symbols indicating the location of a directory for scratch=files (DEFORM_SCRATCH) and a time string that can be@used to create unique file names, etc. (DEFORM_UNIQUE).

)/STATUS= HTTP-Status-String
IThe utility outputs an HTTP header to the browser including the supplied Nstring as the reponse status. It must be a legitimate three digit code, with Hor without a trailing explanation string. When specifying a header any Bsubsequent output to the browser should include full embedded HTTP=carriage-control (i.e. carriage-return/line-feed sequences). 

/TEXT
OThe utility outputs an HTTP response header specifying to the browser that the Ifollowing document will be plain text. The document supplied should not Jinclude embedded HTTP carriage-control (i.e. no carriage-return/line-feed sequences). 

/SYMBOLS
BFor the HTTP POST method the request body is parsed into a series of global symbols.




Z [next] [previous][contents]