$Lstr Get Userbuffer: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (add link) |
||
| (18 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Get user buffer contents to a longstring</span> | <span class="pageSubtitle">Get user buffer contents to a longstring</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Lstr_Get_Userbuffer</var> function.</p> | ||
This function | This function retrieves into a <var>[[Longstrings|Longstring]]</var> the contents of the current user buffer. Such a user buffer is a Universal Buffer or an [[MQ/204]] user buffer, both of which, as of <var class="product">Model 204</var> V6R1, may transfer [[Large Object fields#BLOB.2C CLOB.2C and MINLOBE attributes|Large Object (LOB) data]]. For versions of <var class="product">Model 204</var> prior to 6.1, this function applies only to the MQ user buffer and requires the MQ/204 feature. | ||
The <var>$Lstr_Get_Userbuffer</var> function accepts no arguments and returns a | The <var>$Lstr_Get_Userbuffer</var> function accepts no arguments and returns a <var>Longstring</var> result. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax" | <p class="syntax">%lstr = $Lstr_Get_Userbuffer | ||
</p> | </p> | ||
<p>% | |||
<p><var class="term">%lstr</var> is the longstring for the user buffer contents.</p> | |||
Any errors during the transfer of the buffer contents result in request cancellation. | Any errors during the transfer of the buffer contents result in request cancellation. | ||
Additional functions specifically for working with Large Object data are: | ==Usage notes== | ||
<ul> | |||
<li>Additional functions specifically for working with Large Object data are: | |||
<ul> | <ul> | ||
<li>[[$Lstr_Add_UserBuffer]]</li> | <li>[[$Lstr_Add_UserBuffer]]</li> | ||
<li>[[$ | <li>[[$Lstr_Set_UserBuffer]]</li> | ||
</ul> | |||
</ul> | </ul> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Get_Userbuffer]] | [[Category:$Functions|$Lstr_Get_Userbuffer]] | ||
Latest revision as of 19:48, 1 September 2016
Get user buffer contents to a longstring
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Get_Userbuffer function.
This function retrieves into a Longstring the contents of the current user buffer. Such a user buffer is a Universal Buffer or an MQ/204 user buffer, both of which, as of Model 204 V6R1, may transfer Large Object (LOB) data. For versions of Model 204 prior to 6.1, this function applies only to the MQ user buffer and requires the MQ/204 feature.
The $Lstr_Get_Userbuffer function accepts no arguments and returns a Longstring result.
Syntax
%lstr = $Lstr_Get_Userbuffer
%lstr is the longstring for the user buffer contents.
Any errors during the transfer of the buffer contents result in request cancellation.
Usage notes
- Additional functions specifically for working with Large Object data are: