FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoILockedObjectReader Class Reference

#include <ILockedObjectReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoILockedObjectReader:

[legend]
List of all members.

Detailed Description

The FdoILockedObjectReader interface provides forward-only, read-only functionality to identify lock information for a set of objects.

Remarks:
A reference to an FdoILockedObjectReader interface is returned from the GetLockedObjects and GetLockInfo commands. The initial position of the FdoILockInfoReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 38 of file ILockedObjectReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoILockInfoReader object, freeing any resources it may be holding.
virtual FDO_API FdoStringGetFeatureClassName ()=0
 Gets the class name of the feature currently being read.
virtual FDO_API FdoPropertyValueCollectionGetIdentity ()=0
 Gets an FdoPropertyValueCollection containing the property values that uniquely identify the feature currently being read.
virtual FDO_API FdoStringGetLockOwner ()=0
 Gets the name of user who holds the lock on the feature currently being read.
virtual FDO_API const FdoLockType GetLockType ()=0
 Gets the type of the lock held on the feature currently being read.
virtual FDO_API FdoStringGetLongTransaction ()=0
 Gets the name of the long transaction in which the feature currently being read is locked.
virtual FDO_API bool ReadNext ()=0
 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.

Member Function Documentation

virtual FDO_API void FdoILockedObjectReader::Close  )  [pure virtual]
 

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

Returns:
Returns nothing

virtual FDO_API FdoString* FdoILockedObjectReader::GetFeatureClassName  )  [pure virtual]
 

Gets the class name of the feature currently being read.

Remarks:
The value of the class name will be null in the event that the class name could not be resolved. This can happen if the table has no class id field and multiple classes have been written to the table.
Returns:
Returns the name of the class.

virtual FDO_API FdoPropertyValueCollection* FdoILockedObjectReader::GetIdentity  )  [pure virtual]
 

Gets an FdoPropertyValueCollection containing the property values that uniquely identify the feature currently being read.

Returns:
Returns the property collection identifying the feature.

virtual FDO_API FdoString* FdoILockedObjectReader::GetLockOwner  )  [pure virtual]
 

Gets the name of user who holds the lock on the feature currently being read.

Returns:
Returns the lock owner

virtual FDO_API const FdoLockType FdoILockedObjectReader::GetLockType  )  [pure virtual]
 

Gets the type of the lock held on the feature currently being read.

Returns:
Returns the lock type

virtual FDO_API FdoString* FdoILockedObjectReader::GetLongTransaction  )  [pure virtual]
 

Gets the name of the long transaction in which the feature currently being read is locked.

Returns:
Returns the name of the long transaction in which the feature currently being read is locked.

virtual FDO_API bool FdoILockedObjectReader::ReadNext  )  [pure virtual]
 

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.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.