$Lstr Set UserBuffer

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:
  • $Lstr_Add_UserBuffer
  • $Lstr_Get_Userbuffer

  Products authorizing $Lstr_Set_UserBuffer

  • Sirius functions
  • Fast/Unload User Language Interface
  • Janus Open Client
  • Janus Open Server
  • Janus Sockets
  • Janus Web Server
  • Japanese functions
  • Sir2000 Field Migration Facility