$Lstr_Get_Userbuffer

From m204wiki
Revision as of 22:18, 8 February 2011 by 198.242.244.47 (talk) (Created page with "{{DISPLAYTITLE:$Lstr_Get_Userbuffer}} <span class="pageSubtitle"><section begin="desc" />Get user buffer contents to a longstring<section end="desc" /></span> <p class="warning"...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

<section begin="desc" />Get user buffer contents to a longstring<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Get_Userbuffer function is to be entered.

This function, new in Sirius Mods Version 6.7, retrieves into a longstring the contents of the current user buffer. 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_Get_Userbuffer function accepts no arguments and returns a longstring result.

Syntax

<section begin="syntax" /> %LSTR = $Lstr_Get_Userbuffer <section end="syntax" />

$Lstr_Get_Userbuffer Function

%LSTR is the longstring for the user buffer contents.


Any errors during the transfer of the buffer contents result in request cancellation.

Additional functions specifically for working with Large Object data are:

  • :hdref reftxt=$LSTR_ADD_USERBUFFER refid=ladubuf.
  • :hdref reftxt=$LSTR_SET_USERBUFFER refid=lsetbuf.

Products authorizing $Lstr_Get_Userbuffer