$Lstr Get Userbuffer: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (minor formatting)
m (add link)
 
Line 4: Line 4:
<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>
<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 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&nbsp;204</var> V6R1, may transfer Large Object (LOB) data. For versions of <var class="product">Model&nbsp;204</var> prior to 6.1, this function applies only to the MQ user buffer and requires the MQ/204 feature.  
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&nbsp;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&nbsp;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 <var>Longstring</var> result.
The <var>$Lstr_Get_Userbuffer</var> function accepts no arguments and returns a <var>Longstring</var> result.

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

Products authorizing $Lstr_Get_Userbuffer