MessageQueue Class Members
The following tables list the members exposed by MessageQueue.
Public Constructors
| Name | Description | |
|---|---|---|
 | MessageQueue Constructor | Overloaded. |
Public Fields
| Name | Description | |
|---|---|---|
  | InfiniteQueueSize | Specifies that no size restriction exists for a queue. |
| InfiniteTimeout | Specifies that no time-out exists for methods that peek or receive messages. |
Public Properties
| Name | Description | |
|---|---|---|
 | AccessMode | Gets a value that indicates the access mode for the queue. |
| Authenticate | Gets or sets a value that indicates whether the queue accepts only authenticated messages. |
| BasePriority | Gets or sets the base priority Message Queuing uses to route a public queue's messages over the network. |
| CanRead | Gets a value that indicates whether the MessageQueue can be read. |
| CanWrite | Gets a value that indicates whether the MessageQueue can be written to. |
| Category | Gets or sets the queue category. |
| Container | (Inherited from System.ComponentModel.Component) |
| CreateTime | Gets the time and date that the queue was created in Message Queuing. |
| DefaultPropertiesToSend | Gets or sets the message property values to be used by default when the application sends messages to the queue. |
| DenySharedReceive | Gets or sets a value that indicates whether this MessageQueue has exclusive access to receive messages from the Message Queuing queue. |
| EnableConnectionCache | Gets or sets a value that indicates whether a cache of connections will be maintained by the application. |
| EncryptionRequired | Gets or sets a value that indicates whether the queue accepts only non-private (non-encrypted) messages. |
| FormatName | Gets the unique queue name that Message Queuing generated at the time of the queue's creation. |
| Formatter | Gets or sets the formatter used to serialize an object into or deserialize an object from the body of a message read from or written to the queue. |
| Id | Gets the unique Message Queuing identifier of the queue. |
| Label | Gets or sets the queue description. |
| LastModifyTime | Gets the last time the properties of a queue were modified. |
| MachineName | Gets or sets the name of the computer where the Message Queuing queue is located. |
| MaximumJournalSize | Gets or sets the maximum size of the journal queue. |
| MaximumQueueSize | Gets or sets the maximum size of the queue. |
| MessageReadPropertyFilter | Gets or sets the property filter for receiving or peeking messages. |
| MulticastAddress | Introduced in MSMQ 3.0. Gets or sets the multicast address associated with the queue. |
| Path | Gets or sets the queue's path. Setting the Path causes the MessageQueue to point to a new queue. |
| QueueName | Gets or sets the friendly name that identifies the queue. |
| ReadHandle | Gets the native handle used to read messages from the message queue. |
| Site | (Inherited from System.ComponentModel.Component) |
| SynchronizingObject | Gets or sets the object that marshals the event-handler call resulting from a ReceiveCompleted or PeekCompleted event. |
| Transactional | Gets a value that indicates whether the queue accepts only transactions. |
| UseJournalQueue | Gets or sets a value that indicates whether received messages are copied to the journal queue. |
| WriteHandle | Gets the native handle used to send messages to the message queue. |
Protected Properties
| Name | Description | |
|---|---|---|
 | CanRaiseEvents | (Inherited from System.ComponentModel.Component) |
| DesignMode | (Inherited from System.ComponentModel.Component) |
| Events | (Inherited from System.ComponentModel.Component) |
Public Methods
| Name | Description | |
|---|---|---|
 | BeginPeek | Overloaded. Initiates an asynchronous peek operation that has no time-out. The operation is not complete until a message becomes available in the queue. |
