AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code

◆ DcppSpawnKickArg()

void DcppSpawnKickArg ( DitsTransIdType  transid,
SdsId id,
StatusType *  status 
)
extern

Create an argument structure used when kick actions which spawn.

Actions which spawn (allowing multiple actions of the same name) must be kicked by specifing an argument structure which allows the target task to determine which invocation of the action should be kicked.

This can be done by either specifing the action index (which the subsidary task can get using DitsGetActIndex()) as an argument named "KickByIndex" or anther task using the transaction id (as known by the parent action of this action), as wraped up in an argument by this call.

Note, arguments to the kick itself can be added to the argument created here, using standard ArgPut functions. Also, it is possible to change the transaction id in this structure using DcppSpawnKickArgUpdate().

The Dcpp versions of these functions allow the use of SdsId's to contain the SDS ID, but otherwise just invoked the Dits versions.

See also
DitsSpawnKickArg
DcppSpawnKickArgUpdate
Parameters
transidThe transaction id.
idThe SDS ID is returned here using SdsId::ShallowCopy (and hence deleting any old SDS ID stored here)
statusModified status.

Referenced by DcppTask::Obey(), DcppTask::Obey(), and DcppTask::ObeyForget().