Difference between revisions of "ISInterface:RemoveAlias"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 6: Line 6:
 
=== Parameters ===
 
=== Parameters ===
 
*char *Replace
 
*char *Replace
:Name of the alias to remove
+
:'''[in]'''Name of the alias to remove
 
=== Return Value ===
 
=== Return Value ===
 
Returns true on success, false on failure
 
Returns true on success, false on failure

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");
}

See Also