GetPayload
Syntax
METHOD GetPayload : BOOL
VAR_INPUT
pPayload : PVOID; // payload buffer
nPayloadSize : UDINT; // maximum size of payload buffer in bytes
bSetNullTermination: BOOL; // The publisher specifies the kind of payload. If it is a string, it could be null terminated or not. Setting this input to TRUE will force a null termination. One more byte is required for that.
END_VAR
Rückgabewert
Name | Typ | Beschreibung |
|---|---|---|
GetPayload | BOOL |
|
Eingänge
Name | Typ | Beschreibung |
|---|---|---|
pPayload | PVOID | Hier wird die Speicheradresse des Puffers, in den das Payload kopiert werden soll angegeben. |
nPayloadSize | UDINT | Hier wird die maximal zur Verfügung stehende Größe in Bytes des Puffers angegeben. |
bSetNullTermination | BOOL | Erfordert die Art des Payloads eine Null-Terminierung (String), so kann diese hiermit beim Kopiervorgang vorgenommen werden. Hat die Quelle der Nachricht (Publisher) bereits eine Null-Terminierung vorgenommen und diese in der Größenangebe des Payloads berücksichtigt, so ist dies nicht notwendig. Oft bestehen hierzu jedoch keine verlässlichen Informationen. |