{"id":3254,"date":"2010-03-03T19:12:56","date_gmt":"2010-03-03T19:12:56","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/webdev\/2010\/03\/03\/how-to-package-and-deploy-com-component\/"},"modified":"2010-03-03T19:12:56","modified_gmt":"2010-03-03T19:12:56","slug":"how-to-package-and-deploy-com-component","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/how-to-package-and-deploy-com-component\/","title":{"rendered":"How to package and deploy COM component"},"content":{"rendered":"

I\u2019ll use a walkthrough example to show how to package a web application with speech API COM component using Visual Studio 2010.  I wrote and tested the sample in Win7 x86 with IIS7.5, and packaged and manually installed to win2k3 x86 IIS6 (which only had 3.5 framework installed).<\/p>\n

1. Create a C# 3.5 web application<\/p>\n

2. Add COM reference to \u201cMicrosoft Speech Object Library\u201d<\/p>\n

\"image\"<\/a> <\/p>\n

3. In Default.aspx, add the following between <div><\/p>\n

        <<\/span>asp<\/span>:<\/span>ScriptManager <\/span>ID<\/span>="ScriptManager1" <\/span>runat<\/span>="server">\n        <\/<\/span>asp<\/span>:<\/span>ScriptManager<\/span>>\n        <<\/span>asp<\/span>:<\/span>UpdatePanel <\/span>ID<\/span>="UpdatePanel1" <\/span>runat<\/span>="server">\n            <<\/span>ContentTemplate<\/span>>\n                <<\/span>asp<\/span>:<\/span>TextBox <\/span>ID<\/span>="TextBox1" <\/span>runat<\/span>="server" <\/span>Width<\/span>="274px"><\/span>Welcome to web deployment<\/<\/span>asp<\/span>:<\/span>TextBox<\/span>>\n                <<\/span>asp<\/span>:<\/span>Button <\/span>ID<\/span>="Button1" <\/span>runat<\/span>="server" <\/span>onclick<\/span>="Button1_Click" \n                    <\/span>Text<\/span>="Play the text" \/>\n                <<\/span>asp<\/span>:<\/span>PlaceHolder <\/span>ID<\/span>="PlaceHolder1" <\/span>runat<\/span>="server"><\/<\/span>asp<\/span>:<\/span>PlaceHolder<\/span>>\n            <\/<\/span>ContentTemplate<\/span>>\n        <\/<\/span>asp<\/span>:<\/span>UpdatePanel<\/span>>\n<\/span><\/pre>\n
<\/a><\/p>\n
4. In Default.aspx.cs, write the following:<\/p>\n
using <\/span>System;\nusing <\/span>System.Collections.Generic;\nusing <\/span>System.Linq;\nusing <\/span>System.Web;\nusing <\/span>System.Web.UI;\nusing <\/span>System.Web.UI.WebControls;\nusing <\/span>SpeechLib;\n\nnamespace <\/span>WebApplication2\n{\n    public partial class <\/span>Default <\/span>: System.Web.UI.Page\n    <\/span>{\n        protected void <\/span>Page_Load(object <\/span>sender, EventArgs <\/span>e)\n        {\n            if <\/span>(!String<\/span>.IsNullOrEmpty(Request.Params["text"<\/span>]))\n            {\n                Response.Buffer = false<\/span>;\n\n                byte<\/span>[] byteBuffer = MyTextToWav(Request.Params["text"<\/span>]);\n                Response.Clear();\n                Response.ClearHeaders();\n                Response.ClearContent();\n                \n                Response.AppendHeader("Content-Disposition"<\/span>, "attachment;filename=" <\/span>+ HttpUtility<\/span>.UrlEncode(TextBox1.Text + ".wav"<\/span>, System.Text.Encoding<\/span>.UTF8));\n                Response.ContentType = "audio\/wav"<\/span>;\n                Response.BinaryWrite(byteBuffer);\n                Response.End();\n            }\n        }\n\n        private byte<\/span>[] MyTextToWav(string <\/span>inputText)\n        {\n            byte<\/span>[] b = null<\/span>;\n            {\n                SpMemoryStream <\/span>spMemStream = new <\/span>SpMemoryStream<\/span>();\n\n                \/\/default value is spMemStream.Format.Type = SpeechAudioFormatType.SAFT22kHz16BitMono;\n                <\/span>SpeechLib.SpVoice <\/span>ispvoice1 = new <\/span>SpVoice<\/span>();\n                ispvoice1.AudioOutputStream = spMemStream;\n\n                \/\/Note, in IIS, the app pool has to be using LocalSystem to access speechLib COM\n                <\/span>ispvoice1.Speak(inputText, SpeechVoiceSpeakFlags<\/span>.SVSFDefault);\n                ispvoice1.WaitUntilDone(10000);\n                spMemStream.Seek(0, SpeechStreamSeekPositionType<\/span>.SSSPTRelativeToStart);\n\n                byte<\/span>[] buffer = (byte<\/span>[])spMemStream.GetData();\n                using <\/span>(System.IO.MemoryStream <\/span>memoryStream = new <\/span>System.IO.MemoryStream<\/span>())\n                {\n                    System.IO.BinaryWriter <\/span>writer = new <\/span>System.IO.BinaryWriter<\/span>(memoryStream);\n\n                    HeaderWrite(writer, false<\/span>, 16, buffer.Length \/ 2, 22100);  \/\/Hack, only works if default as SAFT22kHz16BitMono\n                    \/\/HeaderWrite(writer, false, 16, buffer.Length \/ 2, 44100);\n                    <\/span>writer.Write(buffer);\n\n                    b = memoryStream.GetBuffer();\n                }\n            }\n            return <\/span>b;\n        }\n\n        private void <\/span>HeaderWrite(System.IO.BinaryWriter <\/span>writer, bool <\/span>stereo, short <\/span>bitsPerSample, int <\/span>numberOfSamples, int <\/span>sampleRate)\n        {\n            writer.Write(0x46464952); \/\/ "RIFF" in ASCII\n            <\/span>writer.Write((int<\/span>)(44 + (numberOfSamples * bitsPerSample * (stereo ? 2 : 1) \/ 8)) - 8);\n            writer.Write(0x45564157); \/\/ "WAVE" in ASCII\n\n            <\/span>writer.Write(0x20746d66); \/\/ "fmt " in ASCII\n            <\/span>writer.Write(16);\n            writer.Write((short<\/span>)1);\n            writer.Write((short<\/span>)(stereo ? 2 : 1));\n            writer.Write(sampleRate);\n            writer.Write(sampleRate * (stereo ? 2 : 1) * bitsPerSample \/ 8);\n            writer.Write((short<\/span>)((stereo ? 2 : 1) * bitsPerSample \/ 8));\n            writer.Write(bitsPerSample);\n\n            writer.Write(0x61746164); \/\/ "data" in ASCII\n            <\/span>writer.Write((int<\/span>)(numberOfSamples * bitsPerSample * (stereo ? 2 : 1) \/ 8));\n        } \n\n        protected void <\/span>Button1_Click(object <\/span>sender, EventArgs <\/span>e)\n        {\n            try\n            <\/span>{\n                Response.Redirect(String<\/span>.Format("Default.aspx?&text={0}"<\/span>, TextBox1.Text ));\n            <\/span>}\n            catch <\/span>(Exception <\/span>ex)\n            {\n                PlaceHolder1.Controls.Add(new <\/span>LiteralControl<\/span>(ex.ToString()));\n            }\n        }\n    }\n}<\/pre>\n
<\/a><\/p>\n
5. Ctrl-F5 and test, it should work fine with ASP.NET Development Server.<\/p>\n
6. Right click the project name in solution explorer, and choose \u201cBuild Deployment Package\u201d, it should build a debug package inside project\u2019s objdebugpackage directory.  <\/p>\n
7. In a admin command prompt, we can go to that directory, and deploy the package locally to IIS by running \u201c<ProjectName>.deploy.cmd \/y\u201d.  Note, we can also publish it using publish dialog by using localhost as the service URL.<\/p>\n
8. Since SpeechAPI does not work with IIS application pools that runs with \u201cNetwork Service\u201d or \u201cApplicationPoolIdentity\u201d, we\u2019ve to add a new 2.0 application pool, and set its identity to \u201cLocalSystem\u201d.  Then set the deployed website\u2019s application pool to use it.  Test it out, it should work in IIS7 as well.  (Security risk, make sure you change it back after demo.)<\/p>\n
\"image\"<\/a> \"image\"<\/a> <\/p>\n
9. Let\u2019s try to package and deploy to a win2k3 machine.  To install the corresponding Speech API on the win2k3 machine, I can download\/install Microsoft Speech SDK, or copy the corresponding speech API dll from my win7 machine and do regsvr32 on the machine.  But for demonstrating purpose, I decide to use web deploy  provider comObject32<\/a><\/strong> to package the COM component along with my application, so that the package can be easily deployed to many win2k3 machines.  We extend our project similarly to the one stated in the how to package registry blog<\/a>.  The extended projectName.wpp.targets file looks like following:<\/p>\n
<!--<\/span>******************************************************************** <\/span>-->\n<!-- <\/span>Task CollectcomObjectForPackage <\/span>-->\n<!-- <\/span>comObject32 Provider reference: http:\/\/technet.microsoft.com\/en-us\/library\/dd569107(WS.10).aspx <\/span>-->\n<!-- <\/span>comObject64 Provider reference: http:\/\/technet.microsoft.com\/en-us\/library\/dd569022(WS.10).aspx <\/span>-->\n<!--<\/span>********************************************************************<\/span>-->\n<<\/span>Project <\/span>xmlns<\/span>=<\/span>"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003<\/span>">\n  <<\/span>PropertyGroup<\/span>>\n    <!--<\/span>Targets get execute before this Target<\/span>-->\n    <<\/span>OnBeforeCollectcomObjectForPackage <\/span>Condition<\/span>=<\/span>"'$(OnBeforeCollectcomObjectForPackage)'==''<\/span>">\n    <\/<\/span>OnBeforeCollectcomObjectForPackage<\/span>>\n    <!--<\/span>Targets get execute after this Target<\/span>-->\n    <<\/span>OnAfterCollectcomObjectForPackage <\/span>Condition<\/span>=<\/span>"'$(OnAfterCollectcomObjectForPackage)'==''<\/span>">\n    <\/<\/span>OnAfterCollectcomObjectForPackage<\/span>>\n\n    <<\/span>CollectcomObjectForPackageDependsOn <\/span>Condition<\/span>=<\/span>"'$(CollectcomObjectForPackageDependsOn)'==''<\/span>">\n      <\/span>$(OnBeforeCollectcomObjectForPackage);\n      Build;\n    <\/<\/span>CollectcomObjectForPackageDependsOn<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>PropertyGroup<\/span>>\n    <<\/span>IncludecomObjectForMyProject <\/span>Condition<\/span>=<\/span>"'$(IncludecomObjectForMyProject)'==''<\/span>"><\/span>False<\/<\/span>IncludecomObjectForMyProject<\/span>>\n    <<\/span>MyComObject32s <\/span>Condition<\/span>=<\/span>"'$(MyComObject32s)'==''<\/span>"><\/<\/span>MyComObject32s<\/span>>\n    <<\/span>AfterAddContentPathToSourceManifest <\/span>Condition<\/span>=<\/span>"'$(AfterAddContentPathToSourceManifest)'==''<\/span>">\n      <\/span>$(AfterAddContentPathToSourceManifest);\n      CollectcomObjectForPackage;\n    <\/<\/span>AfterAddContentPathToSourceManifest<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>ItemGroup<\/span>>\n    <<\/span>MycomObject <\/span>Include <\/span>= <\/span>"$(MyComObject32s)<\/span>"\/>\n  <\/<\/span>ItemGroup<\/span>>\n\n  <<\/span>Target <\/span>Name<\/span>=<\/span>"CollectcomObjectForPackage<\/span>"\n          DependsOnTargets<\/span>=<\/span>"$(CollectcomObjectForPackageDependsOn)<\/span>"\n          Condition<\/span>=<\/span>"$(IncludecomObjectForMyProject) AND '$(MyComObject32s)'!=''<\/span>">\n\n    <<\/span>Message <\/span>Text<\/span>=<\/span>"Adding %(MycomObject.Identity)<\/span>" \/>\n    <<\/span>ItemGroup<\/span>>\n      <<\/span>MsDeploySourceManifest <\/span>Include<\/span>=<\/span>"comObject32<\/span>"\n                                 Condition<\/span>=<\/span>"$(IncludecomObjectForMyProject)<\/span>">\n        <<\/span>Path<\/span>><\/span>%(MycomObject.Identity)<\/<\/span>Path<\/span>>\n      <\/<\/span>MsDeploySourceManifest<\/span>>\n    <\/<\/span>ItemGroup<\/span>>\n    <<\/span>CallTarget <\/span>Targets<\/span>=<\/span>"$(OnAfterCollectcomObjectForPackage)<\/span>" RunEachTargetSeparately<\/span>=<\/span>"false<\/span>" \/>\n  <\/<\/span>Target<\/span>>\n<\/<\/span>Project<\/span>>\n\n<\/span><\/pre>\n
<\/a><\/p>\n
10. On my sample win2k3 machine, I manually copied WindowsSystem32SpeechCommonsapi.dll and did a registry export before and after regsvr32 it.  It turns out we need to include many registry node for speech API COM component.  I put it in the following package command line (really long).  Run it, you get a package with the speech API COM component.<\/p>\n
msbuild WebApplication5.csproj \/target:package \/p:IncludecomObjectForMyProject=True;MyComObject32s="SAPI.SpAudioFormat;SAPI.SpAudioFormat.1;SAPI.SpCompressedLexicon;SAPI.SpCompressedLexicon.1;SAPI.SpCustomStream;SAPI.SpCustomStream.1;SAPI.SpDataKey;SAPI.SpDataKey.1;SAPI.SpFileStream;SAPI.SpFileStream.1;SAPI.SpGramCompBackEnd;SAPI.SpGramCompBackEnd.1;SAPI.SpGrammarCompiler;SAPI.SpGrammarCompiler.1;SAPI.SpInProcRecoContext;SAPI.SpInProcRecoContext.1;SAPI.SpInprocRecognizer;SAPI.SpInprocRecognizer.1;SAPI.SpITNProcessor;SAPI.SpITNProcessor.1;SAPI.SpLexicon;SAPI.SpLexicon.1;SAPI.SpMemoryStream;SAPI.SpMemoryStream.1;SAPI.SpMMAudioEnum;SAPI.SpMMAudioEnum.1;SAPI.SpMMAudioIn;SAPI.SpMMAudioIn.1;SAPI.SpMMAudioOut;SAPI.SpMMAudioOut.1;SAPI.SPNotify;SAPI.SPNotify.1;SAPI.SpNotifyTranslator;SAPI.SpNotifyTranslator.1;SAPI.SpNullPhoneConverter;SAPI.SpNullPhoneConverter.1;SAPI.SpObjectToken;SAPI.SpObjectToken.1;SAPI.SpObjectTokenCategory;SAPI.SpObjectTokenCategory.1;SAPI.SpObjectTokenEnum;SAPI.SpObjectTokenEnum.1;SAPI.SpPhoneConverter;SAPI.SpPhoneConverter.1;SAPI.SpPhrase;SAPI.SpPhrase.1;SAPI.SpPhraseBuilder;SAPI.SpPhraseBuilder.1;SAPI.SpPhraseInfoBuilder;SAPI.SpPhraseInfoBuilder.1;SAPI.SpResourceManager;SAPI.SpResourceManager.1;SAPI.SpSharedRecoContext;SAPI.SpSharedRecoContext.1;SAPI.SpSharedRecognizer;SAPI.SpSharedRecognizer.1;SAPI.SpShortcut;SAPI.SpShortcut.1;SAPI.SpStream;SAPI.SpStream.1;SAPI.SpStreamFormatConverter;SAPI.SpStreamFormatConverter.1;SAPI.SpTextSelectionInformation;SAPI.SpTextSelectionInformation.1;SAPI.SpUncompressedLexicon;SAPI.SpUncompressedLexicon.1;SAPI.SpVoice;SAPI.SpVoice.1;SAPI.SpWaveFormatEx;SAPI.SpWaveFormatEx.1;SAPIEngine.TTSEngine;SAPIEngine.TTSEngine.1;{1B2AFB92-0B5E-4A30-B5CC-353DB4F9E150};{1B57B2A1-E763-4676-9064-297F1B413632};{2D12DD17-6C4E-456E-A953-D210E3C64176};{4C6F940C-3CFE-11D2-9EE7-00C04F797396};{4F414126-DFE3-4629-99EE-797978317EAD};{9CDAEA40-A7D3-4CC5-AED0-B5E35AD0F169};{C02F29F0-DFCA-4DC1-8B80-ED3216E1B5E0};{CA0AC604-8EF2-448A-AE97-62A2C2CC3C46};{D2C13906-51EF-454E-BC67-A52475FF074C};{D36D2090-4DF3-4BD4-A22F-0D91975F7964};{D6AD10F3-70AB-41E1-96B3-4C36E35D333C};{DC626A64-D684-4627-83CB-44420ABDBD1A};{F3D3F924-11FC-11D3-BB97-00C04F8EE6C0}"<\/p>\n
11. copy the package and deploy command file to win2k3 x86 machine with IIS6, using \u201c<ProjectName>.deploy.cmd \/y\u201d from command line. <\/p>\n
12. In IIS Manager, make sure the new deployed website is running with asp.net 2.0.  Create a new application pool and change its Identity to \u201cLocal System\u201d (Security risk, make sure you change it back after demo).  Assign the deployed website to use this application pool.  Test it out, it should work.<\/p>\n
 <\/p>\n
Note, for IIS7 to IIS7 package and deployment, we can include the application pool setting so that when deploy, a new application pool will be created (or existing be overwritten if app pool name already exists) and \u201cLocal System\u201d is granted as identity. (VS2010 beta1 version\u2019s topic is in http:\/\/blogs.msdn.com\/webdevtools\/archive\/2009\/02\/09\/web-packaging-creating-a-web-package-using-vs-2010.aspx<\/a> , the UI has changed a bit, but still the same mostly.)<\/p>\n
 <\/p>\n
Xinyang Qiu | Visual Web Developer<\/p>\n","protected":false},"excerpt":{"rendered":"
I\u2019ll use a walkthrough example to show how to package a web application with speech API COM component using Visual Studio 2010.  I wrote and tested the sample in Win7 x86 with IIS7.5, and packaged and manually installed to win2k3 x86 IIS6 (which only had 3.5 framework installed). 1. Create a C# 3.5 web application […]<\/p>\n","protected":false},"author":404,"featured_media":58792,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[7352,7353,7354,7323,7329],"class_list":["post-3254","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-aspnet","tag-package","tag-target-extension","tag-target-file","tag-visual-studio-2010","tag-web-deployment"],"acf":[],"blog_post_summary":"
I\u2019ll use a walkthrough example to show how to package a web application with speech API COM component using Visual Studio 2010.  I wrote and tested the sample in Win7 x86 with IIS7.5, and packaged and manually installed to win2k3 x86 IIS6 (which only had 3.5 framework installed). 1. Create a C# 3.5 web application […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/3254","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/404"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=3254"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/3254\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=3254"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=3254"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=3254"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}