Previous Next Contents Index


IStreamBuffer interface (deprecated)

The IStreamBuffer interface is deprecated and is provided for backward compatibility only. New applications developed according to the servlet-JSP programming model do not need the functionality provided by the IStreamBuffer interface.

The IStreamBuffer interface represents a buffer for capturing streamed output during template processing. Use a stream buffer if your AppLogic needs to manipulate the data before sending it to another AppLogic. For example, the AppLogic can collect the data in a stream buffer, then parse it or save it to a file.

To capture the data in a stream buffer, use the evalOutput( ) method in the AppLogic class and pass in an IStream object. To manipulate the data in the stream buffer, use the getStreamData( ) method in this interface.

To create an instance of the IStreamBuffer interface, use the GX.CreateStreamBuffer( ) method.

Package
com.kivasoft

Method
getStreamData( )
Returns an array of byte values from the stream buffer.

getStreamData( )
Returns an array of byte values from the stream buffer.

Syntax
public byte[] getStreamData(
	int flags)

flags. Specify 0 (zero).

Usage
Use getStreamData( ) to retrieve the contents of the stream buffer that was captured during streamed template processing. The AppLogic can then manipulate the data as needed.

Rule
Call getStreamData( ) after evalOutput( ) in the AppLogic class. The evalOutput( ) method captures output in the stream buffer if the AppLogic passes in an IStream object.

Return Value
Array of byte values, or null for failure.

Related Topics
evalOutput( ) in the AppLogic class (deprecated)

 

© Copyright 1999 Netscape Communications Corp.