NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

MessageQueue Methods

The methods of the MessageQueue class are listed below. For a complete list of MessageQueue class members, see the MessageQueue Members topic.

Public:

BeginPeek Overloaded. Returns the first message in the queue without removing it from the queue.
BeginReceive Overloaded. Receives the first message available in the queue.
BeginTransaction Creates a new Message Queuing internal transaction context.
Close Frees all resources allocated by the queue.
CommitTransaction Commits a pending internal transaction.
Create Overloaded. Creates a new backend queue resource with the specified path.
Delete Deletes a queue backend resource identified by the given path.
Dispose (inherited from Component) Disposes of the Component.
EndPeek Terminates a peek asynchronous operation identified by the specified interface.
EndReceive Terminates a receive asynchronous operation identified by the specified interface.
Equals (inherited from Object) Determines whether the specified Object is the same instance as the current Object. Subclasses are expected to override this method to support value equality (not reference equality).
Exists Determines whether a queue with the specified path exists.
GetAllMessages Returns all the messages available in the queue.
GetContainer (inherited from Component) Returns the IContainer that contains the Component.
GetDesignMode (inherited from Component) Gets a value indicating whether the Component is currently in design mode.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetMachineId [To be supplied.]
GetMessageQueuesEnumerator Overloaded. [To be supplied.]
GetMessagesEnumerator Creates an enumerator object for the messages contained in the MessageQueue.
GetPrivateQueuesByMachine Retrieves all the private queues on the specified computer.
GetPublicQueues Overloaded. Retrieves public queues on the network.
GetPublicQueuesByCategory Retrieves a set of public queues filtered by the specified category.
GetPublicQueuesByLabel Retrieves a set of public queues filtered by the specified label.
GetPublicQueuesByMachine Retrieves all public queues on the specified computer.
GetServiceObject (inherited from Component) Returns an object representing a service provided by the Component.
GetType (inherited from Object) Gets the Type of the Object.
Peek Overloaded. Returns the first message in the queue without removing it from the queue.
PeekByCorrelationId Overloaded. [To be supplied.]
PeekById Overloaded. [To be supplied.]
Purge Deletes all the messages contained in the queue.
Receive Overloaded. Receives the first message in the queue.
ReceiveByCorrelationId Overloaded. [To be supplied.]
ReceiveById Overloaded. [To be supplied.]
Refresh Refreshes the properties presented by the MessageQueue to reflect the current state of the resource.
RollbackTransaction Rolls back the pending internal transaction.
Send Overloaded. [To be supplied.]
ToString (inherited from Component) Returns a String containing the name of the Component, if any. This method should not be overridden. For internal use only.

Protected:

Finalize (inherited from Component) [To be supplied.]
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

Event Hookup:

AddOnPeekCompleted Adds an event handler for the TBD event.
AddOnReceiveCompleted Adds an event handler for the TBD event.
RemoveOnPeekCompleted Removes an event handler from the PeekCompleted event.
RemoveOnReceiveCompleted Removes an event handler from the ReceiveCompleted event.

See Also

MessageQueue Class | System.Messaging Namespace