File: C:/Ruby27-x64/share/doc/ruby/html/WIN32OLE_METHOD.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WIN32OLE_METHOD - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-dispid">#dispid</a>
<li ><a href="#method-i-event-3F">#event?</a>
<li ><a href="#method-i-event_interface">#event_interface</a>
<li ><a href="#method-i-helpcontext">#helpcontext</a>
<li ><a href="#method-i-helpfile">#helpfile</a>
<li ><a href="#method-i-helpstring">#helpstring</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-invkind">#invkind</a>
<li ><a href="#method-i-invoke_kind">#invoke_kind</a>
<li ><a href="#method-i-name">#name</a>
<li ><a href="#method-i-offset_vtbl">#offset_vtbl</a>
<li ><a href="#method-i-params">#params</a>
<li ><a href="#method-i-return_type">#return_type</a>
<li ><a href="#method-i-return_type_detail">#return_type_detail</a>
<li ><a href="#method-i-return_vtype">#return_vtype</a>
<li ><a href="#method-i-size_opt_params">#size_opt_params</a>
<li ><a href="#method-i-size_params">#size_params</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-visible-3F">#visible?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WIN32OLE_METHOD">
<h1 id="class-WIN32OLE_METHOD" class="class">
class WIN32OLE_METHOD
</h1>
<section class="description">
<p><code>WIN32OLE_METHOD</code> objects represent OLE method information.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
new(ole_type, method) → WIN32OLE_METHOD object
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new <a href="WIN32OLE_METHOD.html"><code>WIN32OLE_METHOD</code></a> object which represents the information about OLE method. The first argument <em>ole_type</em> specifies <a href="WIN32OLE_TYPE.html"><code>WIN32OLE_TYPE</code></a> object. The second argument <em>method</em> specifies OLE method name defined OLE class which represents <a href="WIN32OLE_TYPE.html"><code>WIN32OLE_TYPE</code></a> object.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
</pre>
<div class="method-source-code" id="new-source">
<pre>static VALUE
folemethod_initialize(VALUE self, VALUE oletype, VALUE method)
{
VALUE obj = Qnil;
ITypeInfo *pTypeInfo;
if (rb_obj_is_kind_of(oletype, cWIN32OLE_TYPE)) {
SafeStringValue(method);
pTypeInfo = itypeinfo(oletype);
obj = olemethod_from_typeinfo(self, pTypeInfo, method);
if (obj == Qnil) {
rb_raise(eWIN32OLERuntimeError, "not found %s",
StringValuePtr(method));
}
}
else {
rb_raise(rb_eTypeError, "1st argument should be WIN32OLE_TYPE object");
}
return obj;
}</pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-dispid" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#dispid
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns dispatch ID.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">dispid</span> <span class="ruby-comment"># => 181</span>
</pre>
<div class="method-source-code" id="dispid-source">
<pre>static VALUE
folemethod_dispid(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_dispid(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-event-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#event?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the method is event.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SheetActivate'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">event?</span> <span class="ruby-comment"># => true</span>
</pre>
<div class="method-source-code" id="event-3F-source">
<pre>static VALUE
folemethod_event(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
if (!pmethod->pOwnerTypeInfo)
return Qfalse;
return ole_method_event(pmethod->pOwnerTypeInfo,
pmethod->index,
rb_ivar_get(self, rb_intern("name")));
}</pre>
</div>
</div>
</div>
<div id="method-i-event_interface" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#event_interface
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns event interface name if the method is event.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SheetActivate'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">event_interface</span> <span class="ruby-comment"># => WorkbookEvents</span>
</pre>
<div class="method-source-code" id="event_interface-source">
<pre>static VALUE
folemethod_event_interface(VALUE self)
{
BSTR name;
struct olemethoddata *pmethod;
HRESULT hr;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
if(folemethod_event(self) == Qtrue) {
hr = ole_docinfo_from_type(pmethod->pTypeInfo, &name, NULL, NULL, NULL);
if(SUCCEEDED(hr))
return WC2VSTR(name);
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-helpcontext" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#helpcontext
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns help context.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">helpcontext</span> <span class="ruby-comment"># => 65717</span>
</pre>
<div class="method-source-code" id="helpcontext-source">
<pre>static VALUE
folemethod_helpcontext(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpcontext(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-helpfile" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#helpfile
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns help file. If help file is not found, then the method returns nil.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">helpfile</span> <span class="ruby-comment"># => C:\...\VBAXL9.CHM</span>
</pre>
<div class="method-source-code" id="helpfile-source">
<pre>static VALUE
folemethod_helpfile(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpfile(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-helpstring" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#helpstring
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns help string of OLE method. If the help string is not found, then the method returns nil.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Internet Controls'</span>, <span class="ruby-string">'IWebBrowser'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Navigate'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">helpstring</span> <span class="ruby-comment"># => Navigates to a URL or file.</span>
</pre>
<div class="method-source-code" id="helpstring-source">
<pre>static VALUE
folemethod_helpstring(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_helpstring(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#inspect → String
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the method name with class name.</p>
<div class="method-source-code" id="inspect-source">
<pre>static VALUE
folemethod_inspect(VALUE self)
{
return default_inspect(self, "WIN32OLE_METHOD");
}</pre>
</div>
</div>
</div>
<div id="method-i-invkind" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_MTHOD#invkind
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the method invoke kind.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">invkind</span> <span class="ruby-comment"># => 1</span>
</pre>
<div class="method-source-code" id="invkind-source">
<pre>static VALUE
folemethod_invkind(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_invkind(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-invoke_kind" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#invoke_kind
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the method kind string. The string is “UNKNOWN” or “PROPERTY” or “PROPERTY” or “PROPERTYGET” or “PROPERTYPUT” or “PROPERTYPPUTREF” or “FUNC”.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">invoke_kind</span> <span class="ruby-comment"># => "FUNC"</span>
</pre>
<div class="method-source-code" id="invoke_kind-source">
<pre>static VALUE
folemethod_invoke_kind(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_invoke_kind(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-name" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#name
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the name of the method.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">name</span> <span class="ruby-comment"># => SaveAs</span>
</pre>
<div class="method-source-code" id="name-source">
<pre>static VALUE
folemethod_name(VALUE self)
{
return rb_ivar_get(self, rb_intern("name"));
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="WIN32OLE_METHOD.html#method-i-to_s">to_s</a>
</div>
</div>
<div id="method-i-offset_vtbl" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#offset_vtbl
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the offset ov VTBL.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">offset_vtbl</span> <span class="ruby-comment"># => 40</span>
</pre>
<div class="method-source-code" id="offset_vtbl-source">
<pre>static VALUE
folemethod_offset_vtbl(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_offset_vtbl(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-params" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#params
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns array of <a href="WIN32OLE_PARAM.html"><code>WIN32OLE_PARAM</code></a> object corresponding with method parameters.</p>
<pre>tobj = WIN32OLE_TYPE.new('Microsoft Excel 9.0 Object Library', 'Workbook')
method = WIN32OLE_METHOD.new(tobj, 'SaveAs')
p method.params # => [Filename, FileFormat, Password, WriteResPassword,
ReadOnlyRecommended, CreateBackup, AccessMode,
ConflictResolution, AddToMru, TextCodepage,
TextVisualLayout]</pre>
<div class="method-source-code" id="params-source">
<pre>static VALUE
folemethod_params(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_params(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-return_type" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#return_type
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns string of return value type of method.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">return_type</span> <span class="ruby-comment"># => Workbook</span>
</pre>
<div class="method-source-code" id="return_type-source">
<pre>static VALUE
folemethod_return_type(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_type(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-return_type_detail" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#return_type_detail
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns detail information of return value type of method. The information is array.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">p</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">return_type_detail</span> <span class="ruby-comment"># => ["PTR", "USERDEFINED", "Workbook"]</span>
</pre>
<div class="method-source-code" id="return_type_detail-source">
<pre>static VALUE
folemethod_return_type_detail(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_type_detail(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-return_vtype" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#return_vtype
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns number of return value type of method.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">return_vtype</span> <span class="ruby-comment"># => 26</span>
</pre>
<div class="method-source-code" id="return_vtype-source">
<pre>static VALUE
folemethod_return_vtype(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_return_vtype(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-size_opt_params" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#size_opt_params
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the size of optional parameters.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">size_opt_params</span> <span class="ruby-comment"># => 4</span>
</pre>
<div class="method-source-code" id="size_opt_params-source">
<pre>static VALUE
folemethod_size_opt_params(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_size_opt_params(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-size_params" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#size_params
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the size of arguments of the method.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbook'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'SaveAs'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">size_params</span> <span class="ruby-comment"># => 11</span>
</pre>
<div class="method-source-code" id="size_params-source">
<pre>static VALUE
folemethod_size_params(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_size_params(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="WIN32OLE_METHOD.html#method-i-name">name</a>
</div>
</div>
<div id="method-i-visible-3F" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
WIN32OLE_METHOD#visible?
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the method is public.</p>
<pre class="ruby"><span class="ruby-identifier">tobj</span> = <span class="ruby-constant">WIN32OLE_TYPE</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Microsoft Excel 9.0 Object Library'</span>, <span class="ruby-string">'Workbooks'</span>)
<span class="ruby-identifier">method</span> = <span class="ruby-constant">WIN32OLE_METHOD</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tobj</span>, <span class="ruby-string">'Add'</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">visible?</span> <span class="ruby-comment"># => true</span>
</pre>
<div class="method-source-code" id="visible-3F-source">
<pre>static VALUE
folemethod_visible(VALUE self)
{
struct olemethoddata *pmethod;
TypedData_Get_Struct(self, struct olemethoddata, &olemethod_datatype, pmethod);
return ole_method_visible(pmethod->pTypeInfo, pmethod->index);
}</pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>