INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "The objects of EOLE_STATSTG class is used in", "EOLE_STORAGE.enum_elements to describe properties of the", "storage elements"
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_STATSTG
inherit

EOLE_OBJECT_WITH_POINTER
end
creation

make
feature

make
-- Purpose:
-- Create an object
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- It's a dummy constructor now.

allocate: POINTER
-- Purpose:
-- Allocate the physical memory block of nesessary size
-- (sizeof (STATSTG)) from memory pool.
-- Params:
-- None.
-- Return Value:
-- Pointer to alocated memory block.
-- Notes:
-- None.

set_element_name (element_name: STRING)
-- Purpose:
-- Set the 'pwcsName' member of the corresponding
-- C++ structure to the specified name of the storage element.
-- Params:
-- element_name [in]
-- Name of the storage element to init the corresponding
-- field of the structure.
-- Return Value:
-- None.
-- Notes:
-- None.

set_element_type (element_type: INTEGER)
-- Purpose:
-- Set the 'type' member of the corresponding
-- C++ structure to the specified type of the storage element.
-- Params:
-- element_type [in]
-- Type of storage element to init the corresponding
-- field of the structure.
-- Return Value:
-- None.
-- Notes:
-- Legal values of the 'element_type' can be found in the
-- EOLE_STGTY class.

set_element_size (element_size: INTEGER)
-- Purpose:
-- Set the 'cbSize' member of the corresponding
-- C++ structure to the specified storage element size.
-- Params:
-- element_size [in]
-- Size of the storage element to init the corresponding
-- field of the structure.
-- Return Value:
-- None.
-- Notes:
-- None.

set_modification_time (mtime: EOLE_FILETIME)
-- Purpose:
-- Set the 'mtime' member of the corresponding
-- C++ structure to the specified storage element
-- modification time.
-- Params:
-- mtime [in]
-- Time of the last modification of the storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- The information supplied by 'mtime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

set_creation_time (ctime: EOLE_FILETIME)
-- Purpose:
-- Set the 'ctime' member of the corresponding
-- C++ structure to the specified storage element
-- creation time.
-- Params:
-- ctime [in]
-- Time of creation of the storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- The information supplied by 'ctime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

set_access_time (atime: EOLE_FILETIME)
-- Purpose:
-- Set the 'atime' member of the corresponding
-- C++ structure to the specified storage element
-- last access time.
-- Params:
-- atime [in]
-- Time of last access to the storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- The information supplied by 'atime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

set_open_mode (mode: INTEGER)
-- Purpose:
-- Set the 'grfMode' member of the corresponding
-- C++ structure to the specified storage element open mode.
-- Params:
-- mode [in]
-- Open mode ofthe storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- None.

set_locks_supported (locks_supported: INTEGER)
-- Purpose:
-- Set the 'grfLocksSupported' member of the corresponding
-- C++ structure to the specified locking, supported by
-- storage element.
-- Params:
-- locks_supported [in]
-- locks, supported by the storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- The locks_supported param is a group of BOOLEAN
-- flags relevant only for stream objects and byte arrays.
-- Legal values are combinations of values from the EOLE_LOCKTYPE
-- class.

set_clsid (clsid: STRING)
-- Purpose:
-- Set the 'clsid' member of the corresponding
-- C++ structure to the specified class identifier.
-- Params:
-- clsid [in]
-- string, representing the clsid in registry format
-- to init the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- The 'clsid' param is relevant only for storage objects and
-- represents the CLSID associated with the storage, if any.

set_state_bits (state_bits: BIT 32)
-- Purpose:
-- Set the 'grfStateBits' member of the corresponding
-- C++ structure to the specified state bits.
-- Params:
-- state_bits [in]
-- state bits of storage element to init
-- the corresponding field of the structure.
-- Return Value:
-- None.
-- Notes:
-- None.

get_element_name: STRING
-- Purpose:
-- Return the value of the 'pwcsName' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Name of the storage element
-- Notes:
-- None.

get_element_type: INTEGER
-- Purpose:
-- Return the value of the 'type' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Type of the storage element.
-- Notes:
-- Legal values of the 'element_type' can be found in the
-- EOLE_STGTY class.

get_element_size: INTEGER
-- Purpose:
-- Return the value of the 'cbSize' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Size of the storage element.
-- Notes:
-- None.

get_modification_time: EOLE_FILETIME
-- Purpose:
-- Return the value of the 'mtime' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Time of the last modification of the storage element
-- Notes:
-- The information supplied by 'mtime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

get_creation_time: EOLE_FILETIME
-- Purpose:
-- Return the value of the 'ctime' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Creation time of the storage element
-- Notes:
-- The information supplied by 'ctime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

get_access_time: EOLE_FILETIME
-- Purpose:
-- Return the value of the 'atime' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Last access time to the storage element.
-- Notes:
-- The information supplied by 'ctime' member applies only to
-- storages; streams do not have time stamps so these member
-- always return zero.

get_open_mode: INTEGER
-- Purpose:
-- Resturn the value of the 'grfMode' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- Mode in which the element was opened.
-- Notes:
-- None.

get_locks_supported: INTEGER
-- Purpose:
-- Return the the 'grfLocksSupported' member of the
-- corresponding C++ structure.
-- Params:
-- locks_supported [in]
-- locks, supported by the storage element
-- to init the corresponding field of the structure.
-- Return Value:
-- Locks, supported by the storage element.
-- Notes:
-- The return value is a group of BOOLEAN
-- flags relevant only for stream objects and byte arrays.
-- Legal values are combinations of values from the EOLE_LOCKTYPE
-- class.

get_clsid: STRING
-- Purpose:
-- Return the string, representing the 'clsid' member of the
-- corresponding C++ structure in the registry format.
-- Params:
-- None.
-- Return Value:
-- String, representing the clsid in registry format
-- Notes:
-- The return value is relevant only for storage objects and
-- represents the CLSID associated with the storage, if any.

get_state_bits: BIT 32
-- Purpose:
-- Return the value of the 'grfStateBits' member of the
-- corresponding C++ structure.
-- Params:
-- None.
-- Return Value:
-- State bits of the storage element.
-- Notes:
-- None.
end -- class EOLE_STATSTG

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES