INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_PERSIST_STREAM", "The IPersistStream interface provides methods for saving and", "loading objects that use a simple serial stream for their", "storage needs. The primary purpose of this interface is to", "support OLE moniker implementations. Each of the OLE-provided", "moniker interfaces provide an IPersistStream implementation", "through which the moniker saves or loads itself. An instance", "of the OLE generic composite moniker class calls the", "IPersistStream methods of its component monikers to load or", "save the components in the proper sequence in a single stream."
project: "Visual Eiffel Library"
revision: "$Revision: 1.2 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: wine
class EOLE_PERSIST_STREAM
inherit

EOLE_PERSIST
redefine
create_ole_interface_ptr,
on_query_interface
end
feature

create_ole_interface_ptr: POINTER
--
-- Purpose:
-- Create an C++ virtual table, corresponding to
-- IPersistStream interface.
-- Params:
-- None.
-- Return Value:
-- Pointer to created VTBL.
-- Notes:
-- None.
--

is_dirty
--
-- Purpose:
-- Checks the object for changes since it was last saved.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- EOLE_S_OK - The object has changed since it was last saved.
-- EOLE_S_FALSE - The object has not changed since the last save.
--

load (stm: EOLE_STREAM)
--
-- Purpose:
-- Initializes an object from the stream where it was
-- previously saved.
-- Params:
-- Stm: EOLE_STREAM [in] Stream from which the object
-- should be loaded.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

save (stm: EOLE_STREAM; cleardirty: BOOLEAN)
--
-- Purpose:
-- Saves an object to the specified stream.
-- Params:
-- Stm: EOLE_STREAM [in] Stream into which the object
-- should be saved.
-- ClearDirty: BOOLEAN [in] Indicates whether to clear the
-- dirty flag after the save is complete.
-- If TRUE, the flag should be cleared.
-- If FALSE, the flag should be left
-- unchanged.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

get_size_max: INTEGER
--
-- Purpose:
-- Returns the size in bytes of the stream needed to save the object.
-- Params:
-- None.
-- Return Value:
-- Size in bytes of the stream needed to save the object.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
end -- class EOLE_PERSIST_STREAM

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES