Difference between revisions of "ISInterface:GetScriptCWD"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 +
== Syntax ==
 +
bool GetScriptCWD(char *ScriptName, char *buffer, unsigned long buflen)
 
== Purpose ==
 
== Purpose ==
 
Retrieves the current working directory for a given script
 
Retrieves the current working directory for a given script
Line 5: Line 7:
 
=== Parameters ===
 
=== Parameters ===
 
*char *ScriptName
 
*char *ScriptName
: Name of the script
+
:'''[in]''' Name of the script
 
*char *buffer
 
*char *buffer
: Buffer to place the path in
+
:'''[out]''' Buffer to place the path in
 
*unsigned long buflen
 
*unsigned long buflen
: Size of the buffer
+
:'''[in]''' Size of the buffer
  
 
=== Return Value ===
 
=== Return Value ===

Latest revision as of 21:03, 2 September 2005

Syntax

bool GetScriptCWD(char *ScriptName, char *buffer, unsigned long buflen)

Purpose

Retrieves the current working directory for a given script

Usage

Parameters

  • char *ScriptName
[in] Name of the script
  • char *buffer
[out] Buffer to place the path in
  • unsigned long buflen
[in] Size of the buffer

Return Value

  • bool
Returns true if the function succeeded. The function will fail if the specified script does not exist

Examples

See Also