Difference between revisions of "ISInterface:RemoveAlias"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | ==Syntax== | ||
| + | *bool RemoveAlias(char *Replace) | ||
== Purpose == | == Purpose == | ||
| − | + | Remove an [[LavishScript:Aliases|Alias]] created with [[ISInterface:AddAlias|AddAlias]] | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| + | *char *Replace | ||
| + | :'''[in]'''Name of the alias to remove | ||
=== Return Value === | === Return Value === | ||
| − | + | Returns true on success, false on failure | |
== Examples == | == Examples == | ||
| − | + | ;Example code | |
| + | void ISXTest::RegisterAliases() | ||
| + | { | ||
| + | pISInterface->AddAlias("Hi","echo Hi bob! How was work? What are you going to do tonight?"); | ||
| + | pISInterface->AddAlias("pipforegroundsize","WindowSize -rescale -viewable ${Display.Width}x${Display.Height}"); | ||
| + | } | ||
| + | void ISXTest::UnRegisterAliases() | ||
| + | { | ||
| + | pISInterface->RemoveAlias("Hi"); | ||
| + | pISInterface->RemoveAlias("pipforegroundsize"); | ||
| + | } | ||
== See Also == | == See Also == | ||
* [[ISXDK:ISInterface|ISInterface]] | * [[ISXDK:ISInterface|ISInterface]] | ||
| + | * [[ISInterface:AddAlias|AddAlias]] | ||
| + | * [[LavishScript:Aliases|Aliases]] | ||
[[Category:ISXDK]] | [[Category:ISXDK]] | ||
[[Category:ISInterface]] | [[Category:ISInterface]] | ||
Latest revision as of 01:10, 2 September 2005
Syntax
- bool RemoveAlias(char *Replace)
Purpose
Remove an Alias created with AddAlias
Usage
Parameters
- char *Replace
- [in]Name of the alias to remove
Return Value
Returns true on success, false on failure
Examples
- Example code
void ISXTest::RegisterAliases()
{
pISInterface->AddAlias("Hi","echo Hi bob! How was work? What are you going to do tonight?");
pISInterface->AddAlias("pipforegroundsize","WindowSize -rescale -viewable ${Display.Width}x${Display.Height}");
}
void ISXTest::UnRegisterAliases()
{
pISInterface->RemoveAlias("Hi");
pISInterface->RemoveAlias("pipforegroundsize");
}