| BeginReceive | Overloaded. Initiates an asynchronous receive operation that has no time-out. The operation is not complete until a message becomes available in the queue. |
| ClearConnectionCache | Clears the connection cache. |
| Close | Frees all resources allocated by the MessageQueue. |
| Create | Overloaded. Creates a non-transactional Message Queuing queue at the specified path. |
| CreateCursor | Creates a new Cursor for the current message queue. |
| CreateObjRef | (Inherited from System.MarshalByRefObject) |
| Delete | Deletes a queue on a Message Queuing server. |
| Dispose | Overloaded. Overridden. Disposes of the resources (other than memory) used by the MessageQueue. |
| EndPeek | Completes the specified asynchronous peek operation. |
| EndReceive | Completes the specified asynchronous receive operation. |
| Exists | Determines whether a Message Queuing queue exists at the specified path. |
| GetAllMessages | Returns all the messages that are in the queue. |
| GetEnumerator | Enumerates the messages in a queue. GetEnumerator is deprecated. GetMessageEnumerator2 should be used instead. |
| GetLifetimeService | (Inherited from System.MarshalByRefObject) |
| GetMachineId | Gets the identifier of the computer on which the queue referenced by this MessageQueue is located. |
| GetMessageEnumerator | Creates an enumerator object for all the messages in the queue. GetMessageEnumerator is deprecated. GetMessageEnumerator2 should be used instead. |
| GetMessageEnumerator2 | Creates an enumerator object for all the messages in the queue. |
| GetMessageQueueEnumerator | Overloaded. Provides forward-only cursor semantics to enumerate through all public queues on the network. |
| GetPrivateQueuesByMachine | Retrieves all the private queues on the specified computer. |
| GetPublicQueues | Overloaded. Retrieves all the public queues on the network. |
| GetPublicQueuesByCategory | Retrieves all the public queues on the network that belong to the specified category. |
| GetPublicQueuesByLabel | Retrieves all the public queues on the network that carry the specified label. |
| GetPublicQueuesByMachine | Retrieves all the public queues that reside on the specified computer. |
| GetSecurityContext | Retrieves the security context that MSMQ associates with the current user (thread identity) at the time of this call. |
| InitializeLifetimeService | (Inherited from System.MarshalByRefObject) |
| Peek | Overloaded. Returns without removing (peeks) the first message in the queue referenced by this MessageQueue. The Peek method is synchronous, so it blocks the current thread until a message becomes available. |
| PeekByCorrelationId | Overloaded. Peeks the message that matches the given correlation identifier and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue. |
| PeekById | Overloaded. Peeks the message whose message identifier matches the id parameter. |
| PeekByLookupId | Overloaded. Introduced in MSMQ 3.0. Peeks at the message that matches the given lookup identifier from a non-transactional queue. |
| Purge | Deletes all the messages contained in the queue. |
| Receive | Overloaded. Receives the first message available in the queue referenced by the MessageQueue. This call is synchronous, and blocks the current thread of execution until a message is available. |
| ReceiveByCorrelationId | Overloaded. Receives the message that matches the given correlation identifier (from a non-transactional queue) and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue. |
| ReceiveById | Overloaded. Receives the message that matches the given identifier from a non-transactional queue and immediately raises an exception if no message with the specified identifier currently exists in the queue. |
| ReceiveByLookupId | Overloaded. Introduced in MSMQ 3.0. Receives the message that matches the given lookup identifier from a non-transactional queue. |
| Refresh | Refreshes the properties presented by the MessageQueue to reflect the current state of the resource. |
| ResetPermissions | Resets the permission list to the operating system's default values. Removes any queue permissions you have appended to the default list. |
| Send | Overloaded. Sends an object to non-transactional queue referenced by this MessageQueue. |
| SetPermissions | Overloaded. Gives a computer, group, or user the specified access rights. |
| ToString | (Inherited from System.ComponentModel.Component) |
Protected Methods
| Name | Description | |
|---|---|---|
 | Finalize | (Inherited from System.ComponentModel.Component) |
| GetService | (Inherited from System.ComponentModel.Component) |
| MemberwiseClone | Overloaded. (Inherited from System.MarshalByRefObject) |
Public Events
| Name | Description | |
|---|---|---|
 | Disposed | (Inherited from System.ComponentModel.Component) |
| PeekCompleted | Occurs when a message is read without being removed from the queue. This is a result of the asynchronous operation, BeginPeek. |
| ReceiveCompleted | Occurs when a message has been removed from the queue. This event is raised by the asynchronous operation, BeginReceive. |
See Also