FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Commands::LongTransaction::OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReader.

Inheritance diagram for OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp:

[legend]
List of all members.

Detailed Description

The ILongTransactionCheckpointReaderImp class is a concrete implementation of ILongTransactionCheckpointReader. The ILongTransactionCheckpointReader interface provides forward only, read-only functionality for enumerating long transaction checkpoints. A reference to an ILongTransactionCheckpointReader is returned from the GetLongTransactionCheckpoints command. The initial position of the ILongTransactionCheckpointReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.


Public Member Functions

System::Void Close ()
 Closes the ILongTransactionCheckpointReader object, freeing any resources it may be holding.
System::String * GetCheckpointDescription ()
 Gets the description of the checkpoint currently being read.
System::String * GetCheckpointName ()
 Gets the name of the checkpoint currently being read.
System::DateTime GetCreationDate ()
 Gets the creation date of the checkpoint currently being read.
System::Boolean IsActive ()
 Returns true if the checkpoint currently being read is the active checkpoint.
System::Boolean ReadNext ()
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Function Documentation

System::Void OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::Close  ) 
 

Closes the ILongTransactionCheckpointReader object, freeing any resources it may be holding.

Returns:
Returns nothing

System::String* OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::GetCheckpointDescription  ) 
 

Gets the description of the checkpoint currently being read.

Returns:
Returns the checkpoint description

System::String* OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::GetCheckpointName  ) 
 

Gets the name of the checkpoint currently being read.

Returns:
Returns the checkpoint name

System::DateTime OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::GetCreationDate  ) 
 

Gets the creation date of the checkpoint currently being read.

Returns:
Returns the creation date

System::Boolean OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::IsActive  ) 
 

Returns true if the checkpoint currently being read is the active checkpoint.

Returns:
Returns true if the checkpoint is active.

System::Boolean OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::ReadNext  ) 
 

Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

System::Void OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReaderImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.


Comments or suggestions? Send us feedback.