restReqBodyGetString (Function)

 Top  Previous  Next

Architecture:

NX32L

Device support:

ALL

Firmware version:

2.10.00

This function will read a the body contents of a request as a string.

 

Input:

req : SYSHANDLE

A handle to the request.

 

 

Output:

str : STRING

The body content of the request as a string.

 

 

Returns: INT

1

- Success

0

- Not supported

-1

- Invalid request

-2

- The body is too large to fit in a string.

-20

- The body was larger than the maximum body size.

 

Declaration:

FUNCTION restReqBodyGetString : INT;
VAR_INPUT
  req            : SYSHANDLE;
  str            : ACCESS STRING;
END_VAR;

 

 

Example:

Please see the "Examples - REST Example"