Deletes a port object. If any threads are in the port's receive thread queue at deletion time, they are awakened with an E_EXIST exceptional condition. Deleting the port counts toward the object limit for the containing process. Any messages queued at the port are discarded and, if the port is forwarded, forwarding is severed.

Deleting a sink port automatically detaches it from its source port.

BOOLEAN DeleteRtPort(
    RTHANDLE hPort   // a port handle 
);

Parameters

hPort

A handle for the port to be deleted.

Return Values

TRUE

Success.

FALSE

Failure. To determine the status, call GetLastRtError.

Status

E_OK 0x0000

No exceptional conditions occurred.

E_EXIST 0x0006

The port is already being deleted.

E_TYPE 0x8002

The handle supplied is not for a port object.

Note:   Other status values may be generated by the service-specific DeletePort handler.

Requirements

See Also

Port system calls, DeletePort