sosObjectDelete (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

All

Firmware version:

1.00.00


sosObjectDelete will delete the objects that matches the specified key.

 

Input:

key : STRING

The key for the object to delete. The wildcards ? and * are supported.

 

Returns: INT

0

- The object is deleted or did not exist.

-1

- Generic error.

 

 

Declaration:

FUNCTION sosObjectDelete : INT;
VAR_INPUT
  key  : STRING;
END_VAR;

 

 

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
 
BEGIN
  ...
  // Delete the object with the key "config.password"
  sosObjectDelete(key := "config.password");
  ...
END;
 
END_PROGRAM;