$Lstr Add UserBuffer: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
m (→‎Usage notes: add link)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
<span class="pageSubtitle">Add longstring to user buffer</span>
<span class="pageSubtitle">Add longstring to user buffer</span>


<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Add_UserBuffer 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_Add_UserBuffer</var> function.</p>


This [[Notation conventions for methods#Callable functions|callable]] function appends the value of its longstring argument to 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.0, may transfer 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.
This [[Notation conventions for methods#Callable functions|callable]] function appends the value of its <var>[[Longstrings|Longstring]]</var> argument to 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&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_Add_UserBuffer</var> function accepts one argument and returns a numeric result: the new length of the user buffer contents.
 
The argument is an arbitrary string or longstring.


==Syntax==
==Syntax==
<p class="syntax">[%LEN =] $Lstr_Add_UserBuffer(longstring)
<p class="syntax">[<span class="term">%len</span> =] $Lstr_Add_UserBuffer(<span class="term">longstring</span>)
</p>
</p>


<p>%LEN is the resultant length of the user buffer data in bytes, or it is -1 to indicate an error.</p>
<table>
<tr><th>%len</th>
<td>The resultant length in bytes of the user buffer contents, or it is -1 to indicate an error.</td></tr>


The Universal Buffer is a one-per-user, temporary storage area that, like the MQ buffer, automatically expands to accommodate its data contents. Unlike prior Versions, the MQ buffer in <var class="product">Model 204</var> 6.1 also becomes a one-per-user buffer.  
<tr><th>longstring</th>
<td>The <var>String</var> or <var>Longstring</var> to be added to the user buffer. </td></tr>
</table>


If the buffer has to be expanded to accommodate the longstring, its length is increased in increments of 4096 bytes (one page). Any errors during the transfer of the longstring result in request cancellation.
==Usage notes==
<ul>
<li>The Universal Buffer is a one-per-user, temporary storage area that, like the [[MQ/204 data conversion and handling#Data handling|MQ buffer]], automatically expands to accommodate its data contents. Unlike prior versions, the MQ buffer in <var class="product">Model&nbsp;204</var> 6.1 also becomes a one-per-user buffer.
<p>
If the buffer has to be expanded to accommodate the <var class="term">longstring</var> value, its length is increased in increments of 4096 bytes (one page). </p></li>


Data insertions into or deletions from the buffer are not allowed in <var class="product">Model 204</var> 6.1.  
<li>Any errors during the transfer of the <var class="term">longstring</var> value result in request cancellation. </li>


Additional functions specifically for working with Large Object data are:
<li>Data insertions into, or deletions from, the buffer are not allowed in <var class="product">Model&nbsp;204</var> 6.1. </li>


<li>Additional functions specifically for working with Large Object data are:
<ul>
<ul>
<li>[[$Lstr_Get_Userbuffer]]</li>
<li>[[$Lstr_Get_Userbuffer]]</li>
<li>[[$Lstr_Set_UserBuffer]]</li>
<li>[[$Lstr_Set_UserBuffer]]</li>
</ul></li>
</ul>
</ul>


Latest revision as of 20:41, 1 September 2016

Add longstring to user buffer

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Add_UserBuffer function.

This callable function appends the value of its Longstring argument to 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.

Syntax

[%len =] $Lstr_Add_UserBuffer(longstring)

%len The resultant length in bytes of the user buffer contents, or it is -1 to indicate an error.
longstring The String or Longstring to be added to the user buffer.

Usage notes

  • The Universal Buffer is a one-per-user, temporary storage area that, like the MQ buffer, automatically expands to accommodate its data contents. Unlike prior versions, the MQ buffer in Model 204 6.1 also becomes a one-per-user buffer.

    If the buffer has to be expanded to accommodate the longstring value, its length is increased in increments of 4096 bytes (one page).

  • Any errors during the transfer of the longstring value result in request cancellation.
  • Data insertions into, or deletions from, the buffer are not allowed in Model 204 6.1.
  • Additional functions specifically for working with Large Object data are:

Products authorizing $Lstr_Add_UserBuffer

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Add_UserBuffer&oldid=93913"