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

FdoIGetLongTransactions Class Reference

#include <IGetLongTransactions.h>

Inherits FdoICommand.

Inheritance diagram for FdoIGetLongTransactions:

[legend]
List of all members.

Detailed Description

The FdoIGetLongTransactions interface defines the GetLongTransactions command. It allows a user to retrieve long transaction information for all or a specific long transaction. The command returns a FdoILongTransactionReader object enumerating the identified long transactions.

Definition at line 36 of file IGetLongTransactions.h.


Public Member Functions

virtual FDO_API FdoILongTransactionReaderExecute ()=0
 Executes the GetLongTransactions command returning a reference to an FdoILongTransactionReader.
virtual FDO_API FdoStringGetName ()=0
 Gets the currently set name of the long transaction for which the long transaction information should be retrieved. If the property is not set, the function returns a NULL pointer.
virtual FDO_API void SetName (FdoString *value)=0
 Sets the name of the long transaction for which information should be retrieved. The function can also be used to nullify the property by using a NULL pointer as the function's parameter. If the the property is not set, the function returns information for all available long transactions.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API FdoILongTransactionReader* FdoIGetLongTransactions::Execute  )  [pure virtual]
 

Executes the GetLongTransactions command returning a reference to an FdoILongTransactionReader.

Returns:
Returns a long transaction reader

virtual FDO_API FdoString* FdoIGetLongTransactions::GetName  )  [pure virtual]
 

Gets the currently set name of the long transaction for which the long transaction information should be retrieved. If the property is not set, the function returns a NULL pointer.

Returns:
Returns a long transaction name.

virtual FDO_API void FdoIGetLongTransactions::SetName FdoString value  )  [pure virtual]
 

Sets the name of the long transaction for which information should be retrieved. The function can also be used to nullify the property by using a NULL pointer as the function's parameter. If the the property is not set, the function returns information for all available long transactions.

Returns:
Returns nothing

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoICommand.

Definition at line 38 of file IGetLongTransactions.h.


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