Difference between revisions of "ISInterface:GetScriptCWD"
Jump to navigation
Jump to search
| (2 intermediate revisions by 2 users not shown) | |||
| 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 | ||
== Usage == | == Usage == | ||
=== Parameters === | === 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 === | === Return Value === | ||
| + | *bool | ||
| + | : Returns true if the function succeeded. The function will fail if the specified script does not exist | ||
== Examples == | == Examples == | ||
| Line 9: | Line 21: | ||
== See Also == | == See Also == | ||
* [[ISXDK:ISInterface|ISInterface]] | * [[ISXDK:ISInterface|ISInterface]] | ||
| − | + | * [[ISInterface:GetCWD|GetCWD]] | |
| + | * [[ISInterface:SetRoot|SetRoot]] | ||
[[Category:ISXDK]] | [[Category:ISXDK]] | ||
[[Category:ISInterface]] | [[Category:ISInterface]] | ||
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
