BizTalkReceiveHandler Class

MSBuild Extension Pack

previous page next page
BizTalkReceiveHandler Class MSBuild Extension Pack Help 4.0.12.0
Valid TaskActions are:

CheckExists (Required: HostName, AdapterName Optional: MachineName, DatabaseServer, DatabaseOutput: Exists)

Create (Required: HostName, AdapterName Optional: MachineName, DatabaseServer, Database, CustomCfg, Force)

Delete (Required: HostName, AdapterName Optional: MachineName, DatabaseServer, Database)

Get (Optional: HostName, AdapterName, MachineName, DatabaseServer, DatabaseOutput: ReceiveHandlers)

Remote Execution Support: Yes

Inheritance Hierarchy
SystemObject  Microsoft.Build.UtilitiesTask
    MSBuild.ExtensionPackBaseTask
      MSBuild.ExtensionPack.BizTalkBizTalkReceiveHandler

Namespace: MSBuild.ExtensionPack.BizTalk
Assembly: MSBuild.ExtensionPack.BizTalk (in MSBuild.ExtensionPack.BizTalk.dll) Version: 4.0.0.0

The BizTalkReceiveHandler type exposes the following members.

Constructors
  NameDescription
Public methodBizTalkReceiveHandler
Top
Properties
  NameDescription
Public propertyAdapterName
Sets the AdapterName
Public propertyCustomCfg
Sets the CustomCfg for the ReceiveHandler. See Configuration Properties for Integrated BizTalk Adapters
Public propertyDatabase
Sets the Management Database to connect to. Default is BizTalkMgmtDb
Public propertyDatabaseServer
Sets the DatabaseServer to connect to. Default is MachineName
Public propertyExists
Gets whether the Application exists
Public propertyForce
Set to true to delete an existing Receive Handler when Create is called.
Public propertyHostName
Sets the Host Name. For TaskAction="Get", a regular expression may be provided
Public propertyReceiveHandlers
Gets the list of Receive Handlers. Identity is HostName. Metadata includes AdapterName, MgmtDbNameOverride, MgmtDbServerOverride, CustomCfg, Description, Caption.
Top
Examples
Copy
<Project ToolsVersion="4.0" DefaultTargets="Default" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <TPath>$(MSBuildProjectDirectory)\..\MSBuild.ExtensionPack.tasks</TPath>
        <TPath Condition="Exists('$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks')">$(MSBuildProjectDirectory)\..\..\Common\MSBuild.ExtensionPack.tasks</TPath>
    </PropertyGroup>
    <Import Project="$(TPath)"/>
    <Target Name="Default">
        <!-- Create a ReceiveHandler (note force is true)-->
        <MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler TaskAction="Create" HostName="MSBEPTESTHOST" AdapterName="MQSeries" Force="true"/>
        <!-- Check a SendHandler exists (it should) -->
        <MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler TaskAction="CheckExists" HostName="MSBEPTESTHOST" AdapterName="MQSeries">
            <Output TaskParameter="Exists" PropertyName="DoesExist"/>
        </MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler>
        <Message Text="BizTalkReceiveHandler  Exists: $(DoesExist) "/>
        <!-- Get all Receive Handlers -->
        <MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler TaskAction="Get">
            <Output TaskParameter="ReceiveHandlers" ItemName="RH"/>
        </MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler>
        <Message Text="%(RH.Identity) - %(RH.AdapterName) - %(RH.CustomCfg)"/>
        <!-- Delete a ReceiveHandler -->
        <MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler TaskAction="Delete" HostName="MSBEPTESTHOST" AdapterName="MQSeries"/>
        <!-- Check a ReceiveHandler exists (it shouldn't) -->
        <MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler TaskAction="CheckExists" HostName="MSBEPTESTHOST" AdapterName="MQSeries">
            <Output TaskParameter="Exists" PropertyName="DoesExist"/>
        </MSBuild.ExtensionPack.BizTalk.BizTalkReceiveHandler>
        <Message Text="BizTalkReceiveHandler  Exists: $(DoesExist) "/>
    </Target>
</Project>
See Also

Reference

MSBuild.ExtensionPack.BizTalk Namespace
previous page start next page