CloneMessage (FUN)¶

FUNCTION CloneMessage : CAA.HANDLE

This function duplicates an existing message. This duplicated message may be modified and sent via Write for example.

Example

VAR
  hReceiver : CAA.HANDLE;
  hMsg : CAA.HANDLE;
  hMsgCloned : CAA.HANDLE;
  ctMsgLeft : CAA.COUNT;
  eError : CL2.ERROR;
END_VAR

//receive a message from hReceiver
hMsg := CL2.Read(hReceiverId := hReceiver, pctMsgLeft := ADR(ctMsgLeft), peError := ADR(eError));

IF hMsg <> CAA.gc_hINVALID THEN
  //Clone received message
  hMsgCloned := CL2.CloneMessage(hMessage := hMsg, peError := ADR(eError));

  //free original message
  CL2.FreeMessage(hMessage := hMsg);
  hMsg := CAA.gc_hINVALID;

  //work with hMsgCloned...
END_IF

InOut:

Scope	Name	Type	Comment
Return	`CloneMessage`	`CAA.HANDLE`	cloned message handle
Input	`hMessage`	`CAA.HANDLE`	handle of message to clone
Input	`peError`	POINTER TO ERROR	optional pointer to error enum