Export (0) Print
Expand All

WMI in Microsoft BizTalk Server 2000

Microsoft Corporation

March 2001

Summary: This white paper shows you how Microsoft BizTalk Server 2000 can be used with Windows Management Instrumentation (WMI) to manage Administration objects and consume events. BizTalk Server's implementation of WMI is discussed along with an example of a temporary event consumer. The schema classes are documented and the white paper ends with a library of code examples that provide solutions to common tasks encountered when using BizTalk Server with WMI. (94 printed pages)

Contents

Introduction
Understanding WMI in BizTalk Server
BizTalk Server Namespace
BizTalk Server Provider and Registration
Using WMI in BizTalk Server
Declaring Variables
Connecting to the Microsoft_BizTalk Server Namespace
Creating the Event Object
Monitoring Events
Handling Errors
BizTalk Server WMI Reference
DocSuspendedEvent
InterchangeProvError
MicrosoftBizTalkServer_Group
MicrosoftBizTalkServer_GroupReceiveFunction
MicrosoftBizTalkServer_GroupServer
MicrosoftBizTalkServer_MgmtDB
MicrosoftBizTalkServer_Queue
MicrosoftBizTalkServer_ReceiveFunction
MicrosoftBizTalkServer_RetryQueue
MicrosoftBizTalkServer_ScheduledQueue
MicrosoftBizTalkServer_Server
MicrosoftBizTalkServer_SuspendedQueue
MicrosoftBizTalkServer_WorkQueue
Appendix: Solutions Library
   Working with Documents
   Working with Groups
   Working with the Management Database
   Working with Receive Services
   Working with Servers
   Working with Queues

Introduction

Windows® Management Instrumentation (WMI) is a data-management layer included in Microsoft® Windows® 2000. Microsoft BizTalk™ Server 2000 uses the WMI layer to encapsulate administrative functions that support the management of systems in an enterprise.

This white paper contains sample code in Microsoft Visual Basic®, and Visual Basic Script.

For background and overview information about WMI, see the article Microsoft Windows Management Instrumentation: Background and Overview, at the MSDN Online Library Web site.

For information about how to use WMI to administer Windows and applications across your enterprise, see the article Windows Management Instrumentation: Administering Windows and Applications across Your Enterprise, at the MSDN Online Library Web site.

The most recent version of the WMI SDK is available from the Microsoft Web site at http://msdn.microsoft.com/Downloads/sdks/wmi/eula.asp.

Understanding WMI in BizTalk Server

When you use BizTalk Server Administration to change group, server, queue, and database management settings, the new values are stored in the BizTalk Messaging Management database through the BizTalk Server WMI provider. In BizTalk Server 2000, this WMI provider uses a Microsoft SQL Server™ database to store administrative objects. All timestamps are created by using the local time on the Microsoft SQL Server. However, the WMI provider refers to all timestamps in coordinated universal time (UTC). The administration console then converts the timestamps back to local time for display.

The WMI provider acts as an intermediary between WMI and BizTalk Administration objects. The WMI provider gathers information from a resource (managed object) and makes it available to management applications through the WMI API.

The BizTalk schema classes are registered and defined by using Managed Object Format (MOF), which is a compiled language based on the Interface Definition Language (IDL). You place this information in an .mof file that you submit to the MOF compiler, Mofcomp.exe.

The MOF code examples in the following sections are taken from the InterchangeProvSchema.mof file found in the \Program Files\Microsoft BizTalk Server\Setup folder. This file, along with SrvEvents.mof, contains the BizTalk Server namespace, provider, provider registration, and schema class definitions.

To access the WMI database layer programmatically, see BizTalk Server WMI Reference, later in this white paper, which documents the BizTalk Server WMI schema classes that correspond to the administration objects.

BizTalk Server Namespace

Every WMI namespace contains a set of system classes, including __NAMESPACE. A namespace groups a collection of classes into logical units. Every computer has a defined namespace at the top of the hierarchy called the Root namespace. The location of a namespace is described by a path.

In the following MOF code, "MicrosoftBizTalkServer" is specified as the value for the Name property of the __NAMESPACE system class for BizTalk Server:

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

BizTalk Server defines the "MicrosoftBizTalkServer" namespace as a sibling of the Root namespace, logically distinguishing the BizTalk Server-managed environment from other managed environments.

BizTalk Server Provider and Registration

When WMI receives a request from a BizTalk Server management application, it forwards the request to the WMI provider, "InterchangeProv." The WMI provider retrieves, modifies, deletes, and/or enumerates instances of the BizTalk Server schema classes. In addition, "InterchangeProv" supplies dynamic instance information and generates event information.

In the following MOF code, "InterchangeProv" is specified as the value for the Name property of the of __Win32Provider system class:

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

"InterchangeProv" is a custom provider designed to interact with the managed objects in the BizTalk Server environment. For a complete reference of these managed objects and their properties and methods, see BizTalk Server WMI Reference, later in this white paper.

In the following MOF code, an instance of the __InstanceProviderRegistration system class is used to register the instance provider with WMI:

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

The BizTalk Server instance provider supports data retrieval, data modification, data deletion, data enumeration, and query processing.

In the following MOF code, an instance of the __MethodProviderRegistration system class is used to register the method provider with WMI:

instance of __MethodProviderRegistration
{
    Provider = $P;
};

Using WMI in BizTalk Server

WMI provides a powerful event architecture that enables modifications in management information to be identified, aggregated, and associated with other management information, which can then be forwarded to local or remote management applications. Event handling and notification is a key benefit provided by WMI that provides a mechanism for identifying and dealing with hardware or software events and errors.

After an event occurs, a notification is delivered to one or more registered recipients, knows as event consumers. Event consumers can register to receive certain types of notifications. Event consumers register to receive notifications without any knowledge of how events and notifications are provided. To register, event consumers specify a filter that is created by using the WMI Query Language (WQL). The query describes the conditions under which the consumer receives the event notification.

In addition to DCOM interfaces, WMI supports a uniform scripting application programming interface (API) that gives applications and scripts access to the WMI provider on either a local computer or a remote computer.

This section shows the basic steps necessary to write a temporary WMI event consumer with Microsoft Visual Basic script, although some of the associated DCOM interfaces are mentioned.

For code examples that show how to create and manipulate the BizTalk Administration objects by using WMI, see "Appendix: Solutions Library," later in this white paper.

Note   If you have Health Monitor installed (either from Microsoft Application Center 2000 or Microsoft BackOffice®), you can configure Health Monitor through its Monitor Management Console (MMC) user interface (UI) (or its WMI class) to consume events.

For more information about publishing and consuming events, see the article Event Notification in the WMI SDK on the MSDN Online Library Web site.

For more information about WMI Application Programming, go to the MSDN Online Library Web site and search for WMI Application Programming.

Declaring Variables

In order to write an event consumer using WMI, you will need to obtain a locator object, a services object, an event object, and an object to represent a WMI class instance.

First, declare the variables, as shown in the following code:

Dim wbemLocat
Dim wbemSrvcs
Dim wbemEvent
Dim wbemObject

The locator object variable, wbemLocat, of type SwbemLocator is used to connect to WMI. To connect to the "MicrosoftBizTalkServer" namespace under the Root namespace ("Root/MicrosoftBizTalkServer"), you set the services object variable, wbemSrvcs, of type SWbemServices. The event object variable, wbemEvent, of type SwbemEventSource is needed to execute a query to receive events. To retrieve an event from the event query, you set the wbemObject variable of type SwbemObject.

Connecting to the Microsoft_BizTalk Server Namespace

After you declare the variables, you need to retrieve the locator object. If you are using the scripting API, create a WbemScripting.SwbemLocator object, as shown in the following code:

Set wbemLocat = CreateObject("WbemScripting.SWbemLocator")

Note that the first step for any application using WMI is to retrieve a locator object. If you are using the DCOM interfaces, you would retrieve an IWBEMLocator pointer by using the COCreateInstance method with the CLSID_WbemLocator, as shown in the following code:

IWbemLocator* piWMI = NULL;
HRESULT hr;

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

Using the locator object and the ConnectServer method, you can request a connection to the WMI service. The following code attempts to connect to WMI by specifying the Root namespace on the local computer. In the following code, substitute the string "ComputerName" with the name of the server that publishes the event:

Set wbemSrvcs = wbemLocat.ConnectServer("ComputerName", _     
    "root\MicrosoftBizTalkServer")

If Err.number is equal to 0, then the connection to the WMI namespace is established. Specify both the computer name and the namespace; otherwise, if these fields are left blank, you will be connected to the default namespace on the local computer.

The returned SWbemServices object provides a communication path to the SQL Server database that is used to store administrative objects.

Creating the Event Object

Now that you have connected to the "MicrosoftBizTalkServer" namespace, you need to create the event object. The following code generates an event object to receive event notifications:

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

The filter used in the SWbemServices.ExecNotificationQuery method call is "Select * from DocSuspendedEvent", which is written using WQL. Like SQL queries, WQL queries can be refined to return a specific set of properties, or a subset of instances that satisfy some criteria.

When the consumer submits this query, it requests to be notified of all occurrences of the event represented by the DocSuspendedEvent class. This request includes a request for notification on all of the event's system and nonsystem properties. When the event provider submits the query, it registers support for generating notifications whenever an event represented by the DocSuspendedEvent class occurs.

Monitoring Events

Now that you have created the event object for the DocSuspendedEvent class, you need to set up the mechanism to monitor events represented by that class. First, set wbemObject of type SWbemObject to Empty, as shown in the following code:

wbemObject = Empty

Then, if an event is available, the SWbemEventSource.NextEvent method retrieves the event from an event query, as shown in the following code:

Set wbemObject = wbemEvent.NextEvent(Timeout)

The SWbemObject object supports generic properties and methods that apply to all WMI objects, as well as exposing the properties and methods of the object as dynamic automation properties and methods of this object.

Use the following code to retrieve the GUID for the item in the suspended queue event:

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

If the wbemObject is not set to Empty, then the GUID for the item in the Suspended queue event is retrieved; otherwise; a timeout error occurs while waiting for the Suspended queue event.

Note that stringSuspendedGuid is a property of the DocSuspendedEvent class. The Properties_ property returns an SWbemPropertySet object that is a collection of the properties for the current class or instance, in this case the DocSuspendedEvent class. The Item method then retrieves an SWbemProperty from the collection, in this case the stringSuspendedGuid property.

For more information about WMI Application Programming in BizTalk Server, see the next section, Handling Errors, and Appendix: Solutions Library, later in this white paper.

Handling Errors

This section uses Microsoft Visual Basic code to illustrate how to determine whether a WMI method returns an error, and if so, how to decipher the meaning of the error.

First, you declare two variables: an SwbemLastError object to contain and manipulate error objects, and an array of String objects to contain the numerical value, parameter information, and text description of the error, as shown in the following code:

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

To determine whether WMI raises an error, check the Err object. If the Err object is not equal to 0, then an error has been raised. Then, you can try to set the SwbemLastError object to a new instance.

Note that the TypeName function is used to return information about the objWMIError variable. If it is equal to Nothing, error information is not available, and the attempt to create the error object has failed.

If the call succeeds and an error object returns, the status of the object is reset and the members of the string array are set to meaningful values, as shown in the following code:

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

BizTalk Server WMI Reference

The BizTalk Server WMI classes are defined in text files using the Managed Object Format (MOF). Note that each class has a key property qualifier. The key property qualifier tells you that any instance of that class (or any instance of a derived class) can be uniquely identified by the value of the key property qualifier. This is a concept borrowed from database technologies.

To access the functionality provided by WMI you implement a set of DCOM interfaces. These interfaces make it possible to write management applications that work with classes and instances managed by WMI. For more information about these interfaces, such as IWbemClassObject and IWbemServices, see the Platform SDK.

In addition, you can access WMI from environments that support Automation objects through scripting objects that wrap the DCOM interfaces. For example, the SWbemObject class wraps the IWbemClassObject interface, and SWbemServices wraps IWbemServices. When using WMI with the BizTalk Server schema classes, you can get complete access to WMI through Microsoft Visual Basic or Visual Basic Scripting Edition (VBScript). Visual Basic projects can access these objects by adding Microsoft WMI Scripting V1.1 Library in the Reference dialog box.

The COM API is available directly to C/C++ programmers. You can use the Scripting API to develop script and applications based on Microsoft Visual Basic that you can use to view or control managed objects.

For a complete description of the interfaces in the WMI COM API, see the article COM API for WMI, in the WMI SDK on the MSDN Online Library Web site.

For a description of the interfaces in the Scripting API, see the article Scripting API for WMI, in the WMI SDK on the MSDN Online Library Web site.

DocSuspendedEvent

The DocSuspendedEvent class represents events raised by documents sent to the Suspended queue.

DocSuspendedEvent inherits from the __ExtrinsicEvent system class, an abstract base class that serves as a superclass for all user-defined event types.

The DocSuspendedEvent class defines the following property:

PropertyDescription
stringSuspendedGuidContains the tracking key of the item in the Suspended queue event.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: SrvEvents.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

StringSuspendedGuid Property

Contains the tracking key of the item in the Suspended queue event.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string stringSuspendedGuid;

Parameters

None

Return values 

A string data type.

Remarks

This property is read-only.

The tracking key of the item in the Suspended queue event is based on a globally unique identifier (GUID).

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: SrvEvents.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

InterchangeProvError

The InterchangeProvError class represents error information returned by the interchange provider when creating class instances.

InterchangeProvError inherits from the __ExtendedStatus system class, which is used to report detailed status and error information.

The InterchangeProvError class defines the following property:

PropertyDescription
InterchangeProvNameContains the name of the interchange provider returning error information.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

InterchangeProvError Property

Contains the name of the interchange provider returning error information.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

String InterchangeProvName;

Parameters

None

Return values 

String data type.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_Group

The MicrosoftBizTalkServer_Group class represents a logical grouping of a specific number of BizTalk Servers in an enterprise. It is the management abstraction for global BizTalk properties.

MicrosoftBizTalkServer_Group is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

The MicrosoftBizTalkServer_Group class defines the following properties:

PropertyDescription
ConfigurationCacheRefreshIntervalIndicates how often the server refreshes the cache of the BizTalk Messaging Configuration objects, in seconds.
ConnectToDbStatusIndicates the status of the connection to the Tracking and Shared Queue databases.
DateModifiedIndicates the last modification date of the instance data.
DocTrackDbLogonContains the user ID component of the connect string for the Tracking database.
DocTrackDbNameContains the database name component of the connect string for the Tracking database.
DocTrackDbPasswordContains the password component of the connect string for the Tracking database.
DocTrackDbServerContains the server name component of the connect string for the Tracking database.
EnableDocumentTracking Indicates whether document tracking is enabled or disabled.
LoggingPointStateRepresents a collection of flags that indicate the events that cause a Tracking entry to be logged.
NameContains the name of the server.
ParserOrderContains the CLSIDs of the parser components registered in the Registry, sorted in parsing order.
ProxyHostContains the proxy host address.
ProxyPortIndicates the proxy port number.
QueueDbLogonContains the user ID component of the connect string for the Shared Queue database.
QueueDbNameContains the database name component of the connect string for the Shared Queue database.
QueueDbPasswordContains the password component of the connect string for the Shared Queue database.
QueueDbServerContains the server name component of the connect string for the Shared Queue database.
ReliableMessagingReplyToURLContains the URL repository for reliable messaging.
RetryQueueCountIndicates the number of documents in the Retry queue.
ScheduledQueueCountIndicates the number of documents in the Scheduled queue.
SMTPHostContains the name of the SMTP host that is used for this group.
SuspendedQueueCountIndicates the number of documents in the Suspended queue.
UseProxyServerIndicates whether or not to use the proxy server.
WorkQueueCountIndicates the number of documents in the Work queue.

The MicrosoftBizTalkServer_Group class defines the following methods:

MethodDescription
PurgeSuspendedQueueEnables an administrator to remove all the documents in the Suspended queue.
RefreshParserListFromRegistryUpdates the list of parser components in the database, based on current components registered in the Registry.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ConfigurationCacheRefreshInterval Property

Indicates how often the server refreshes the cache of the BizTalk Messaging Configuration objects, in seconds.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ConfigurationCacheRefreshInterval = 50;

Parameters

None

Return values 

Unsigned 32-bit unsigned integer that indicates how often the server refreshes the cache of the BizTalk Messaging Configuration objects, in seconds.

Remarks

This property is read/write.

This property has a default value of 50.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ConnectToDbStatus Property

Indicates the status of the connection to the Tracking and Shared Queue databases.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ConnectToDbStatus;

Parameters

None

Return values 

32-bit unsigned integer that indicates the status of the connection to the Tracking and Shared Queue databases.

Remarks

This property is read-only.

Permissible values for this property are "BothDbConnectOK," "DTAConnectFail," "SQConnectFail," and "BothConnectFail," which map to the integers 0, 1, 2, and 3, respectively. Note that the integer values must be used in code and script.

The following code is taken from the MOF file (InterchangeProvSchema.mof), and shows the mapping:

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

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DateModified Property

Indicates the last modification date of the instance data.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime DateModified;

Parameters

None

Return values 

A datetime data type that indicates the last modification date of the instance data.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocTrackDbLogon Property

Contains the user ID component of the connect string for the Tracking database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocTrackDbLogon;

Parameters

None

Return values 

A string data type that contains the user ID component of the connect string for the Tracking database.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocTrackDbName Property

Contains the database name component of the connect string for the Tracking database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocTrackDbName;

Parameters

None

Return values 

A string data type that contains the database name component of the connect string for the Tracking database.

Remarks

This property is read/write.

The maximum value for the length of this property is 123 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocTrackDbPassword Property

Contains the password component of the connect string for the Tracking database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocTrackDbPassword;

Parameters

None

Return values 

A string data type that contains the password component of the connect string for the Tracking database.

Remarks

This property is write-only.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocTrackDbServer Property

Contains the server name component of the connect string for the Tracking database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocTrackDbServer;

Parameters

None

Return values 

A string data type that contains the server name component of the connect string for the Tracking database.

Remarks

This property is read/write

The maximum value for the length of this property is 60 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

EnableDocumentTracking Property

Indicates whether document tracking is enabled or disabled.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

boolean EnableDocumentTracking = 1;

Parameters

None

Return values 

A boolean data type that indicates whether document tracking is enabled or disabled. If TRUE, document tracking is enabled; otherwise, this value is FALSE and document tracking is disabled.

Remarks

This property is read/write.

The default value for this property is TRUE.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

LoggingPointState Property

Represents a collection of flags that indicate the events that cause a Tracking entry to be logged.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 LoggingPointState;

Parameters

None

Return values 

32-bit unsigned integer that represents a collection of flags which indicate the events that cause a Tracking entry to be logged.

Remarks

This property is read/write.

Permissible values for this property are "LogIncomingInterchange," "LogMIMEBlob," and "LogOutgoingInterchange," which map to the integers 0, 1, and 2, respectively. Note that the integer values must be used in code and script.

The following code is taken from the MOF file (InterchangeProvSchema.mof), and shows the mapping:

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

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Name Property

Contains the name of the server.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Name;

Parameters

None

Return values 

A string data type that contains the name of the server.

Remarks

This property is read/write.

The value of this property acts as the key for the class; its value uniquely identifies an instance of the class.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ParserOrder Property

Contains the CLSIDs of the parser components registered in the Registry, sorted in parsing order.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ParserOrder[];

Parameters

None

Return values 

A string data type that contains the CLSIDs of the parser components registered in the Registry, sorted in parsing order.

Remarks

This property is read/write.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProxyHost Property

Contains the proxy host address.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ProxyHost;

Parameters

None

Return values 

A string data type that contains the proxy host address.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProxyPort Property

Indicates the proxy port number.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ProxyPort = 80; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the proxy port number.

Remarks

This property is read/write.

The default value for this property is 80.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

PurgeSuspendedQueue Method

Enables an administrator to remove all the documents in the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 PurgeSuspendedQueue();

Parameters

None

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QueueDbLogon Property

Contains the user ID component of the connect string for the Shared Queue database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string QueueDbLogon;

Parameters

None

Return values 

A string data type that contains the user ID component of the connect string for the Shared Queue database.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QueueDbName Property

Contains the database name component of the connect string for the Shared Queue database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string QueueDbName;

Parameters

None

Return values 

A string data type that contains the database name component of the connect string for the Shared Queue database.

Remarks

This property is read/write.

The maximum value for the length of this property is 123 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QueueDbPassword Property

Contains the password component of the connect string for the Shared Queue database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string QueueDbName;

Parameters

None

Return values 

A string data type that contains the password component of the connect string for the Shared Queue database.

Remarks

This property is write-only.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QueueDbServer Property

Contains the server name component of the connect string for the Shared Queue database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string QueueDbServer;

Parameters

None

Return values 

A string data type that contains the server name component of the connect string for the Shared Queue database.

Remarks

This property is read/write.

The maximum value for the length of this property is 60 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ReliableMessagingReplyToURL Property

Contains the URL repository for reliable messaging.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ReliableMessagingReplyToURL;

Parameters

None

Return values 

A string data type that contains the URL repository for reliable messaging.

Remarks

This property is read/write.

The maximum value for the length of this property is 512 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

RefreshParserListFromRegistry Method

Updates the list of parser components in the database, based on current components registered in the Registry.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 RefreshParserListFromRegistry(); 

Parameters

None.

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

RetryQueueCount Property

Indicates the number of documents in the Retry queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 RetryQueueCount; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the number of documents in the Retry queue.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ScheduledQueueCount Property

Indicates the number of documents in the Scheduled queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ScheduledQueueCount; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the number of documents in the Scheduled queue.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

SMTPHost Property

Contains the name of the SMTP host that is used for this group.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string SMTPHost; 

Parameters

None

Return values 

A string data type that contains the name of the SMTP host that is used for this group.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

SuspendedQueueCount Property

Indicates the number of documents in the Suspended queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 SuspendedQueueCount; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the number of documents in the Suspended queue.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

UseProxyServer Property

Indicates whether or not to use the proxy server.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

boolean UseProxyServer = 0; 

Parameters

None

Return values 

A boolean data type that indicates whether or not to use the proxy server. If TRUE, a proxy server is used; otherwise, this value is FALSE and a proxy server is not used.

Remarks

This property is read/write.

The default value for this property is FALSE.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

WorkQueueCount Property

Indicates the number of documents in the Work queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 WorkQueueCount; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the number of documents in the Work queue.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_GroupReceiveFunction

The MicrosoftBizTalkServer_GroupReceiveFunction class is an association class that is provided as a convenience. Associations are instances of association classes and are used to represent relationships between other WMI objects.

MicrosoftBizTalkServer_GroupReceiveFunction is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed. This class allows you to retrieve all the receive functions in a group.

The MicrosoftBizTalkServer_GroupReceiveFunction class defines the following properties:

PropertyDescription
AntecedentReferences the properties of the BizTalk Server group.
DependentReferences the properties of the receive function that is associated with the BizTalk Server group.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Antecedent Property

References the properties of the BizTalk Server group.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

MicrosoftBizTalkServer_Group ref Antecedent; 

Parameters

None

Return values 

A ref data type that references the properties of the BizTalk Server group. The returned reference is to an instance of a MicrosoftBizTalkServer_Group object.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of Dependent uniquely identifies an instance of the class.

This property is the parent component of an aggregation association.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Dependent Property

References the properties of the receive function that is associated with the BizTalk Server group.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

MicrosoftBizTalkServer_ReceiveFunction ref Dependent; 

Parameters

None

Return values 

A ref data type that references the properties of the receive function that is associated with the BizTalk Server group. The returned reference is to an instance of a MicrosoftBizTalkServer_ReceiveFunction object.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of Antecedent uniquely identifies an instance of the class.

This property is the child component of an aggregation association.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_GroupServer

The MicrosoftBizTalkServer_GroupServer class is an association class that is provided as a convenience. Associations are instances of association classes and are used to represent relationships between other WMI objects.

MicrosoftBizTalkServer_GroupServer is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed. This class allows you to retrieve all the servers in a group.

The MicrosoftBizTalkServer_GroupServer class defines the following properties:

PropertyDescription
AntecedentReferences the properties of the BizTalk Server group.
DependentReferences the properties of the server that is associated with the BizTalk Server group.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Antecedent Property

References the properties of the BizTalk Server group.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

MicrosoftBizTalkServer_Group ref Antecedent; 

Parameters

None

Return values 

A ref data type that references the properties of the BizTalk Server group. The returned reference is to an instance of a MicrosoftBizTalkServer_Group object.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of Dependent uniquely identifies an instance of the class.

This property is the parent component of an aggregation association.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Dependent Property

References the properties of the server that is associated with the BizTalk Server group.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

MicrosoftBizTalkServer_Server ref Dependent; 

Parameters

None

Return values 

A ref data type that references the properties of the server that is associated with the BizTalk Server group. The returned reference is to an instance of a MicrosoftBizTalkServer_Server object.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of Antecedent uniquely identifies an instance of the class.

This property is the child component of an aggregation association.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_MgmtDB

The MicrosoftBizTalkServer_MgmtDB class represents the BizTalk Messaging Management database.

MicrosoftBizTalkServer_MgmtDB is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

The MicrosoftBizTalkServer_MgmtDB class defines the following properties:

PropertyDescription
LocalServerContains the name of the class, identifying the instance of the class.
MgmtDbLogonContains the user ID component of the BizTalk Messaging Management database connect string.
MgmtDbNameContains the initial catalog component of the BizTalk Messaging Management database connect string and represents the database name.
MgmtDbPasswordContains the password component of the BizTalk Messaging Management database connect string.
MgmtDbServerContains the data source part of the BizTalk Messaging Management database connect string.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

LocalServer Property

Contains the name of the class, identifying the instance of the class.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string LocalServer;

Parameters

None

Return values 

A string value that contains the name of the class, identifying the instance of the class.

Remarks

This property is read-only.

The value of this property acts as the key for the class; its value uniquely identifies an instance of the class.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MgmtDbLogon Property

Contains the user ID component of the BizTalk Messaging Management database connect string.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string MgmtDbLogon; 

Parameters

None

Return values 

A string data type that Contains the user ID component of the BizTalk Messaging Management database connect string.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MgmtDbName Property

Contains the initial catalog component of the BizTalk Messaging Management database connect string and represents the database name.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string MgmtDbName; 

Parameters

None

Return values 

A string data type that contains the initial catalog component of the BizTalk Messaging Management database connect string and represents the database name.

Remarks

This property is read/write.

The maximum value for the length of this property is 123 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MgmtDbPassword Property

Contains the password component of the BizTalk Messaging Management database connect string.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string MgmtDbPassword; 

Parameters

None

Return values 

A string data type that contains the password component of the BizTalk Messaging Management database connect string.

Remarks

This property is write-only.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MgmtDbServer Property

Contains the data source part of the BizTalk Messaging Management database connect string.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string MgmtDbServer;

Parameters

None

Return values 

A string data type that contains the data source part of the BizTalk Messaging Management database connect string.

Remarks

This property is read/write.

The maximum value for the length of this property is 60 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_Queue

The MicrosoftBizTalkServer_Queue class is abstract and serves only as a base for new classes. This class should not be implemented.

The MicrosoftBizTalkServer_Queue class defines the following properties:

PropertyDescription
DestinationContains the name of the organization or application that receives the document.
GroupContains the name of the group to which the queue belongs.
QIDIdentifies an instance of the class.
SourceContains the name of the organization or application that sends the document.
TimestampIndicates the last time the document was used, or when it entered the queue.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Destination Property

Contains the name of the organization or application that receives the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Destination; 

Parameters

None

Return values 

A string data type that contains the name of the organization or application that receives the document.

Remarks

This property is read-only.

The maximum value for the length of this property is 512 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Group Property

Contains the name of the group to which the queue belongs.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Group; 

Parameters

None

Return values 

A string data type that contains the name of the group to which the queue belongs.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of QID uniquely identifies an instance of the class.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QID Property

Identifies an instance of the class.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 QID;

Parameters

None

Return values 

32-bit unsigned integer that identifies an instance of the class.

Remarks

This property is read-only.

The value of this property acts as a key for the class; its value along with the value of Group uniquely identifies an instance of the class.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Source Property

Contains the name of the organization or application that sends the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Source;

Parameters

None

Return values 

A string data type that contains the name of the organization or application that sends the document.

Remarks

This property is read-only.

The maximum value for the length of this property is 64 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Timestamp Property

Indicates the last time the document was used, or when it entered the queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime Timestamp; 

Parameters

None

Return values 

Indicates the last time the document was used, or when it entered the queue.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_ReceiveFunction

The MicrosoftBizTalkServer_ReceiveFunction class represents a service that is set up on a BizTalk Server to handle incoming interchanges by using a specific protocol such as File, Message Queuing, or Script.

MicrosoftBizTalkServer_ReceiveFunction is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

The MicrosoftBizTalkServer_ReceiveFunction class defines the following properties:

PropertyDescription
ChannelNameContains the name of the channel that the receive function should pass to the Submit method call when the pass-through flag is enabled.
CommentContains user comments.
DateModifiedIndicates the last modification date of the instance data.
DestinationIDRepresents the ID of the organization or application that receives the document.
DestinationQualifierRepresents the ID type of the organization or application that receives the document.
DisableReceiveFunctionIndicates whether to enable or disable the receive function.
DocumentNameContains the name of the document definition for the input document of a channel.
EnvelopeName Contains the name of an envelope definition instance in the BizTalk Messaging Management database.
FilenameMaskContains the file name mask to use for receive functions that pull files from the file system for input to BizTalk Server.
GroupNameContains the name of the group to which the server belongs.
IsPassThrough Indicates whether a Submit method call is made with the pass-through flag enabled or disabled.
NameContains the name of the component.
OpennessFlag Indicates the value of the lOpenness parameter that the receive function passes to the Submit method.
PasswordContains the password to use for FTP or Message Queuing receive functions that require a user name and password.
PollingLocationContains the name of the directory to poll (directory, message queue, and so on) for receive functions that require polling.
PreProcessorIndicates any pre-processing that must be done for received document.
ProcessingServerContains the name of the server that is currently processing the interchange.
SourceIDContains the ID of the organization or application that sends the document.
SourceQualifierContains the ID type of the organization or application that sends the document.
UsernameContains the user name to use for FTP or Message Queuing receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ChannelName Property

Contains the name of the channel that the receive function should pass to the Submit method call when the pass-through flag is enabled.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ChannelName; 

Parameters

None

Return values 

A string data type that contains the name of the channel that the receive function should pass to the Submit method call when the pass-through flag is enabled.

Remarks

This property is read/write.

The maximum value for the length of this property is 64 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Comment Property

Contains user comments.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Comment; 

Parameters

None

Return values 

A string data type that contains user comments.

Remarks

This property is read/write.

The maximum value for this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DateModified Property

Indicates the last modification date of the instance data.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime DateModified; 

Parameters

None

Return values 

A datetime data type that indicates the last modification date of the instance data.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DestinationID Property

Represents the ID of the organization or application that receives the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DestinationID; 

Parameters

None

Return values 

A string data type that represents the ID of the organization or application that receives the document.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DestinationQualifier Property

Represents the ID type of the organization or application that receives the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DestinationQualifier;

Parameters

None

Return values 

A string data type that represents the ID type of the organization or application that receives the document.

Remarks

This property is read/write.

The maximum value for the length of this property is 64 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DisableReceiveFunction Property

Indicates whether to enable or disable the receive function.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

boolean DisableReceiveFunction = 0; 

Parameters

None.

Return values 

A boolean data type that indicates whether to enable or disable the receive function. If TRUE, the receive function is disabled; otherwise, this value is FALSE and the receive function is enabled.

Remarks

This property is read/write.

The default value for this property is FALSE.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocumentName Property

Contains the name of the document definition for the input document of a channel.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocumentName; 

Parameters

None

Return values 

A string data type that contains the name of the document definition for the input document of a channel.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

EnvelopeName Property

Contains the name of an envelope definition instance in the BizTalk Messaging Management database.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string EnvelopeName; 

Parameters

None

Return values 

A string data type that contains the name of an envelope definition instance in the BizTalk Messaging Management database.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

FilenameMask Property

Contains the file name mask to use for receive functions that pull files from the file system for input to BizTalk Server.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string FilenameMask; 

Parameters

None

Return values 

A string data type that contains the file name mask to use for receive functions that pull files from the file system for input to BizTalk Server.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

GroupName Property

Contains the name of the group to which the server belongs.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string GroupName; 

Parameters

None

Return values 

A string data type that contains the name of the group to which the server belongs.

Remarks

This property is read-only.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

IsPassThrough Property

Indicates whether a Submit method call is made with the pass-through flag enabled or disabled

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

boolean IsPassThrough = 0; 

Parameters

None

Return values 

A boolean data type that indicates whether a Submit method call is made with the pass-through flag enabled or disabled. If TRUE, the pass-through flag is enabled; otherwise, this value is FALSE and the pass-through flag is disabled.

Remarks

This property is read/write.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Name Property

Contains the name of the component.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Name; 

Parameters

None

Return values 

A string data type that contains the name of the component.

Remarks

This property is read/write.

The value of this property acts as the key for the class; its value uniquely identifies an instance of the class.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

OpennessFlag Property

Indicates the value of the lOpenness parameter that the receive function passes to the Submit method.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 OpennessFlag; 

Parameters

None

Return values 

32-bit unsigned integer that Indicates the value of the lOpenness parameter that the receive function passes to the Submit method.

Remarks

This property is read/write.

Permissible values for this property are "NotOpen", "OpenSource", and "OpenDestination," which map to the integers 0, 1, and 2, respectively. Note that the integer values must be used in code and script.

The following code is taken from the MOF file (InterchangeProvSchema.mof), and shows the values:

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

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Password Property

Contains the password to use for FTP or Message Queuing receive functions that require a user name and password.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Password; 

Parameters

None

Return values 

A string data type that contains the password to use for FTP or Message Queuing receive functions that require a user name and password.

Remarks

The property is read/write.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

PollingLocation Property

Contains the name of the directory to poll (directory, message queue, and so on) for receive functions that require polling.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string PollingLocation;

Parameters

None

Return values 

A string data type that contains the name of the directory to poll (directory, message queue, and so on) for receive functions that require polling.

Remarks

This property is read/write.

The maximum value for the length of this property is 260 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

PreProcessor Property

Indicates any pre-processing that must be done for received document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string PreProcessor; 

Parameters

None

Return values 

A string data type that indicates any pre-processing that must be done for received document.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProcessingServer Property

Contains the name of the server that is currently processing the interchange.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ProcessingServer; 

Parameters

None

Return values 

A string data type that contains the name of the server that is currently processing the interchange.

Remarks

This property is read/write.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

SourceID Property

Contains the ID of the organization or application that sends the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string SourceID; 

Parameters

None

Return values 

A string data type that contains the ID of the organization or application that sends the document.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

This property is required for custom receive functions.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

SourceQualifier Property

Contains the ID type of the organization or application that sends the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string SourceQualifier; 

Parameters

None

Return values 

A string data type that contains the ID type of the organization or application that sends the document.

Remarks

This property is read/write.

The maximum value for the length of this property is 64 characters.

This property is required for custom receive functions. The value of this property can be a phone number, a Dunn & Bradstreet number, and so on.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Username Property

Contains the user name to use for FTP or Message Queuing receive functions.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Username;

Parameters

None

Return values 

A string data type that contains the user name to use for FTP or Message Queuing receive functions.

Remarks

This property is read/write.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_RetryQueue

The MicrosoftBizTalkServer_RetryQueue class represents a logical grouping of interchanges in the Shared queue that are awaiting receipt correlation, or interchanges that are due to be sent to multiple destinations.

MicrosoftBizTalkServer_RetryQueue is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

MicrosoftBizTalkServer_RetryQueue inherits the following properties from the MicrosoftBizTalkServer_Queue class.

PropertyDescription
DestinationRepresents the organization or application that receives the document.
GroupRepresents the name of the group to which the queue belongs.
QIDIdentifies an instance of the class and is used as the key.
SourceRepresents the organization or application that sends the document.
TimestampRepresents the last time the document was used, or when it entered the queue.

The MicrosoftBizTalkServer_RetryQueue class defines the following properties:

PropertyDescription
LastRetryTimeIndicates the last time the server attempted a transmission.
ProcessingServerContains the name of the server that last processed the document.
RemainingRetryCountIndicates the number of outstanding retries remaining.
RetryIntervalIndicates the wait time between retry intervals.
ServiceWindowFromTimeIndicates the start time of the service window in which to send interchanges.
ServiceWindowToTimeIndicates the end time of the service window in which to send interchanges.

The MicrosoftBizTalkServer_RetryQueue class defines the following method:

MethodDescription
MoveToSuspendedQueueEnables the administrator to move the selected document to the Suspended queue.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

LastRetryTime Property

Indicates the last time the server attempted a transmission.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime LastRetryTime; 

Parameters

None

Return values 

A datetime data type that indicates the last time the server attempted a transmission.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MoveToSuspendedQueue Method

Enables the administrator to move the selected document to the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 MoveToSuspendedQueue(); 

Parameters

None.

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProcessingServer Property

Contains the name of the server that last processed the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ProcessingServer; 

Parameters

None

Return values 

A string data type that contains the name of the server that last processed the document.

Remarks

This is a read-only property.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

RemainingRetryCount Property

Indicates the number of outstanding retries remaining.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 RemainingRetryCount; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the number of outstanding retries remaining.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

RetryInterval Property

Indicates the wait time between retry intervals, in minutes.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 RetryInterval; 

Parameters

None

Return values 

32-bit unsigned integer that indicates the wait time between retry intervals, in minutes.

Remarks

This property is read-only.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ServiceWindowFromTime Property

Indicates the start time of the service window in which to send interchanges.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime ServiceWindowFromTime; 

Parameters

None

Return values 

A datetime data type that indicates the start time of the service window in which to send interchanges.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ServiceWindowToTime Property

Indicates the end time of the service window in which to send interchanges.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime ServiceWindowToTime;

Parameters

None

Return values 

A datetime data type that indicates the end time of the service window in which to send interchanges.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_ScheduledQueue

The MicrosoftBizTalkServer_ScheduledQueue class represents a logical grouping of interchanges in the Shared queue that are scheduled for a later delivery time based on a service window.

MicrosoftBizTalkServer_ScheduledQueue is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

MicrosoftBizTalkServer_ScheduledQueue inherits the following properties from the MicrosoftBizTalkServer_Queue class.

PropertyDescription
DestinationRepresents the organization or application that receives the document.
GroupRepresents the name of the group to which the queue belongs.
QIDIdentifies an instance of the class and is used as the key.
SourceRepresents the organization or application that sends the document.
TimestampRepresents the last time the document was used, or when it entered the queue.

The MicrosoftBizTalkServer_ScheduledQueue class defines the following properties:

PropertyDescription
ProcessingServerContains the name of the server that last worked on the document.
ServiceWindowFromTimeIndicates the start time of the service window in which to send interchanges.
ServiceWindowToTimeIndicates the end time of the service window in which to send interchanges.

The MicrosoftBizTalkServer_ScheduledQueue class defines the following method:

MethodDescription
MoveToSuspendedQueueEnables the administrator to move the selected document to the Suspended queue.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MoveToSuspendedQueue Method

Enables the administrator to move the selected document to the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 MoveToSuspendedQueue(); 

Parameters

None

Return values 

32 bit unsigned integer.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProcessingServer Property

Contains the name of the server that last worked on the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ProcessingServer; 

Parameters

None

Return values 

A string data type that contains the name of the server that last worked on the document.

Remarks

This property is read-only.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ServiceWindowFromTime Property

Indicates the start time of the service window in which to send interchanges.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime ServiceWindowFromTime; 

Parameters

None

Return values 

A datetime data type that indicates the start time of the service window in which to send interchanges.

Remarks

This property is read-only.

The value of this property is in interval format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ServiceWindowToTime Property

Indicates the end time of the service window in which to send interchanges.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime ServiceWindowToTime; 

Parameters

None

Return values

A datetime data type that indicates the end time of the service window in which to send interchanges.

Remarks

This property is read-only.

The value of this property is in interval format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_Server

The MicrosoftBizTalkServer_Server class represents specific Windows 2000 computers within a BizTalk Server group that are running BizTalk Messaging Services.

MicrosoftBizTalkServer_Server is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

The MicrosoftBizTalkServer_Server class defines the following properties:

PropertyDescription
DateModifiedIndicates the date of the last modification of the instance data.
GroupNameContains the name of the group to which the server belongs.
MaxRecvSvcThreadsPerProcessorIndicates the maximum number of receive function threads that BizTalk Server can use per processor for asynchronous calls.
MaxWorkerThreadsPerProcessorIndicates the maximum number of worker threads that BizTalk Server can use per processor for asynchronous calls.
NameContains the name of the server.
ParticipateInWorkItemProcessingIndicates whether or not the server participates in work-item processing.
SchedulerWaitTimeIndicates the time interval that BizTalk Server scheduler waits between tries.
ServiceStateIndicates the state of the BizTalk Server services on a particular server.

The MicrosoftBizTalkServer_Server class defines the following methods:

MethodDescription
FreeInterchangesFrees interchanges that are currently assigned to a specific server if the server is stopped, removed, or in an error state, so that other servers can work on these interchanges.
StartServerStarts BizTalk Server services on a specific server.
StopServerStops the BizTalk Server services on a specific server.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DateModified Property

Indicates the date of the last modification of the instance data.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

datetime DateModified; 

Parameters

None

Return values

A datetime data type that indicates the date of the last modification of the instance data.

Remarks

This property is read-only.

The value of this property is in date and time format. For more information, see the Platform SDK.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

FreeInterchanges Property

Frees interchanges that are currently assigned to a specific server if the server is stopped, removed, or in an error state, so that other servers can work on these interchanges.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 FreeInterchanges(); 

Parameters

None

Return values

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

GroupName Property

Contains the name of the group to which the server belongs.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string GroupName; 

Parameters

None

Return values

A string data type that contains the name of the group to which the server belongs.

Remarks

This property is read-only.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MaxRecvSvcThreadsPerProcessor Property

Indicates the maximum number of receive function threads that BizTalk Server can use per processor for asynchronous calls.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 MaxRecvSvcThreadsPerProcessor = 4; 

Parameters

None

Return values

32-bit unsigned integer that indicates the maximum number of receive function threads that BizTalk Server can use per processor for asynchronous calls.

Remarks

This property is read/write.

The default value for this property is 4.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MaxWorkerThreadsPerProcessor Property

Indicates the maximum number of worker threads that BizTalk Server can use per processor for asynchronous calls.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 MaxWorkerThreadsPerProcessor = 4; 

Parameters

None

Return values

32-bit unsigned integer that indicates the maximum number of worker threads that BizTalk Server can use per processor for asynchronous calls.

Remarks

This property is read/write.

The default value for this property is 4.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Name Property

Contains the name of the server.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string Name; 

Parameters

None

Return values

A string data type that contains the name of the server.

Remarks

This property is read/write.

The value of this property acts as the key for the class; its value uniquely identifies an instance of the class.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ParticipateInWorkItemProcessing Property

Indicates whether or not the server participates in work-item processing.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

boolean ParticipateInWorkItemProcessing = 1; 

Parameters

None

Return values

A boolean data type that indicates whether or not the server participates in work-item processing. If TRUE, the server participates in work-item processing; otherwise, this value is FALSE and the server does not participate in work-item processing.

Remarks

This property is read/write.

The default value for this parameter is TRUE.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

SchedulerWaitTime Property

Indicates the time interval that BizTalk Server scheduler waits between tries, in milliseconds.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 SchedulerWaitTime = 2000; 

Parameters

None

Return values

32-bit unsigned integer that indicates the time interval that BizTalk Server scheduler waits between tries, in milliseconds.

Remarks

This property is read/write.

The default value for this parameter is 2000 milliseconds.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ServiceState Property

Indicates the state of the BizTalk Server services on a particular server.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ServiceState;

Parameters

None

Return values

32-bit integer that indicates the state of the BizTalk Server services on a particular server.

Remarks

This property is read-only.

Permissible values for this parameter are

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

StartServer Method

Starts BizTalk Server services on a specific server.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 StartServer(); 

Parameters

None

Return values

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Remarks

The execution of this method is valid anytime the specific server is in a stopped state.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

StopServer Method

Stops the BizTalk Server services on a specific server.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 StopServer(); 

Parameters

None

Return values

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Remarks

The execution of this method is valid anytime the specific server is in a running state.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_SuspendedQueue

The MicrosoftBizTalkServer_SuspendedQueue class represents a logical grouping of interchanges in the Shared queue that could not be successfully processed.

MicrosoftBizTalkServer_SuspendedQueue is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

MicrosoftBizTalkServer_SuspendedQueue inherits the following properties from the MicrosoftBizTalkServer_Queue class.

PropertyDescription
DestinationRepresents the organization or application that receives the document.
GroupRepresents the name of the group to which the queue belongs.
QIDIdentifies an instance of the class and is used as the key.
SourceRepresents the organization or application that sends the document.
TimestampRepresents the last time the document was used, or when it entered the queue.

The MicrosoftBizTalkServer_SuspendedQueue class defines the following properties:

PropertyDescription
DocNameContains the name of the document definition related to the document in the queue.
ErrorDescriptionContains the first 64 characters of the error description.
QGUIDContains the submission GUID of the Suspended queue work item.
StateIndicates the state of the document or interchange in the Suspended queue.

The MicrosoftBizTalkServer_SuspendedQueue class defines the following methods:

MethodDescription
ResubmitEnables an administrator to resubmit the selected document to the server.
ViewDocumentEnables an administrator to view the contents of a selected document on the Suspended queue.
ViewErrorDescriptionEnables the administrator to view a description of the error.
ViewInterchangeEnables the administrator to view the contents of a selected interchange on the Suspended queue.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocName Property

Contains the name of the document definition related to the document in the queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocName; 

Parameters

None

Return values

A string data type that contains the name of the document definition related to the document in the queue.

Remarks

This property is read only.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ErrorDescription Property

Contains the first 64 characters of the error description.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ErrorDescription; 

Parameters

None

Return values 

A string data type that contains the first 64 characters of the error description.

Remarks

This property is read only.

The maximum value for the length of this property is 64 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

QGUID Property

Contains the submission GUID of the Suspended queue work item.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string QGUID; 

Parameters

None

Return values 

A string data type that contains the submission GUID of the Suspended queue work item.

Remarks

This property is read only.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Resubmit Method

Enables an administrator to resubmit the selected document to the server.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 Resubmit(); 

Parameters

None

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Remarks

This method enables an administrator to resubmit interchanges after problems have been fixed.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

State Property

Indicates the state of the document or interchange in the Suspended queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 State; 

Parameters

None

Return values 

32-bit integer that indicates the state of the document or interchange in the Suspended queue. For more information, see Remarks.

Remarks

This property is read-only.

The tables in this section show the possible processing states of a document or interchange in the Suspended queue.

Documents in the following states are at the interchange level, so you should use the ViewInterchange method to view the data. In addition, interchanges in these states cannot be resubmitted, so in this case you should not call Resubmit.

ValueDescription
0Initial
1Custom component
2Parsing

Documents in the following states are at the document level, so you should use the ViewDocument method to view the data. In addition, documents in the document validation state (3) cannot be resubmitted, so in this case you should not call Resubmit.

ValueDescription
3Document validation
4Channel selection
5Field tracking
6Correlating
7Mapping
8Serializing

Documents in the following states are at the interchange level, so you should use the ViewInterchange method to view the data.

ValueDescription
9Encoding
10Signing
11Encrypting
12Transmitting

Note that the ViewErrorDescription method can be used to retrieve error description information on failed documents and interchanges.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ViewDocument Method

Enables an administrator to view the contents of a selected document on the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ViewDocument(
    uint8 Document[],
    uint32 CodePage
); 

Parameters

Document[]
[out] An array of bytes, representing the information in the document. This data may need to be converted into a readable format. The maximum size for this parameter is 4 MB. If the data exceeds 4 MB, the data will be truncated. For more information about this parameter, see Remarks.
CodePage
[out] The code page of the document. For more information about this parameter, see Remarks.

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Remarks

The following table shows the possible values for the CodePage parameter and their meanings.

ValueDescription
-1No codepage available
0Default system codepage
1200Unicode codepage
1252ASCII codepage

If the value returned in CodePage is 0 or 1200, the data is displayable and no conversion is needed. However, if the value is -1, you should try loading the data into MSXML.

If the value returned in CodePage is 1252, you should try loading the data into MSXML. If this fails, you can use the MultiByteToWideChar function, passing in CodePage as the codepage parameter to the Win32 API. For information on MultiByteToWideChar, see the Platform SDK.

For more information about displaying the contents of the document, see "Displaying the Contents of a Document or Interchange" in "Appendix: Solutions Library," later in this white paper.

If the data contained in Document is over 4 MB, C++ programmers can use the IInterchange::GetSuspendedQueueItemDetails method to retrieve the document.

If the data contained in Document is over 4 MB, Microsoft Visual Basic programmers can use the Interchange.GetSuspendedQueueItemDetails method to retrieve the document.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ViewErrorDescription Method

Enables the administrator to view a description of the error.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ViewErrorDescription(
    string CompleteErrorDescription
); 

Parameters

CompleteErrorDescription
[out] A string describing the error.

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ViewInterchange Method

Enables the administrator to view the contents of a selected interchange on the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 ViewInterchange(
uint8 Interchange[],
uint32 CodePage
); 

Parameters

Interchange[]
[out] An array of bytes, representing the information in the interchange. This data may need to be converted into a readable format. The maximum size for this parameter is 4 MB. If the data exceeds 4 MB, the data will be truncated. For more information, see Remarks.
CodePage
[out] The code page of the interchange. For more information, see Remarks.

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Remarks

The following table shows the possible values for the CodePage parameter and their meanings.

ValueDescription
-1No codepage available
0Default system codepage
1200Unicode codepage
1252ASCII codepage

If the value returned in CodePage is 0 or 1200, the data is displayable and no conversion is needed. However, if the value is -1, you should try loading the data into MSXML.

If the value returned in CodePage is 1252, you should try loading the data into MSXML. If this fails, you can use the MultiByteToWideChar function, passing in CodePage as the codepage parameter to the Win32 API. For information on MultiByteToWideChar, see the Platform SDK.

For more information about displaying the contents of the interchange, see "Displaying the Contents of a Document or Interchange" in the Working with Documents section of the Appendix: Solutions Library.

If the data contained in Interchange is over 4 MB, C++ programmers can use the IInterchange::GetSuspendedQueueItemDetails method to retrieve the interchange.

If the data contained in Interchange is over 4 MB, Microsoft Visual Basic programmers can use the Interchange.GetSuspendedQueueItemDetails method to retrieve the interchange.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MicrosoftBizTalkServer_WorkQueue

The MicrosoftBizTalkServer_WorkQueue class represents a logical grouping of interchanges in the Shared queue that are currently in process.

MicrosoftBizTalkServer_WorkQueue is a dynamic class, supplied by the WMI provider "InterchangeProv" at run time, as needed.

MicrosoftBizTalkServer_WorkQueue inherits the following properties from the MicrosoftBizTalkServer_Queue class.

PropertyDescription
DestinationRepresents the organization or application that receives the document.
GroupRepresents the name of the group to which the queue belongs.
QIDIdentifies an instance of the class and is used as the key.
SourceRepresents the organization or application that sends the document.
TimestampRepresents the last time the document was used, or when it entered the queue.

The MicrosoftBizTalkServer_WorkQueue class defines the following properties:

PropertyDescription
DocNameContains the name of the document definition related to the document in the queue.
EngineStateIndicates whether the work item is waiting for receipt correlation or waiting for transmission.
ProcessingServerContains the name of the server that last processed the document.

The MicrosoftBizTalkServer_WorkQueue class defines the following method:

MethodDescription
MoveToSuspendedQueueEnables the administrator to move the selected document to the Suspended queue.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

DocName Property

Contains the name of the document definition related to the document in the queue.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string DocName; 

Parameters

None

Return values 

A string data type that contains the name of the document definition related to the document in the queue.

Remarks

This property is read-only.

The maximum value for the length of this property is 256 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

EngineState Property

Indicates whether the work item is waiting for receipt correlation or waiting for transmission.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 EngineState; 

Parameters

None

Return values 

32-bit unsigned integer that indicates whether the work item is waiting for receipt correlation or waiting for transmission. For more information, see Remarks below.

Remarks

This property is read-only.

The possible values for this property are defined by the BTSCoreQueueStates enumeration, as shown in the following code:

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

The following table provides the numerical values of the constants defined in the BTSCoreQueueStates enumeration.

ValueConstant
29Processing
30Correlation
31TransmissionWServiceWindow
33Transmission

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

MoveToSuspendedQueue Method

Enables the administrator to move the selected document to the Suspended queue.

Syntax

The syntax shown is language neutral. This method is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

uint32 MoveToSuspendedQueue(); 

Parameters

None

Return values 

32-bit unsigned integer, an HRESULT.

For more information, see Handling Errors, earlier in this white paper.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

ProcessingServer Property

Contains the name of the server that last processed the document.

Syntax

The syntax shown is language neutral. This property is supported in C++, Microsoft Visual Basic, and Visual Basic Script.

string ProcessingServer; 

Parameters

None

Return values 

A string data type that contains the name of the server that last processed the document.

Remarks

This property is read-only.

The maximum value for the length of this property is 63 characters.

Requirements

Windows NT/2000: Requires Windows 2000 SP1 or later
Header and Library: Wbemidl.h, Wbemuuid.lib
MOF File: InterchangeProvSchema.mof
Scripting Library: Microsoft WMI Scripting V1.1 Library (wbemdisp.tlb)

Appendix: Solutions Library

This section uses Microsoft Visual Basic examples to demonstrate code solutions to common tasks encountered when using BizTalk Server with WMI.

To ensure that your Visual Basic projects can access the WMI objects used in the following code, you need to add the Microsoft WMI Scripting V1.1 Library in the Reference dialog.

Then, you can declare the WMI locator and services variables:

Public g_objLocator As SWbemLocator
Public g_objService As SWbemServices

In addition, the following constants should be defined:

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"

You should make the connection to WMI with the following code:

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

Working with Documents

The code examples in this section are useful when working with documents and interchanges. An interchange is a collection of one or more document instances that comprises a single transmission.

This section presents functions that work together to convert variant data from a document or interchange into a string.

Displaying the Contents of a Document or Interchange

When using the ViewDocument or ViewInterchange methods of the MicrosoftBizTalkServer_SuspendedQueue class, you may need to convert the returned byte array into a readable format.

The following function takes a codepage and variant data and returns a string:

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

The following function is used by the ConvertViewDocument function to convert the variant data into a string:

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

The following private function is used by the ConvertVarToBstr function to return a character set:

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

Working with Groups

The code examples in this section are useful when working with groups. Server groups are collections of individual servers that are centrally managed, configured, and monitored.

This section presents functions that create a group, delete a group, retrieve a group by name, and retrieve all groups.

Creating a Group

The following function creates a group:

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
        ' Handle the error.
        CreateGroup = False
    End If
End Function

Deleting a Group

The following function deletes a group:

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
        ' Handle the error.
        DeleteGroup = False
    End If
End Function

Retrieving a Group by Name

The following function retrieves a group by name:

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
        ' Handle the error.
    End If
End Function

Retrieving All Groups

The following function retrieves all groups:

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
        ' Handle the error.
    End If
End Function

Working with the Management Database

The code examples in this section are useful when working with the BizTalk Messaging Management database. The management database stores information for all server configurations, including group and server settings, and receive functions.

This section presents functions that create the management database and retrieve the management database.

Creating the Management Database

The following function creates the management database:

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
        ' Handle the error.
        CreateMgmtDB = False
     End If
End Function

Retrieving the Management Database

The following function retrieves the management database:

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
       ' Handle the error.
       Exit Function
    End If
    
    Set GetMgmtDB = objSet_BTSMgmt.Item(MGMT_NAMESPACE & _
                    ".LocalServer=""" & strLocalServer & """")
End Function

Working with Receive Services

The code examples in the section are useful when working with receive services. You create receive services to process data.

This section presents functions that create a File receive service, delete a File receive service, retrieve a receive service by name, retrieve all receive services, and retrieve all receive services by group.

Creating a File Receive Service

The following function creates a receive service:

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
        ' Handle the error.
        CreateReceiveService = False
    End If
End Function

Deleting a File Receive Service

The following function deletes a receive service:

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
        ' Handle the error.
        DeleteReceiveSvc = False
    End If

End Function

Retrieving a Receive Service by Name

The following function retrieves a receive service by name:

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
        ' Handle the error.
    End If
End Function

Retrieving All Receive Services

The following function retrieves all receive services:

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
        ' Handle the error.
    End If
End Function 

Retrieving All Receive Services by Group

The following function retrieves all receive services by group:

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
        ' Handle the error.
    End If
End Function

Working with Servers

The code examples in this section are useful when working with servers. A server in a server group hosts the appropriate BizTalk Messaging Services functionality to manage document exchange between other servers and applications that are external to the BizTalk server group.

This section presents functions that create a server, delete a server, start a server, stop a server, retrieve a server by name, retrieve all servers, and retrieve all servers by group.

Creating a Server

The following function creates a 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
        ' Handle the error.
        CreateServer = False
    End If
End Function

Deleting a Server

The following function deletes a server:

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
        ' Handle the error.
        DeleteServer = False
    End If
End Function

Starting a Server

The following function will start a server:

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  
        ' Handle the error.
        StartServer = False
    Else
        Err.Clear
    End If
End Function

Note that if Err is not equal to 0, and the hexadecimal value of the error is not equal to 80070420, then the service was already running.

Stopping a Server

The following function will stop a server:

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  
        ' Handle the error.
        StopServer = False
    Else
        Err.Clear
    End If
End Function

Note that if Err is not equal to 0, and the hexadecimal value of the error is not equal to 80070426, then the service was not running.

Retrieving a Server by Name

The following function will retrieve a server by name:

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
        ' Handle the error.
    End If
End Function

Retrieving All Servers

The following function retrieves all servers:

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
        ' Handle the error.
    End If
End Function

Retrieving All Servers by Group

The following function retrieves all servers by group:

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
        ' Handle the error.
    End If
End Function

Working with Queues

The code examples in this section are useful when working with queues. Queues are used to contain incoming and outgoing documents that are in various stages of routing and processing in BizTalk Server.

This section presents functions that retrieve queues by group and retrieve all queues.

Retrieving Queues by Group

This section illustrates functions that retrieve the Work, Retry, Suspended, or Scheduled queue by group.

The Work queue contains documents that are currently being processed by BizTalk Server. The following function retrieves the Work queue by group:

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

The Retry queue contains documents that are being resubmitted for delivery and documents that are waiting for reliable messaging receipts. The following function retrieves the retry queue by group:

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

The Suspended queue contains work items that have failed processing for a variety of reasons, including parsing errors, serialization errors, and failed transmissions. The following function retrieves the suspended queue by group:

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

The Scheduled queue contains work items that have been processed by BizTalk Server and are waiting for transmission. The following function retrieves the scheduled queue by group:

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

The following helper function is used by the above functions to retrieve a given queue by group:

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
        ' Handle the error.
    End If
End Function

Retrieving All Queues

The following function retrieves all queues:

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
        ' Handle the error.
    End If
End Function

The information contained in this document represents the current view of Microsoft Corporation on the issues discussed as of the date of publication. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information presented after the date of publication.

This white paper is for informational purposes only. MICROSOFT MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE INFORMATION IN THIS DOCUMENT.

Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

The example companies, organizations, products, people and events depicted herein are fictitious. No association with any real company, organization, product, person or event is intended or should be inferred.

Copyright © 2001 Microsoft Corporation. All rights reserved.

Microsoft, ActiveX, BizTalk, SourceSafe, Visio, Visual Basic, Visual C++, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

The names of actual companies and products mentioned herein may be the trademarks of their respective owners.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft