Microsoft BizTalk Server 2000 における WMI

[アーティクル]
07/12/2010

発行日 : 2001 年 2 月

概要

このホワイトペーパーでは、Microsoft® BizTalk・Server 2000 と Windows Management Instrumentation (WMI) を使用した管理オブジェクトの管理方法とイベントの使用方法を説明します。一時イベントコンシューマの例を取り上げて WMI の BizTalk Server への実装を説明します。また、スキーマクラスも記載し、BizTalk Server と WMI を使用する際に一般的なタスクにソリューションを提供するコードサンプルのライブラリも記載しています。

はじめに

Windows Management Instrumentation (WMI) は、Microsoft Windows® 2000 に含まれるデータ管理層です。Microsoft BizTalk Server 2000 は WMI 層を使用して、エンタプライズにおけるシステム管理をサポートする管理目的の関数をカプセル化します。

このホワイトペーパーには、Microsoft Visual Basic® および Visual Basic Script で記述したサンプルコードを掲載しています。

WMI の背景と概要については、Microsoft MSDN® Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にある記事『Microsoft Windows Management Instrumentation: Background and Overview』 (英語版) を参照してください。

全社の Windows とアプリケーションの管理に WMI を使用する方法については、MSDN Online Library の Web サイトの記事『Windows Management Instrumentation: Administering Windows and Applications across Your Enterprise』 (英語版) を参照してください。

WMI SDK の最新バージョンを入手するには、Microsoft の Web サイト https://www.microsoft.com/downloads/details.aspx?displaylang=ja&FamilyID;=AFE41F46-E213-4CBF-9C5B-FBF236E0E875 をご覧ください。

BizTalk Server における WMI を理解する

BizTalk Server 管理を使用して、グループ、サーバー、キューおよびデータベースの管理設定を変更する場合、新しい値は BizTalk Server WMI プロバイダを経由して BizTalk メッセージ管理データベースに格納されます。BizTalk Server 2000 における WMI プロバイダは、Microsoft SQL Server・データベースを使用して管理オブジェクトを格納します。タイムスタンプは、すべて SQL Server のローカル時刻を使用して作成されますが、WMI プロバイダは、すべてのタイムスタンプを協定世界時 (UTC) で参照します。管理コンソールは、このタイムスタンプを表示用にローカル時刻に戻します。

WMI プロバイダは、WMI と BizTalk 管理オブジェクト間の仲介役として機能します。WMI プロバイダは、リソース (管理オブジェクト) からの情報を収集し、WMI API 経由で管理アプリケーションがその情報を利用できるようにします。

BizTalk スキーマクラスは、Managed Object Format (MOF) を使用して登録され、また定義されます。MOF は、Interface Definition Language (IDL) を基に作成された言語です。このスキーマクラス情報は、MOF コンパイラ (Mofcomp.exe) を使用してコンパイルする .mof ファイルに保存します。

これから取り上げる MOF コードのサンプルは、･Program Files･Microsoft BizTalk Server･Setup フォルダにある InterchangeProvSchema.mof ファイルにあるものです。このファイルと SrvEvents.mof には、BizTalk Server の名前空間、プロバイダ、プロバイダ登録、およびスキーマクラスの定義が含まれます。

WMI データベース層にプログラムからアクセスするには、後述の「BizTalk Server WMI リファレンス」を参照してください。ここには、管理オブジェクトに対応する BizTalk Server WMI スキーマクラスを記載しています。

BizTalk Server の名前空間

個々の WMI 名前空間は、システムクラスのセットがあり、__NAMESPACE も含まれます。名前空間のグループは、クラスのコレクションで、論理的な単位にまとめたものです。すべてのコンピュータには、階層の最上位にルート名前空間と呼ばれる定義された名前空間があります。名前空間の場所は、パスを使用して表現します。

次の MOF コードは、BizTalk Server の __NAMESPACE システムクラスの Name プロパティの値として MicrosoftBizTalkServer を指定しています。

#pragma namespace ("\\\\.\\Root") 
instance of __Namespace 
{ 
  Name = "MicrosoftBizTalkServer"; 
}

BizTalk Server は、MicrosoftBizTalkServer 名前空間をルート名前空間の兄弟として定義し、BizTalk Serve で管理された環境とほかの管理された環境とを論理的に区別します。

BizTalk Server のプロバイダと登録

WMI が BizTalk Server 管理アプリケーションからの要求を受信すると、その要求を WMI プロバイダである InterchangeProv に渡します。WMI プロバイダは、BizTalk Server スキーマクラスインスタンスの取得、変更、削除、および列挙を行います。さらに、InterchangeProv は動的なインスタンス情報を提供し、イベント情報を生成します。

次の MOF コードは、__Win32Provider システムクラスの Name プロパティの値として InterchangeProv を指定しています。

instance of __Win32Provider as $P 
{ 
  Name = "InterchangeProv"; 
  ClsId = "{9ac8efd6-c454-11d2-92c7-00c04fa356e8}"; 
};

InterchangeProv は、BizTalk Server 環境で管理オブジェクトと交信できるように設計されたカスタムプロバイダです。これらの管理オブジェクトとプロパティのすべてのリファレンスについては、後述の「BizTalk Server WMI リファレンス」を参照してください。

次の MOF コードでは、__InstanceProviderRegistration システムクラスのインスタンスを使用して、インスタンスプロバイダを WMI に登録しています。

instance of __InstanceProviderRegistration 
{ 
  Provider = $P; 
  SupportsGet = TRUE; 
  SupportsPut = TRUE; 
  SupportsDelete = TRUE; 
  SupportsEnumeration = TRUE; 
  QuerySupportLevels = {"WQL:UnarySelect"}; 
};

BizTalk Server インスタンスプロバイダは、データの取得、変更、削除、列挙、およびクエリ処理をサポートします。

次の MOF コードでは、__MethodProviderRegistration システムクラスのインスタンスを使用して、メソッドプロバイダを WMI に登録しています。

instance of __MethodProviderRegistration 
{ 
  Provider = $P; 
};

.mof ファイルの記述方法と解釈方法については WMI SDK の記事『Managed Object Format (MOF) Language』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にあります。

BizTalk Server で WMI を使用する

WMI は、管理情報の変更を認識、収集し、ほかの管理情報と関連付けして、ローカルまたはリモートの管理アプリケーションに転送できる強力なイベントアーキテクチャを備えています。イベント処理と通知は、WMI が備える重要な利点です。これが、ハードウェアとソフトウェアのイベントとエラーを特定し、処理するメカニズムを提供します。

イベントが発生すると、イベントコンシューマと呼ばれる 1 つまたは複数の登録された受信者に通知を配信します。イベントコンシューマは、特定の種類の通知を受信するように登録することができます。イベントコンシューマは、イベントと通知の提供方法を認識することなく、通知を受信するように登録します。登録するには、WQL (WMI Query Language) を使用して作成したフィルタをイベントコンシューマに指定します。クエリには、イベントコンシューマがイベント通知を受信する条件を記述します。

WQL の詳細については、WMI SDK の記事『WMI Query Language』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にあります。

WMI は、DCOM インターフェイスのほかに単一スクリプト API をサポートしているので、アプリケーションとスクリプトはローカルまたはリモートコンピューター上の WMI プロバイダにアクセスすることができます。

ここでは、一時 WMI イベントコンシューマを Microsoft Visual Basic スクリプトで記述するのに必要な基本的な手順を示します。関連する DCOM インターフェイスの一部についても記載します。

WMI を使用した BizTalk 管理オブジェクトの作成と操作方法を示すコードサンプルについては、「付録ソリューションライブラリ」を参照してください。

メモ

Microsoft Application Center 2000 または Microsoft BackOffice® Server からヘルスモニタをインストールしている場合には、Microsoft 管理コンソール (MMC) のユーザーインターフェイス (UI) または WMI クラスを通して、イベントを使用するようにヘルスモニタを設定することができます。

WMI プロバイダの記述方法については、WMI SDK の記事『WMI Provider Programming』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にあります。

クライアントアプリケーションの記述方法については、WMI SDK の記事『WMI Application Programming』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイトにあります。

イベントの発行と使用については、WMI SDK の記事『Event Notification』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイトにあります。

WMI アプリケーションプログラミングの詳細については、MSDN Online Library の Web サイトで「WMI Application Programming」を検索してください。

変数を宣言する

WMI を使用してイベントコンシューマを記述するには、ロケータオブジェクト、サービスオブジェクト、イベントオブジェクト、および WMI クラスインスタンスを表すオブジェクトを取得する必要があります。

次のコードに示すように、最初に変数を宣言します。

Dim wbemLocat 
Dim wbemSrvcs 
Dim wbemEvent 
Dim wbemObject

ロケータオブジェクト変数 wbemLocat は SwbemLocator 型で、WMI に接続するのに使用します。ルート名前空間 (Root/MicrosoftBizTalkServer) 下の MicrosoftBizTalkServer 名前空間に接続するには、SWbemServices 型のサービスオブジェクト変数 wbemSrvcs を設定します。イベントオブジェクト変数 wbemEvent は SwbemEventSource 型で、イベントを受信するためのクエリ実行に必要です。イベントクエリからイベントを取得するには、SwbemObject 型の wbemObject 変数を設定します。

Microsoft_BizTalk Server の名前空間に接続する

変数を宣言したら、ロケータオブジェクトを取得する必要があります。スクリプト API を使用している場合は、次のコードに示すように WbemScripting.SwbemLocator オブジェクトを作成します。

Set wbemLocat = CreateObject("WbemScripting.SWbemLocator")

WMI を使用したいずれのアプリケーションでも最初のステップは、ロケータオブジェクトの取得であることに注意してください。DCOM インターフェイスを使用している場合は、次のコードに示すように、CLSID_WbemLocator クラス識別子を指定した COCreateInstance メソッドを使用して IWBEMLocator ポインタを取得します。

IWbemLocator* piWMI = NULL; 
HRESULT hr; 
  hr = CoCreateInstance( 
      CLSID_WbemLocator,       
      NULL,              
      CLSCTX_INPROC_SERVER,   
      IID_IWbemLocator,        
      (LPVOID*) &piWMI         
      );

ロケータオブジェクトと ConnectServer メソッドを使用すると、WMI サービスへの接続を要求することができます。次のコードは、ローカルコンピュータ上のルート名前空間を指定することで WMI への接続を試みます。次のコードの <コンピュータ名> には、イベントを発行するサーバー名を指定します。

Set wbemSrvcs = wbemLocat.ConnectServer("< コンピュータ名 >", _    
  "root\MicrosoftBizTalkServer")

Err.number が 0 の場合、WMI 名前空間への接続が確立されます。コンピュータ名と名前空間の両方を指定します。指定しないで両方のフィールドを空白のままにすると、ローカルコンピュータ上の既定の名前空間に接続されます。

返された SWbemServices オブジェクトには、管理オブジェクトの格納に使用される SQL Server データベースへの通信パスが格納されます。

イベント オブジェクトを作成する

これで MicrosoftBizTalkServer 名前空間に接続したので、次は、イベントオブジェクトを作成する必要があります。次のコードは、イベント通知を受信するイベントオブジェクトを生成します。

Set wbemEvent = _  
  wbemSrvcs.ExecNotificationQuery("Select * from DocSuspendedEvent")

SWbemServices.ExecNotificationQuery メソッド呼出しで使用されるフィルタは、"Select * from DocSuspendedEvent" で、これは WQL で記述します。SQL クエリと同様に、WQL クエリは、プロパティの特定のセットや複数の条件を満たすインスタンスのサブセットを返すように条件付けることができます。

コンシューマがこのクエリを発行する場合、DocSuspendedEvent クラスが表すイベントの発生をすべて通知するように要求します。この要求には、イベントのシステムおよびシステム以外のすべてのプロパティに関する通知要求が含まれます。イベントプロバイダがクエリを発行する場合、DocSuspendedEvent クラスが表すイベントが発生したときに必ず通知の生成を行うサポートを登録します。

イベントを監視する

