TCOM_Store
What: class
Amcestor: TCommon_COM_Interface
File: _Stores
Layer: 1
Platforms: C++, Pascal (Object)
The base class for debuggers for a COM managed store. All methods use the stdcall
calling convention. It has the following methods:
Bytes_Read
int32 Bytes_Read() { return Get_Bytes_Read(); }
property Bytes_Read : longint read Get_Bytes_Read write Set_Bytes_Read
Access to bytes read.
Bytes_Written
int32 Bytes_Written() { return Get_Bytes_Written(); }
property Bytes_Written : longint read Get_Bytes_Written write Set_Bytes_Written
Access to bytes written.
Contiguous_Store
bool Contiguous_Store()
function Contiguous_Store : boolean
Returns True if the store's addresses are contiguous (non-sparse).
Error_Count
int32 Error_Count() { return Get_Error_Count(); }
property Error_Count : longint read Get_Error_Count write Set_Error_Count
Access to error count status.
Extend
TStore_Address Extend( TStore_Address Amount )
function Extend( Amount : TStore_Address ) : TStore_Address
Requests extension of store by the amount specified. Returns the amount actually
added to store. If Amount is 0, function returns 0 if store is extendable, and -1
if it is not.
Extended_Size
TStore_Address Extended_Size()
function Extended_Size : TStore_Address
Returns the maximum theoretical size that the store can be extended to. If the store
is not extendable, this returns the same value as Max_Storage.
Format
void Format()
procedure Format
Does a low-level format of the store.
Get_Bytes_Read
int32 Get_Bytes_Read()
function Get_Bytes_Read : longint
Returns the number of bytes read from the store since object instantiation.
Get_Bytes_Written
int32 Get_Bytes_Written()
function Get_Bytes_Written : longint
Returns the number of bytes written to the store since object instantiation.
Get_Cache
TCOM_Cache* Get_Cache()
function Get_Cache : TCOM_Cache
Returns the current cache object.
Get_Error_Count
int32 Get_Error_Count()
function Get_Error_Count : longint
Returns the number of errors since object instantiation.
Get_Name
char* Get_Name()
function Get_Name : Pchar
Returns name of store.
Get_Read_Only
bool Get_Read_Only()
function Get_Read_Only : boolean
Indicates that the store can only be read from.
Get_Reads
int32 Get_Reads()
function Get_Reads : longint
Returns the number of read operations since object instantiation.
Get_Write_Only
bool Get_Write_Only()
function Get_Write_Only : boolean
Indicates that the store can only be written to.
Get_Writes
int32 Get_Writes()
function Get_Writes : longint
Returns the number of write operations since object instantiation.
Max_Storage
TStore_Size Max_Storage()
function Max_Storage : TStore_Size
Returns the maximum (current) size of the store, in bytes. In other words, this is
the highest valid address (plus 1).
Min_Storage
TStore_Address Min_Storage()
function Min_Storage : TStore_Address
Returns the minimum atomic size of the store. For instance, this would be the sector
size for a disk.
Read_Data
TStore_Address Read_Data( void* Data, TStore_Address Address, TStore_Address _Size, TUnified_Exception* &UEC )
function Read_Data( var Data ; Address, _Size : TStore_Address ; var UEC : TUnified_Exception ) : TStore_Address
Read data from specified Address in store to Data. Read _Size bytes. Returns success
of operation in UEC. Function returns the number of bytes actually read.
Read_Only
bool Read_Only() { return Get_Read_Only(); }
property Read_Only : boolean read Get_Read_Only write Set_Read_Only
Access to read-only status.
Reads
int32 Reads() { return Get_Reads(); }
property Reads : longint read Get_Reads write Set_Reads
Access to number of reads.
Set_Bytes_Read
void Set_Bytes_Read( int32 Value )
procedure Set_Bytes_Read( Value : longint )
Sets the number of bytes read value.
Set_Bytes_Written
void Set_Bytes_Written( int32 Value )
procedure Set_Bytes_Written( Value : longint )
Sets the number of bytes written value.
Set_Cache
void Set_Cache( TCOM_Cache* Value )
procedure Set_Cache( Value : TCOM_Cache )
Sets the current cache object.
Set_Error_Count
void Set_Error_Count( int32 Value )
procedure Set_Error_Count( Value : longint )
Sets the error count value.
Set_Max_Storage
void Set_Max_Storage( TStore_Address Value, TUnified_Exception* &Res )
procedure Set_Max_Storage( Value : TStore_Address ; var Res : TUnified_Exception )
Sets the maximum (current) size of the store, in bytes. In other words, this is the
new highest valid address (plus 1). If the store is not resizable, the call fails
and an error code is returned in Res. This should only be used to shrink the size
of the store, not to extend it. To extend, use the Extend method.
Set_Read_Only
void Set_Read_Only( bool Value )
procedure Set_Read_Only( Value : boolean )
If true is passed, the store is set to read-only. If false is passed, the store
allows write operations.
Set_Reads
void Set_Reads( int32 Value )
procedure Set_Reads( Value : longint )
Sets the number of read operations value.
Set_Write_Only
void Set_Write_Only( bool Value )
procedure Set_Write_Only( Value : boolean )
If true is passed, the store cannot be read from - it can only be written to. If
false is passed, the store allows read operations.
Set_Writes
void Set_Writes( int32 Value )
procedure Set_Writes( Value : longint )
Sets the number of write operations value.
Write_Data
TStore_Address Write_Data( void* Data, TStore_Address Address, TStore_Address _Size, TUnified_Exception* &UEC )
function Write_Data( var Data ; Address, _Size : TStore_Address ; var UEC : TUnified_Exception ) : TStore_Address
Write data from Data to specified Address in store. Write _Size bytes. Returns success
of operation in UEC. The function returns the number of bytes actually written.
Write_Only
bool Write_Only() { return Get_Write_Only(); }
property Write_Only : boolean read Get_Write_Only write Set_Write_Only
Access to write-only status.
Writes
int32 Writes() { return Get_Writes(); }
property Writes : longint read Get_Writes write Set_Writes
Access to number of writes.