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

FdoILockConflictReader Class Reference

#include <ILockConflictReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoILockConflictReader:

[legend]
List of all members.

Detailed Description

The FdoILockConflictReader interface provides forward only, read-only functionality for identifying features that have a lock conflict. Features with a lock conflict are those that the caller is attempting to modify that are already locked by someone else.

Remarks:
A reference to an FdoILockConflictReader is returned from the FdoIAcquireLock, FdoISelect, FdoIReleaseLock, FdoIUpdate, and FdoIDelete commands. The initial position of the FdoILockConflictReader is prior to the first item, thus you must call ReadNext to begin accessing any data.

Definition at line 40 of file ILockConflictReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoILockConflictReader object, freeing any resources it may be holding.
virtual FDO_API FdoConflictType GetConflictType ()=0
 Gets the conflict type for the conflict currently being read.
virtual FDO_API FdoStringGetFeatureClassName ()=0
 Gets the class name of the feature currently being read.
virtual FDO_API FdoPropertyValueCollectionGetIdentity ()=0
 Returns an FdoPropertyValueCollection containing the property values that uniquely identify the feature currently being read.
virtual FDO_API FdoStringGetLockOwner ()=0
 Gets the name of the owner who holds a lock 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 FdoILockConflictReader::Close  )  [pure virtual]
 

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

Returns:
Returns nothing

virtual FDO_API FdoConflictType FdoILockConflictReader::GetConflictType  )  [pure virtual]
 

Gets the conflict type for the conflict currently being read.

Returns:
Returns the conflict type for the conflict currently being read.

virtual FDO_API FdoString* FdoILockConflictReader::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 class name.

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

Returns 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* FdoILockConflictReader::GetLockOwner  )  [pure virtual]
 

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

Returns:
Returns the name of the owner

virtual FDO_API FdoString* FdoILockConflictReader::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 FdoILockConflictReader::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.