Difference between revisions of "MQCURMSGS()"
From Recital Documentation Wiki
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (5 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==Purpose== | |
| + | Return the number of unread messages in the specified queue | ||
| + | |||
| + | |||
| + | ==Syntax== | ||
| + | MQCURMSGS(<expN>) | ||
| + | |||
| + | |||
| + | ==See Also== | ||
| + | [[MQCLOSE()]], [[MQCREATE()]], [[MQOPEN()]], [[MQRECEIVE()]], [[MQSEND()]], [[MQUNLINK()]], [[XML_DECODE()]], [[XML_ENCODE()]], [[XML_GATHER()]], [[XML_SCATTER()]] | ||
| + | |||
| + | |||
| + | ==Description== | ||
| + | The MQCURMSGS() function returns the current number of unread messages in the open queue specified by <expN>. The <expN> is the pointer to a queue opened with MQCREATE() or MQOPEN(). | ||
| + | |||
| + | The MQCLOSE() function is used to close a queue which has been opened with MQOPEN() or MQCREATE(). | ||
| + | |||
| + | For more examples of handling message queues, please see the examples/mqueue programs in the software distribution. | ||
| + | |||
| + | |||
| + | ==Example== | ||
| + | <code lang="recital"> | ||
| + | // Open up the queue for reading | ||
| + | mqdes=mqopen("/myqueue") | ||
| + | if (mqdes < 0) | ||
| + | messagebox(strerror()+",errno="+alltrim(str(error()))) | ||
| + | return | ||
| + | endif | ||
| + | // do while there are messages | ||
| + | do while (mqcurmsgs(mqdes) > 0) | ||
| + | // Get each message | ||
| + | mstr=mqreceive(mqdes) | ||
| + | if (empty(mstr)) | ||
| + | messagebox(strerror()+",errno="+alltrim(str(error()))) | ||
| + | return | ||
| + | endif | ||
| + | messagebox(mstr) | ||
| + | enddo | ||
| + | mqclose(mqdes) | ||
| + | </code> | ||
| + | |||
| + | |||
| + | ==Products== | ||
| + | Recital, Recital Server | ||
| + | [[Category:Documentation]] | ||
| + | [[Category:Functions]] | ||
| + | [[Category:Messaging]] | ||
| + | [[Category:Messaging Functions]] | ||
Latest revision as of 10:09, 5 July 2011
Purpose
Return the number of unread messages in the specified queue
Syntax
MQCURMSGS(<expN>)
See Also
MQCLOSE(), MQCREATE(), MQOPEN(), MQRECEIVE(), MQSEND(), MQUNLINK(), XML_DECODE(), XML_ENCODE(), XML_GATHER(), XML_SCATTER()
Description
The MQCURMSGS() function returns the current number of unread messages in the open queue specified by <expN>. The <expN> is the pointer to a queue opened with MQCREATE() or MQOPEN().
The MQCLOSE() function is used to close a queue which has been opened with MQOPEN() or MQCREATE().
For more examples of handling message queues, please see the examples/mqueue programs in the software distribution.
Example
// Open up the queue for reading mqdes=mqopen("/myqueue") if (mqdes < 0) messagebox(strerror()+",errno="+alltrim(str(error()))) return endif // do while there are messages do while (mqcurmsgs(mqdes) > 0) // Get each message mstr=mqreceive(mqdes) if (empty(mstr)) messagebox(strerror()+",errno="+alltrim(str(error()))) return endif messagebox(mstr) enddo mqclose(mqdes)
Products
Recital, Recital Server
