From WikiChip
Editing mirc/component object model

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

This page supports semantic in-text annotations (e.g. "[[Is specified as::World Heritage Site]]") to build structured and queryable content provided by Semantic MediaWiki. For a comprehensive description on how to use annotations or the #ask parser function, please have a look at the getting started, in-text annotation, or inline queries help pages.

Latest revision Your text
Line 1: Line 1:
{{mirc title|Component Object Model}}
+
{{mIRC Guide}}
 
'''Component Object Model''' ('''COM''') is a specification for applications (like exe and dll files) to make their functionality available to any COM-compliant application. The applications interact with each other through a collection of functions called interfaces. The advantages of COM objects are that they are object-oriented, customizable, modular, upgradeable, and language-independent. Regardless of in which language they were programmed, any other language/script that supports the COM specification will be able to use it. mSL offers a variety of commands and identifiers to handle COM objects.
 
'''Component Object Model''' ('''COM''') is a specification for applications (like exe and dll files) to make their functionality available to any COM-compliant application. The applications interact with each other through a collection of functions called interfaces. The advantages of COM objects are that they are object-oriented, customizable, modular, upgradeable, and language-independent. Regardless of in which language they were programmed, any other language/script that supports the COM specification will be able to use it. mSL offers a variety of commands and identifiers to handle COM objects.
  
Line 26: Line 26:
 
<source lang="mIRC">/comclose <hName></source>
 
<source lang="mIRC">/comclose <hName></source>
  
Before we can go on to use the COM object, we have to confirm a successful connection has been established. The {{mIRC|$comerr}} will return 1 if the connection has failed, 0 otherwise.
+
Before we can go on to use the COM object, we have to confirm a successful connection has been established. The $comerr will return 1 if the connection has failed, 0 otherwise.
  
 
=== Connecting/Disconnecting Example ===
 
=== Connecting/Disconnecting Example ===
Below is a simple example of connecting to the windows script shell and disconnecting.
+
Below is a simple example of connecting to the windows script host and disconnecting.
  
 
<source lang="mIRC">alias example {
 
<source lang="mIRC">alias example {
Line 76: Line 76:
 
|}
 
|}
  
* These methods with an * are the result of a combination of multiple methods using the four basic methods (1, 2, 4, and 8). For example 5 = 1 + 4, set a property with a member call. Other combinations not included in the table above are possible.
+
* These methods are the result of a combination of multiple methods using the four basic methods (1, 2, 4, and 8). For example 5 = 1 + 4, set a property with a member call. Other combinations not included in the table above as possible.
  
 
=== Variable Type ===
 
=== Variable Type ===
Line 85: Line 85:
 
! Type !! Description !! Values  
 
! Type !! Description !! Values  
 
|-
 
|-
|i1 || single byte signed integer || -128 to 127
+
|i1 || single byte signed integer || 0 to 225
 
|-
 
|-
 
|ui1 || single byte unsigned integer || 0 to 255
 
|ui1 || single byte unsigned integer || 0 to 255
Line 127: Line 127:
  
 
== Invoking members ==
 
== Invoking members ==
To invoke a member of a COM object, we use the {{mIRC|$com}} identifier using the following sytax:
+
To invoke a member of a COM object, we use the $com identifier using the following sytax:
  
 
<source lang="mIRC">;member with no arguments
 
<source lang="mIRC">;member with no arguments
Line 147: Line 147:
 
#The argument is a string - data type is bstr
 
#The argument is a string - data type is bstr
  
Using the information above we can write our {{mIRC|$com}} identifier to invoke that method:
+
Using the information above we can write our $com identifier to invoke that method:
  
<source lang="mIRC">;Exec is the Object's member we are invoking
+
<source lang="mIRC">;Exec is the Object's memeber we are invoking
 
;1 = Call a member of an object
 
;1 = Call a member of an object
 
;bstr is the string data type of "calc"
 
;bstr is the string data type of "calc"
Line 155: Line 155:
 
$com(shellCOM, Exec, 1, bstr, calc)</source>
 
$com(shellCOM, Exec, 1, bstr, calc)</source>
  
{{mIRC|$com}} will return either 1 if the invocation of the Object's member was successful, 0 otherwise. It is a good practice to check if the invocation was a success. Below is the complete script:
+
$com will return either 1 if the invocation of the Object's member was successful, 0 otherwise. It is a good practice to check if the invocation was a success. Below is the complete script:
  
 
<source lang="mIRC">alias openCalc {
 
<source lang="mIRC">alias openCalc {
Line 172: Line 172:
  
 
== Value of A Property / Enumerated Collection ==
 
== Value of A Property / Enumerated Collection ==
Retrieving a value from an enumerated collection or a property (like a variable) can be done using the {{mIRC|$comval}} identifier following this syntax:
+
Retrieving a value from an enumerated collection or a property (like a variable) can be done using the $comval identifier following this syntax:
  
<source lang="mIRC">$comval(<hName>, <N>, <member>)</source>
+
<source lang="mIRC">$comval(<hName>, <N>, <memeber>)</source>
 
If the member returns an enumeration of values, you can traverse through them. When n = 0, it will return the total number of values in the enumeration.
 
If the member returns an enumeration of values, you can traverse through them. When n = 0, it will return the total number of values in the enumeration.
  
 
== Retrieving return values ==
 
== Retrieving return values ==
Recall from before, if we use invocation method value 2, we are indicating we want a return value. Well, to retrieve that value we can use the {{mIRC|$com}} identifier in a different way:
+
Recall from before, if we use invocation method value 2, we are indicating we want a return value. Well, to retrieve that value we can use the $com identifier in a different way:
  
 
<source lang="mIRC">var %value = $com(<hName>).result</source>
 
<source lang="mIRC">var %value = $com(<hName>).result</source>
Line 192: Line 192:
 
comopen mainObj some.object
 
comopen mainObj some.object
 
;dispatch the child's object onto his own com connection, named childObj
 
;dispatch the child's object onto his own com connection, named childObj
var %result = $com(mainObj, memberName, 3, dispatch* childObj)
+
var %result = $com(mainObj, memeberName, 3, dispatch* childObj)
 
;close the parent object
 
;close the parent object
 
comclose mainObj
 
comclose mainObj
 
;do something with the child object
 
;do something with the child object
var %result = $com(childObj, memberName, 1, ...)
+
var %result = $com(childObj, memeberName, 1, ...)
 
;close the child object
 
;close the child object
 
comclose childObj</source>
 
comclose childObj</source>
Line 260: Line 260:
 
}</source>
 
}</source>
  
Since we are now at the Win32_Porocessor object, all we have to do is retrieve the values. Recall from above that we can do that using the {{mIRC|$comval}} identifier:
+
Since we are now at the Win32_Porocessor object, all we have to do is retrieve the values. Recall from above that we can do that using the $comval identifier:
  
 
<source lang="mIRC">$comval(Win32_Processor, 1, <property>)</source>
 
<source lang="mIRC">$comval(Win32_Processor, 1, <property>)</source>
Line 294: Line 294:
  
 
== Other useful properties ==
 
== Other useful properties ==
The {{mIRC|$com}} identifier has a few other useful properties:
+
The $com identifier has a few other useful properties:
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 308: Line 308:
 
|progid || object's name
 
|progid || object's name
 
|-
 
|-
|dispatch/unknown || return {{mIRC|$true}} or {{mIRC|$null}} if a pointer to this object exists
+
|dispatch/unknown || return $true or $null if a pointer to this object exists
 
|}
 
|}
 
 
== Limitations of COM ==
 
Currently mIRC/mSL's COM implantation has a few limitations that other languages may not encounter.
 
 
=== COM Passing ===
 
There is no way to pass the raw result or object from one COM instance to another. For results that mIRC can interpret, such as strings or integers, this isn't an issue(unless the result is excessively long) but for a returned object there is currently no way to pass it to another com.
 
 
=== COM Events ===
 
mIRC/mSL does not support events that a COM instance may issue. The implantation works on a ask-receive programa, where mIRC requests the COM instance for data or to do something, and the instance is to return an immediate result.
 
  
 
== Examples ==
 
== Examples ==
Line 504: Line 494:
 
   return $gettok(%types, $calc($1 +1), 44)  
 
   return $gettok(%types, $calc($1 +1), 44)  
 
}</source>
 
}</source>
 
  
 
== Finding ProgIDs ==
 
== Finding ProgIDs ==
 
The only thing you might still be wondering about is: how do I find other ProgIDs? The answer is, you need to do a little research. They are all over the place. Below are two great tools you can use to find some of the ProgIDs that nest on your computer:  
 
The only thing you might still be wondering about is: how do I find other ProgIDs? The answer is, you need to do a little research. They are all over the place. Below are two great tools you can use to find some of the ProgIDs that nest on your computer:  
  
* [https://docs.microsoft.com/en-us/windows/desktop/com/ole-com-object-viewer OLE-COM Object Viewer] - Microsoft tool for locating COM Objects
+
* [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=5233b70d-d9b2-4cb5-aeb6-45664be858b6&displaylang=en OLE-COM Object Viewer] - Microsoft tool for locating COM Objects
 
* [http://www.nirsoft.net/utils/axhelper.html ActiveXHelper] - A small utility that allows you to view info about ActiveX components
 
* [http://www.nirsoft.net/utils/axhelper.html ActiveXHelper] - A small utility that allows you to view info about ActiveX components
  
Line 556: Line 545:
 
<nowiki>*</nowiki> Discontinued Product
 
<nowiki>*</nowiki> Discontinued Product
  
[[Category:mIRC|component object model]]
+
[[Category:mIRC]]

Please note that all contributions to WikiChip may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see WikiChip:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)