CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- CONTROL graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
    - hasEvent()
      This function checks if an object defines an event.
    - hasMethod()
      The function returns TRUE when the specified method exists.
    - HOOK_aes_acknowledgeTableFunction()
      The system executes the function when you acknowledge an alert in the alert screen. Implement the function in a CONTROL library.
    - HOOK_ep_acknowledgeTableFunction()
      The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.
    - HOOK_isAckable()
      The system executes the function when you acknowledge alarms. Implement the function in a CONTROL library.
    - hotKeyDialog()
      The function opens a window that allows you to select a hotkey for a shape.
    - hour()
      Returns the hour portion (0 to 23) of a time t.
    - html_ref()
      This function loads a reference into an HTML reference. The parameters will be replaced.
    - httpAccessLog()
      Creates an httpAccess.log file in the log directory and writes a log line for each HTTP request into the file.
    - httpCloseWebSocket()
      The function closes web sockets.
    - httpConnect()
      Registers a CTRL function as a Web resource
    - httpDisconnect()
      Remove a registered Web-Resource
    - httpGetAllHeaders()
      The function returns a mapping of all HTTP headers.
    - httpGetContent()
      This function extracts the content of the currently processing HTTP-Request.
    - httpGetHeader()
      Returns the value of the header (== key) of the last HTTP message.
    - httpGetLanguage()
      The function checks the stated client connection and returns a matching language ID. The function httpGetLanguageId() can be used to keep the same functionality but have a OaLanguage enum value returned.
    - httpGetLanguageId()
      The function checks the stated client connection and returns a matching OaLanguage enum value. This function provides the same functionality as httpGetLanguage(), but uses the new OaLanguage enum as return value.
    - httpGetMethod()
      The function returns the HTTP method of the last HTTP message.
    - httpGetPort()
      Returns the port and connection used for the HTTP request.
    - httpGetQuery()
      Returns the HTTP query elements as key/value pairs
    - httpGetURI()
      Returns the last from the Client (index) requested URI from the HTTP server.
    - httpMakeParamString()
      Returns a string from the passed arguments that represents the query part of a URL.
    - httpOnConnectionClose()
      The function starts the specified callBack function when the HTTP connection is closed.
    - httpParseDate()
      Allows parsing an RFC-2616 conform date string, e.g. from header "If-Modified-Since".
    - httpReadWebSocket()
      The function reads web sockets.
    - httpSaveFilesFromUpload()
      The function returns the HTTP content of a Blob variable that was received from an HTTP client via an HTML form. The function copies the content of this blob variable (a file) into a directory.
    - httpServer()
      Installs and activates an HTTP server.
    - httpSetMaxAge()
      Defines the time in seconds how long files should be cached by the client.
    - httpSetMaxContentLength()
      Sets the maximum length of a POST request.
    - httpSetMethodHandler()
      The function can be used to redirect an HTTP method to a user-defined CTRL callback function.
    - httpSetPermission()
      The function httpSetPemission() allows to define more fine grained user permissions for a specific URL used with the HTTP Server.
    - httpSetSecondaryAuthSuccess()
      The function is used to check for secondary authentification and implement a login delay.
    - httpSetUlcUserName()
      Sets the userName that will be used for the ULC_UX/ulc_ux_basics.html.
    - httpWriteWebSocket()
      The function writes web sockets.
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.

httpGetHeader()

Returns the value of the header (== key) of the last HTTP message.

Synopsis

string httpGetHeader(int idx, string key);

Parameter


Parameter	Description
idx	Idx ist the client index that was specified as last argument (after dyn_string headerValues) in the callback function - see example below.
key	The name of the header - see example below.

Return value

The value of the header (== key) of the last HTTP request.

Description

Returns the value of a specific header (the header that the key parameter includes) of the last HTTP message.

Example

The following example starts an HTTP server at the port 12000 without authentication, creates a form with text and executes the function httpGetHeader to return the value of the HTTP header.

#uses "CtrlHTTP"
int MAXLENGTH = 100 * 1024 * 1024;   //100 MB
main()
{
  //starts the HTTP Server at Port 12000 without authentication
  httpServer(FALSE,12000);
  httpSetMaxContentLength(MAXLENGTH);

  /* Use http://localhost:12000/callBack1 URL in order to show the data */
  /* httpConnect registers the function "callBack1" as a Web resource under the name "callBack1" */

  httpConnect("callBack1","/callBack1");
}
  //See rfc1867 for detailed information on form-based file uploads in HTML
 string callBack1(blob content, string user, string ip, dyn_string headernames, dyn_string headervalues, int connIdx)
{
  string formDoc = "<html><head><title>Test</title></head>" +
                 "<body>" +
                 "<p>Example page</p>" +
                 "</body></html>";
  string host = httpGetHeader(connIdx, "Host"); //Returns the value of the header
  DebugN("Host:",host);
  return formDoc;  //Returns the form
}

Assignment

CTRL PlugIn

Availability

CTRL