Export (0) Print
Expand All
3 out of 4 rated this helpful - Rate this topic

MSMQQueueInfo

The MSMQQueueInfo object provides queue management for a single queue. It provides methods for creating a queue (either a transactional or non-transactional queue), opening a queue, changing or retrieving the properties of a queue, and deleting a queue.

MSMQQueueInfo objects are either returned by a query using the MSMQQuery.LookupQueue method or created by the sending or receiving application. Before using an application-created MSMQQueueInfo object, the application must initialize it to reference a specific queue by setting its MSMQQueueInfo.FormatName or MSMQQueueInfo.PathName property.

There is a one-to-one relationship between each MSMQQueueInfo object and the queue it represents. However, as shown in the illustration below, 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.

<No Change>

Methods

The MSMQQueueInfo object defines the following methods.

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 MSMQQueueInfo object defines the following properties.

Property Description

MSMQQueueInfo.ADsPath

(Introduced in MSMQ 3.0) Provides the ADs path to the queue object in the Active Directory Domain Services (AD DS) (not available for private queues).

Run-time access: Read-only

Data type: Long

MSMQQueueInfo.Authenticate

Specifies whether the queue accepts only authenticated messages.

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.BasePriority

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

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.CreateTime

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

Run time access: Read-only

Data type: Variant (Date)

MSMQQueueInfo.FormatName

Specifies the format name of the queue.

Runtime access: Read/write

Data type: String

MSMQQueueInfo.IsTransactional

(Superseded by IsTransactional2.) Indicates whether the queue supports transactions.

Runtime access: Read-only

Data type: Short

MSMQQueueInfo.IsTransactional2

(Introduced in MSMQ 3.0, supersedes IsTransactional.) Indicates whether the queue supports transactions.

Runtime access: Read-only

Data type: Boolean

MSMQQueueInfo.IsWorldReadable

(Superseded by IsWorldreadable2.) Indicates whether all members of the Everyone group can read messages in the queue.

Runtime access: Read-only

Data type: Short

MSMQQueueInfo.IsWorldReadable2

(Introduced in MSMQ 3.0, supersedes IsWorldReadable.) Indicates whether all members of the Everyone group can read the messages in the queue.

Runtime access: Read-only

Data type: Boolean

MSMQQueueInfo.Journal

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

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.JournalQuota

Specifies the maximum size of the queue journal.

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.Label

Specifies a description of the queue or message.

Runtime access: Read/write

Data type: String

MSMQQueueInfo.ModifyTime

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

Runtime access: Read-only

Data type: Variant (Date)

MSMQQueueInfo.MulticastAddress

(Introduced in MSMQ 3.0.) Specifies the multicast address associated with the queue.

Runtime access: Read/write

Data type: String

MSMQQueueInfo.PathName

Specifies the MSMQQueueInfo.PathName of the queue.

Runtime access: Read/write

Data type: String

MSMQQueueInfo.PathNameDNS

(Read-only, introduced in MSMQ 2.0.) Provides the DNS path name of the queue.

Runtime access: Read-only

Data type: String

MSMQQueueInfo.PrivLevel

Specifies the privacy level of the queue.

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.QueueGuid

Provides the identifier of the public queue associated with the MSMQQueueInfo object.

Runtime access: Read-only

Data type: String (GUID format)

MSMQQueueInfo.Quota

Specifies the maximum size of the queue.

Runtime access: Read/write

Data type: Long

MSMQQueueInfo.ServiceTypeGuid

Specifies the type of service provided by the queue.

Runtime access: Read/write

Data type: GUID

Requirements

Windows NT/2000/XP: Included in Windows NT 4.0 SP3 and later.

Windows 95/98/Me: Included in Windows 95 and later.

Header: Declared in Mqoai.h.

Library: Use Mqoa.lib.

See Also

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.