MSMQQueueInfo.Refresh (Compact 2013)
3/26/2014
This method refreshes the property values of the MSMQQueueInfo object. These values are retrieved from the directory service, which are public queues, or from the local computer, which are private queues.
Syntax
HRESULT Refresh(void);
Parameters
None.
Return Value
The following table describes the common return values.
Value |
Description |
|---|---|
S_OK |
Success |
E_INVALIDARG |
One or more arguments are invalid |
E_NOTIMPL |
The function contains no implementation |
E_OUTOFMEMORY |
Out of memory |
Remarks
All queue properties can be retrieved. However, you can only retrieve the properties of private queues if they are located on your local computer.
Refresh is typically used when more than one user is using the queue. For example, if user 1 locates the queue and then user 2 modifies the queue's properties, user 1 needs to call Refresh to sync up with user 2's changes.
After a queue is created, the properties of the MSMQQueueInfo object are not updated until Refresh is explicitly called, or the queue is closed and reopened.
For example, even though Message Queuing sets MSMQQueueInfo.CreateTime, MSMQQueueInfo.ModifyTime, or MSMQQueueInfo.QueueGuid when it creates the queue, the application must call Refresh to update the properties of the MSMQQueueInfo object before it can read those properties.
Equivalent Function
To retrieve the properties of a queue using function calls, see the MQGetQueueProperties function.
Requirements
Header |
mqoai.h |
Library |
mqoa.lib |