$Lstr Add UserBuffer: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
m (→Usage notes: add link) |
||
| (6 intermediate revisions by 2 users 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> | <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 | 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 204</var> prior to 6.1, this $function applies only to the MQ user buffer and requires the MQ/204 feature. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">[% | <p class="syntax">[<span class="term">%len</span> =] $Lstr_Add_UserBuffer(<span class="term">longstring</span>) | ||
</p> | </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 | <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). | ==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 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> | |||
<li>Any errors during the transfer of the <var class="term">longstring</var> value result in request cancellation. </li> | |||
<li>Data insertions into, or deletions from, the buffer are not allowed in <var class="product">Model 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> | ||
| Line 34: | Line 40: | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Media:JosrvrNew.pdf|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>Japanese functions</li> | <li>Japanese functions</li> | ||
<li>[ | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Add_UserBuffer]] | [[Category:$Functions|$Lstr_Add_UserBuffer]] | ||
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: