Difference between revisions of "ISInterface:RemoveTopLevelObject"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 +
==Syntax==
 +
*bool RemoveTopLevelObject(char *Name)
 +
 
== Purpose ==
 
== Purpose ==
 
+
To remove [[LavishScript:Top-Level_Objects|Top-Level_Objects]]
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 +
*char *Name
 +
:'''[in]''' Name of the TLO to remove
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
 +
;Example code
 +
void ISXTest::RegisterTopLevelObjects()
 +
{
 +
    pISInterface->AddTopLevelObject("ISXTest",TLO_ISXTest);
 +
}
 +
void ISXTest::UnRegisterTopLevelObjects()
 +
{
 +
    pISInterface->RemoveTopLevelObject("ISXTest");
 +
}
 +
bool __cdecl TLO_ISXTest(int argc, char *argv[], LSTYPEVAR &Dest)
 +
{
 +
    Dest.Ptr="Hello World";
 +
    Dest.Type=pStringType;
 +
 +
    return true;
 +
}
  
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 
+
* [[ISInterface:AddTopLevelObject|AddTopLevelObject]]
 +
* [[LavishScript:Top-Level_Objects|Top-Level_Objects]]
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Latest revision as of 01:18, 2 September 2005

Syntax

  • bool RemoveTopLevelObject(char *Name)

Purpose

To remove Top-Level_Objects

Usage

Parameters

  • char *Name
[in] Name of the TLO to remove

Return Value

  • bool
Returns true on success, false on failure

Examples

Example code
void ISXTest::RegisterTopLevelObjects()
{
    pISInterface->AddTopLevelObject("ISXTest",TLO_ISXTest);
}
void ISXTest::UnRegisterTopLevelObjects()
{
   pISInterface->RemoveTopLevelObject("ISXTest");
}
bool __cdecl TLO_ISXTest(int argc, char *argv[], LSTYPEVAR &Dest)
{
   Dest.Ptr="Hello World";
   Dest.Type=pStringType;

   return true;
}

See Also