INDEX | CLUSTER | FEATURES | SHORT | FRAMES | NO FRAMES |
-- Purpose:
-- Create an object.
-- Params:
-- None.
-- Return Value:
-- None
-- Notes:
-- It's a dummy constructor now.
-- Purpose:
-- Reads data from the stream starting at the current
-- seek pointer.
-- Params:
-- buf_ [out]
-- Points to the buffer into which the stream data
-- should be stored. If an error is returned, this
-- parameter must be set to 'default_pointer'. (NULL)
-- num_bytes_to_read [in]
-- Specifies the number of bytes of data to read from
-- the stream.
-- Return Value:
-- The number of bytes actually read from the stream.
-- Notes:
-- None.
-- Purpose:
-- Attempts to write 'num_bytes_to_write' bytes from the buffer
-- pointed to by 'buf_' into the stream starting at the current
-- seek pointer.
-- Params:
-- buf_ [in]
-- Points to the buffer containing the data to be written
-- to the stream.
-- num_bytes_to_write [in]
-- Defines the number of bytes of data to write into the stream.
-- Return Value:
-- Number of bytes actually written into the stream.
-- Notes:
-- None.
-- Purpose:
-- Adjusts the location of the seek pointer on the stream.
-- Params:
-- offset [in]
-- Specifies the displacement to be added to the location
-- indicated by 'origin'. If 'origin' is EOLE_STREAM_SEEK_SET,
-- this is interpreted as an unsigned value rather than a
-- signed value.
-- origin [in]
-- Specifies the seek mode; the origin with respect to which
-- 'offset' should be interpreted; see the following comments.
-- Return Value:
-- None.
-- Notes:
-- The 'origin' parameter can have one of the following values:
-- EOLE_STREAM_SEEK_SET,
-- EOLE_STREAM_SEEK_CUR,
-- EOLE_STREAM_SEEK_END.
-- This constants defined in EOLE_STREAM_SEEK class (eolestrs.e)
-- See this file for meanings of this constants.
-- Purpose:
-- Determines whether the end of stream has been reached.
-- Params:
-- None.
-- Return Value:
-- False, if the current seek position is not end of stream.
-- True, otherwise.
-- Notes:
-- None.
-- Purpose:
-- Changes the size of the stream.
-- Params:
-- new_size [in]
-- Specifies the new size of the stream.
-- Return Value:
-- None.
-- Notes:
-- None.
-- Purpose:
-- Copies data from one stream to another stream,
-- starting at the current seek pointer in each stream.
-- Params:
-- stream_dest [in]
-- The stream into which the data should be copied.
-- num_byrtes_to_copy [in]
-- Specifies the number of bytes to read from the source
-- stream.
-- Return Value:
-- None.
-- Notes:
-- None.
-- Purpose:
-- Commits any changes made to the EOLE_STORAGE object containing
-- the stream.
-- Params:
-- mode [in]
-- Controls how the object is to be committed to storage.
-- This parameter consists of the OR-ing of constants from the
-- EOLE_STGC class (eolestgc.e). See comments in this class
-- for meaning of valid commit modes.
-- Return Value:
-- None.
-- Notes:
-- None.
-- Purpose:
-- Discard all changes made to the stream since it was opened
-- or last committed in transacted mode.
-- In direct mode has no effect.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- None.
-- Purpose:
-- Read a single character from a stream at the current position.
-- Params:
-- None.
-- Return Value:
-- Readed character.
-- Notes:
-- Hack! size of 'CHARACTER' in Eiffel/X is 1 (Undocumented).
-- Purpose:
-- Write a single character to the stream at the current position.
-- Params:
-- ch [in]
-- Character to write.
-- Return Value:
-- None.
-- Notes:
-- Hack! size of 'CHARACTER' in Eiffel/X is 1 (Undocumented).
-- Purpose:
-- Read an integer value from a stream at the current position.
-- Params:
-- None.
-- Return Value:
-- Readed integer.
-- Notes:
-- Hack! size of 'INTEGER' in Eiffel/X is 4 (Undocumented).
-- Purpose:
-- Write an integer value to the stream at the current position.
-- Params:
-- i [in]
-- Integer to write.
-- Return Value:
-- None.
-- Notes:
-- Hack! size of 'INTEGER' in Eiffel/X is 4 (Undocumented).
-- Purpose:
-- Read an real value from a stream at the current position.
-- Params:
-- None.
-- Return Value:
-- Readed real.
-- Notes:
-- Hack! size of 'REAL' in Eiffel/X is 8 (Undocumented).
-- Purpose:
-- Write an real value to the stream at the current position.
-- Params:
-- r [in]
-- Real to write.
-- Return Value:
-- None.
-- Notes:
-- Hack! size of 'REAL' in Eiffel/X is 8 (Undocumented).
-- Purpose:
-- Read an boolean value from a stream at the current position.
-- Params:
-- None.
-- Return Value:
-- Readed boolean.
-- Notes:
-- Hack! size of 'BOOLEAN' in Eiffel/X is 1 (Undocumented).
-- Purpose:
-- Write an boolean value to the stream at the current position.
-- Params:
-- b [in]
-- Boolean to write.
-- Return Value:
-- None.
-- Notes:
-- Hack! size of 'BOOLEAN' in Eiffel/X is 1 (Undocumented).
-- Purpose:
-- Read the string from a stream at the current position.
-- Params:
-- None.
-- Return Value:
-- Readed string.
-- Notes:
-- You must be sure that you read explicitly string!
-- Otherwise, the result will unpredictable.
-- Purpose:
-- Write string to the stream at the current seek pointer.
-- Params:
-- s [in]
-- String to write.
-- Return Value:
-- None.
-- Notes:
-- None.
-- Purpose:
-- Creation of corresponding C++ object
-- Params:
-- None
-- Return Value:
-- Pointer to the corresponding C++ object.
-- Notes:
-- This method should be never called.
INDEX | CLUSTER | FEATURES | SHORT | FRAMES | NO FRAMES |