INtime SDK Help
CancelRtTransaction
INtime SDK v6 > About INtime > INtime Kernel > Ports > CancelRtTransaction

From INtime 6.0 the INtime Service and Port objects have been deprecated.

New projects should not be started using these features, and existing projects will not work with XM mode. You will receive a compiler warning by default if you use these calls.

Performs synchronous cancellation of RSVP message transmission.

If a SendRtMessage or SendRtReply operation is canceled, then it must have returned a valid transaction ID, supplied as a parameter to cancel.

If cancellation of a SendRtMessageRSVP is successful, the reply buffer, if used, is disassociated from the port. Cancellation of a SendRtMessageRSVP operation is possible after the original request message transmission is complete and before a response message is received.

BOOLEAN CancelRtTransaction(
    RTHANDLE hPort,  
    WORD wTransID    
);

Parameters

hPort
A handle for the port.
wTransID
The transaction ID of the message to be canceled.

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_TRANS_ID 0x00E8
The wTransId parameter is not valid.
E_TYPE 0x8002
The handle supplied is not for a port object.
Note:   Other status values may be generated by the service-specific CancelTransaction handler.

Requirements

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