FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

mgICommand.h File Reference


Namespaces

namespace  OSGeo
namespace  OSGeo::FDO
namespace  OSGeo::FDO::Commands
namespace  OSGeo::FDO::Connections

Functions

System::Void Cancel ()
 Attempts to cancel command execution. Cancel may be called on a separate thread after the commands Execute method has been called and before Execute has returned. If successful, an exception is thrown from the Execute method. If there is nothing to cancel, nothing happens. If command execution is in process, and the attempt to cancel fails or is not supported, an exception is thrown.
__property System::Int32 get_CommandTimeOut ()
 Gets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, 0 is returned.
__property OSGeo::FDO::Commands::ParameterValueCollectionget_ParameterValues ()
 Returns an ParameterValueCollection. If the command requires parameters, the literal values to bind to each of those named parameters must be added to this collection.
__property OSGeo::FDO::Connections::ITransactionget_Transaction ()
 Gets the transaction in which the command executes.
System::Void Prepare ()
 Validates and optimizes the command for execution. Calling this method is optional, but recommended if bound to different sets of parameters and executed multiple times.
__property System::Void set_CommandTimeOut (System::Int32 value)
 Sets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, then attempting to set a timeout will result in an exception.
__property System::Void set_Transaction (OSGeo::FDO::Connections::ITransaction *value)
 Sets the transaction in which the command executes.

Variables

public __gc __interface ICommand
public __gc __interface IConnection
public __gc __interface ITransaction

Function Documentation

System::Void Cancel  ) 
 

Attempts to cancel command execution. Cancel may be called on a separate thread after the commands Execute method has been called and before Execute has returned. If successful, an exception is thrown from the Execute method. If there is nothing to cancel, nothing happens. If command execution is in process, and the attempt to cancel fails or is not supported, an exception is thrown.

Returns:
Returns nothing

__property System::Int32 get_CommandTimeOut  ) 
 

Gets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, 0 is returned.

Returns:
Returns the time (in milliseconds)

__property OSGeo ::FDO ::Commands ::ParameterValueCollection* get_ParameterValues  ) 
 

Returns an ParameterValueCollection. If the command requires parameters, the literal values to bind to each of those named parameters must be added to this collection.

Returns:
Returns the list of parameters and their respective values

__property OSGeo ::FDO ::Connections ::ITransaction* get_Transaction  ) 
 

Gets the transaction in which the command executes.

Returns:
Returns the transaction object

System::Void Prepare  ) 
 

Validates and optimizes the command for execution. Calling this method is optional, but recommended if bound to different sets of parameters and executed multiple times.

Returns:
Returns nothing

__property System::Void set_CommandTimeOut System::Int32  value  ) 
 

Sets the number of milliseconds to wait before terminating the attempt to execute a command and generating an error. If the provider does not support the timeout capability, then attempting to set a timeout will result in an exception.

Parameters:
value Input the time (in milliseconds)
Returns:
Returns nothing

__property System::Void set_Transaction OSGeo::FDO::Connections::ITransaction value  ) 
 

Sets the transaction in which the command executes.

Parameters:
value Input the transaction object
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Commands::ICommand
 

public __gc __interface OSGeo::FDO::Connections::IConnection
 

public __gc __interface OSGeo::FDO::Connections::ITransaction
 


Comments or suggestions? Send us feedback.