MessageQueueException Class

.NET Framework (current version)

The exception that is thrown if a Microsoft Message Queuing internal error occurs.

Namespace: System.Messaging
Assembly: System.Messaging (in System.Messaging.dll)

Inheritance Hierarchy

System::Object
System::Exception
System::SystemException
System.Runtime.InteropServices::ExternalException
System.Messaging::MessageQueueException

Syntax

C++

[SerializableAttribute]
public ref class MessageQueueException : ExternalException, ISerializable

Constructors

	Name	Description
	MessageQueueException(SerializationInfo^, StreamingContext)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the MessageQueueException class with serialized data.

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception.(Inherited from Exception.)
	ErrorCode	Gets the HRESULT of the error.(Inherited from ExternalException.)
	HelpLink	Gets or sets a link to the help file associated with this exception.(Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.(Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception.(Inherited from Exception.)
	Message	Gets a value that describes the Message Queuing error.(Overrides Exception::Message.)
	MessageQueueErrorCode	Gets a value that indicates the error code associated with this exception.
	Source	Gets or sets the name of the application or the object that causes the error.(Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack.(Inherited from Exception.)
	TargetSite	Gets the method that throws the current exception.(Inherited from Exception.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.(Inherited from Exception.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetObjectData(SerializationInfo^, StreamingContext)	Populates a serialization information object with the data needed to serialize the MessageQueueException.(Overrides Exception::GetObjectData(SerializationInfo^, StreamingContext).)
	GetType()	Gets the runtime type of the current instance.(Inherited from Exception.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that contains the HRESULT of the error.(Inherited from ExternalException.)

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.(Inherited from Exception.)

Remarks

Exceptions associated with the MessageQueueException class are generated by internal errors within Message Queuing that should be dealt with through your code.

Every exception consists of an error code and a text string that describes the source of the error. See the MessageQueueErrorCode class for a list of these error codes and their descriptions.

If a MessageQueue opens a queue with the sharedModeDenyReceive parameter set to true, any MessageQueue that subsequently tries to read from the queue generates a MessageQueueException exception because of a sharing violation. The same exception is thrown if a MessageQueue tries to access the queue in exclusive mode while another MessageQueue already has nonexclusive access to the queue.

Visual Basic Note
MessageQueueTransaction is threading-apartment–aware. Visual Basic sets the state of the main thread to STA, so you must apply the MTAThreadAttribute in the Main subroutine. Otherwise, sending a transactional message using another thread throws a MessageQueueException exception.

Examples

C++

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
int main()
{

   // Determine whether the queue exists.
   if ( MessageQueue::Exists( ".\\myQueue" ) )
   {
      try
      {

         // Delete the queue.
         MessageQueue::Delete( ".\\myQueue" );
      }
      catch ( MessageQueueException^ e ) 
      {
         if ( e->MessageQueueErrorCode == MessageQueueErrorCode::AccessDenied )
         {
            Console::WriteLine( "Access is denied. Queue might be a system queue." );
         }

         // Handle other sources of MessageQueueException.
      }

   }

   return 0;
}

Version Information

.NET Framework
Available since 1.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.