MSMQQueueInfo.Update (Compact 2013)

3/26/2014

This method updates the directory service, the public queues, or the local computer, the private queues, with the current property values of the MSMQQueueInfo object.

Syntax

HRESULT Update(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

The MSMQQueueInfo.Update method can update the property values of existing public and local private queues. It cannot be called on an MSMQQueueInfo object before the queue is created or after the queue is deleted.

Message Queuing updates queue property values in these circumstances:

• When a queue is created.
• When a queue is opened.
• When MSMQQueueInfo.Update is explicitly called.

Calling MSMQQueueInfo.Update

When MSMQQueueInfo.Update is called, the local queue property values of the MSMQQueueInfo object are stored in one of two places:

• For public queues, these property values are stored in the directory service.
• For private queues, these property values are stored on the local computer.

Queue Properties that cannot be Updated

The MSMQQueueInfo.Update method cannot update the following queue properties.

• MSMQQueueInfo.BasePriority 
  This property cannot be updated for private queues.
• MSMQQueueInfo.CreateTime 
  This property is set by Message Queuing.
• MSMQQueueInfo.ModifyTime 
  This property is set by Message Queuing.
• MSMQQueueInfo.PathName 
  This property is set only when the queue is created.
• MSMQQueueInfo.QueueGuid 
  This property is set by Message Queuing.

Propagation Delays

When setting the properties of a public queue, some clients might still see the old settings registered in the directory service after the properties are changed.

Changes to the directory service (such as setting properties) are propagated from domain controller to domain controller, which can cause delays in the availability of new information.

Consequently, clients using a specific domain controller might still see the old property settings, even though the settings of the properties were changed by Update.

Propagation delays, including communication network delays such as down links, are controlled by the MSMQ Administrator.

Equivalent Function

To set the properties of a queue using function calls, see the MQSetQueueProperties function.

Requirements

Header	mqoai.h
Library	mqoa.lib

See Also

Reference

MSMQQueueInfo