MQCloseCursor
This function closes a specific cursor, allowing Message Queuing (MSMQ) to release the associated resources.
HRESULT APIENTRY MQCloseCursor(
HANDLE hCursor
);
Parameters
- hCursor
[in] Handle to the cursor you want to close.
Return Values
- MQ_OK
Indicates success. - MQ_ERROR_INVALID_HANDLE
The cursor handle specified in hCursor is not valid.
Remarks
Typically, cursors are closed by calling MQCloseCursor. However, MSMQ automatically closes any cursor created for a given queue when that queue is closed. MQCloseCursor returns MQ_ERROR_INVALID_HANDLE when an attempt is made to close a cursor that has already been closed by MSMQ.
To create a cursor, call MQCreateCursor.
Requirements
| Runs on | Versions | Defined in | Include | Link to |
|---|---|---|---|---|
| Windows CE OS | 2.0 and later. Versions prior to 2.12 require the MSMQ add-on pack. | Mq.h | Mq.h | Msmqrt.lib |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.