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

FdoILongTransactionPrivilegeReader Class Reference

#include <ILongTransactionPrivilegeReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoILongTransactionPrivilegeReader:

[legend]
List of all members.

Detailed Description

The FdoILongTransactionPrivilegeReader interface provides forward only, read-only functionality for enumerating long transaction privileges. A reference to an FdoILongTransactionPrivilegeReader is returned from the GetLongTransactionPrivileges command. The initial position of the FdoILongTransactionPrivilegeReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 35 of file ILongTransactionPrivilegeReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoILongTransactionPrivilegesReader object, freeing any resources it may be holding.
virtual FDO_API FdoInt32 GetPrivileges ()=0
 Gets the privileges granted to the user currently being read. The returned value may be any combination of the values from the FdoLongTransactionPrivileges enumeration combined via a bit-wise or operation.
virtual FDO_API FdoStringGetUserName ()=0
 Gets the name of the user currently being read.
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. Therefore you must call ReadNext to begin accessing any data.

Member Function Documentation

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

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

Returns:
Returns nothing

virtual FDO_API FdoInt32 FdoILongTransactionPrivilegeReader::GetPrivileges  )  [pure virtual]
 

Gets the privileges granted to the user currently being read. The returned value may be any combination of the values from the FdoLongTransactionPrivileges enumeration combined via a bit-wise or operation.

Returns:
Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration

virtual FDO_API FdoString* FdoILongTransactionPrivilegeReader::GetUserName  )  [pure virtual]
 

Gets the name of the user currently being read.

Returns:
Returns the user name

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

Advances the reader to the next item. The default position of the reader is prior to the first item. Therefore 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.