Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 3 Tools : $GETENVCOMMAREA

$GETENVCOMMAREA
Retrieves data passed into TIBCO Object Service Broker from a calling environment that is not TIBCO Object Service Broker. (F)
Invocation
value = $GETENVCOMMAREA(segment#)
 
On return, contains the retrieval data. Its syntax is V (variable-length character string) with length of either 8,192 or 31,744 depending on retrieval data length.
Usage Notes
0 – Scratch Pad Area (SPA).
1 – The user data or the session parameter string if using a non-seamless interface.
2 – The user data.
For CICS, the value for segment# is ignored.
For the SDK (C/C++), the maximum length for value applies even though much larger COMMAREAs are supported through the MAP table interface.
See Also
TIBCO Object Service Broker for z/OS External Environments or TIBCO Object Service Broker for Open Systems External Environments for information about using TIBCO Object Service Broker with external environments
TIBCO Object Service Broker Managing Data for information about MAP tables
Example
The following rule retrieves the data from segment 0.

 
RULE EDITOR ===> SCROLL: P
GETENV_1;
_ LOCAL COMMAREA;
_ ---------------------------------------------------------------------------
_ ------------------------------------------------------------+--------------
_ COMMAREA = $GETENVCOMMAREA(0); | 1
_ ---------------------------------------------------------------------------

 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved