MessageQueue.Exists メソッド

.NET Framework クラス ライブラリ リファレンス

MessageQueue.Exists メソッド

指定したパスにメッセージ キューのキューが存在するかどうかを判断します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Shared Function Exists
 ( _
    path As String _
) As Boolean

Visual Basic (使用法)

Dim path As String
Dim returnValue As Boolean

returnValue = MessageQueue.Exists(path)

C#

public static bool Exists
 (
    string path
)

C++

public:
static bool Exists (
    String^ path
)

J#

public static boolean Exists (
    String path
)

JScript

public static function Exists
 (
    path : String
) : boolean

パラメータ

path

検索するキューの場所。

戻り値
指定したパスにキューが存在する場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentException	path 構文が無効です。
MessageQueueException	メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。 または Exists メソッドが、リモート プライベート キューに対して呼び出されています。
InvalidOperationException	キューの存在を確認するときに、アプリケーションが書式名構文を使用しました。

解説

Exists メソッドは、指定したパスにメッセージ キューのキューが存在するかどうかを判断します。指定した書式名のキューが存在するかどうかを判断するメソッドはありません。書式名構文およびその他のパス構文の書式の詳細については、Path プロパティのトピックを参照してください。

Exists は、負荷が高い操作です。アプリケーションで必要な場合にだけ使用してください。

メモ
Exists メソッドは、FormatName プレフィックスをサポートしていません。

path パラメータの構文は、キューの種類によって異なります。詳細については、次の表を参照してください。

キューの種類	構文
パブリック キュー	MachineName\QueueName

リモート プライベート キューの存在を確認するために、Exists を呼び出すことができませんでした。

構文の詳細については、Path プロパティのトピックを参照してください。

Label を使用してキューのパスを記述することもできます。

参照	構文
ラベル	Label:[ label ]

このメソッドが各種のワークグループ モードで使用できるかどうかを次の表に示します。

ワークグループ モード	使用可否
ローカル コンピュータ	○
ローカル コンピュータと直接書式名	×
リモート コンピュータ	×
リモート コンピュータと直接書式名	×

使用例

メッセージ キューのキューが存在するかどうかを確認してから、それを削除するコード例を次に示します。

Visual Basic

Imports System
Imports System.Messaging



Public Class MyNewQueue


        
        ' Provides an entry point into the application.
        '         
        ' This example verifies existence and attempts to 
        ' delete a queue.
        

        Public Shared Sub
 Main()

            ' Determine whether the queue exists.
            If MessageQueue.Exists(".\myQueue")
 Then

                Try

                    ' Delete the queue.
                    MessageQueue.Delete(".\myQueue")

                Catch e As MessageQueueException

                    If e.MessageQueueErrorCode = _
                        MessageQueueErrorCode.AccessDenied Then

                        Console.WriteLine("Access is denied. "
 _
                            + "Queue might be a system queue.")
                    End If

                    ' Handle other sources of exceptions as necessary.

                End Try

            End If


            Return

        End Sub 'Main

End Class 'MyNewQueue 

C#

using System;
using System.Messaging;

namespace MyProject
{
    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {

        //**************************************************
        // Provides an entry point into the application.
        //         
        // This example verifies existence and attempts to 
        // delete a queue.
        //**************************************************

        public static void
 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;
        }

    }
}

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;
}

J#

package MyProject;

import System.*;
import System.Messaging.*;

/// <summary>
/// Provides a container class for the example.
/// </summary>
public class MyNewQueue
{
    //**************************************************
    // Provides an entry point into the application.
    //         
    // This example verifies existence and attempts to 
    // delete a queue.
    //**************************************************
    public static void main(String[]
 args)
    {
        // Determine whether the queue exists.
        if (MessageQueue.Exists(".\\myQueue")) {
            try {
                // Delete the queue.
                MessageQueue.Delete(".\\myQueue");
            }
            catch (MessageQueueException e) {
                if (e.get_MessageQueueErrorCode().
                    Equals(MessageQueueErrorCode.AccessDenied)) {
                    Console.WriteLine("Access is denied. "
                        + "Queue might be a system queue.");
                }
                // Handle other sources of MessageQueueException.
            }
        }        
        return;
    } //main
} //MyNewQueue 

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
MessageQueue クラス
MessageQueue メンバ
System.Messaging 名前空間
Path