DeleteObject (System subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (copied content from PDF and updated to be system only)
(Automatically generated page update)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:System:DeleteObject subtitle}}
{{Template:System:DeleteObject subtitle}}
<var>DeleteObject</var> is a shared method that deletes a specified <var>[[System_class#System-wide_objects|system-wide]]</var> object.
<var>DeleteObject</var> is a shared method that deletes a specified [[System_class#System-wide_objects|"system-wide object"]].


==Syntax==
==Syntax==
Line 6: Line 6:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%(System)</th>
<tr><th><var class="nobr">%(System)</var></th>
<td>The class name in parentheses denotes a shared method. <var>DeleteObject</var> can also be invoked via a <var>[[System_class|System]]</var> object variable, which may be null.</td></tr>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>DeleteObject</var> can also be invoked via a <var>[[System_class|System]]</var> object variable, which may be <var>null</var>.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td>The string ID of the system-wide object to be deleted.</td></tr>
<td>The string ID of the system-wide object to be deleted.</td></tr>
Line 14: Line 14:
==Usage notes==
==Usage notes==
<ul><li>All errors result in request cancellation.
<ul><li>All errors result in request cancellation.
<li><var>DeleteObject</var> is available from <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version  6.7,
</ul>
</ul>



Latest revision as of 00:26, 16 February 2014

Delete a system-wide object (System class)

DeleteObject is a shared method that deletes a specified "system-wide object".

Syntax

%(System):DeleteObject( string)

Syntax terms

%(System) The class name in parentheses denotes a shared method. DeleteObject can also be invoked via a System object variable, which may be null.
string The string ID of the system-wide object to be deleted.

Usage notes

  • All errors result in request cancellation.

Examples

See also