これまでに DocSuspendedEvent クラスのイベントオブジェクトを作成したので、次は、このクラスが表すイベントの監視メカニズムをセットアップする必要があります。まず、次のコードのように SWbemObject 型の wbemObject に Empty をセットします。

wbemObject = Empty

イベントが利用できる場合、次のコードに示すように SWbemEventSource.NextEvent メソッドがイベントクエリからイベントを取得します。

Set wbemObject = wbemEvent.NextEvent(Timeout)

SWbemObject オブジェクトは、すべての WMI オブジェクトに適用されるジェネリックプロパティとメソッドをサポートし、また、オブジェクトのプロパティとメソッドをオブジェクトの動的オートメーションプロパティとメソッドとして提供します。

次のコードを使用して、保留キューイベントにある項目のグローバル一意識別子 (GUID) を取得します。

EventSuspendedQueueWaitForEvent = _ 
  wbemObject.Properties_.Item("stringSuspendedGuid").Value

wbemObject が Empty にセットされていない場合、保留キューイベントにある項目の GUID が取得されます。Empty がセットされている場合は、保留キューイベントを待機している間にタイムアウトエラーが発生します。

stringSuspendedGuid は DocSuspendedEvent クラスのプロパティであることに注意してください。Properties_ プロパティは、SWbemPropertySet オブジェクトを返します。このオブジェクトは、現在のクラスまたはインスタンス (この場合 DocSuspendedEvent クラス) のプロパティのコレクションです。次に、Item メソッドが、このコレクション (この場合 stringSuspendedGuid プロパティ) から SWbemProperty を取得します。

BizTalk Server での WMI アプリケーションプログラミングの詳細については、次の「WMI エラーを処理する」、および「付録ソリューションライブラリ」を参照してください。

WMI エラーを処理する

ここでは、Microsoft Visual Basic コードを使用して、WMI メソッドがエラーを返すかどうかの判断方法と、エラーが返された場合のエラー内容の解釈方法を説明します。

最初に、次の 2 つの変数を宣言します。1 つは SWbemLastError オブジェクトで、エラーオブジェクトを格納し、操作します。もう 1 つは String オブジェクトの配列で、次のコードのように、エラーの数値、パラメータ情報、および説明テキストを格納します。

Dim objWMIError As SWbemLastError 
Dim strError(0 To 2) As String

WMI によりエラーが発生したかどうかを判断するには、Err オブジェクトを確認します。Err オブジェクトの値が 0 以外の場合は、エラーが発生しています。この場合は、SWbemLastError オブジェクトを新しいインスタンスにセットしてみます。

objWMIError 変数の情報を返すために、TypeName 関数が使用されることに注意してください。この変数の値が Nothing の場合、エラー情報は提供されず、エラーオブジェクトの作成に失敗します。

呼出しが成功して、エラーオブジェクトが返されると、次のコードに示すように、オブジェクトの状態はリセットされ、エラーの文字列配列の各要素には有意な値がセットされます。

If Err <> 0 Then 
    strError(0) = Hex(Err.Number) 
    Set objWMIError = New SWbemLastError 
    If TypeName(objWMIError) <> "Nothing" Then 
      strError(1) = objWMIError.ParameterInfo 
      strError(2) = objWMIError.Description 
    Else 
      Err.Clear 
      strError(1) = "" 
      strError(2) = "" 
    End If 
  Else 
    strError(0) = 0 
    strError(1) = "" 
    strError(2) = "" 
  End If

DCOM インターフェイスを使用したエラー処理については、WMI SDK の記事『Error Handling for Applications』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にあります。

BizTalk Server WMI リファレンス

BizTalk Server WMI クラスは、Managed Object Format (MOF) を使用してテキストファイルに定義します。各クラスにはキープロパティ修飾子があることに注意してください。キープロパティ修飾子により、クラス (または、派生クラス) のどのようなインスタンスでもキープロパティ修飾子の値で一意に識別できることがわかります。これは、データベースの技術に用いられていたものを採用したものです。

WMI が提供する機能を利用するには、DCOM インターフェイスのセットを実装します。このインターフェイスのセットを使用すると、WMI が管理するクラスとインスタンスを操作する管理アプリケーションを記述することができます。IWbemClassObject、IWbemServices など、これらのインターフェイスの詳細については、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) で、Platform SDK、Management Services、Windows Management Instrumentation、WMI Reference のページを順に開いて参照してください。

さらに、オートメーションオブジェクトをサポートする環境から、DCOM インターフェイスをラップするスクリプトオブジェクト経由で WMI にアクセスすることができます。たとえば、SWbemObject クラスは IWbemClassObject インターフェイスをラップし、SWbemServices は IWbemServices をラップします。WMI を BizTalk Server スキーマクラスと共に使用する場合、WMI には Microsoft Visual Basic または Visual Basic Scripting Edition (VBScript) 経由で完全にアクセスすることができます。Visual Basic の [参照設定] ダイアログボックスで Microsoft WMI Scripting V1.1 Library を追加すると、Visual Basic プロジェクトからこれらのオブジェクトにアクセスできます。

C/C++ プログラムの場合は、COM (Component Object Model) API を直接利用することができます。Scripting API を使用すると、Microsoft Visual Basic に基づくスクリプトやアプリケーションを開発することができます。Visual Basic を使用すると、管理オブジェクトを表示したり、制御することができます。

WMI COM API インターフェイスの説明については、WMI SDK の記事『COM API for WMI』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイト (https://msdn.microsoft.com/ja-jp/library/default.aspx) にあります。

Scripting API インターフェイスの説明については、WMI SDK の記事『Scripting API for WMI』 (英語版) を参照してください。WMI SDK は、MSDN Online Library の Web サイトにあります。

DocSuspendedEvent

DocSuspendedEvent クラスは、保留キューに送信されたドキュメントによって発生するイベントを表します。

DocSuspendedEvent は、__ExtrinsicEvent システムクラスから、ユーザー定義のすべてのイベントタイプのスーパークラスとして機能する抽象基底クラスを継承します。

DocSuspendedEvent クラスは、次のプロパティを定義します。

プロパティ	説明
stringSuspendedGuid	保留キューイベントにある項目の追跡キーを格納します。

要件

Microsoft Windows NT ®/Windows 2000 : Windows 2000 Service Pack 1 (SP1) 以降

ヘッダーとライブラリ : Wbemidl.h、Wbemuuid.lib

MOF ファイル : SrvEvents.mof

スクリプト ライブラリ : Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

StringSuspendedGuid プロパティ

stringSuspendedGuid プロパティは、保留キューイベントにある項目の追跡キーを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string stringSuspendedGuid;

パラメータ

なし

戻り値

string データ型

解説

このプロパティは読み取り専用です。

保留キューイベントにある項目の追跡キーは、GUID に基づきます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ヘッダーとライブラリ : Wbemidl.h、Wbemuuid.lib
MOF ファイル : SrvEvents.mof
スクリプト ライブラリ : Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

InterchangeProvError

InterchangeProvError クラスは、クラスインスタンスの作成時にインターチェンジプロバイダが返したエラー情報を表します。

InterchangeProvError は、詳しい状態とエラー情報の報告に使用される __ExtendedStatus システムクラスから継承されます。

InterchangeProvError クラスは、次のプロパティを定義します。

プロパティ	説明
InterchangeProvName	エラー情報を返すインターチェンジプロバイダの名前を格納します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ヘッダーとライブラリ : Wbemidl.h、Wbemuuid.lib
MOF ファイル : InterchangeProvSchema.mof
スクリプト ライブラリ : Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

InterchangeProvError プロパティ

InterchangeProvError プロパティは、エラー情報を返すインターチェンジプロバイダの名前を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

String InterchangeProvName;

パラメータ

なし

戻り値

string データ型

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_Group

MicrosoftBizTalkServer_Group クラスは、企業における特定台数の BizTalk Server の論理グループ化を表します。これは、グローバル BizTalk Server プロパティの管理抽象です。

MicrosoftBizTalkServer_Group は動的クラスで、必要に応じて WMI プロバイダの InterchangeProv が実行時に提供します。

MicrosoftBizTalkServer_Group クラスは、次のプロパティを定義します。

プロパティ	説明
ConfigurationCacheRefreshInterval	BizTalk メッセージ構成オブジェクトのキャッシュをサーバーが更新する間隔 (秒単位) を示します。
ConnectToDbStatus	追跡データベースおよび共有キューデータベースへの接続状態を示します。
DateModified	インスタンスデータの最終更新日を示します。
DocTrackDbLogon	追跡データベースへの接続文字列のユーザー ID コンポーネントを格納します。
DocTrackDbName	追跡データベースへの接続文字列のデータベース名コンポーネントを格納します。
DocTrackDbPassword	追跡データベースへの接続文字列のパスワードコンポーネントを格納します。
DocTrackDbServer	追跡データベースへの接続文字列のサーバー名コンポーネントを格納します。
EnableDocumentTracking	ドキュメント追跡が有効か、無効かを示します。
LoggingPointState	追跡エントリが記録される原因となったイベントを示すフラグのコレクションを表します。
Name	サーバー名を格納します。
ParserOrder	レジストリに登録されているパーサーコンポーネントの CLSID を、解析順に格納します。
ProxyHost	プロキシホストアドレスを格納します。
ProxyPort	プロキシポート番号を示します。
QueueDbLogon	共有キューデータベースへの接続文字列のユーザー ID コンポーネントを格納します。
QueueDbName	共有キューデータベースへの接続文字列のデータベース名コンポーネントを格納します。
QueueDbPassword	共有キューデータベースへの接続文字列のパスワードコンポーネントを格納します。
QueueDbServer	共有キューデータベースへの接続文字列のサーバー名コンポーネントを格納します。
ReliableMessagingReplyToURL	信頼性のあるメッセージングのための URL リポジトリを格納します。
RetryQueueCount	再試行キューにあるドキュメントの数を示します。
ScheduledQueueCount	送信待キューにあるドキュメントの数を示します。
SMTPHost	このグループが使用する SMTP のホスト名を格納します。
SuspendedQueueCount	保留キューにあるドキュメントの数を示します。
UseProxyServer	プロキシサーバーを使用するか、使用しないかを示します。
WorkQueueCount	作業キューにあるドキュメントの数を示します。

MicrosoftBizTalkServer_Group クラスは、次のメソッドを定義します。

メソッド	説明
PurgeSuspendedQueue	保留キューにあるすべてのドキュメントを管理者が削除できるようにします。
RefreshParserListFromRegistry	レジストリに登録されている現在のコンポーネントに基づいて、データベースにあるパーサーコンポーネントの一覧を更新します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ConfigurationCacheRefreshInterval プロパティ

ConfigurationCacheRefreshInterval プロパティは、BizTalk メッセージ構成オブジェクトのキャッシュをサーバーが更新する間隔 (秒単位) を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ConfigurationCacheRefreshInterval = 50;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、BizTalk メッセージ構成オブジェクトのキャッシュをサーバーが更新する間隔 (秒単位) を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は 50 です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ConnectToDbStatus プロパティ

ConnectToDbStatus プロパティは、追跡データベースおよび共有キューデータベースへの接続状態を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ConnectToDbStatus;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、追跡データベースまたは共有キューデータベースへの接続状態を示します。

解説

このプロパティは読み取り専用です。

このプロパティの許容値は、BothDbConnectOK、DTAConnectFail、SQConnectFail、および BothConnectFail で、それぞれ整数の 0、1、2 および 3 に対応します。コードとスクリプトでは、整数値を使用する必要があることに注意してください。

次のコードは、MOF ファイル (InterchangeProvSchema.mof) にあるもので、マッピングを示します。

Values {"BothDbConnectOK", "DTAConnectFail", "SQConnectFail",  
    "BothConnectFail"}, 
ValueMap{"0", "1", "2", "3"}

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DateModified プロパティ

DateModified プロパティは、インスタンスデータの最終更新日を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime DateModified;

パラメータ

なし

戻り値

datetime データ型で、インスタンスデータの最終更新日を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocTrackDbLogon プロパティ

DocTrackDbLogon プロパティは、追跡データベースへの接続文字列のユーザー ID コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocTrackDbLogon;

パラメータ

なし

戻り値

string データ型で、追跡データベースへの接続文字列のユーザー ID コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocTrackDbName プロパティ

DocTrackDbName プロパティは、追跡データベースへの接続文字列のデータベース名コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocTrackDbName;

パラメータ

なし

戻り値

string データ型で、追跡データベースへの接続文字列のデータベース名コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、123 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocTrackDbPassword プロパティ

DocTrackDbPassword プロパティは、追跡データベースへの接続文字列のパスワ－ドコンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocTrackDbPassword;

パラメータ

なし

戻り値

string データ型で、追跡データベースへの接続文字列のパスワードコンポーネントを格納します。

解説

このプロパティは書き込み専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocTrackDbServer プロパティ

DocTrackDbServer プロパティは、追跡データベースへの接続文字列のサーバー名コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocTrackDbServer;

パラメータ

なし

戻り値

string データ型で、追跡データベースへの接続文字列のサーバー名コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、60 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

EnableDocumentTracking プロパティ

EnableDocumentTracking プロパティは、ドキュメント追跡が有効か、無効かを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

boolean EnableDocumentTracking = 1;

パラメータ

なし

戻り値

boolean データ型で、ドキュメント追跡が有効か、無効かを示します。TRUE の場合、ドキュメント追跡は有効で、そうでない場合、値は FALSE で、ドキュメント追跡は無効です。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は TRUE です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

LoggingPointState プロパティ

LoggingPointState プロパティは、追跡エントリが記録される原因となったイベントを示すフラグのコレクションを表します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 LoggingPointState;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、追跡エントリが記録される原因となったイベントを示すフラグのコレクションを表します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの許容値は、LogIncomingInterchange、LogMIMEBlob、および LogOutgoingInterchange で、それぞれ整数の 0、1 および 2 に対応します。コードとスクリプトでは、整数値を使用する必要があることに注意してください。

次のコードは、MOF ファイル (InterchangeProvSchema.mof) にあるもので、マッピングを示します。

Values{"LogIncomingInterchange", "LogMIMEBlob",  
     "LogOutgoingInterchange" }, 
BitMap{"0", "1", "2"}

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Name プロパティ

Name プロパティは、サーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Name;

パラメータ

なし

戻り値

string データ型で、サーバー名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの値は、クラスのキーのように働きます。この値で、クラスのインスタンスを一意に識別します。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ParserOrder プロパティ

ParserOrder プロパティは、レジストリに登録されているパーサーコンポーネントの CLSID を、解析順に格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ParserOrder[];

パラメータ

なし

戻り値

string データ型で、レジストリに登録されているパーサーコンポーネントの CLSID を、解析順に格納します。

解説

このプロパティは読み取りおよび書き込み用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProxyHost プロパティ

ProxyHost プロパティは、プロキシホストアドレスを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ProxyHost;

パラメータ

なし

戻り値

string データ型で、プロキシホストアドレスを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProxyPort プロパティ

ProxyPort プロパティは、プロキシポート番号を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ProxyPort = 80;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、プロキシポート番号を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は 80 です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

PurgeSuspendedQueue メソッド

PurgeSuspendedQueue メソッドは、保留キューにあるすべてのドキュメントを管理者が削除できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 PurgeSuspendedQueue();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QueueDbLogon プロパティ

QueueDbLogon プロパティは、共有キューデータベースへの接続文字列のユーザー ID コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string QueueDbLogon;

パラメータ

なし

戻り値

string データ型で、共有キューデータベースへの接続文字列のユーザー ID コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QueueDbName プロパティ

QueueDbName プロパティは、共有キューデータベースへの接続文字列のデータベース名コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string QueueDbName;

パラメータ

なし

戻り値

string データ型で、共有キューデータベースへの接続文字列のデータベース名コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、123 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QueueDbPassword プロパティ

QueueDbPassword プロパティは、共有キューデータベースへの接続文字列のパスワードコンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string QueueDbPassword;

パラメータ

なし

戻り値

string データ型で、共有キューデータベースへの接続文字列のパスワードコンポーネントを格納します。

解説

このプロパティは書き込み専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QueueDbServer プロパティ

QueueDbServer プロパティは、共有キューデータベースへの接続文字列のサーバー名コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string QueueDbServer;

パラメータ

なし

戻り値

string データ型で、共有キューデータベースへの接続文字列のサーバー名コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、60 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ReliableMessagingReplyToURL プロパティ

ReliableMessagingReplyToURL プロパティは、信頼性のあるメッセージングのための URL リポジトリを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ReliableMessagingReplyToURL;

パラメータ

なし

戻り値

string データ型で、信頼性のあるメッセージングのための URL リポジトリを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、512 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

RefreshParserListFromRegistry メソッド

RefreshParserListFromRegistry メソッドは、レジストリに登録されている現在有効なコンポーネントに基づいて、データベースにあるパーサーコンポーネントの一覧を更新します。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 RefreshParserListFromRegistry();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

RetryQueueCount プロパティ

RetryQueueCount プロパティは、再試行キューにあるドキュメントの数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 RetryQueueCount;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、Retry キューにあるドキュメントの数を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ScheduledQueueCount プロパティ

ScheduledQueueCount プロパティは、送信待キューにあるドキュメントの数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ScheduledQueueCount;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、送信待キューにあるドキュメントの数を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

SMTPHost プロパティ

SMTPHost プロパティは、このグループが使用する SMTP のホスト名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string SMTPHost;

パラメータ

なし

戻り値

string データ型で、このグループが使用する SMTP のホスト名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

SuspendedQueueCount プロパティ

SuspendedQueueCount プロパティは、保留キューにあるドキュメントの数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 SuspendedQueueCount;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、保留キューにあるドキュメントの数を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

UseProxyServer プロパティ

UseProxyServer プロパティは、プロキシサーバーを使用するか、使用しないかを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

boolean UseProxyServer = 0;

パラメータ

なし

戻り値

boolean データ型で、プロキシサーバーを使用するか、使用しないかを示します。TRUE の場合、プロキシサーバーが使用され、そうでない場合、値は FALSE で、プロキシサーバーは使用されません。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は FALSE です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

WorkQueueCount プロパティ

WorkQueueCount プロパティは、作業キューにあるドキュメントの数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 WorkQueueCount;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、作業キューにあるドキュメントの数を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_GroupReceiveFunction

MicrosoftBizTalkServer_GroupReceiveFunction クラスは、使いやすさのために提供されている関連付け (association) クラスです。このクラスを使用すると、グループ内のすべての受信関数を取得できます。

Association は、関連付けクラスのインスタンスで、ほかの WMI オブジェクトとの関係を表すのに使用されます。

MicrosoftBizTalkServer_GroupReceiveFunction は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_GroupReceiveFunction クラスは、次のプロパティを定義します。

プロパティ	説明
Antecedent	BizTalk Server グループのプロパティを参照します。
Dependent	BizTalk Server グループに関連する受信関数のプロパティを参照します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Antecedent プロパティ

Antecedent プロパティは、BizTalk Server グループのプロパティを参照します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

MicrosoftBizTalkServer_Group ref Antecedent;

パラメータ

なし

戻り値

ref データ型で、BizTalk Server グループのプロパティを参照します。返される参照は、MicrosoftBizTalkServer_Group オブジェクトのインスタンスへの参照です。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーのように働きます。この値と Dependent プロパティの値で、クラスのインスタンスを一意に識別します。

このプロパティは、集約関連付け付けの親コンポーネントです。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Dependent プロパティ

Dependent プロパティは、BizTalk Server グループに関連する受信関数のプロパティを参照します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

MicrosoftBizTalkServer_ReceiveFunction ref Dependent;

パラメータ

なし

戻り値

ref データ型で、BizTalk Server グループに関連する受信関数のプロパティを参照します。返される参照は、MicrosoftBizTalkServer_ReceiveFunction オブジェクトのインスタンスへの参照です。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値と Antecedent プロパティの値によって、クラスのインスタンスを一意に識別します。

このプロパティは、集約関連付けの子コンポーネントです。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_GroupServer

MicrosoftBizTalkServer_GroupServer クラスは、使いやすさのために提供されている関連付けクラスです。このクラスを使用すると、グループ内のすべてのサーバーを取得できます。

Association は、関連付けクラスのインスタンスで、ほかの WMI オブジェクトとの関係を表すのに使用されます。

MicrosoftBizTalkServer_GroupServer は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_GroupServer クラスは、次のプロパティを定義します。

プロパティ	説明
Antecedent	BizTalk Server グループのプロパティを参照します。
Dependent	BizTalk Server グループに関連するサーバーのプロパティを参照します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Antecedent プロパティ

Antecedent プロパティは、BizTalk Server グループのプロパティを参照します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

MicrosoftBizTalkServer_Group ref Antecedent;

パラメータ

なし

戻り値

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値と Dependent プロパティの値によって、クラスのインスタンスを一意に識別します。

このプロパティは、集約関連付けの親コンポーネントです。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Dependent プロパティ

Dependent プロパティは、BizTalk Server グループに関連するサーバーのプロパティを参照します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

MicrosoftBizTalkServer_Server ref Dependent;

パラメータ

なし

戻り値

ref データ型で、BizTalk Server グループに関連するサーバーのプロパティを参照します。返される参照は、MicrosoftBizTalkServer_Server オブジェクトのインスタンスへの参照です。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値と Antecedent プロパティの値によって、クラスのインスタンスを一意に識別します。

このプロパティは、集約関連付けの子コンポーネントです。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_MgmtDB

MicrosoftBizTalkServer_MgmtDB クラスは、BizTalk メッセージ管理データベースを表します。

MicrosoftBizTalkServer_MgmtDB は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_MgmtDB クラスは、次のプロパティを定義します。

プロパティ	説明
LocalServer	クラスのインスタンスを識別するクラス名を格納します。
MgmtDbLogon	BizTalk メッセージ管理データベースへの接続文字列のユーザー ID コンポーネントを格納します。
MgmtDbName	BizTalk メッセージ管理データベースへの接続文字列の初期カタログコンポーネントを格納し、このデータベース名を表します。
MgmtDbPassword	BizTalk メッセージ管理データベースへの接続文字列のパスワードコンポーネントを格納します。
MgmtDbServer	BizTalk メッセージ管理データベースへの接続文字列のデータソース部分を格納します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

LocalServer プロパティ

LocalServer プロパティは、クラスのインスタンスを識別するクラス名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string LocalServer;

パラメータ

なし

戻り値

string データ型で、クラスのインスタンスを識別するクラス名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値によって、クラスのインスタンスを一意に識別します。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MgmtDbLogon プロパティ

MgmtDbLogon プロパティは、BizTalk メッセージ管理データベースへの接続文字列のユーザー ID コンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string MgmtDbLogon;

パラメータ

なし

戻り値

string データ型で、BizTalk メッセージ管理データベースへの接続文字列のユーザー ID コンポーネントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MgmtDbName プロパティ

MgmtDbName プロパティは、BizTalk メッセージ管理データベースへの接続文字列の初期カタログコンポーネントを格納し、このデータベース名を表します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string MgmtDbName;

パラメータ

なし

戻り値

string データ型で、BizTalk メッセージ管理データベースへの接続文字列の初期カタログコンポーネントを格納し、このデータベース名を表します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、123 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MgmtDbPassword プロパティ

MgmtDbPassword プロパティは、BizTalk メッセージ管理データベースへの接続文字列のパスワードコンポーネントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string MgmtDbPassword;

パラメータ

なし

戻り値

string データ型で、BizTalk メッセージ管理データベースへの接続文字列のパスワードコンポーネントを格納します。

解説

このプロパティは書き込み専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MgmtDbServer プロパティ

MgmtDbServer プロパティは、BizTalk メッセージ管理データベースへの接続文字列のデータソース部分を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string MgmtDbServer;

パラメータ

なし

戻り値

string データ型で、BizTalk メッセージ管理データベースへの接続文字列のデータソース部分を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、60 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_Queue

MicrosoftBizTalkServer_Queue クラスは、抽象クラスで、新しいクラスの基底クラスとしてのみ機能します。このクラスは、実装しないでください。

MicrosoftBizTalkServer_Queue クラスは、次のプロパティを定義します。

プロパティ	説明
Destination	ドキュメントを受信する組織名またはアプリケーション名を格納します。
Group	キューが属するグループ名を格納します。
QID	クラスのインスタンスを識別します。
Source	ドキュメントを送信する組織名またはアプリケーション名を格納します。
Timestamp	ドキュメントが最後に使用された日時またはキューに入った日時を示します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Destination プロパティ

Destination プロパティは、ドキュメントを受信する組織名またはアプリケーション名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Destination;

パラメータ

なし

戻り値

string データ型で、ドキュメントを受信する組織名またはアプリケーション名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、512 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Group プロパティ

Group プロパティは、キューが属するグループ名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Group;

パラメータ

なし

戻り値

string データ型で、キューが属するグループ名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値と QID プロパティの値によって、クラスのインスタンスを一意に識別します。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QID プロパティ

QID プロパティは、クラスのインスタンスを識別します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 QID;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、クラスのインスタンスを識別します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、クラスのキーとして働きます。この値と Group プロパティの値によって、クラスのインスタンスを一意に識別します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Source プロパティ

Source プロパティは、ドキュメントを送信する組織名またはアプリケーション名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Source;

パラメータ

なし

戻り値

string データ型で、ドキュメントを送信する組織名またはアプリケーション名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、64 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Timestamp プロパティ

Timestamp プロパティは、ドキュメントが最後に使用された日時またはキューに入った日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime Timestamp;

パラメータ

なし

戻り値

datetime データ型で、ドキュメントが最後に使用された日時またはキューに入った日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_ReceiveFunction

MicrosoftBizTalkServer_ReceiveFunction クラスは、受信したインターチェンジを特定のプロトコル (ファイル、メッセージキュー、スクリプトなど) を使用して処理するように BizTalk Server 上にセットアップされたサービスを表します。

MicrosoftBizTalkServer_ReceiveFunction は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_ReceiveFunction クラスは、次のプロパティを定義します。

プロパティ	説明
ChannelName	パススルーフラグが有効な場合に、受信関数が Submit メソッド呼び出しに渡す必要があるチャネル名を格納します。
Comment	ユーザーコメントを格納します。
DateModified	インスタンスデータの最終更新日を示します。
DestinationID	ドキュメントを受信する組織またはアプリケーションの ID を表します。
DestinationQualifier	ドキュメントを受信する組織またはアプリケーションの ID の種類を表します。
DisableReceiveFunction	受信関数を有効にするか、無効にするかを示します。
DocumentName	チャネルの入力ドキュメントのドキュメント定義名を格納します。
EnvelopeName	BizTalk メッセージ管理データベースのエンベロープ定義インスタンスの名前を格納します。
FilenameMask	BizTalk Server に入力するファイルをファイルシステムから取り出す受信関数で使用するファイル名マスクを格納します。
GroupName	サーバーが属するグループ名を格納します。
IsPassThrough	パススルーフラグを有効、または無効のどちらにして Submit メソッド呼出しを行うかを示します。
Name	コンポーネント名を格納します。
OpennessFlag	受信関数が Submit メソッドに渡す lOpenness パラメータの値を示します。
Password	ユーザー名およびパスワードを必要とする FTP またはメッセージキュー受信関数が使用するパスワードを格納します。
PollingLocation	ポーリングを必要とする受信関数用に、ディレクトリ、メッセージキューなどをポーリングするディレクトリ名を格納します。
PreProcessor	受信ドキュメントに対して行う必要がある処理を示します。
ProcessingServer	インターチェンジを現在処理中のサーバー名を格納します。
SourceID	ドキュメントを送信する組織またはアプリケーションの ID を格納します。
SourceQualifier	ドキュメントを送信する組織またはアプリケーションの ID の種類を格納します。
Username	FTP またはメッセージキュー受信関数で使用するユーザー名を格納します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ChannelName プロパティ

ChannelName プロパティは、パススルーフラグが有効な場合に、受信関数が Submit メソッド呼び出しに渡す必要があるチャネル名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ChannelName;

パラメータ

なし

戻り値

string データ型で、パススルーフラグが有効な場合に、受信関数が Submit メソッド呼び出しを渡さなければならないチャネル名を格納します。詳細については、次の「解説」を参照してください。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、64 文字です。

このプロパティは、カスタム受信関数に必要です。

C++ プログラムの場合は、このプロパティの値を IInterchange::Submit メソッドで使用してください。Visual Basic プログラムの場合は、このプロパティの値を Interchange.Submit メソッドで使用してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Comment プロパティ

Comment プロパティは、ユーザーコメントを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Comment;

パラメータ

なし

戻り値

string データ型で、ユーザーコメントを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は 256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DateModified プロパティ

DateModified プロパティは、インスタンスデータの最終更新日を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime DateModified;

パラメータ

なし

戻り値

datetime データ型で、インスタンスデータの最終更新日を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DestinationID プロパティ

DestinationID プロパティは、ドキュメントを受信する組織またはアプリケーションの ID を表します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DestinationID;

パラメータ

なし

戻り値

string データ型で、ドキュメントを受信する組織またはアプリケーションの ID を表します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

このプロパティは、カスタム受信関数に必要です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DestinationQualifier プロパティ

DestinationQualifier プロパティは、ドキュメントを受信する組織またはアプリケーションの ID の種類を表します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DestinationQualifier;

パラメータ

なし

戻り値

string データ型で、ドキュメントを受信する組織またはアプリケーションの ID の種類を表します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、64 文字です。

このプロパティは、カスタム受信関数に必要です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DisableReceiveFunction プロパティ

DisableReceiveFunction プロパティは、受信関数を有効にするか、無効にするかを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

boolean DisableReceiveFunction = 0;

パラメータ

なし

戻り値

boolean データ型で、受信関数を有効にするか、無効にするかを示します。TRUE の場合、受信関数は無効で、そうでない場合、値は FALSE で、受信関数は有効です。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は FALSE です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocumentName プロパティ

DocumentName プロパティは、チャネルの入力ドキュメントのドキュメント定義名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocumentName;

パラメータ

なし

戻り値

string データ型で、チャネルの入力ドキュメントのドキュメント定義名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

このプロパティは、カスタム受信関数に必要です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

EnvelopeName プロパティ

EnvelopeName プロパティは、BizTalk メッセージ管理データベースのエンベロープ定義インスタンスの名前を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string EnvelopeName;

パラメータ

なし

戻り値

string データ型で、BizTalk メッセージ管理データベースのエンベロープ定義インスタンスの名前を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

このプロパティは、カスタム受信関数に必要です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

FilenameMask プロパティ

FilenameMask プロパティは、BizTalk Server に入力するファイルをファイルシステムから取り出す受信関数で使用するファイル名マスクを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string FilenameMask;

パラメータ

なし

戻り値

string データ型で、BizTalk Server に入力するファイルをファイルシステムから取り出す受信関数で使用するファイル名マスクを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

GroupName プロパティ

GroupName プロパティは、サーバーが属するグループ名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string GroupName;

パラメータ

なし

戻り値

string データ型で、サーバーが属するグループ名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

IsPassThrough プロパティ

IsPassThrough プロパティは、パススルーフラグを有効、または無効のどちらにして Submit メソッド呼出しを行うかを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

boolean IsPassThrough = 0;

パラメータ

なし

戻り値

boolean データ型で、パススルーフラグを有効、または無効のどちらにして Submit メソッド呼出しを行うかを示します。TRUE の場合、パススルーフラグは有効で、そうでない場合、値は FALSE で、パススルーフラグは無効です。詳細については、次の「解説」を参照してください。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は FALSE です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Name プロパティ

Name プロパティは、コンポーネント名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Name;

パラメータ

なし

戻り値

string データ型で、コンポーネント名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの値は、クラスのキーとして働きます。この値によって、クラスのインスタンスを一意に識別します。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

OpennessFlag プロパティ

OpennessFlag プロパティは、受信関数が Submit メソッドに渡す lOpenness パラメータの値を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 OpennessFlag;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、受信関数が Submit メソッドに渡す lOpenness パラメータの値を示します。詳細については、次の「解説」を参照してください。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの許容値は、NotOpen、OpenSource、および OpenDestination で、それぞれ整数の 0、1 および 2 に対応します。コードとスクリプトには、整数値を使用する必要があることに注意してください。

次のコードは MOF ファイル (InterchangeProvSchema.mof) にあるもので、その整数値を示します。

Values {"NotOpen", "OpenSource", "OpenDestination"}

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Password プロパティ

Password プロパティは、ユーザー名およびパスワードを必要とする FTP またはメッセージキュー受信関数が使用するパスワードを格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Password;

パラメータ

なし

戻り値

string データ型で、ユーザー名およびパスワードを必要とする FTP またはメッセージキュー受信関数が使用するパスワードを格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

PollingLocation プロパティ

PollingLocation プロパティは、ポーリングを必要とする受信関数用に、ディレクトリ、メッセージキューなどをポーリングするディレクトリ名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string PollingLocation;

パラメータ

なし

戻り値

string データ型で、ポーリングを必要とする受信関数用に、ディレクトリ、メッセージキューなどをポーリングするディレクトリ名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、260 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

PreProcessor プロパティ

PreProcessor プロパティは、受信ドキュメントに対して行う必要がある処理を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string PreProcessor;

パラメータ

なし

戻り値

string データ型で、受信ドキュメントに対して行う必要がある処理を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProcessingServer プロパティ

ProcessingServer プロパティは、インターチェンジを現在処理中のサーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ProcessingServer;

パラメータ

なし

戻り値

string データ型で、インターチェンジを現在処理中のサーバー名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

SourceID プロパティ

SourceID プロパティは、ドキュメントを送信する組織またはアプリケーションの ID を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string SourceID;

パラメータ

なし

戻り値

string データ型で、ドキュメントを送信する組織またはアプリケーションの ID を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

このプロパティは、カスタム受信関数に必要です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

SourceQualifier プロパティ

SourceQualifier プロパティは、ドキュメントを送信する組織またはアプリケーションの ID の種類を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string SourceQualifier;

パラメータ

なし

戻り値

string データ型で、ドキュメントを送信する組織またはアプリケーションの ID の種類を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、64 文字です。

このプロパティは、カスタム受信関数に必要です。このプロパティの値として、電話番号や Dunn & Bradstreet 番号などを使用することができます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Username プロパティ

Username プロパティは、FTP またはメッセージキュー受信関数で使用するユーザー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Username;

パラメータ

なし

戻り値

string データ型で、FTP またはメッセージキュー受信関数で使用するユーザー名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_RetryQueue

MicrosoftBizTalkServer_RetryQueue クラスは、共有キューにある受信確認の照合を待機しているインターチェンジの論理グループ化、または複数の宛先に送信される予定のインターチェンジを表します。

MicrosoftBizTalkServer_RetryQueue は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_RetryQueue は、次のプロパティを MicrosoftBizTalkServer_Queue クラスから継承します。

プロパティ	説明
Destination	ドキュメントを受信する組織名またはアプリケーション名を格納します。
Group	キューが属するグループ名を格納します。
QID	クラスのインスタンスを識別します。
Source	ドキュメントを送信する組織名またはアプリケーション名を格納します。
Timestamp	ドキュメントが最後に使用された日時またはキューに入った日時を示します。

MicrosoftBizTalkServer_RetryQueue クラスは、次のプロパティを定義します。

プロパティ	説明
LastRetryTime	サーバーが最後に送信を試行した日時を示します。
ProcessingServer	ドキュメントを最後に処理したサーバー名を格納します。
RemainingRetryCount	残りの再試行回数を示します。
RetryInterval	試行間隔 (分単位) を示します。
ServiceWindowFromTime	インターチェンジを送信するサービスウィンドウの開始日時を示します。
ServiceWindowToTime	インターチェンジを送信するサービスウィンドウの終了日時を示します。

MicrosoftBizTalkServer_RetryQueue クラスは、次のメソッドを定義します。

メソッド	説明
MoveToSuspendedQueue	管理者が選択したドキュメントを保留キューに移動できるようにします。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

LastRetryTime プロパティ

LastRetryTime プロパティは、サーバーが最後に送信を試行した日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime LastRetryTime;

パラメータ

なし

戻り値

datetime データ型で、サーバーが最後に送信を試行した日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MoveToSuspendedQueue メソッド

MoveToSuspendedQueue メソッドは、管理者が選択したドキュメントを保留キューに移動できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 MoveToSuspendedQueue();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProcessingServer プロパティ

ProcessingServer プロパティは、ドキュメントを最後に処理したサーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ProcessingServer;

パラメータ

なし

戻り値

string データ型で、ドキュメントを最後に処理したサーバー名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

RemainingRetryCount プロパティ

RemainingRetryCount プロパティは、残りの再試行回数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 RemainingRetryCount;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、残りの再試行回数を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

RetryInterval プロパティ

RetryInterval プロパティは、試行間隔 (分単位) を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 RetryInterval;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、試行間隔 (分単位) を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ServiceWindowFromTime プロパティ

ServiceWindowFromTime プロパティは、インターチェンジを送信するサービスウィンドウの開始日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime ServiceWindowFromTime;

パラメータ

なし

戻り値

datetime データ型で、インターチェンジを送信するサービスウィンドウの開始日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ServiceWindowToTime プロパティ

ServiceWindowToTime プロパティは、インターチェンジを送信するサービスウィンドウの終了日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime ServiceWindowToTime;

パラメータ

なし

戻り値

datetime データ型で、インターチェンジを送信するサービスウィンドウの終了日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_ScheduledQueue

MicrosoftBizTalkServer_ScheduledQueue クラスは、サービスウィンドウに基づいて後で配信される予定の共有キューにあるインターチェンジの論理グループ化を表します。

MicrosoftBizTalkServer_ScheduledQueue は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_ScheduledQueue は、次のプロパティを MicrosoftBizTalkServer_Queue クラスから継承します。

プロパティ	説明
Destination	ドキュメントを受信する組織名またはアプリケーション名を格納します。
Group	キューが属するグループ名を格納します。
QID	クラスのインスタンスを識別します。
Source	ドキュメントを送信する組織名またはアプリケーション名を格納します。
Timestamp	ドキュメントが最後に使用された日時またはキューに入った日時を示します。

MicrosoftBizTalkServer_ScheduledQueue クラスは、次のプロパティを定義します。

プロパティ	説明
ProcessingServer	ドキュメントを最後に処理したサーバー名を格納します。
ServiceWindowFromTime	インターチェンジを送信するサービスウィンドウの開始日時を示します。
ServiceWindowToTime	インターチェンジを送信するサービスウィンドウの終了日時を示します。

MicrosoftBizTalkServer_ScheduledQueue クラスは、次のメソッドを定義します。

メソッド	説明
MoveToSuspendedQueue	管理者が選択したドキュメントを保留キューに移動できるようにします。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MoveToSuspendedQueue メソッド

MoveToSuspendedQueue メソッドは、管理者が選択したドキュメントを保留キューに移動できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 MoveToSuspendedQueue();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProcessingServer プロパティ

ProcessingServer プロパティは、ドキュメントを最後に処理したサーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ProcessingServer;

パラメータ

なし

戻り値

string データ型で、ドキュメントを最後に処理したサーバー名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ServiceWindowFromTime プロパティ

ServiceWindowFromTime プロパティは、インターチェンジを送信するサービスウィンドウの開始日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime ServiceWindowFromTime;

パラメータ

なし

戻り値

datetime データ型で、インターチェンジを送信するサービスウィンドウの開始日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、間隔で表されます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ServiceWindowToTime プロパティ

ServiceWindowToTime プロパティは、インターチェンジを送信するサービスウィンドウの終了日時を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime ServiceWindowToTime;

パラメータ

なし

戻り値

datetime データ型で、インターチェンジを送信するサービスウィンドウの終了日時を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、間隔で表されます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_Server

MicrosoftBizTalkServer_Server クラスは、BizTalk メッセージングサービスを実行している BizTalk Server グループ内の特定の Windows 2000 コンピュータを表します。

MicrosoftBizTalkServer_Server は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_Server クラスは、次のプロパティを定義します。

プロパティ	説明
DateModified	インスタンスデータの最終更新日を示します。
GroupName	サーバーが属するグループ名を格納します。
MaxRecvSvcThreadsPerProcessor	BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できる受信関数スレッドの最大数を示します。
MaxWorkerThreadsPerProcessor	BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できるワーカースレッドの最大数を示します。
Name	サーバー名を格納します。
ParticipateInWorkItemProcessing	サーバーが作業項目の処理に参加するか、参加しないかを示します。
SchedulerWaitTime	BizTalk Server スケジューラの試行間隔 (ミリ秒) を示します。
ServiceState	特定のサーバー上の BizTalk Server サービスの状態を示します。

MicrosoftBizTalkServer_Server クラスは、次のメソッドを定義します。

メソッド	説明
FreeInterchanges	特定のサーバーが停止、撤去、またはエラー状態になった場合、そのサーバーに割り当てられていたインターチェンジを解放し、ほかのサーバーが、これらのインターチェンジを使用できるようにします。
StartServer	特定のサーバー上の BizTalk Server サービスを開始します。
StopServer	特定のサーバー上の BizTalk Server サービスを停止します。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DateModified プロパティ

DateModified プロパティは、インスタンスデータの最終更新日を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

datetime DateModified;

パラメータ

なし

戻り値

datetime データ型で、インスタンスデータの最終更新日を示します。

解説

このプロパティは読み取り専用です。

このプロパティの値は、日付と時刻の形式です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

FreeInterchanges メソッド

FreeInterchanges メソッドは、特定のサーバーが停止、撤去、またはエラー状態になった場合、そのサーバーに割り当てられていたインターチェンジを解放し、ほかのサーバーが、これらのインターチェンジを使用できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 FreeInterchanges();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

GroupName プロパティ

GroupName プロパティは、サーバーが属するグループ名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string GroupName;

パラメータ

なし

戻り値

string データ型で、サーバーが属するグループ名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MaxRecvSvcThreadsPerProcessor プロパティ

MaxRecvSvcThreadsPerProcessor プロパティは、BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できる受信関数スレッドの最大数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 MaxRecvSvcThreadsPerProcessor = 4;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できる受信関数スレッドの最大数を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は 4 です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MaxWorkerThreadsPerProcessor プロパティ

MaxWorkerThreadsPerProcessor プロパティは、BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できるワーカースレッドの最大数を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 MaxWorkerThreadsPerProcessor = 4;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、BizTalk Server が非同期呼出しにプロセッサ 1 個につき使用できるワーカースレッドの最大数を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの既定値は 4 です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Name プロパティ

Name プロパティは、サーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string Name;

パラメータ

なし

戻り値

string データ型で、サーバー名を格納します。

解説

このプロパティは読み取りおよび書き込み用です。

このプロパティの値は、クラスのキーとして働きます。この値によって、クラスのインスタンスを一意に識別します。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ParticipateInWorkItemProcessing プロパティ

ParticipateInWorkItemProcessing プロパティは、サーバーが作業項目の処理に参加するか、参加しないかを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

boolean ParticipateInWorkItemProcessing = 1;

パラメータ

なし

戻り値

boolean データ型で、サーバーが作業項目の処理に参加するか、参加しないかを示します。TRUE の場合、サーバーは作業項目の処理に参加し、そうでない場合、値は FALSE で、サーバーは作業項目の処理に参加しません。

解説

このプロパティは読み取りおよび書き込み用です。

このパラメータの既定値は TRUE です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

SchedulerWaitTime プロパティ

SchedulerWaitTime プロパティは、BizTalk Server スケジューラの試行間隔 (ミリ秒) を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 SchedulerWaitTime = 2000;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、BizTalk Server スケジューラの試行間隔 (ミリ秒) を示します。

解説

このプロパティは読み取りおよび書き込み用です。

このパラメータの既定値は 2,000 ミリ秒です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ServiceState プロパティ

ServiceState プロパティは、特定のサーバー上の BizTalk Server サービスの状態を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ServiceState;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、特定のサーバー上の BizTalk Server サービスの状態を示します。

解説

このプロパティは読み取り専用です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

StartServer メソッド

StartServer メソッドは、特定のサーバー上の BizTalk Server サービスを開始します。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 StartServer();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

解説

指定されたサーバーが停止中であれば、このメソッドの実行は随時有効です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

StopServer メソッド

StopServer メソッドは、特定のサーバー上の BizTalk Server サービスを停止します。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 StopServer();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

解説

指定されたサーバーが実行中であれば、このメソッドの実行は随時有効です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_SuspendedQueue

MicrosoftBizTalkServer_SuspendedQueue クラスは、共有キューにある正常に処理可能なインターチェンジの論理グループ化を表します。

MicrosoftBizTalkServer_SuspendedQueue は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_SuspendedQueue は、次のプロパティを MicrosoftBizTalkServer_Queue クラスから継承します。

プロパティ	説明
Destination	ドキュメントを受信する組織名またはアプリケーション名を格納します。
Group	キューが属するグループ名を格納します。
QID	クラスのインスタンスを識別します。
Source	ドキュメントを送信する組織名またはアプリケーション名を格納します。
Timestamp	ドキュメントが最後に使用された日時またはキューに入った日時を示します。

MicrosoftBizTalkServer_SuspendedQueue クラスは、次のプロパティを定義します。

プロパティ	説明
DocName	キュー内のドキュメントに関連したドキュメント定義名を格納します。
ErrorDescription	エラーの説明テキストの最初の 64 文字を格納します。
QGUID	保留キューの作業項目の送信 GUID を格納します。
State	保留キューにあるドキュメントまたはインターチェンジの状態を示します。

MicrosoftBizTalkServer_SuspendedQueue クラスは、次のメソッドを定義します。

メソッド	説明
Resubmit	管理者が選択したドキュメントをサーバーに送信できるようにします。
ViewDocument	管理者が保留キューで選択したドキュメントの内容を表示できるようにします。
ViewErrorDescription	管理者がエラーの説明を表示できるようにします。
ViewInterchange	管理者が保留キューで選択したインターチェンジの内容を表示できるようにします。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocName プロパティ

DocName プロパティは、キュー内のドキュメントに関連したドキュメント定義名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocName;

パラメータ

なし

戻り値

string データ型で、キュー内のドキュメントに関連したドキュメント定義名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ErrorDescription プロパティ

ErrorDescription プロパティは、エラーの説明テキストの最初の 64 文字を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ErrorDescription;

パラメータ

なし

戻り値

string データ型で、エラーの説明テキストの最初の 64 文字を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、64 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

QGUID プロパティ

QGUID プロパティは、保留キューの作業項目の送信 GUID を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string QGUID;

パラメータ

なし

戻り値

string データ型で、保留キューの作業項目の送信 GUID を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

Resubmit メソッド

Resubmit メソッドは、管理者が選択したドキュメントをサーバーに送信できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 Resubmit();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

解説

このメソッドは、問題が解決された後で、管理者がインターチェンジを再送信できるようにします。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

State プロパティ

State プロパティは、保留キューにあるドキュメントまたはインターチェンジの状態を示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 State;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、保留キューにあるドキュメントまたはインターチェンジの状態を示します。詳細については、次の「解説」を参照してください。

解説

このプロパティは読み取り専用です。

次ぎの表は、保留キューにあるドキュメントやインターチェンジの処理状態としてあり得るものを示します。

次の表の状態にあるドキュメントは、インターチェンジレベルのため、データを表示するには ViewInterchange メソッドを使用する必要があります。さらに、これらの状態にあるインターチェンジは再送信できないため、Resubmit メソッドの呼び出しを行うことはできません。

値	状態
0	初期状態
1	カスタムコンポーネント
2	解析

次の表の状態にあるドキュメントは、インターチェンジではなくドキュメントと見なされるため、データを表示するには ViewDocument メソッドを使用する必要があります。さらに、ドキュメントの確認状態 (3) にあるドキュメントは再送信できないため、この状態のドキュメントについては Resubmit メソッドの呼び出しを行うことはできません。

値	状態
3	ドキュメントの確認
4	チャネルの選択
5	フィールドの追跡
6	関連付け
7	マッピング
8	シリアライズ

次の表の状態にあるドキュメントは、インターチェンジと見なされるため、データを表示するには ViewInterchange メソッドを使用する必要があります。

値	状態
9	エンコード
10	署名
11	暗号化
12	送信

ViewErrorDescription メソッドは、失敗したドキュメントおよびインターチェンジについてのエラーの説明情報を取得するのに使用できることに注意してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ViewDocument メソッド

ViewDocument メソッドは、管理者が保留キューで選択したドキュメントの内容を表示できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ViewDocument(

uint8 <ドキュメント>[],

uint32 <コードページ>

);

パラメータ

<ドキュメント>[]

[出力] バイトの配列で、ドキュメント内の情報を表します。判読可能な形式への変換が必要な場合があります。このパラメータの最大サイズは 4 MB です。4 MB を超えた部分は切り捨てられます。このパラメータの詳細については、次の「解説」を参照してください。

<コードページ>

[出力] ドキュメントのコードページです。このパラメータの詳細については、次の「解説」を参照してください。

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

解説

次の表に、< コードページ > パラメータの値としてとり得る値と、その意味を示します。

値	説明
-1	使用できるコードページはなし
0	既定のシステムコードページ
1200	Unicode コードページ
1252	ASCII コードページ

< コードページ > パラメータに返された値が 0 または 1200 の場合、データは表示可能で変換する必要はありません。ただし、返された値が -1 の場合、Microsoft XML (MSXML) にデータをロードしてみる必要があります。

< コードページ > に返された値が 1252 の場合は、MSXML にデータをロードしてみる必要があります。この方法で表示できない場合、MultiByteToWideChar 関数を使用し、< コードページ > をコードページパラメータとして Microsoft Win32® API に渡すことができます。

ドキュメントの内容の表示方法については、「付録ソリューションライブラリ」の「ドキュメントおよびインターチェンジの内容を表示する」の項を参照してください。

< ドキュメント > パラメータに含まれるデータが 4 MB を超える場合、C++ プログラムの場合は IInterchange::GetSuspendedQueueItemDetails メソッドを使用して、ドキュメントを取得することができます。

また、Microsoft Visual Basic プログラムの場合は、Interchange.GetSuspendedQueueItemDetails メソッドを使用して、ドキュメントを取得することができます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ViewErrorDescription メソッド

ViewErrorDescription メソッドは、管理者がエラーの説明を表示できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ViewErrorDescription(

string CompleteErrorDescription

);

パラメータ

CompleteErrorDescription

[出力] エラーの内容を説明する文字列です。

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ViewInterchange メソッド

ViewInterchange メソッドは、管理者が保留キューで選択したインターチェンジの内容を表示できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 ViewInterchange(

uint8 <インターチェンジ>[],

uint32 <コードページ>

);

パラメータ

<インターチェンジ>[]

[出力] バイトの配列で、インターチェンジ内の情報を表します。判読可能な形式への変換が必要な場合があります。このパラメータの最大サイズは 4 MB です。4 MB を超えた部分は切り捨てられます。詳細については、次の「解説」を参照してください。

<コードページ>

[出力] インターチェンジのコードページです。詳細については、次の「解説」を参照してください。

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

解説

次の表に、< コードページ > パラメータの値としてとり得る値と、その意味を示します。

値	説明
-1	使用できるコードページはなし
0	既定のシステムコードページ
1200	Unicode コードページ
1252	ASCII コードページ

< コードページ > パラメータに返された値が 0 または 1200 の場合、データは表示可能で変換する必要はありません。ただし、返された値が -1 の場合、MSXML にデータをロードしてみる必要があります。

< コードページ > に返された値が 1252 の場合は、MSXML にデータをロードしてみる必要があります。この方法で表示できない場合、MultiByteToWideChar 関数を使用し、< コードページ > をコードページパラメータとして Win32 API に渡すことができます。

インターチェンジの内容の表示方法については、「付録ソリューションライブラリ」の「ドキュメントおよびインターチェンジの内容を表示する」の項を参照してください。

< インターチェンジ > パラメータに含まれるデータが 4 MB を超える場合、C++ プログラムの場合は IInterchange::GetSuspendedQueueItemDetails メソッドを使用して、インターチェンジを取得することができます。

また、Microsoft Visual Basic プログラムの場合は、Interchange.GetSuspendedQueueItemDetails メソッドを使用して、インターチェンジを取得することができます。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MicrosoftBizTalkServer_WorkQueue

MicrosoftBizTalkServer_WorkQueue クラスは、共有キューにある現在処理中のインターチェンジの論理グループ化を表します。

MicrosoftBizTalkServer_WorkQueue は動的クラスで、必要に応じて WMI プロバイダである InterchangeProv の実行時に提供されます。

MicrosoftBizTalkServer_WorkQueue は、次のプロパティを MicrosoftBizTalkServer_Queue クラスから継承します。

プロパティ	説明
Destination	ドキュメントを受信する組織名またはアプリケーション名を格納します。
Group	キューが属するグループ名を格納します。
QID	クラスのインスタンスを識別します。
Source	ドキュメントを送信する組織名またはアプリケーション名を格納します。
Timestamp	ドキュメントが最後に使用された日時またはキューに入った日時を示します。

MicrosoftBizTalkServer_WorkQueue クラスは、次のプロパティを定義します。

プロパティ	説明
DocName	キュー内のドキュメントに関連したドキュメント定義名を格納します。
EngineState	作業項目が受信確認の照合の待機中か、または送信の待機中かを示します。
ProcessingServer	ドキュメントを最後に処理したサーバー名を格納します。

MicrosoftBizTalkServer_WorkQueue クラスは、次のメソッドを定義します。

メソッド	説明
MoveToSuspendedQueue	管理者が選択したドキュメントを保留キューに移動できるようにします。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

DocName プロパティ

DocName プロパティは、キュー内のドキュメントに関連したドキュメント定義名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string DocName;

パラメータ

なし

戻り値

string データ型で、キュー内のドキュメントに関連したドキュメント定義名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、256 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

EngineState プロパティ

EngineState プロパティは、作業項目が関連付けの待機中か、または送信の待機中かを示します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 EngineState;

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、作業項目が受信確認の照合を待機しているか、または送信を待機しているかを示します。詳細については、次の「解説」を参照してください。

解説

このプロパティは読み取り専用です。

このプロパティに使用できる値は、次のコードで示すように BTSCoreQueueStates 列挙によって定義されます。

typedef enum { 
  Processing = STATE_TRANSLATION, 
  Correlation = STATE_RECEIPT_CORRELATION, 
  TransmissionWServiceWindow = STATE_FIND_TRANSMISSION, 
  Transmission = STATE_TRANSMISSION 
} BTSCoreQueueStates;

次の表に、BTSCoreQueueStates 列挙で定義される定数の数値を示します。

値	定数
29	Processing
30	Correlation
31	TransmissionWServiceWindow
33	Transmission

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

MoveToSuspendedQueue メソッド

MoveToSuspendedQueue メソッドは、管理者が選択したドキュメントを保留キューに移動できるようにします。

構文

この構文は、言語に依存しません。このメソッドは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

uint32 MoveToSuspendedQueue();

パラメータ

なし

戻り値

32 ビットの符号なしの整数で、HRESULT です。

詳細については、前述の「WMI エラーを処理する」を参照してください。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

ProcessingServer プロパティ

ProcessingServer プロパティは、ドキュメントを最後に処理したサーバー名を格納します。

構文

この構文は、言語に依存しません。このプロパティは、C++、Microsoft Visual Basic、および Visual Basic Script でサポートされます。

string ProcessingServer;

パラメータ

なし

戻り値

string データ型で、ドキュメントを最後に処理したサーバー名を格納します。

解説

このプロパティは読み取り専用です。

このプロパティ値の最大長は、63 文字です。

要件

Windows NT/Windows 2000 : Windows 2000 SP1 以降

付録 - ソリューションライブラリ

ここでは、Microsoft Visual Basic のサンプルを使用して、BizTalk Server と WMI を使用する際の一般的なタスクに対するコードソリューションの例を示します。

Visual Basic プロジェクトが次のコードで使用される WMI オブジェクトに確実にアクセスできるようにするには、[参照設定] ダイアログボックスで Microsoft WMI Scripting V1.1 Library を追加する必要があります。

まず、WMI ロケータとサービス変数を宣言します。

Public g_objLocator As SWbemLocator 
Public g_objService As SWbemServices

さらに、次の定数も定義する必要があります。

Public Const GROUP_NAMESPACE = "MicrosoftBizTalkServer_Group" 
Public Const MGMT_NAMESPACE = "MicrosoftBizTalkServer_MgmtDB" 
Public Const SERVER_NAMESPACE = "MicrosoftBizTalkServer_Server" 
Public Const RECVSVC_NAMESPACE = "MicrosoftBizTalkServer_ReceiveFunction" 
Public Const QUEUE_NAMESPACE = "MicrosoftBizTalkServer_Queue" 
Public Const WORKQ_NAMESPACE = "MicrosoftBizTalkServer_WorkQueue" 
Public Const SCHEDULEDQ_NAMESPACE = _   
       "MicrosoftBizTalkServer_ScheduledQueue" 
Public Const RETRYQ_NAMESPACE = "MicrosoftBizTalkServer_RetryQueue" 
Public Const SUSPENDEDQ_NAMESPACE = _ 
       "MicrosoftBizTalkServer_SuspendedQueue"

WMI への接続には、次のコードを使用します。

Set g_objLocator = New SWbemLocator 
Set g_objService = g_objLocator.ConnectServer(, _ 
           "root/MicrosoftBizTalkServer")

ドキュメントを操作する

ここで取り上げるコードサンプルは、ドキュメントやインターチェンジの操作に活用できます。インターチェンジは、1 回の送信から成る 1 つまたは複数のドキュメントインスタンスのコレクションです。

ここでは、ドキュメントやインターチェンジから可変データを文字列に変換するために組み合わせて使用する関数を示します。

ドキュメントおよびインターチェンジの内容を表示する

MicrosoftBizTalkServer_SuspendedQueue クラスの ViewDocument メソッドまたは ViewInterchange メソッドを使用する場合、返されたバイト配列の判読可能な形式への変換が必要な場合があります。

次の関数はコードページと可変データ取得して、文字列を返します。

Function ConvertViewDocument(ByVal varData As Variant, _  
               ByVal codepage As Long) As String 
   Dim varData2() As Byte 
   Dim i As Long 
   Dim strTemp As String 
   Dim Dom As New DOMDocument 
    
   On Error Resume Next 
   ReDim varData2(UBound(varData)) 
   For i = LBound(varData) To UBound(varData) 
    varData2(i) = varData(i) 
   Next 
   If codepage = -1 Then 
    strTemp = CStr(varData2) 
    Call Dom.loadXML(strTemp) 
    If Err <> 0 Then 
      ConvertViewDocument = "" 
    ElseIf Dom.parseError.errorCode <> 0 Then 
      ConvertViewDocument = "" 
    Else 
      ConvertViewDocument = Dom.xml 
    End If 
  Else 
    ConvertViewDocument = ConvertVarToBstr(varData2, codepage) 
  End If 
End Function

ConvertViewDocument 関数は、次の関数を使用して可変データを文字列に変換します。

Public Function ConvertVarToBstr(ByRef varData As Variant, _ 
                 ByVal strCodePage As String) As String 
  Dim stm As New ADODB.Stream 
     
  Select Case UCase(TypeName(varData)) 
    Case "STRING" 
      ConvertVarToBstr = varData 
    Case "BYTE()" 
      stm.Type = adTypeBinary ' adTypeBinary 
      stm.Open 
      stm.Write varData 
      stm.Position = 0 
      stm.Type = adTypeText 
      stm.Charset = GetCharset(strCodePage) 
      ConvertVarToBstr = stm.ReadText 
      stm.Close 
    Case Else 
      ConvertVarToBstr = "" 
   End Select 
End Function

ConvertVarToBstr 関数は、次のプライベート関数を使用して文字セットを返します。

Private Function GetCharset(ByVal codepage As String) 
  Select Case codepage 
    Case 932 
      GetCharset = "shift-jis" 
    Case 1252 
      GetCharset = "us-ascii" 
    Case 160001 
      GetCharset = "utf-8" 
    Case 1200 
      GetCharset = "unicode" 
  End Select 
End Function

グループを操作する

ここで取り上げるコードサンプルは、グループの操作に活用できます。サーバーグループは、中央から集中的に管理、構成、および監視されているサーバーのコレクションです。

ここでは、グループの作成、グループの削除、グループ名を指定したグループの取得、およびすべてのグループの取得を行う関数を示します。

グループを作成する

次の関数はグループを作成します。

Public Function CreateGroup(ByVal strGroupName As String, _ 
        ByVal strDocTrackDbLogon As String, _         
        ByVal strDocTrackDbName As String, _ 
        ByVal strDocTrackDbPassword As String, _ 
        ByVal strDocTrackDbServer As String, _ 
        ByVal strQueueDbLogon As String, _  
        ByVal strQueueDbName As String, _ 
        ByVal strQueueDbPassword As String, _ 
        ByVal strQueueDbServer As String, _ 
        Optional ByVal lAdminCacheRefreshInterval As Long, _ 
        Optional ByVal strSMTPHost As String, _ 
        Optional ByVal strReliableMessagingReplyToURL As String, _ 
        Optional UseProxyServer As Boolean, _  
        Optional strProxyName As String, _ 
        Optional lProxyport As Long, _ 
        Optional lLoggingPointState As Integer) _ 
                      As Boolean 
         
  Dim objBTGroup As SWbemObject 
  Dim objBTGroupInstance As SWbemObject 
   
  On Error Resume Next 
  Set objBTGroup = g_objService.Get(GROUP_NAMESPACE) 
  Set objBTGroupInstance = objBTGroup.SpawnInstance_ 
  CreateGroup = True 
  objBTGroupInstance.Name = strGroupName 
  objBTGroupInstance.DocTrackDbLogon = strDocTrackDbLogon 
  objBTGroupInstance.DocTrackDbName = strDocTrackDbName 
  objBTGroupInstance.DocTrackDbPassword = strDocTrackDbPassword 
  objBTGroupInstance.DocTrackDbServer = strDocTrackDbServer 
  objBTGroupInstance.QueueDbLogon = strQueueDbLogon 
  objBTGroupInstance.QueueDbName = strQueueDbName 
  objBTGroupInstance.QueueDbPassword = strQueueDbPassword 
  objBTGroupInstance.QueueDbServer = strQueueDbServer 
     
  If strReliableMessagingReplyToURL <> "" Then 
    objBTGroupInstance.ReliableMessagingReplyToURL = _  
      strReliableMessagingReplyToURL 
  End If 
  If lAdminCacheRefreshInterval <> 0 Then 
    objBTGroupInstance.ConfigurationCacheRefreshInterval = _  
      lAdminCacheRefreshInterval 
  End If 
  objBTGroupInstance.UseProxyServer = UseProxyServer 
  objBTGroupInstance.ProxyHost = strProxyName 
  If lProxyport = 0 Then 
    objBTGroupInstance.ProxyPort = lProxyport 
  Else 
    objBTGroupInstance.ProxyPort = lProxyport 
  End If 
  objBTGroupInstance.LoggingPointState = lLoggingPointState 
  objBTGroupInstance.SMTPHost = strSMTPHost 
  objBTGroupInstance.Put_ (wbemChangeFlagCreateOnly) 
  If Err <> 0 Then 
    ' エラー処理 
    CreateGroup = False 
  End If 
End Function

グループを削除する

次の関数はグループを削除します。

Public Function DeleteGroup(ByVal strGroupName As String) As Boolean 
  On Error Resume Next 
  DeleteGroup = True 
  Call g_objService.Delete(GROUP_NAMESPACE & ".NAME=""" _  
               & strGroupName & """") 
  If Err <> 0 Then 
    ' エラー処理 
    DeleteGroup = False 
  End If 
End Function

名前を指定してグループを取得する

次の関数は名前を指定してグループを取得します。

Public Function GetGroupByName(ByVal strGroupName As String) As Object 
  Dim objBTGroup As SWbemObject 
  On Error Resume Next 
  Set GetGroupByName = Nothing 
  Set GetGroupByName = g_objService.Get(GROUP_NAMESPACE & ".NAME=""" & _  
                      strGroupName & """") 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべてのグループを取得する

次の関数はすべてのグループを取得します。

Public Function GetAllGroups() As SWbemObjectSet 
  Dim objBTGroup As SWbemObject 
   
  On Error Resume Next 
  Set GetAllGroups = Nothing 
  Set objBTGroup = g_objService.Get(GROUP_NAMESPACE) 
  Set GetAllGroups = objBTGroup.Instances_ 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

BizTalk メッセージ管理データベースを操作する

ここで取り上げるコードサンプルは、BizTalk メッセージ管理データベースの操作に活用できます。BizTalk メッセージ管理データベースには、すべてのサーバー設定 (グループとサーバーの設定を含む) および受信関数の情報が格納されます。

ここでは、BizTalk メッセージ管理データベースの作成、および BizTalk メッセージ管理データベースの取得を行う関数を示します。

BizTalk メッセージ管理データベースを作成する

次の関数は BizTalk メッセージ管理データベースを作成します。

Public Function CreateMgmtDB(ByVal strMgmtDbLogon As String, _  
               ByVal strMgmtDBPassword As String, _ 
               ByVal strMgmtDBServer As String, _ 
               ByVal strMgmtDBDatabase As String, _ 
               ByVal strLocalServer As String) As Boolean 
                
   Dim objBTSMgmt As SWbemObject 
   Dim objBTSMgmtInstance As SWbemObject 
   On Error Resume Next 
    
   CreateMgmtDB = True 
   Set objBTSMgmt = g_objService.Get(GROUP_NAMESPACE) 
   Set objBTSMgmtInstance = objBTGroup.SpawnInstance_ 
   
   objBTSMgmtInstance.MgmtDbLogon = strMgmtDbLogon 
   objBTSMgmtInstance.MgmtDBPassword = strMgmtDBPassword 
   objBTSMgmtInstance.MgmtDbServer = strMgmtDBServer 
   objBTSMgmtInstance.MgmtDbDatabase = strMgmtDBDatabase 
   objBTSMgmtInstance.localserver = strLocalServer 
   objBTSMgmtInstance.Put_ (wbemChangeFlagCreateOnly) 
   If Err <> 0 Then 
    ' エラー処理 
    CreateMgmtDB = False 
   End If 
End Function

BizTalk メッセージ管理データベースを取得する

次の関数は BizTalk メッセージ管理データベースを取得します。

Public Function GetMgmtDB(ByVal strLocalServer As String) As SWbemObject 
  Dim objBTSMgmt As SWbemObject 
  Dim objSet_BTSMgmt As SWbemObjectSet 
  Dim objBTSMgmtInstance As SWbemObject 
   
  On Error Resume Next 
  Set GetMgmtDB = Nothing 
  Set objBTSMgmt = g_objService.Get(MGMT_NAMESPACE) 
  Set objSet_BTSMgmt = objBTSMgmt.Instances_ 
  If objSet_BTSMgmt.Count <> 1 Then 
     ' エラー処理 
     Exit Function 
  End If 
   
  Set GetMgmtDB = objSet_BTSMgmt.Item(MGMT_NAMESPACE & _ 
          ".LocalServer=""" & strLocalServer & """") 
End Function

受信サービスを操作する

ここで取り上げるコードサンプルは、受信サービスの操作に活用できます。受信サービスを作成するとデータを処理することができます。

ここでは、ファイル受信サービスの作成、ファイル受信サービスの削除、名前を指定したファイル受信サービスの取得、すべてのファイル受信サービスの取得、およびグループを指定したファイル受信サービスの取得を行う関数を示します。

ファイル受信サービスを作成する

次の関数はファイル受信サービスを作成します。

Public Function CreateReceiveService(ByVal strRecvSvcName As String, _  
             ByVal strGroupName As String, _ 
             ByVal strProcessingServer As String, _ 
             ByVal strFileMask As String, _  
             ByVal fProtocolType As ProtocolType, _ 
             ByVal strPollingLoc As String, _ 
             Optional ByVal strPassword As String, _ 
             Optional ByVal strUsername As String, _ 
             Optional ByVal strDocumentName As String, _ 
             Optional ByVal strSourceID As String, _ 
             Optional ByVal strSourceQualifier As String, _ 
             Optional ByVal strDestinationID As String, _    
             Optional ByVal strDestinationQualifier As String, _ 
             Optional ByVal lOpenness As Integer, _ 
             Optional ByVal lPassthrough As Integer, _ 
             Optional ByVal strChannelName As String, _  
             Optional fDisabled As Boolean, _ 
             Optional ByVal strEnvelopeName As String, _ 
             Optional ByVal strComment As String, _ 
             Optional ByVal strPreProcessor As String) _ 
                            As Boolean 
  Dim objBTSRecvSvc As SWbemObject 
  Dim objBTSRecvSvcInstance As SWbemObject 
   
  On Error Resume Next 
  CreateReceiveService = True 
  Set objBTSRecvSvc = g_objService.Get(RECVSVC_NAMESPACE) 
  Set objBTSRecvSvcInstance = objBTSRecvSvc.SpawnInstance_ 
  objBTSRecvSvcInstance.Name = strRecvSvcName 
  objBTSRecvSvcInstance.groupName = strGroupName 
  objBTSRecvSvcInstance.Comment = strComment 
  objBTSRecvSvcInstance.FilenameMask = strFileMask 
  objBTSRecvSvcInstance.ProcessingServer = strProcessingServer 
  objBTSRecvSvcInstance.ProtocolType = fProtocolType 
  objBTSRecvSvcInstance.PollingLocation = strPollingLoc 
  objBTSRecvSvcInstance.password = strPassword 
  objBTSRecvSvcInstance.UserName = strUsername 
  objBTSRecvSvcInstance.DocumentName = strDocumentName 
  objBTSRecvSvcInstance.SourceID = strSourceID 
  objBTSRecvSvcInstance.SourceQualifier = strSourceQualifier 
  objBTSRecvSvcInstance.DestinationID = strDestinationID 
  objBTSRecvSvcInstance.DestinationQualifier = strDestinationQualifier 
  objBTSRecvSvcInstance.EnvelopeName = strEnvelopeName 
  objBTSRecvSvcInstance.DisableReceiveFunction = fDisabled 
  objBTSRecvSvcInstance.PreProcessor = strPreProcessor 
   
  If lOpenness <> 0 Then 
    objBTSRecvSvcInstance.OpennessFlag = lOpenness 
  End If 
     
  If lPassthrough <> 0 Then 
    objBTSRecvSvcInstance.IsPassThrough = lPassthrough 
  End If 
   
  If strChannelName <> "" Then 
     objBTSRecvSvcInstance.ChannelName = strChannelName 
  End If 
  objBTSRecvSvcInstance.Put_ (wbemChangeFlagCreateOnly) 
  If Err <> 0 Then 
    ' エラー処理 
    CreateReceiveService = False 
  End If 
End Function

ファイル受信サービスを削除する

次の関数はファイル受信サービスを削除します。

Public Function DeleteReceiveSvc(ByVal strRecvSvcName As String) _ 
                            As Boolean 
  On Error Resume Next 
  DeleteReceiveSvc = True 
  Call g_objService.Delete(RECVSVC_NAMESPACE & ".NAME=""" & _  
               strRecvSvcName & """")   
  If Err <> 0 Then 
    ' エラー処理 
    DeleteReceiveSvc = False 
  End If 
End Function

名前を指定して受信サービスを取得する

次の関数は名前を指定して受信サービスを取得します。

Public Function GetReceiveFunctionByName(ByVal strRecvFunction _  
                     As String) _             
                     As SWbemObject 
  On Error Resume Next 
  Set GetReceiveFunctionByName = Nothing 
  Set GetReceiveFunctionByName = g_objService.Get(RECVSVC_NAMESPACE & _                              
                   ".NAME=""" & strRecvFunction & """")    
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべての受信サービスを取得する

次の関数はすべての受信サービスを取得します。

Public Function GetAllReceiveServices() As SWbemObjectSet 
  Dim objBTSRecvSvc As SWbemObject 
   
  On Error Resume Next 
  Set GetAllReceiveServices = Nothing 
  Set objBTSRecvSvc = g_objService.Get(RECVSVC_NAMESPACE) 
  Set GetAllReceiveServices = objBTSRecvSvc.Instances_ 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべての受信サービスをグループごとに取得する

次の関数はすべての受信サービスをグループごとに取得します。

Public Function GetAllReceiveSvcsByGroup(ByVal strGroupName As String) 
  Dim strWMIQuery As String 
   
  On Error Resume Next 
  strWMIQuery = "select * from " & RECVSVC_NAMESPACE & _ 
          " where groupname= '" & strGroupName & "'"   
  Set GetAllReceiveSvcsByGroup = g_objService.ExecQuery(strWMIQuery) 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

サーバーを操作する

ここで取り上げるコードサンプルは、サーバーの操作に活用できます。サーバーグループ内のサーバーは、BizTalk メッセージングサービスの適切な機能をホストし、BizTalk Server グループ以外のサーバーとアプリケーション間のドキュメント交換を管理します。

ここでは、サーバーの作成、サーバーの削除、サーバーの開始、サーバーの停止、名前を指定したサーバーの取得、すべてのサーバーの取得、およびすべてのサーバーのグループごとの取得を行う関数を示します。

サーバーを作成する

次の関数はサーバーを作成します。

Public Function CreateServer(ByVal strServerName As String, _  
              ByVal strGroupName As String, _ 
              ByVal lMaxWorkerThreadsPerProcessor As Long, _ 
              ByVal lSchedulerWaitTime As Double) As Boolean 
  Dim objBTSSvr As SWbemObject 
  Dim objBTSSvrInstance As SWbemObject 
   
  On Error Resume Next 
  CreateServer = True 
  Set objBTSSvr = g_objService.Get(SERVER_NAMESPACE) 
  Set objBTSSvrInstance = objBTSSvr.SpawnInstance_ 
  objBTSSvrInstance.Name = strServerName 
  objBTSSvrInstance.groupName = strGroupName 
  objBTSSvrInstance.MaxWorkerThreadsPerProcessor = _  
    lMaxWorkerThreadsPerProcessor 
  objBTSSvrInstance.SchedulerWaitTime = lSchedulerWaitTime 
  Call objBTSSvrInstance.Put_(wbemChangeFlagCreateOnly) 
  If Err <> 0 Then 
    ' エラー処理 
    CreateServer = False 
  End If 
End Function

サーバーを削除する

次の関数はサーバーを削除します。

Public Function DeleteServer(ByVal strServerName As String) As Boolean 
   
  On Error Resume Next 
  DeleteServer = True 
  Call g_objService.Delete(SERVER_NAMESPACE & ".NAME=""" _  
               & strServerName & """") 
  If Err <> 0 Then 
    ' エラー処理 
    DeleteServer = False 
  End If 
End Function

サーバーを開始する

次の関数はサーバーを開始します。

Public Function StartServer(ByVal strServerName As String) As Boolean 
  Dim strWMIPath As String 
  Dim objBTSSvrs As SWbemObject 
  On Error Resume Next 
  StartServer = True 
  strWMIPath = SERVER_NAMESPACE & ".NAME=""" & strServerName & """" 
  Set objBTSSvrs = g_objService.ExecMethod(strWMIPath, "StartServer") 
  If Err <> 0 And Hex(Err) <> "80070420" Then   
    ' エラー処理 
    StartServer = False 
  Else 
    Err.Clear 
  End If 
End Function

Err が 0 以外で、エラーの 16 進値が 80070420 でない場合は、サービスはすでに実行中であることに注意してください。

サーバーを停止する

次の関数はサーバーを停止します。

Public Function StopServer(ByVal strServerName As String) As Boolean 
  Dim strWMIPath As String 
  Dim objBTSSvrs As SWbemObject 
   
  On Error Resume Next 
  StopServer = True 
  strWMIPath = SERVER_NAMESPACE & ".NAME=""" & strServerName & """" 
  Set objBTSSvrs = g_objService.ExecMethod(strWMIPath, "StopServer") 
  If Err <> 0 And Hex(Err) <> "80070426" Then   
    ' エラー処理 
    StopServer = False 
  Else 
    Err.Clear 
  End If 
End Function

Err が 0 以外で、エラーの 16 進値が 80070426 でない場合は、サービスは実行中ではないことに注意してください。

名前を指定してサーバーを取得する

次の関数は名前を指定してサーバーを取得します。

Public Function GetServerByName(ByVal strServerName As String) _ 
                          As SWbemObject 
  On Error Resume Next 
  Set GetServerByName = Nothing 
  Set GetServerByName = g_objService.Get(SERVER_NAMESPACE & ".NAME=""" _  
                       & strServerName & """")   
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべてのサーバーを取得する

次の関数はすべてのサーバーを取得します。

Public Function GetAllServers() As SWbemObjectSet 
  Dim objBTSSvrs As SWbemObject 
   
  On Error Resume Next 
  Set objBTSSvrs = g_objService.Get(SERVER_NAMESPACE) 
  Set GetAllServers = objBTSSvrs.Instances_ 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべてのサーバーをグループごとに取得する

次の関数はすべてのサーバーをグループごとに取得します。

Public Function GetAllServersByGroup(ByVal strGroupName As String) _ 
                            As SWbemObjectSet 
  Dim strWMIQuery As String 
  On Error Resume Next 
  strWMIQuery = "select * from " & SERVER_NAMESPACE &  _ 
          " where groupname= '" & strGroupName & "'"   
  Set GetAllServersByGroup = g_objService.ExecQuery(strWMIQuery) 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

キューを操作する

ここで取り上げるコードサンプルは、キューの操作に活用できます。キューは、BizTalk Server でのルーティングと処理におけるさまざまな段階にある受信および送信ドキュメントを格納するのに使用されます。

ここでは、グループを指定したキューの取得、およびすべてのキューの取得を行う関数を示します。

グループを指定してキューを取得する

ここでは、グループを指定した作業キュー、再試行キュー、保留キュー、および送信待キューの取得を行う関数を示します。

作業キューには、BizTalk Server が現在処理中のドキュメントが格納されます。次の関数はグループを指定して作業キューを取得します。

Public Function GetWorkQByGroup(ByVal strGroupName As String) _ 
                           As SWbemObjectSet 
  Set GetWorkQByGroup = GetXXXXQByGroup(strGroupName, WORKQ_NAMESPACE) 
End Function

再試行キューには、再送信予定のドキュメント、および信頼できるメッセージの受信確認を待機中のドキュメントが格納されます。次の関数はグループを指定して再試行キューを取得します。

Public Function GetRetryQByGroup(ByVal strGroupName As String) _  
                          As SWbemObjectSet 
  Set GetRetryQByGroup = GetXXXXQByGroup(strGroupName, RETRYQ_NAMESPACE) 
End Function

保留キューには、何らかの理由 (解析エラー、シリアライズエラー、送信の失敗など) で処理が失敗した作業項目が格納されます。次の関数はグループを指定して保留キューを取得します。

Public Function GetSuspendedQByGroup(ByVal strGroupName As String) _  
                            As SWbemObjectSet 
  Set GetSuspendedQByGroup = GetXXXXQByGroup(strGroupName, _  
                         SUSPENDEDQ_NAMESPACE) 
End Function

送信待キューには、BizTalk Server が処理した作業項目と送信待ちの作業項目が格納されます。次の関数は送信待キューをグループを指定して取得します。

Public Function GetScheduledQByGroup(ByVal strGroupName As String) _ 
                            As SWbemObjectSet 
  Set GetScheduledQByGroup = GetXXXXQByGroup(strGroupName, _  
                         SCHEDULEDQ_NAMESPACE) 
End Function

次のヘルパ関数は、前述の関数によるグループを指定した特定のキューの取得に使用します。

Public Function GetXXXXQByGroup(ByVal strGroupName As String, _ 
                ByVal QueueNameSpace As String) _ 
                           As SWbemObjectSet 
  Dim strWMIQuery As String 
  On Error Resume Next 
   
  strWMIQuery = "select * from " & QueueNameSpace & _  
          " where group= """ & strGroupName & """" 
  Set GetXXXXQByGroup = g_objService.ExecQuery(strWMIQuery) 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

すべてのキューを取得する

次の関数はすべてのキューを取得します。

Public Function GetAllQueues() As SWbemObjectSet 
  Dim objBTQueue As SWbemObject 
   
  On Error Resume Next 
  Set GetAllQueues = Nothing 
  Set objBTQueue = g_objService.Get(QUEUE_NAMESPACE) 
  Set GetAllQueues = objBTQueue.Instances_ 
  If Err <> 0 Then 
    ' エラー処理 
  End If 
End Function

本書に記載されている情報は、発行時点で議論されている問題点に関する Microsoft Corporation の最新の見解を示しています。当社では市場のニーズの変化に対応して変更が必要となる場合があり、そのため本書の内容は当社のコミットメントを示すものではなく、また発行日以降、その情報の正確性を保証するものでもありません。

本書は、情報の通知のみを目的としており、Microsoft は本書に記載されている情報について明示的にも暗黙的にも一切の保証をいたしません。

本書の使用にあたっては、お客様の責任において、適用されるすべての著作権法に従ってください。本書中のいかなる部分も、Microsoft の書面による許可なしには、いかなる目的のためであれ、いかなる形態、手段 (電子的、機械的、コピー機の使用、記録など) によっても複製、検索システムへの格納、または伝送してはなりません。

この文書の内容に関する特許、特許出願、商標、著作権、およびその他の知的財産は、Microsoft が所有します。Microsoft との書面によるライセンス契約に明記されていない限り、本書の提供が、以上の特許、商標、著作権、あるいはその他の知的財産権の利用を認めるものではありません。

Microsoft、BackOffice、BizTalk、MSDN、Visual Basic、Win32、Windows、Windows NT は米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です。

本書に記載されているその他の製品名および会社名は各所有者の商標です。

Microsoft BizTalk Server 2000 における WMI

目次

はじめに

BizTalk Server における WMI を理解する

BizTalk Server の名前空間

BizTalk Server で WMI を使用する

変数を宣言する

WMI エラーを処理する

BizTalk Server WMI リファレンス

DocSuspendedEvent

付録 - ソリューションライブラリ

ドキュメントを操作する

その他のリソース

Microsoft BizTalk Server 2000 における WMI

目次

はじめに

BizTalk Server における WMI を理解する

BizTalk Server の名前空間

BizTalk Server で WMI を使用する

変数を宣言する

WMI エラーを処理する

BizTalk Server WMI リファレンス

DocSuspendedEvent

付録 - ソリューション ライブラリ

ドキュメントを操作する

その他のリソース

付録 - ソリューションライブラリ