Difference between revisions of "MQUNLINK()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
Line 4: Line 4:
  
 
==Syntax==
 
==Syntax==
MQUNLINK(<expN>)
+
MQUNLINK(<expC>)
  
  
Line 12: Line 12:
  
 
==Description==
 
==Description==
The MQCLOSE() function is used to close an open message queue.  The <expN> is the pointer to a queue opened with MQCREATE() or MQOPEN().  It returns .T. (true) if the queue is closed successfully.  If an error occurs and it is unable to close the queue, it returns .F. (false) and the ERRNO() function can be checked to determine the error.
+
The MQUNLINK() function is used to remove a message queue.  The <expC> is the name of the queue.  It returns .T. (true) if the queue is removed successfully.  If an error occurs and it is unable to remove the queue, it returns .F. (false) and the ERRNO() function can be checked to determine the error.
  
 
For more examples of handling message queues, please see the examples/mqueue programs in the software distribution.
 
For more examples of handling message queues, please see the examples/mqueue programs in the software distribution.
Line 31: Line 31:
 
     return
 
     return
 
endif
 
endif
 +
// close the queue
 
mqclose(mqdes)
 
mqclose(mqdes)
 +
// remove the queue
 +
rc = mqremove("/myqueue2")
 +
if (rc < 0)
 +
    messagebox(strerror()+",errno="+alltrim(str(error())))
 +
    return
 +
endif
 
</code>
 
</code>
  

Latest revision as of 10:36, 5 July 2011

Purpose

Function to remove a message queue


Syntax

MQUNLINK(<expC>)


See Also

MQCLOSE(), MQCREATE(), MQCURMSGS(), MQOPEN(), MQRECEIVE(), MQSEND(), XML_DECODE(), XML_ENCODE(), XML_GATHER(), XML_SCATTER()


Description

The MQUNLINK() function is used to remove a message queue. The <expC> is the name of the queue. It returns .T. (true) if the queue is removed successfully. If an error occurs and it is unable to remove the queue, it returns .F. (false) and the ERRNO() function can be checked to determine the error.

For more examples of handling message queues, please see the examples/mqueue programs in the software distribution.


Example

// Open up the queue for read/write access
mqdes=mqcreate("/myqueue2", 2)
if (mqdes < 0)
    messagebox(strerror()+",errno="+alltrim(str(error())))
    return
endif
// send a message to the queue
rc = mqsend(mqdes, "Test message")
if (rc < 0)
    messagebox(strerror()+",errno="+alltrim(str(error())))
    return
endif
// close the queue
mqclose(mqdes)
// remove the queue
rc = mqremove("/myqueue2")
if (rc < 0)
    messagebox(strerror()+",errno="+alltrim(str(error())))
    return
endif


Products

Recital, Recital Server