AddLongstring (HttpRequest subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 2: Line 2:


This subroutine adds the contents of a <var>[[Longstrings|Longstring]]</var>
This subroutine adds the contents of a <var>[[Longstrings|Longstring]]</var>
to the HTTP Post data that is subsequently sent on a [[Post (HTTPRequest function)|Post]]
to the HTTP Post data that is subsequently sent on a [[Post (HttpRequest function)|Post]]
method invocation.
method invocation.


Line 8: Line 8:
being built.
being built.
Invoking this method erases any post data previously
Invoking this method erases any post data previously
added by <var>[[AddXML (HTTPRequest subroutine)|AddXML]]</var>
added by <var>[[AddXML (HttpRequest subroutine)|AddXML]]</var>
or <var>AddLongString</var> method calls.
or <var>AddLongString</var> method calls.
By default, the data is converted from
By default, the data is converted from
Line 17: Line 17:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%httpreq</th>
<tr><th>%httpreq</th>
<td>A previously defined and instantiated <var>HTTPRequest</var> object.
<td>A previously defined and instantiated <var>HttpRequest</var> object.
</td></tr>
</td></tr>
<tr><th>%ls</th>
<tr><th>%ls</th>
Line 28: Line 28:
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>Unlike the <var>[[AddField (HTTPRequest subroutine)|AddField]]</var> method
<li>Unlike the <var>[[AddField (HttpRequest subroutine)|AddField]]</var> method
for example, <var>AddLongString</var> has no effect on the request content type.
for example, <var>AddLongString</var> has no effect on the request content type.
</ul>
</ul>
==See also==
==See also==
{{Template:HttpRequest:AddLongString footer}}
{{Template:HttpRequest:AddLongString footer}}

Revision as of 20:17, 16 June 2011

Add a longstring to POST data for this request (HttpRequest class)


This subroutine adds the contents of a Longstring to the HTTP Post data that is subsequently sent on a Post method invocation.

The contents of the passed Longstring become the post data of the request being built. Invoking this method erases any post data previously added by AddXML or AddLongString method calls. By default, the data is converted from EBCDIC to ASCII; however, this can be turned off.

Syntax

httpRequest:AddLongString( string, [xlatFlag])

Syntax terms

%httpreq A previously defined and instantiated HttpRequest object.
%ls A longstring variable.
binflag A numeric expression that, if nonzero, indicates binary data. Setting this option overrides the default behaviour of translating EBCDIC to ASCII.

Usage notes

  • Unlike the AddField method for example, AddLongString has no effect on the request content type.

See also