◆ SetReturnArg() [1/2]

void drama::MessageHandler::SetReturnArg	(	const sds::Id &	arg,
		bool	copy = `true`
	)

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.

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.
copy	If true, then the SDS structure is copied. If false, then no copy is made, but the user must ensure underlying SDS ID is NOT deleted until after the action has completed (For example, it is not deleted until the next DRAMA message is processed. This is more efficient for large messages but imposes management overheads on user code which must ensure the item outlives the completion of the action.