TerminateMessage function
Terminate the specified request
Function:
bool UAPI TerminateMessage(
int hMessage
);
Parameters:
- hMessage [in]:Request handle
Return value:
- Type:BOOL
- Text:Returns TRUE on success, FALSE on failure, FALSE on failure of function
Remarks:
Instead of using the TerminateMessage function to force termination of a specified request, you should normally allow the request method handler function normally return to exit the current request
TerminateMessage function for asynchronous operation, the operation does not mean that will be processed immediately
Terminating a request using the TerminateMessage function is not always safe unless TerminateMessage function is not required
- TerminateMessage function If executed successfully, the specified request will be forcibly terminated and the SOCKET kernel object associated with it will be forcibly closed. The request handle associated with it will not be able to complete the relevant operation, when used again with the kernel object request handle will cause the function to fail
- If you just need to close the current request should use DestroyMessage function instead of TerminateMessage function
- TerminateMessage function does not make its handle is closed, you should use the CloseMessage function to automatically shut down or return to the system automatically shut down
- If a network I / O operation is taking place on a SOCKET core object with which the request is associated when using the TerminateMessage function, the target operation will be forcibly stopped
Requirements:
| Keyword | Value |
|---|---|
| Minimum Agine Version | 171012.1 |
| Minimum SDK Version | 171012.1 |
| Header File | h.message |
| Library Server | kext |