MSMQQueueInfo (Compact 2013)

  • Article

3/26/2014

The MSMQQueueInfo object provides queue management for a single queue. It provides methods for the following:

  • Creating a queue (transactional or nontransactional)
  • Opening a queue
  • Changing the properties of a queue
  • Deleting a queue

MSMQQueueInfo objects are returned by a query or are created by the sending or receiving application.

There is a one-to-one relationship between each MSMQQueueInfo object and the queue it represents.

There is a one-to-many relationship between the MSMQQueueInfo object of the queue and the MSMQQueue objects that represent open instances of the queue.

Methods

The following table lists the methods of the MSMQQueueInfo object.

Method

Description

MSMQQueueInfo.Create

Creates a queue based on the queue properties of the MSMQQueueInfo object.

MSMQQueueInfo.Delete

Deletes an existing queue.

MSMQQueueInfo.Open

Opens a queue, returning an MSMQQueue object.

MSMQQueueInfo.Refresh

Refreshes the property values of the MSMQQueueInfo object with the values stored in the directory service (for public queues) or the local computer (for private queues).

MSMQQueueInfo.Update

Updates the directory service or the local computer with the current property values of the MSMQQueueInfo object.

Properties

The following table lists the properties of the MSMQQueueInfo object.

Property

Description

MSMQQueueInfo.Authenticate 

Access: Read/write

Data type: Long

Specifies whether the queue accepts only authenticated messages.

MSMQQueueInfo.BasePriority 

Access: Read/write

Data type: Long

Specifies a base priority for all messages sent to a public queue.

MSMQQueueInfo.CreateTime 

Access: Read-only

Data type: Date Variant

(Read-only, introduced in MSMQ 2.0 for private queues.) Provides the time and date when the public or private queue was created.

MSMQQueueInfo.FormatName 

Access: Read/write

Data type: String

Specifies the format name of the queue.

MSMQQueueInfo.IsTransactional 

Access: Read-only

Data type: Short

Indicates whether the queue supports transactions.

MSMQQueueInfo.IsWorldReadable 

Access: Read-only

Data type: Short

Indicates whether everyone can read the messages in the queue.

MSMQQueueInfo.Journal 

Access: Read/write

Data type: Long

Specifies whether or not messages retrieved from the queue are stored in a queue journal.

MSMQQueueInfo.JournalQuota 

Access: Read/write

Data type: Long

Specifies the maximum size of the queue journal.

MSMQQueueInfo.Label 

Access: Read/write

Data type: String

Specifies a description of the queue or message.

MSMQQueueInfo.ModifyTime 

Access: Read-only

Data type: Date Variant

(Read-only, introduce in MSMQ 2.0 for private queues.) Provides the time and date when the stored properties of the queue were last updated.

MSMQQueueInfo.PathName 

Access: Read/write

Data type: String

Specifies the Message Queuing pathname of the queue.

MSMQQueueInfo.PrivLevel 

Access: Read/write

Data type: Long

Specifies the privacy level of a queue or message.

MSMQQueueInfo.QueueGuid 

Access: Read-only

Data type: GUID

(Read-only.) Provides the identifier of the public queue associated with the MSMQQueueInfo object.

MSMQQueueInfo.Quota 

Access: Read/write

Data type: Long

Specifies the maximum size of the queue.

MSMQQueueInfo.ServiceTypeGuid 

Access: Read/write

Data type: GUID

Specifies the type of service provided by the queue.

Requirements

Header

mqoai.h

Library

mqoa.lib

See Also

Reference

MSMQ COM Objects