Salesforce

RqHTTPHeader (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

RqHTTPHeader (Magic xpa 4.x)

Sets the required HTTP Header information for the returned HTTP result of a batch program.

Syntax:

RqHTTPHeader(header string[,header string])

Parameters:

header string – a string representing a required HTTP Header data. For example, 'Content-type: application/pdf' to indicate that the requester output data is in PDF format. A header string must follow the [Type]:[Value]

Returns:

Logical – The function returns a True value if the header information is defined in the [Type]:[Value] format.

Example:

To post a PDF file by using the File2Req function, you must define the HTTP Header as RqHTTPHeader('Content-type: application/pdf') within the execution of the request.

Exceptions:

This function is not supported for Rich Client tasks.

This function is supported only while using the Broker as a middleware.

Note:

The HTTP header is set for the request just as the request is completed and the output is sent back to the requester. This means that the RqHTTPHeader function can be evaluated at any point of the request tasks flow.

The last RqHTTPHeader to be evaluated will take effect. The next request will not be affected by any evaluation of this function in previous requests.

See also:

The Online and Rich Client Samples projects (program ES17 and RES17)

Note that the samples programs are batch programs sending an HTTP request (not a RIA request).

Reference
Attachment 
Attachment