BtsCatalogExplorer Class
 

Provides the implementation for the IBtsCatalogExplorer interface.

Namespace:   Microsoft.BizTalk.ExplorerOM
Assembly:  Microsoft.BizTalk.ExplorerOM (in Microsoft.BizTalk.ExplorerOM.dll)

SystemObject
  Microsoft.BizTalk.ExplorerOMBtsCatalogExplorer

[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
[GuidAttribute("51C20CE5-372E-444c-A6EF-99DB60341E4E")]
public sealed class BtsCatalogExplorer : IBtsCatalogExplorer2, 
	IBtsCatalogExplorer, IDisposable
[ClassInterfaceAttribute(ClassInterfaceType::None)]
[ComVisibleAttribute(true)]
[GuidAttribute("51C20CE5-372E-444c-A6EF-99DB60341E4E")]
public ref class BtsCatalogExplorer sealed : IBtsCatalogExplorer2, 
	IBtsCatalogExplorer, IDisposable
[<Sealed>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<ComVisibleAttribute(true)>]
[<GuidAttribute("51C20CE5-372E-444c-A6EF-99DB60341E4E")>]
type BtsCatalogExplorer = 
    class
        interface IBtsCatalogExplorer2
        interface IBtsCatalogExplorer
        interface IDisposable
    end
<ClassInterfaceAttribute(ClassInterfaceType.None)>
<ComVisibleAttribute(True)>
<GuidAttribute("51C20CE5-372E-444c-A6EF-99DB60341E4E")>
Public NotInheritable Class BtsCatalogExplorer
	Implements IBtsCatalogExplorer2, IBtsCatalogExplorer, IDisposable
NameDescription
System_CAPS_pubmethod BtsCatalogExplorer

Initializes a new instance of the BtsCatalogExplorer class.

NameDescription
System_CAPS_pubproperty

Gets the application collection contained in this group.

System_CAPS_pubproperty

Gets the BizTalk assemblies deployed in the Partner Management database.

System_CAPS_pubproperty

Gets the certificates installed in the AddressBook store of the local computer.

System_CAPS_pubproperty

Gets or sets the string used to open the Partner Management database.

System_CAPS_pubproperty

Gets or sets the default application in the group.

System_CAPS_pubproperty

Gets the Admin Group name.

System_CAPS_pubproperty

Gets the collection of hosts contained in the database.

System_CAPS_pubproperty

Gets the collection of parties contained in the database.

System_CAPS_pubproperty

Gets the collection of pipelines contained in the database.

System_CAPS_pubproperty

Gets the collection of adapter types contained in the database.

System_CAPS_pubproperty

Gets the collection of receive handlers contained in the database.

System_CAPS_pubproperty

Gets the collection of receive ports contained in the database.

System_CAPS_pubproperty

Gets the rule deployment driver for the database.

System_CAPS_pubproperty

Gets the collection of schemas contained in the database.

System_CAPS_pubproperty

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of send handlers in the database.

System_CAPS_pubproperty

Gets the collection of send port groups contained in the database.

System_CAPS_pubproperty

Gets the collection of send ports contained in the database.

System_CAPS_pubproperty

Gets the collection of standard aliases that can be used for a party.

System_CAPS_pubproperty

Gets the system application in the group.

System_CAPS_pubproperty

Gets the collection of transforms contained in the database.

NameDescription
System_CAPS_pubmethod AddNewApplication

Creates and adds a new application to the application collection.

System_CAPS_pubmethod AddNewParty

Creates and adds a party object to the party collection.

System_CAPS_pubmethod AddNewReceivePort

Creates and adds a receive port to the receive port collection.

System_CAPS_pubmethod AddNewSendPort

Creates and adds a send port to the send port collection.

System_CAPS_pubmethod AddNewSendPortGroup

Creates and adds a send port group to the send port group collection.

System_CAPS_pubmethod DiscardChanges

Rejects all BtsCatalogExplorer changes to the database since the last time the SaveChanges method or the SaveChangesWithTransaction method was called.

System_CAPS_pubmethod Dispose

Releases the resources used by the current instance of the BtsCatalogExplorer class.

System_CAPS_pubmethod Equals

(Inherited from Object.)

System_CAPS_pubmethod GetCollection

Gets the collection of a particular type.

System_CAPS_pubmethod GetHashCode

(Inherited from Object.)

System_CAPS_pubmethod GetType

(Inherited from Object.)

System_CAPS_pubmethod Refresh

Removes all the content from the BtsCatalogExplorer object.

System_CAPS_pubmethod RemoveApplication

Deletes the specified application from the application collection.

System_CAPS_pubmethod RemoveParty

Removes a party from the party collection.

System_CAPS_pubmethod RemoveReceivePort

Removes the specified receive port from the receive port collection.

System_CAPS_pubmethod RemoveSendPort

Removes the specified send port from the send port collection.

System_CAPS_pubmethod RemoveSendPortGroup

Removes the specified send port group from the send port group collection.

System_CAPS_pubmethod SaveChanges

Commits all BtsCatalogExplorer object changes to the database since the last time the SaveChanges method or SaveChangesWithTransaction method was called.

System_CAPS_pubmethod SaveChangesWithTransaction

Commits all BtsCatalogExplorer object changes to the database since the last time the SaveChanges method or SaveChangesWithTransaction method was called.

System_CAPS_pubmethod ToString

(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerAddNewParty

Creates and adds a party object to the party collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerAddNewReceivePort

Creates and adds a receive port to the receive port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerAddNewSendPort

Creates and adds a send port to the send port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerAddNewSendPortGroup

Creates and adds a send port group to the send port group collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerRemoveParty

Removes a party from the party collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerRemoveReceivePort

Removes the specified receive port from the receive port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerRemoveSendPort

Removes the specified send port from the send port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorerRemoveSendPortGroup

Removes the specified send port group from the send port group collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2AddNewApplication

Creates and adds a new application to the application collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2AddNewParty

Creates and adds a party object to the party collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2AddNewReceivePort

Creates and adds a receive port to the receive port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2AddNewSendPort

Creates and adds a send port to the send port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2AddNewSendPortGroup

Creates and adds a send port group to the send port group collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2RemoveApplication

Deletes the specified application from the application collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2RemoveParty

Removes a party from the party collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2RemoveReceivePort

Removes the specified receive port from the receive port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2RemoveSendPort

Removes the specified send port from the send port collection.

System_CAPS_pubinterface System_CAPS_privmethod IBtsCatalogExplorer2RemoveSendPortGroup

Removes the specified send port group from the send port group collection.

Each top level item exposed through the BtsCatalogExplorer class has a RootXXData object representing the DataTable, DataRelation, SelectSchema and DataColumn initializations. The SelectSchemas of all the DataTables involved are validated when the connection is established to the partner management database. Each RootXXData command builder uses the select schema to build the Update, Insert and Delete SQL statements to validate its schema and also the schema of its child DataTables, this is recursive.

For example, a party validates its schema and the schemas of the party alias and party send ports. Since the schema is validated during connection stage, any discrepancy in the database tables or relations is identified at an early stage.

All the changes are done in memory and are committed to the database when the SaveChanges method is called. This method is transactional in the sense that the entire changes are rolled back if any failure occurs during this execution of this method. If no changes are made when SaveChanges is called then no data is committed thereby avoiding a round-trip to the database. Call DiscardChanges to reject the in memory changes during failure case.

If you will be adding, changing or removing multiple objects, use a single instance of BtsCatalogExplorer and invoke the SaveChanges method when you have made all of your changes. This is more efficient than creating multiple BtsCatalogExplorer objects or saving after each change.

Namespace: Microsoft.BizTalk.ExplorerOM

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003

Assembly: BizTalk Explorer Object Model (in Microsoft.Biztalk.ExplorerOM.dll)

The following example demonstrates how to enumerate collections using VBScript. BtsCatalogExplorer collections cannot be enumerated using the IEnumerable interface and the "for each" syntax.

sub EnumApplication
    dim Exp, Applications, Application
    dim i

    ' Create a BtsCatalogExplorer object and connect it to
    ' the default management database 
    set Exp = CreateObject("BtsCatalogExplorer")
    Exp.ConnectionString = "Data Source=ServerName;Initial Catalog=BizTalkMgmtDb;Integrated Security=SSPI;"

    ' Create an ArrayList to hold the enumerated values,
    ' in this case a list of BizTalk Server Applications
    set Applications = CreateObject("System.Collections.ArrayList")
    Applications.AddRange Exp.Applications

    ' Display the list
    i = 0
    for each Application in Applications
        WScript.Echo "App Name is " & Application.Name
        i = i+1
    next

    Wscript.Echo "Applications found = " & i
 end sub 

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

Return to top