$Lstr Set UserBuffer: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 4: | Line 4: | ||
<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>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Set_UserBuffer function.</p> | ||
This [[Notation conventions for methods#Callable functions|callable]] function | This [[Notation conventions for methods#Callable functions|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 <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. | ||
The <var>$Lstr_Set_UserBuffer</var> function accepts one argument and returns a numeric result: the length of the longstring argument. | 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">[% | <p class="syntax">[%len =] $Lstr_Set_UserBuffer(longstring) | ||
</p> | </p> | ||
<p>%len is the length in bytes of the user buffer contents, or it is -1 to indicate an error.</p> | |||
If the user buffer has to be expanded to accommodate the longstring, 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 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 longstring, length is increased in increments of 4096 bytes (one page). </p> | |||
Any errors during the transfer of the longstring result in request cancellation. | <li>Any errors during the transfer of the longstring result in request cancellation. | ||
Additional functions specifically for working with Large Object data are: | <li>Additional functions specifically for working with Large Object data are: | ||
<ul> | <ul> | ||
| Line 28: | Line 29: | ||
</ul> | </ul> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
| Line 41: | Line 41: | ||
</ul> | </ul> | ||
[[Category:$Functions|$Lstr_Set_UserBuffer]] | [[Category:$Functions|$Lstr_Set_UserBuffer]] | ||
Revision as of 00:37, 19 July 2013
Set user buffer to longstring value
Note: Most Sirius $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.0, 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_Set_UserBuffer function accepts one argument and returns a numeric result: the length of the longstring argument.
Syntax
[%len =] $Lstr_Set_UserBuffer(longstring)
%len is the length in bytes of the user buffer contents, or it is -1 to indicate an error.
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, length is increased in increments of 4096 bytes (one page).
- Any errors during the transfer of the longstring result in request cancellation.
- Additional functions specifically for working with Large Object data are:
Products authorizing $Lstr_Set_UserBuffer