PM_FREE_SET
Syntax
int_val = PM_FREE_SET( set );
- Input arguments
-
handle set The handle of the set.
Return Values
- Success:
-
int 0 Resources for a given set freed successfully.
- Failure:
-
int -1 Script interface error.
Description
This function frees resources allocated for a given set. Plant Modeller automatically frees resources allocated for sets when script terminates execution so these calls are voluntary.
PM_FREE_SET assigns a null value (data type = handle, value 0) to the set handle, when freed. Testing the value after PM_FREE_SET is done as described in A_FREE documentation.