AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ COut()

virtual SdsIdType drama::sds::Id::COut ( const bool  outlives,
bool *const  free = 0,
bool *const  del = 0,
bool *const  readfree = 0 
)
inlinevirtual

Return this item as an SdsIdType for return to C code.

This method will setup for and obtain details of this item for return of this item using an SdsIdType. Of particular note - if outlives is true, the SdsIdType item returned by this is considered to outlive this object and we leave the freeing of the id etc up to the caller, who can use the other variables to work out what to do. If outlives is false, can method be used as an inquiry for what is to happen when the destructor is invoked.

Parameters
outlivesIf true, then the returned value will outlive this object and this object is modified to reflect this.
freeIf specified, set true to indicate that the destructor for this object would have invoked SdsFreeId() on the underlying SDS ID. If outlives is true, this won't now happen.
delIf specified, set true to indicate that the destructor for this object would have invoked SdsDelete() on the underlying SDS ID.
If outlives is true, this won't now happen.
readfreeIf specified, set true to indicate that the destructor for this object would have invoked SdsReadFree() on the underlying SDS ID. If outlives is true, this won't now happen.
Returns
The underlying SDS ID value.

References drama::CreateRunDramaTask().

Referenced by drama::MessageHandler::SetReturnArg().