This function returns a data string and a return code.
- Data String:
- If asynchronous message mode is not specified in position 5
(6 for standard interface) and the function is completed successfully,
the following data string is returned.
| Byte |
Definition |
| Standard |
Enhanced |
|
| 1 |
1 |
A 1-character presentation space
short name (PSID). |
| 2–8 |
Reserved. |
| 9–12 |
4 byte value in which the event object
address is returned by EHLLAPI. The application can wait for this event
object. (32-bit only). |
- Data String:
- If M (asynchronous message mode) is specified in position 5
(6 for standard interface) and the function is completed successfully,
the following data string is returned.
| Byte |
Definition |
| Standard |
Enhanced |
|
| 1 |
1 |
A 1-character presentation space
short name (PSID) |
| 2–8 |
Reserved |
| 2–3 |
9–10 |
Task ID of asynchronous message mode |
Note: If a user selects the close option, an application
window receives a message. The message is a return value of RegisterWindowMessage
(PCSHLL). The wParam parameter will contain the Task ID returned by
this function call. The HIWORD of the lParam parameter will contain
the Return Code 26, which shows a close intercept occurred, and the
LOWORD of the lParam parameter will contain the function number 41.
- Return Code:
- The following codes are defined:
| Return Code |
Explanation |
| 0 |
The Start Close
Intercept function was successful. |
| 1 |
An incorrect host presentation space
was specified. |
| 2 |
A parameter error occurred. |
| 9 |
A system error occurred. |
| 10 |
The function is not supported by
the emulation program. |