$Lstr Set UserBuffer: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (typo)
m (add <var>s)
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="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Set_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_Set_UserBuffer</var> function.</p>


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 (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 [[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 (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.  

Revision as of 18:17, 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