$Lstr Set UserBuffer: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (add link)
 
(35 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Set user buffer to longstring value</span>
<span class="pageSubtitle">Set user buffer to longstring value</span>


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


This callable function, new in <var class="product">[[Sirius Mods]]</var> Version 6.7, sets the contents of the current user buffer to the longstring argument value. 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 sets the contents of the current user buffer to the <var>[[Longstrings|Longstring]]</var> argument value. 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_Set_UserBuffer</var> function accepts one argument and returns a numeric result: the length of the longstring argument.


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> [%LEN =] $Lstr_Set_UserBuffer(longstring)
<p class="syntax">[<span class="term">%len</span> =] $Lstr_Set_UserBuffer(<span class="term">longstring</span>)
<section end="syntax" /></p>
<p class="caption">$Lstr_Set_UserBuffer Function
</p>
</p>
<p class="caption">%LEN is the length in bytes of the user buffer contents, or it is -1 to indicate an error.</p>


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.
<table>
<tr><th>%len</th>
<td>The length in bytes of the user buffer contents, or it is -1 to indicate an error.</td></tr>


If the user buffer has to be expanded to accommodate the longstring, length is increased in increments of 4096 bytes (one page).  
<tr><th>longstring</th>
<td>The <var>String</var> or <var>Longstring</var> to be copied to the user buffer. </td></tr>
</table>


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 204</var> 6.1 also becomes a one-per-user buffer.
<p>
If the user 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>


Additional functions specifically for working with Large Object data are:
<li>Any errors during the transfer of the <var class="term">longstring</var> value result in request cancellation. </li>


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


<p class="code">
==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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
   
   
</p>
<p class="caption">Products authorizing $Lstr_Set_UserBuffer
</p>
[[Category:$Functions|$Lstr_Set_UserBuffer]]
[[Category:$Functions|$Lstr_Set_UserBuffer]]

Latest revision as of 20:40, 1 September 2016

Set user buffer to longstring value

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

This callable function sets the contents of the current user buffer to the Longstring argument value. 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_Set_UserBuffer(longstring)

%len The length in bytes of the user buffer contents, or it is -1 to indicate an error.
longstring The String or Longstring to be copied 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 user 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.
  • Additional functions specifically for working with Large Object data are:

Products authorizing $Lstr_Set_UserBuffer