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

FdoILockOwnersReader Class Reference

#include <ILockOwnersReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoILockOwnersReader:

[legend]
List of all members.

Detailed Description

The FdoILockOwnersReader interface provides forward-only, read-only functionality for identifying users. A connected user has status of lock owner even if he has no locks or has released his locks.

Remarks:
A reference to an FdoILockOwnersReader interface is returned from the GetLockOwners command. The initial position of the FdoILockOwnersReader interface is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 37 of file ILockOwnersReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoILockOwnersReader object, freeing any resources it may be holding.
virtual FDO_API FdoStringGetLockOwner ()=0
 Gets the name of a user.
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 FdoILockOwnersReader::Close  )  [pure virtual]
 

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

Returns:
Returns nothing

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

Gets the name of a user.

Returns:
Returns the name of a user

virtual FDO_API bool FdoILockOwnersReader::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.