INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_PERSIST_STORAGE", "The IPersistStorage interface enables a container application", "to pass a storage object to one of its contained objects and", "to load and save the storage object. This interface supports", "the structured storage scheme in which each component object", "has its own storage that is nested within the container%'s", "storage."
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_STORAGE
inherit

EOLE_PERSIST
redefine
create_ole_interface_ptr,
on_query_interface
end
feature

create_ole_interface_ptr: POINTER

is_dirty
--
-- Purpose:
-- Checks the object for changes since it was last saved
-- to its current storage.
-- 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.
--

init_new (stg: EOLE_STORAGE)
--
-- Purpose:
-- Initializes a new storage object.
-- Params:
-- Stg: EOLE_STORAGE [in] IStorage pointer to the new storage
-- object to initialize and use.
-- The container creates a nested storage
-- object in its storage object
-- (see IStorage::CreateStorage).
-- Then, the container calls the
-- WriteClassStg function to initialize
-- the new storage object with the component
-- object class identifier (CLSID).
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

load (stg: EOLE_STORAGE)
--
-- Purpose:
-- Initializes an object from ts existing storage.
-- Params:
-- Stg: EOLE_STORAGE [in] Existing storage object from which the
-- component object is to be loaded.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

save (stg: EOLE_STORAGE; sameasload: BOOLEAN)
--
-- Purpose:
-- Saves an object to the specified stream.
-- Params:
-- Stg: EOLE_STIRAGE [in] Storage into which the object
-- should be saved.
-- SameAsLoad: BOOLEAN [in] Indicates whether the specified
-- storage object is the current one,
-- which was passed to the object by
-- one of the following calls:
-- * IPersistStorage::InitNew when
-- it was created.
-- * IPersistStorage::Load when it was
-- loaded.
-- * IPersistStorage::SaveCompleted
-- when it was saved to a storage
-- different from its current
-- storage.
-- This parameter is set to FALSE
-- when performing a Save As or
-- Save A Copy To operation or
-- when performing a full save.
-- In the latter case, this method
-- saves to a temporary file, deletes
-- the original file, and renames
-- the temporary file. This parameter
-- is set to TRUE to perform a full
-- save in a low-memory situation or
-- to perform a fast incremental save
-- in which only the dirty components
-- are saved.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

save_completed (stgnew: EOLE_STORAGE)
--
-- Purpose:
-- Notifies the object that it can revert from NoScribble or
-- HandsOff mode, in which it must not write to its storage object,
-- to Normal mode, in which it can. The component object enters
-- NoScribble mode when it receives an IPersistStorage::Save call.
-- Params:
-- StgNew: EOLE_STORAGE [in] Storage object, if different from the
-- storage object prior to saving.
-- This pointer can be Void if the
-- current storage object does not change
-- during the save operation. If the
-- object is in HandsOff mode, this
-- parameter must be non-Void.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

hands_off_storage
--
-- Purpose:
-- Instructs the object to release all storage objects that have
-- been passed to it by its container and to enter HandsOff mode,
-- in which the object cannot do anything and the only operation
-- that works is a close operation.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
end -- class EOLE_PERSIST_STORAGE

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES