Return Parameters
This function returns a data string and a return code.
- Data String:
- If A (asynchronous) is specified in position 5 (2 for standard interface) and the function is completed successfully, the following data string is returned:
| Byte | Definition | |
|---|---|---|
| 9–10 | 13–14 | 2-byte Function Request ID. It is used by the Get Request Completion (125) function to determine the completion of this function call. |
| 15–16 | Reserved. | |
| 17–20 | 4-byte value in which the event object address is returned by EHLLAPI. The application can wait for this event object. When the event object is cleared, the application must issue the Get Request Completion (125) function call to get results of the Write Structured Fields request. (32-bit only). | |
Note: An event object is returned for each successful asynchronous
request. The event object should not be used again. A new event object
is returned for each request and is valid for only the duration of
that request.
- Data String:
- If M (asynchronous message mode) is specified in position 5 (2 for standard interface) and the function is completed successfully, the following data string is returned:
| Byte | Definition | |
|---|---|---|
| 9–10 | 13–14 | 2-byte Function Request ID. It is used by the Get Request Completion (125) function to determine the completion of this function call. |
| 15–16 | Reserved. | |
| 11–12 | 17–18 | Task ID of asynchronous message mode. |
| 19–20 | Reserved. | |
Note: If the function is completed successfully, an application
window receive a message. The message is a return value of RegisterWindowMessage
(PCSHLL). The wParam parameter contains the Task ID returned by the
function call. HIWORD of lParam parameter contains return code 0,
which shows the function was successful, and LOWORD of lParam parameter
contains function number 127.
- Return Code:
- The following codes are defined:
| Return Code | Explanation |
|---|---|
| 0 | The Write Structured Fields function was successful. |
| 1 | A specified host presentation space short session ID was not valid or was not connected. |
| 2 | An error was made in specifying parameters. |
| 9 | A system error occurred. |
| 11 | Resource unavailable (memory unavailable). |
| 34 | The message sent inbound to the host was canceled. |
| 35 | An outbound transmission from the host was canceled. |
| 36 | Request rejected. Lost contact with the host. |
| 37 | Failed. The host is inbound disabled. |