Difference between revisions of "ISInterface:ResolveCommand"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | |||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool ResolveCommand(char *Text, char *buf,unsigned long buflen) | |
== Purpose == | == Purpose == | ||
| − | + | To find the command closest to given '''Text'''. | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *char *Text | |
| + | :'''[in]''' Text given to try to find a command | ||
| + | *char *buf | ||
| + | :'''[out]''' The result of the closest command found, or false if it can't find any | ||
| + | *unsigned long buflen | ||
| + | :'''[in]''' Length of the buffer | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | *pISInterface->ResolveCommand("z",result,sizeof(result)); | |
| + | :This would return false as there are no commands starting with z | ||
| + | *pISInterface->ResolveCommand("d",result,sizeof(result)); | ||
| + | :This would resolve into result being 'DeclareVariable' | ||
== See Also == | == See Also == | ||
Latest revision as of 20:18, 2 September 2005
Syntax
- bool ResolveCommand(char *Text, char *buf,unsigned long buflen)
Purpose
To find the command closest to given Text.
Usage
Parameters
- char *Text
- [in] Text given to try to find a command
- char *buf
- [out] The result of the closest command found, or false if it can't find any
- unsigned long buflen
- [in] Length of the buffer
Return Value
- bool
- Returns true on success, false on failure
Examples
- pISInterface->ResolveCommand("z",result,sizeof(result));
- This would return false as there are no commands starting with z
- pISInterface->ResolveCommand("d",result,sizeof(result));
- This would resolve into result being 'DeclareVariable'
