PM_OVERLAY_REMOVE_ENTITY

Syntax

int_val = PM_OVERLAY_REMOVE_ENTITY ( overlay_handle, entity_handle );
Input arguments
handle overlay_handle Handle of the overlay context from which to remove an entity.
handle entity_handle Handle of the entity to be removed.

Return Values

Success:
int 0 Removing the entity succeeded.
Failure:
int -1 Script interface error.

Description

This function removes a given overlay entity from an overlay context. The overlay context must first be opened with PM_OVERLAY_OPEN(overlay_handle).

Example

%PMS_HOME%\pm\macro\Examples\PM_OVERLAY_DEMO.mac