SetReturnArg() [2/2]

void drama::MessageHandler::SetReturnArg ( sds::Id *  arg )

inlineinherited

Set the argument to be sent as part of the action completion message.

This is only sent if the action completes returning a request code of drama::RequestCode::End or drama::RequestCode::Exit.

This version of SetReturnArg() is to be used in cases where the user does not want the argument copied, but wants DRAMA to deal with tidying it up. The drama::sds::Id::COut(true) is invoked on the argument and DRAMA will take control of tidying it up.

Note

Only valid if invoked in the contact of MessageReceived() being invoked for an Obey or Kick message.

Parameters

arg	The SDS ID of the structure to be sent with the completion message.

References drama::sds::Id::COut(), drama::CreateRunDramaTask(), and DramaTHROW.