Return Parameters
This function returns a data string, length, and a return code.
- Data String:
- A string containing data from the identified field in the host
presentation space. The first byte in the returned data string is
the beginning byte of the identified field in the host presentation
space. The number of bytes in the returned data string is determined
by the smaller of:
- Number of bytes specified in the calling length parameter
- Number of bytes in the identified field in the host presentation space
- Length:
- The length of the data returned.
- Return Code:
- The following codes are defined:
| Return Code | Explanation |
|---|---|
| 0 | The Copy Field to String function was successful. |
| 1 | Your program is not connected to a host session. |
| 2 | An error was made in specifying parameters. |
| 6 | The data to be copied and the target field are not the same size. The data is truncated if the string length is smaller than the field copied. |
| 7 | The host presentation space position is not valid. |
| 9 | A system error was encountered. |
| 24 | Unformatted host presentation space. |