INtime SDK Help
DeleteRtRegion
INtime SDK v7 > About INtime > INtime Kernel > Regions > DeleteRtRegion

Deletes a region object.

BOOLEAN DeleteRtRegion(
    RTHANDLE hRegion
);

Parameters

hRegion
RT handle for the region to delete.

Remarks

If a thread with access to the region tries to delete the region, the thread receives an E_CONTEXT status code. If a thread requests deletion while another thread has access, deletion does not occur until access is surrendered.

A deadlock can occur when two or more threads request deletion of a region that another thread has access to, or when a thread tries to delete another thread that is trying to delete an occupied region. When the region is deleted, any waiting threads awaken with an E_EXIST exceptional condition.

Return Values

TRUE
Success.
FALSE
Failure. To determine the status, call GetLastRtError.

Status

E_OK 0x0000
No exceptional conditions occurred.
E_CONTEXT 0x0005
The deletion request originates from a thread that currently has access to data protected by the region.
E_EXIST 0x0006
You used an invalid value for hRegion.
E_TYPE 0x8002
hRegion is not a region handle.

Requirements

Versions Defined in Include Link to
INtime 3.0 intime/rt/include/rtbase.h rt.h rt.lib

See Also

Region system calls,