Sets the COMMAREA data associated with the request.

Namespace:  IBM.CTG
Assembly:  IBM.CTG.Client (in IBM.CTG.Client.dll) Version: 9.0.0.0

Syntax

C#
public void SetCommareaData(
	byte[] commarea
)
Visual Basic
Public Sub SetCommareaData ( _
	commarea As Byte() _
)
Visual C++
public:
void SetCommareaData(
	array<unsigned char>^ commarea
)

Parameters

commarea
Type: array<System..::..Byte>[]()[][]
A byte array containing the COMMAREA data, or nullNothingnullptra null reference (Nothing in Visual Basic) to specify no COMMAREA.

Remarks

If the length of commarea is zero, it is treated as if nullNothingnullptra null reference (Nothing in Visual Basic) was specified.

The COMMAREA held within the EciRequest is cloned from commarea. Subsequent modifications to the array will not be reflected in the COMMAREA that is sent to CICS unless SetCommareaData(array<Byte>[]()[][]) is invoked with the modified array.

The maximum COMMAREA size that can be flowed successfully to the CICS server depends on a variety of factors, including the communication protocol used between the CICS Transaction Gateway and the CICS server, and the amount of non-zero data in the COMMAREA. Applications are advised to use a maximum size of 32500 bytes, as this is guaranteed to be flowed successfully across all protocols. COMMAREA sizes larger than this may generate an EciErrInvalidDataLength return code when the request is flowed.

Exceptions

ExceptionCondition
System..::..ArgumentOutOfRangeException The length of commarea exceeds the maximum value of an Int16 (32767).

See Also