Difference between revisions of "ISInterface:QueueCommand"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 +
== Syntax ==
 +
*bool QueueCommand(char *ScriptName, char *Command)
 
== Purpose ==
 
== Purpose ==
 
Places a command in the given script's queue for execution via ExecuteQueued
 
Places a command in the given script's queue for execution via ExecuteQueued
Line 5: Line 7:
 
=== Parameters ===
 
=== Parameters ===
 
*char *ScriptName
 
*char *ScriptName
: Name of the script
+
:'''[in]''' Name of the script
 
*char *Command
 
*char *Command
: Command to queue
+
:'''[in]''' Command to queue
  
 
=== Return Value ===
 
=== Return Value ===
Line 14: Line 16:
  
 
== Examples ==
 
== Examples ==
 
+
*pISInterface->QueueCommand("test","echo hello");
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]

Latest revision as of 21:07, 2 September 2005

Syntax

  • bool QueueCommand(char *ScriptName, char *Command)

Purpose

Places a command in the given script's queue for execution via ExecuteQueued

Usage

Parameters

  • char *ScriptName
[in] Name of the script
  • char *Command
[in] Command to queue

Return Value

  • bool
Returns true if the function succeeded. The function will fail if the given script is not running

Examples

  • pISInterface->QueueCommand("test","echo hello");

See Also