Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

ExecutionCommandContext Class Reference

This class is used to give context to the command being executed. More...

List of all members.


Public Methods

 ExecutionCommandContext ()
 Constructor for the Execution Command Context object.

virtual ~ExecutionCommandContext ()
 Destructor for the Execution Command Context object.

void setEnvironment (const char *name, const char *value) throw (SoamException)
 Sets an environment variable (i.e a name/value string pair) within the context of a command.

void setPreCommand (const char *command) throw (SoamException)
 Sets the command string to be pre-executed.

void setPostCommand (const char *command) throw (SoamException)
 Sets the command string to be post-executed.


Detailed Description

This class is used to give context to the command being executed.

This class may be used in the more advanced form of the ExecutionSession.sendTaskCmd(...) call.

NOTE: If any of the methods of this class are called after the main(...) method exits, the client or service process may behave in an undefined manner (for example, hang or terminate abnormally).

See also:
ExecutionSession::sendTaskCmd(String , ExecutionCommandContext)


Constructor & Destructor Documentation

ExecutionCommandContext  
 

Constructor for the Execution Command Context object.

virtual ~ExecutionCommandContext   [virtual]
 

Destructor for the Execution Command Context object.


Member Function Documentation

void setEnvironment const char *    name,
const char *    value
throw (SoamException)
 

Sets an environment variable (i.e a name/value string pair) within the context of a command.

Parameters:
name  The name of the environment variable being set.
value  The value to be assigned to this environment variable.
Exceptions:
SoamException 

void setPreCommand const char *    command throw (SoamException)
 

Sets the command string to be pre-executed.

Parameters:
command  The command string to be executed prior to the actual command. A null value will be treated as an empty string.
Exceptions:
SoamException 

void setPostCommand const char *    command throw (SoamException)
 

Sets the command string to be post-executed.

Parameters:
command  The command string to be executed after to the actual command. A null value will be treated as an empty string.
Exceptions:
SoamException 


     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.