Legacy Document

Inside Macintosh: QuickDraw GX Environment and Utilities /

Chapter 6 - Message Manager / Message Manager Reference

Functions / Sending and Forwarding Messages

ForwardThisMessage

You can use the ForwardThisMessage function to forward the current message to the next message handler.

OSErr ForwardThisMessage (...);

parameters

Parameters associated with the message sent.

function result

An error of type OSErr.

DESCRIPTION

The ForwardThisMessage function explicitly inherits the current message by forwarding it to the next handler in the message class of the current message target. By definition, all message overrides return a function result of type OSErr.

The OSErr error returned may indicate that the message could not be forwarded. If no error occurs, the function result is noErr. In addition, the receiving message handler may return a result of type OSErr.

The ellipsis character in the parameter list indicates that the parameters are unspecified; the caller must pass whatever parameters are expected by the recipient of the message. It is an error to call the ForwardThisMessage function except from within a message handler. In any other case, behavior is undefined.

SEE ALSO

To send a specified message to the current message target, use the SendMessage function described on page 6-23.

To forward a specified message to the next message handler, use the ForwardMessage function described in the previous section.

The use of the ForwardThisMessage function is described in the section "Sending and Forwarding Messages" beginning on page 6-15.