$Lstr Set UserBuffer: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Set user buffer to longstring value<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Set user buffer to longstring value<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">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 callable function, new in ''[[Sirius Mods]]'' 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 ''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. | This callable function, new in ''[[Sirius Mods]]'' 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 ''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. | The $Lstr_Set_UserBuffer 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"><section begin="syntax" /> [%LEN =] $Lstr_Set_UserBuffer(longstring) | ||
| Line 13: | Line 14: | ||
</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> | <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 ''Model 204'' 6.1 also becomes a one-per-user buffer. | 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. | ||
| Line 22: | Line 22: | ||
Additional functions specifically for working with Large Object data are: | Additional functions specifically for working with Large Object data are: | ||
<ul> | <ul> | ||
<li>[[$Lstr_Add_Userbuffer]] | |||
<li>[[$Lstr_Get_USerBuffer]] | |||
</ul> | |||
<p class="code"> | <p class="code"> | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[Sirius functions]]</li> | ||
| Line 38: | Line 38: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
| Line 44: | Line 43: | ||
<p class="caption">Products authorizing $Lstr_Set_UserBuffer | <p class="caption">Products authorizing $Lstr_Set_UserBuffer | ||
</p> | </p> | ||
[[Category:$Functions|$Lstr_Set_UserBuffer]] | [[Category:$Functions|$Lstr_Set_UserBuffer]] | ||
Revision as of 22:48, 10 February 2011
<section begin="desc" />Set user buffer to longstring value<section end="desc" />
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, new in Sirius Mods 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 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
<section begin="syntax" /> [%LEN =] $Lstr_Set_UserBuffer(longstring) <section end="syntax" />
$Lstr_Set_UserBuffer Function
%LEN is the length in bytes of the user buffer contents, or it is -1 to indicate an error.
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:
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $Lstr_Set_UserBuffer