DeleteLocalString(object, string)

Deletes oObject's string variable sVarName.

void DeleteLocalString(
    object oObject,
    string sVarName
);

Parameters

oObject

The object storing the variable.

sVarName

Variable name to delete.


Description

Use this function to delete an object's entry for the string defined by sVarName.



Remarks

As with all deletions, once removed, GetLocalString returns "", a blank string. Cleaning up old variables can help CPU performance if many are stored on one object (especially a module).


Version

1.22

Example

// We delete the string stored on the PC under "PASSWORD" when they go into
// this trigger.
void main()
{
    // Declare the PC object
    object oPC = GetEnteringObject();
    // Delete the local string
    DeleteLocalString(oPC, "PASSWORD");
}

See Also

categories: Local Variables Functions


 author: Michael Nork, editor: Jasperre
 Send comments on this topic.