Difference between revisions of "ISInterface:IsTopLevelObject"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
Line 1: Line 1:
 
 
===Syntax===
 
===Syntax===
 
+
*bool IsTopLevelObject(char *Name)
 
== Purpose ==
 
== Purpose ==
 
+
Check to see if '''Name''' is a TopLevelObject
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*char *Name
 +
:'''[in]''' Name to check
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true if it is a TopLevelObject, false if it is not
 
== Examples ==
 
== Examples ==
 
+
;Example code
 +
if (pISInterface->IsTopLevelObject("If"))
 +
  {
 +
    pISInterface->ExecuteCommand("echo hi");
 +
  }
  
 
== See Also ==
 
== See Also ==

Latest revision as of 02:01, 2 September 2005

Syntax

  • bool IsTopLevelObject(char *Name)

Purpose

Check to see if Name is a TopLevelObject

Usage

Parameters

  • char *Name
[in] Name to check

Return Value

  • bool
Returns true if it is a TopLevelObject, false if it is not

Examples

Example code
if (pISInterface->IsTopLevelObject("If"))
 {
    pISInterface->ExecuteCommand("echo hi");
 }

See Also