<?xml version="1.0" encoding="EUC-JP" ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>ruby-src:ext/win32ole/doc/win32ole.rd</title>
<meta http-equiv="Content-type" content="text/html; charset=EUC-JP" />
<link href="default.css" type="text/css" rel="stylesheet" />
<link href="refm467.html" rel="next" />
<link href="refm465.html" rel="prev" />
<link href="index.html" rel="start" />
</head>
<body>
<div class="navigator"><span class="navigator">[<a href="index.html">MAIN</a>][<a href="refm482.html">INDEX</a>][<a href="refm483.html">KEYWORD</a>][<a href="refm594.html">METHOD</a>(<a href="refm633.html">NC</a>)] [<a href="index.html">TOP</a>][<a href="index.html">UP</a>][<a href="refm465.html"><-PREV</a>][<a href="refm467.html">NEXT-></a>]</span></div>
<hr />
<h1><a name="L008894" id="L008894">Win32OLE extension module</a></h1>
<h2><a name="XXINVALIDXX" id="XXINVALIDXX">WIN32OLE </a></h2>
<h3><a name="L008896" id="L008896">Constants</a></h3>
<dl>
<dt><a name="L008897" id="L008897">VERSION</a></dt>
<dd>
<p>The version number of WIN32OLE.</p>
</dd>
<dt><a name="L008898" id="L008898">ARGV</a></dt>
<dd>
<p>The argument of the method invoked recently.
This constant is used to get value of argument
when the argument is passed by reference.</p>
</dd>
</dl>
<h3><a name="L008899" id="L008899">Class Method</a></h3>
<dl>
<dt><a name="L008900" id="L008900">connect(oleserver)</a></dt>
<dd>
<p>returns running OLE automation object or WIN32OLE object from moniker.</p>
</dd>
<dt><a name="L008901" id="L008901">const_load(ole [,obj])</a></dt>
<dd>
<p>defines the constants of OLE automation
server as 'obj' class constants. If 'obj' omitted, the default
is WIN32OLE.</p>
</dd>
<dt><a name="L008902" id="L008902">new(oleserver)</a></dt>
<dd>
<p>returns OLE Automation object.</p>
</dd>
<dt><a name="L008903" id="L008903">ole_free(obj)</a></dt>
<dd>
<p>invokes Release method of Dispatch interface of WIN32OLE object.
This method should not be used because this method exists for debugging WIN32OLE.</p>
</dd>
<dt><a name="L008904" id="L008904">ole_reference_count(obj)</a></dt>
<dd>
<p>returns reference counter of Dispatch interface.
This method should not be used because this method exists for debugging WIN32OLE.</p>
</dd>
<dt><a name="L008905" id="L008905">ole_show_help(info [,helpcontext])</a></dt>
<dd>
<p>displays helpfile.
The first argument specifies WIN32OLE_TYPE object or WIN32OLE_METHOD object
or helpfile.</p>
</dd>
</dl>
<h3><a name="L008906" id="L008906">Method</a></h3>
<dl>
<dt><a name="L008907" id="L008907">self[property]</a></dt>
<dd>
<p>gets property of OLE object.</p>
</dd>
<dt><a name="L008908" id="L008908">self[property]=</a></dt>
<dd>
<p>sets property of OLE object.</p>
</dd>
<dt><a name="L008909" id="L008909">_invoke(dispid, args, types)</a></dt>
<dd>
<p>runs the early binding method.
The dispid specifies Dispatch ID, args specifies the array of arguments,
types specifies array of the type of arguments.</p>
</dd>
<dt><a name="L008910" id="L008910">each {...}</a></dt>
<dd>
<p>Iterates over each item of OLE collection which has IEnumVARIANT
interface.</p>
</dd>
<dt><a name="L008911" id="L008911">invoke(method, args,...)</a></dt>
<dd>
<p>runs OLE method.</p>
</dd>
<dt><a name="L008912" id="L008912">ole_func_methods</a></dt>
<dd>
<p>returns array of WIN32OLE_METHOD object which corresponds with function.</p>
</dd>
<dt><a name="L008913" id="L008913">ole_get_methods</a></dt>
<dd>
<p>returns array of WIN32OLE_METHOD object which corresponds with get properties.</p>
</dd>
<dt><a name="L008914" id="L008914">ole_method(method)</a></dt>
<dd>
<p>returns WIN32OLE_METHOD object which coreesponds with method
which specified by argument.</p>
</dd>
<dt><a name="L008915" id="L008915">ole_method_help(method)</a></dt>
<dd>
<p>alias of ole_method.</p>
</dd>
<dt><a name="L008916" id="L008916">ole_methods</a></dt>
<dd>
<p>returns WIN32OLE_METHOD object which coreesponds with method.</p>
</dd>
<dt><a name="L008917" id="L008917">ole_obj_help</a></dt>
<dd>
<p>returns WIN32OLE_TYPE object.</p>
</dd>
<dt><a name="L008918" id="L008918">ole_put_methods</a></dt>
<dd>
<p>returns array of WIN32OLE_METHOD object which corresponds with put properties.</p>
</dd>
<dt><a name="L008919" id="L008919">setproperty(property, key, val)</a></dt>
<dd>
<p>set property of OLE object.
This method is used when the property has argument.</p>
<p>For example, in VB</p>
<pre>obj.item("key") = val</pre>
<p>in Win32OLE</p>
<pre>obj.setproperty("item", "key", val)</pre>
</dd>
</dl>
<h2><a name="L008920" id="L008920">WIN32OLE_EVENT class</a></h2>
<h3><a name="L008899" id="L008899">Class Method</a></h3>
<dl>
<dt><a name="L008921" id="L008921">new(ole, interface)</a></dt>
<dd>
<p>The new class method creates OLE event sink object to connect ole.
The ole must be WIN32OLE object, and interface is the interface
name of event.</p>
</dd>
<dt><a name="L008922" id="L008922">message_loop</a></dt>
<dd>
<p>The message_loop class method translates and dispatches Windows
message.</p>
</dd>
</dl>
<h3><a name="L008906" id="L008906">Method</a></h3>
<dl>
<dt><a name="L008923" id="L008923">on_event([event]){...}</a></dt>
<dd>
<p>defines the callback of event.
If event omitted, defines the callback of all events.</p>
</dd>
<dt><a name="L008924" id="L008924">on_event_with_outargs([event]) {...}</a></dt>
<dd>
<p>defines the callback of event.
If you want modify argument in callback, </p>
</dd>
</dl>
<h2><a name="L008925" id="L008925">WIN32OLE_METHOD</a></h2>
<h3><a name="L008926" id="L008926">Class Methods</a></h3>
<dl>
<dt><a name="L008927" id="L008927">new(win32ole_type, method)</a></dt>
<dd>
<p>creates WIN32OLE_METHOD object.</p>
</dd>
</dl>
<h3><a name="L008928" id="L008928">Methods</a></h3>
<dl>
<dt><a name="L008929" id="L008929">dispid</a></dt>
<dd>
<p>returns Dispatch ID.</p>
</dd>
<dt><a name="L008930" id="L008930">event?</a></dt>
<dd>
<p>returns true if the method is event.</p>
</dd>
<dt><a name="L008931" id="L008931">event_interface</a></dt>
<dd>
<p>returns interface name of event if the method is event.</p>
</dd>
<dt><a name="L008932" id="L008932">helpcontext</a></dt>
<dd>
<p>returns help context.</p>
</dd>
<dt><a name="L008933" id="L008933">helpfile</a></dt>
<dd>
<p>returns help file.</p>
</dd>
<dt><a name="L008934" id="L008934">invkind</a></dt>
<dd>
<p>returns invkind.</p>
</dd>
<dt><a name="L008935" id="L008935">invoke_kind</a></dt>
<dd>
<p>returns invoke kind string.</p>
</dd>
<dt><a name="L008936" id="L008936">name</a></dt>
<dd>
<p>returns name of method.</p>
</dd>
<dt><a name="L008937" id="L008937">offset_vtbl</a></dt>
<dd>
<p>returns the offset of Vtbl.</p>
</dd>
<dt><a name="L008938" id="L008938">params</a></dt>
<dd>
<p>returns array of WIN32OLE_PARAM object.</p>
</dd>
<dt><a name="L008939" id="L008939">return_type</a></dt>
<dd>
<p>returns string of return value type of method.</p>
</dd>
<dt><a name="L008940" id="L008940">return_vtype</a></dt>
<dd>
<p>returns number of return value type of method.</p>
</dd>
<dt><a name="L008941" id="L008941">return_type_detail</a></dt>
<dd>
<p>returns detail information of return value type of method.</p>
</dd>
<dt><a name="L008942" id="L008942">size_params</a></dt>
<dd>
<p>returns the size of arguments.</p>
</dd>
<dt><a name="L008943" id="L008943">size_opt_params</a></dt>
<dd>
<p>returns the size of optional arguments.</p>
</dd>
<dt><a name="L008944" id="L008944">visible?</a></dt>
<dd>
<p>returns true if the method is public.</p>
</dd>
</dl>
<h2><a name="L008945" id="L008945">WIN32OLE_PARAM</a></h2>
<dl>
<dt><a name="L008946" id="L008946">default</a></dt>
<dd>
<p>returns default value.</p>
</dd>
<dt><a name="L008947" id="L008947">input?</a></dt>
<dd>
<p>returns true if argument is input.</p>
</dd>
<dt><a name="L008948" id="L008948">optional?</a></dt>
<dd>
<p>returns true if argument is optional.</p>
</dd>
<dt><a name="L008949" id="L008949">output?</a></dt>
<dd>
<p>returns true if argument is output.</p>
</dd>
<dt><a name="L008936" id="L008936">name</a></dt>
<dd>
<p>returns name.</p>
</dd>
<dt><a name="L008950" id="L008950">ole_type</a></dt>
<dd>
<p>returns type of argument.</p>
</dd>
<dt><a name="L008951" id="L008951">ole_type_detail</a></dt>
<dd>
<p>returns detail information of type of argument.</p>
</dd>
<dt><a name="L008952" id="L008952">retval?</a></dt>
<dd>
<p>returns true if argument is return value.</p>
</dd>
</dl>
<h2><a name="L008953" id="L008953">WIN32OLE_TYPE</a></h2>
<h3><a name="L008926" id="L008926">Class Methods</a></h3>
<dl>
<dt><a name="L008954" id="L008954">new(typelibrary, class)</a></dt>
<dd>
<p>returns WIN32OLE_TYPE object.</p>
</dd>
<dt><a name="L008955" id="L008955">ole_classes(typelibrary)</a></dt>
<dd>
<p>returns array of WIN32OLE_TYPE objects defined by Type Library.</p>
</dd>
<dt><a name="L008956" id="L008956">progids</a></dt>
<dd>
<p>returns array of ProgID.</p>
</dd>
<dt><a name="L008957" id="L008957">typelibs</a></dt>
<dd>
<p>returns array of type libraries.</p>
</dd>
</dl>
<h3><a name="L008928" id="L008928">Methods</a></h3>
<dl>
<dt><a name="L008958" id="L008958">guid</a></dt>
<dd>
<p>returns GUID.</p>
</dd>
<dt><a name="L008933" id="L008933">helpfile</a></dt>
<dd>
<p>returns helpfile.</p>
</dd>
<dt><a name="L008932" id="L008932">helpcontext</a></dt>
<dd>
<p>returns helpcontext.</p>
</dd>
<dt><a name="L008959" id="L008959">helpstring</a></dt>
<dd>
<p>returns help string.</p>
</dd>
<dt><a name="L008960" id="L008960">major_version</a></dt>
<dd>
<p>returns major version.</p>
</dd>
<dt><a name="L008961" id="L008961">minor_version</a></dt>
<dd>
<p>returns minor version.</p>
</dd>
<dt><a name="L008936" id="L008936">name</a></dt>
<dd>
<p>returns name.</p>
</dd>
<dt><a name="L008916" id="L008916">ole_methods</a></dt>
<dd>
<p>returns array of WIN32OLE_METHOD objects.</p>
</dd>
<dt><a name="L008950" id="L008950">ole_type</a></dt>
<dd>
<p>returns type of class.</p>
</dd>
<dt><a name="L008962" id="L008962">progid</a></dt>
<dd>
<p>returns ProgID if it exists. If not found, then returns nil.</p>
</dd>
<dt><a name="L008963" id="L008963">src_type</a></dt>
<dd>
<p>returns source class when the OLE class is 'Alias'.</p>
</dd>
<dt><a name="L008964" id="L008964">typekind</a></dt>
<dd>
<p>returns number which represents type.</p>
</dd>
<dt><a name="L008965" id="L008965">variables</a></dt>
<dd>
<p>returns array of variables defined in OLE class.</p>
</dd>
<dt><a name="L008944" id="L008944">visible?</a></dt>
<dd>
<p>returns true if the OLE class is public.</p>
</dd>
</dl>
<h2><a name="L008966" id="L008966">WIN32OLE_VARIABLE</a></h2>
<h3><a name="L008928" id="L008928">Methods</a></h3>
<dl>
<dt><a name="L008936" id="L008936">name</a></dt>
<dd>
<p>returns the name.</p>
</dd>
<dt><a name="L008950" id="L008950">ole_type</a></dt>
<dd>
<p>returns type</p>
</dd>
<dt><a name="L008951" id="L008951">ole_type_detail</a></dt>
<dd>
<p>returns detail information of type.</p>
</dd>
<dt><a name="L008967" id="L008967">value</a></dt>
<dd>
<p>returns value.</p>
</dd>
<dt><a name="L008968" id="L008968">variable_kind</a></dt>
<dd>
<p>returns variable kind string.</p>
</dd>
<dt><a name="L008969" id="L008969">varkind</a></dt>
<dd>
<p>returns the number which represents variable kind.</p>
</dd>
</dl>
<h2><a name="L008970" id="L008970">WIN32OLE::VARIANT</a></h2>
<h3><a name="L008896" id="L008896">Constants</a></h3>
<ul>
<li>VT_I4</li>
<li>VT_R4</li>
<li>VT_R8</li>
<li>VT_CY</li>
<li>VT_DATE</li>
<li>VT_BSTR</li>
<li>VT_USERDEFINED</li>
<li>VT_PTR</li>
<li>VT_DISPATCH</li>
<li>VT_ERROR</li>
<li>VT_BOOL</li>
<li>VT_VARIANT</li>
<li>VT_UNKNOWN</li>
<li>VT_I1</li>
<li>VT_UI1</li>
<li>VT_UI2</li>
<li>VT_UI4</li>
<li>VT_INT</li>
<li>VT_UINT</li>
<li>VT_ARRAY</li>
<li>VT_BYREF</li>
</ul>
<hr />
<div class="navigator"><span class="navigator">[<a href="index.html">MAIN</a>][<a href="refm482.html">INDEX</a>][<a href="refm483.html">KEYWORD</a>][<a href="refm594.html">METHOD</a>(<a href="refm633.html">NC</a>)] [<a href="index.html">TOP</a>][<a href="index.html">UP</a>][<a href="refm465.html"><-PREV</a>][<a href="refm467.html">NEXT-></a>]</span></div>
</body>
</html>
