Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

Creating COM and DCOM objects with Perl

by JamesNC (Chaplain)
on Dec 12, 2005 at 20:11 UTC ( #516137=perltutorial: print w/ replies, xml ) Need Help??

Ok, you have a written a really cool perl program and you would like to use if from MSExcel or MSWord or from a WSH or VB script. Perhaps it is an interface to DBI or some other really great perl module. How do you do it?
This short tutorial for Win32 users explains how and give examples of how to share perl $scalars, @arrays and %hashes using a WSC - Windows Scripting Component to local and networked users. The documentation shows much more info. This tutorial is a just a quick and dirty how to get it working along with some stuff I have learned that is NOT in the documentation like how to do hashes( mimicked )
This tutorial also assumes that you know some VBA and how to open up the VB Editor in Excel.
Helpful links:
  • WSC Wizard Technically optional, but I would get this free tool that generates a .wsc framework for you.
  • WSH Optional on W2K/XP
  • WSC and WSH Documentation

    The process is fairly simple.

    1. Create a .WSC file ( recommend using the Wizard )
    2. Add Perl and/or Perlscript code to the .WSC file
    3. Register the .WSC COM object with windows
    4. In your VB code, use CreateObject to create a instance of the COM object
    Now on to the examples!

    Copy and paste the following code into a file named "pcom.WSC" ( Note: do not alter the classid in this file! )
    <?xml version="1.0"?> <component> <?component debug="true" ?> <registration description="pcom" progid="pcom.WSC" version="1.00" classid="{e91a2a76-18bc-4ab0-8b1c-06d6d0442287}" > </registration> <public> <method name="sortList"> <parameter name="vbArray"/> </method> <method name="getHash"> </method> <method name="getScalar"> <parameter name="scalar"/> </method> </public> <script language="PerlScript"> <![CDATA[ # Author: James Moosmann # Copyright 2005 use Win32::OLE::Variant; sub sortList { my @list = @_; @list = sort @list; my $ary = convertArrayToVBArray( \@list ); return $ary; } sub getHash { my @input = @_; my %dog = ( "buddy" => "dog" , "georgie", "dog" ); my $hash = convertHashToDict(\%dog); return $hash; } sub getScalar { my $scalar = $_[0]; if( $scalar =~/^[\d\.]+$/g ){ return $scalar+1; } return $scalar = "perl_saw:$scalar"; } sub convertHashToDict { my $hash_ref = $_[0]; my $dict = Win32::OLE->CreateObject("Scripting.Dictionary") or die + $!; foreach my $key ( keys %{$hash_ref} ){ $dict->add( $key, ${$hash_ +ref}{$key} ); } return $dict; } sub convertArrayToVBArray { my $array_ref = $_[0]; my $ary = Variant( VT_ARRAY|VT_VARIANT, $#{$array_ref}+1); $ary->Put(\@{$array_ref}); return $ary; } ]]> </script> </component>
    After you create the above file on your system. Then you just need to Register it with windows. In windows this is simple.
    1. Right click on the file
    2. Select -> Register
    Whew! That was tough.
    **You may also notice the "Generate Type Library" and wonder what it does. If it worked, it would help open up the api to your COM object and things like autocomplete in the VB editor would work for you. It kind of works in that if you were to create the typelib and then go to Excel and create a refrence to it, things would seem to work. But at run time when the COM object gets created, it is always the wrong type (Variant/Object) vs the Object that you created. So, don't even bother. Microsoft knows about this error and just hasn't fixed the documentation.

    Ok, we have Registered our COM object. Now, we need to use it! Here's how using Excel:
    Open a blank Excel sheet and add the following code to a module or sheet using the vba editor (aka Alt-F11 for newbies)

    Sub sortList_test() Set obj = CreateObject("pcom.WSC") Dim l() As Variant l = obj.sortList("fox", "dog", "moose", "cat", "fish") For Each li In l Debug.Print li Next li End End Sub Sub getHash_test() Set obj = CreateObject("pcom.WSC") Dim hash As Scripting.Dictionary Set hash = obj.getHash("dogHash") Debug.Print "Buddy is my " & hash.Item("buddy") End Sub Sub getScalar_test() Set obj = CreateObject("pcom.WSC") scalar = obj.getScalar(1) Debug.Print scalar scalar = obj.getScalar("a string! from VB") Debug.Print scalar End Sub

    Make sure that you have References to "Microsoft Scriptlet Library" and "Microsoft Scripting Runtime" selected. Call the subs and that's it for the fast track intro. I will elaborate more below on DCOM and a few more selected details.


    What about DCOM? Why use it?
    Your office mate on the same network doesn't have Perl installed on his box, but he wants to use your nifty perl object. DCOM comes to the rescue! Here are the steps needed to allow a user on another computer have access to the object. (Since this is documented in the above links I am only going to give an outline, search the docs for more details.)

    1. You need to modify the pcom.WSC file and add remotable attribute (be careful of the spelling! it is NOT remoteable) to the <registration ... > section like so:
      <registration description="pcom" progid="pcom.WSC" version="1.00" classid="{e91a2a76-18bc-4ab0-8b1c-06d6d0442287}" remotable="true" > </registration>
    Now, you can call the object by using the the 2 argument form of CreateObject in your VB like so...
    Set hash = obj.getHash("dogHash", "127.0.0.1")
    If you tried this, it would fail on your friends computer because you have to first register your object on his machine AND you need to give him permission to use that object from your computer.

    How to register your COM object on his computer

    1. Open up regedit and search for pcom.WSC
    2. Right-click on the "{e91a2a76-18bc-4ab0-8b1c-06d6d0442287}" entry (pcom.WSC's classid ) and then select Export from the popup menu.
    3. Save this registry entry as pcom.reg

    Now, you just can use this file to add the needed information to his registry. Copy the file to your friends computer and Merge the file with his registry. ( You can do that with a Right-click and select Merge )

    You are 1/2 way there. Now, you need to give him permission to access the object on your machine. You do that with "dcomcnfg.exe". This utility has a different interface for W2K and XP, so I will let you figure this part out. Basically, after you add the remotable entry, you will need to re-register the pcom.WSC file again, then open dcomcnfg.exe (on your machine) and browse the the pcom object and set the permissions for that object as appropriate. See the documentation for more details on how to run the object with different credentials. You can set security on the objects and more with the utility!

    What about debugging?
    The docs again. But my take on it is obviously debug your perl separately or in a .vb script where you can see the output more easily.

    Well, that's it. Hope it will open the world of amazing things perl can do with great ease and power to spread sheets and and other Windows applications for you.
    Other options I did not talk about include some solutions from ActiveState. They have some commercially available tools that can turn your scripts into stand alone controls and services, system tray utilities, apps and more. I don't work for them, but their PDK - Perl Dev Kit is worth the money IMHO if you want more robust features of doing these types of things.

    Cheers,
    JamesNC

  • Comment on Creating COM and DCOM objects with Perl
    Select or Download Code
    Re: Creating COM and DCOM objects with Perl
    by Anonymous Monk on Dec 13, 2005 at 06:33 UTC
      Good One. I think many people like me, would need this kind of information.
    Reaped: (tagged title)
    by NodeReaper (Curate) on Oct 17, 2007 at 07:31 UTC

    Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Node Status?
    node history
    Node Type: perltutorial [id://516137]
    help
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others romping around the Monastery: (8)
    As of 2014-11-23 10:15 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      My preferred Perl binaries come from:














      Results (130 votes), past polls