pmGetWakeSourceString (Function)

 
This function is used to get a textural description of the return code from pmSuspend.

This is meant to use for debugging and the text may change without notice.

A typical use case would be to pass the string on to debugMsg, to log especially unhandled return codes.

Input:

Source : DINT

The return code from pmSuspend.

Returns: STRING

A string with a description of the wake-up source or the error.

Declaration:

FUNCTION pmGetWakeSourceString : STRING;
VAR_INPUT
   source : DINT;
END_VAR;

Example:

 
   ...
      wk := pmSuspend(time:=600, mode := 0);
      // Parse return code
      DebugFmt(message:=pmGetWakeSourceString(source := wk));
   ...